https://github.com/offchainlabs/gnosis-safe-contracts
https://github.com/offchainlabs/gnosis-safe-contracts
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/offchainlabs/gnosis-safe-contracts
- Owner: OffchainLabs
- License: lgpl-3.0
- Created: 2021-05-26T00:11:35.000Z (about 5 years ago)
- Default Branch: arb-kovan5
- Last Pushed: 2021-05-26T00:12:29.000Z (about 5 years ago)
- Last Synced: 2025-01-08T02:18:22.119Z (over 1 year ago)
- Language: TypeScript
- Size: 5.3 MB
- Stars: 3
- Watchers: 27
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Gnosis Safe Contracts
=====================
[](https://badge.fury.io/js/%40gnosis.pm%2Fsafe-contracts)
[](https://github.com/gnosis/safe-contracts/actions)
[](https://coveralls.io/github/gnosis/safe-contracts)
Usage
-----
### Install requirements with yarn:
```bash
yarn
```
### Run all tests:
```bash
yarn build
yarn test
```
### Deployments
A collection of the different Safe contract deployments and their addresses can be found in the [Safe deployments](https://github.com/gnosis/safe-deployments) repository.
To add support for a new network follow the steps of the ``Deploy`` section and create a PR in the [Safe deployments](https://github.com/gnosis/safe-deployments) repository.
### Deploy
> :warning: **Make sure to use the correct commit when deploying the contracts.** Any change (even comments) within the contract files will result in different addresses. The tagged versions that are used by the Gnosis Safe team can be found in the [releases](https://github.com/gnosis/safe-contracts/releases).
This will deploy the contracts deterministically and verify the contracts on etherscan using [Solidity 0.7.6](https://github.com/ethereum/solidity/releases/tag/v0.7.6) by default.
Preparation:
- Set `MNEMONIC` in `.env`
- Set `INFURA_KEY` in `.env`
```bash
yarn deploy-all
```
This will perform the following steps
```bash
yarn build
yarn hardhat --network deploy
yarn hardhat --network etherscan-verify
yarn hardhat --network local-verify
```
#### Custom Networks
It is possible to use the `NODE_URL` env var to connect to any EVM based network via an RPC endpoint. This connection then can be used with the `custom` network.
E.g. to deploy the Safe contract suite on that network you would run `yarn deploy-all custom`.
The resulting addresses should be on all networks the same.
Note: Address will vary if contract code is changed or a different Solidity version is used.
### Verify contract
This command will use the deployment artifacts to compile the contracts and compare them to the onchain code
```bash
yarn hardhat --network local-verify
```
This command will upload the contract source to Etherescan
```bash
yarn hardhat --network etherscan-verify
```
Documentation
-------------
- [Safe developer portal](http://docs.gnosis.io/safe)
- [Error codes](docs/error_codes.md)
- [Coding guidelines](docs/guidelines.md)
Audits/ Formal Verification
---------
- [for Version 1.3.0 by G0 Group](docs/audit_1_3_0.md)
- [for Version 1.2.0 by G0 Group](docs/audit_1_2_0.md)
- [for Version 1.1.1 by G0 Group](docs/audit_1_1_1.md)
- [for Version 1.0.0 by Runtime Verification](docs/rv_1_0_0.md)
- [for Version 0.0.1 by Alexey Akhunov](docs/alexey_audit.md)
Security and Liability
----------------------
All contracts are WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
License
-------
All smart contracts are released under LGPL-3.0