Gnosis Safe allows secure management of blockchain assets.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Go to file
Mikhail 689f4c536c
Merge pull request #535 from safe-global/feat/audit-notes
7 hours ago
.github rename gnosissafe to safe 2 months ago
.husky Closes #201: Allow storage to be read on-chain (#269) 2 years ago
.vscode Support debug in visual studio code 3 years ago
benchmark Rename DefaultCallbackHandler to TokenFallbackHandler 4 weeks ago
contracts add a warning about guards 7 hours ago
docs add a warning about guards 7 hours ago
src Rename DefaultCallbackHandler to TokenFallbackHandler 4 weeks ago
test Update docs/error_codes.md 23 hours ago
tests_deprecated Closes #251: Update solc compiler (#271) 2 years ago
types add linting 2 months ago
.env.sample use safe-singleton-factory for deployment 3 months ago
.eslintrc.js add linting 2 months ago
.gitattributes Create .gitattributes 5 years ago
.gitignore Tooling PR (#296) 2 years ago
.nvmrc Backmerge 1.3.0 libs.0 (#383) 10 months ago
.prettierrc Docs: Improve documentation of `common/` contracts (#510) 4 weeks ago
.solcover.js add prettier formatting for ts & format files 2 months ago
.solhint.json add prettier formatting for ts & format files 2 months ago
CHANGELOG.md Update Readme (#457) 3 months ago
LICENSE Create LICENSE 5 years ago
README.md use safe-singleton-factory for deployment 3 months ago
hardhat.config.ts add prettier formatting for ts & format files 2 months ago
package.json Docs: Improve Accessors and Manager contracts documentation (#507) 1 month ago
tsconfig.json Tooling PR (#296) 2 years ago
yarn.lock Docs: Improve Accessors and Manager contracts documentation (#507) 1 month ago

README.md

Safe Contracts

npm version Build Status Coverage Status

⚠️ This branch contains changes that are under development To use the latest audited version make sure to use the correct commit. The tagged versions that are used by the Safe team can be found in the releases.

Usage

Install requirements with yarn:

yarn

Run all tests:

yarn build
yarn test

Deployments

A collection of the different Safe contract deployments and their addresses can be found in the 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 repository.

Deploy

⚠️ 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 Safe team can be found in the releases.

Current version: The latest release is v1.3.0-libs.0 on the commit 767ef36

This will deploy the contracts deterministically and verify the contracts on etherscan using Solidity 0.7.6 by default.

Preparation:

  • Set MNEMONIC in .env
  • Set INFURA_KEY in .env
yarn deploy-all <network>

This will perform the following steps

yarn build
yarn hardhat --network <network> deploy
yarn hardhat --network <network> sourcify
yarn hardhat --network <network> etherscan-verify
yarn hardhat --network <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.

Replay protection (EIP-155)

Some networks require replay protection, making it incompatible with the default deployment process as it relies on a presigned transaction without replay protection (see https://github.com/Arachnid/deterministic-deployment-proxy).

Safe contracts use a different deterministic deployment proxy (https://github.com/safe-global/safe-singleton-factory). To make sure that the latest version of this package is installed, make sure to run yarn add @gnosis.pm/safe-singleton-factory before deployment. For more information, including how to deploy the factory to a new network, please refer to the factory repo.

Note: This will result in different addresses compared to hardhat's default deterministic deployment process.

Verify contract

This command will use the deployment artifacts to compile the contracts and compare them to the onchain code

yarn hardhat --network <network> local-verify

This command will upload the contract source to Etherescan

yarn hardhat --network <network> etherscan-verify

Documentation

Audits/ Formal Verification

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