Skip to content

Commit

Permalink
Update README and add license
Browse files Browse the repository at this point in the history
  • Loading branch information
garyghayrat committed Feb 6, 2024
1 parent 8131727 commit e7f405a
Show file tree
Hide file tree
Showing 2 changed files with 76 additions and 1 deletion.
22 changes: 22 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
The MIT License (MIT)

Copyright (c) 2016-2023 zOS Global Limited and contributors

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
55 changes: 54 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,67 @@
# ERC-5564 and ERC-6538 Contracts

This repo contains the canonical implementations of the ERC-5564 and ERC-6538 contracts:

- [ERC-5564](https://eips.ethereum.org/EIPS/eip-5564) Stealth Addresses: Private, non-interactive transfers and interactions.
- [ERC-6538](https://eips.ethereum.org/EIPS/eip-6538) Stealth Meta-Address Registry: A registry to map addresses to stealth meta-addresses

## Development
## Usage

This repo is developed using [Foundry](https://book.getfoundry.sh/).

### Setup

1. Install [Foundry](https://book.getfoundry.sh/getting-started/installation) on your local machine by opening the terminal and running the following command:

```sh
curl -L https://foundry.paradigm.xyz | bash
```

2. Clone the repo and navigate to the root directory of the repo.

```sh
git clone [email protected]:ScopeLift/stealth-address-erc-contracts.git
cd stealth-address-erc-contracts
```

### Compile

```sh
# Build the contracts
forge build
```

### Test

```sh
# Run the tests
forge test
```

### Coverage

```sh
# See test coverage
forge coverage
```

### Specifications

#### Pre-requisites

1. Install the [rust toolchain](https://www.rust-lang.org/tools/install).
2. Run `cargo install scopelint`

#### See contract specifications

```sh
scopelint spec
```

## Deployments

## Security

## License

Contracts in this repository are released under the [MIT License](https://github.com/ScopeLift/stealth-address-erc-contracts/blob/main/LICENSE).

0 comments on commit e7f405a

Please sign in to comment.