Skip to content

Commit 3d360a3

Browse files
authored
Update Readme (#457)
* Update Readme * Update CHANGELOG.md * Update package.json * Update bug_report.md * Update feature_request.md * Update safe_tx_gas.md * Update alexey_audit.md * Update audit_1_1_1.md * Update audit_1_2_0.md * Update audit_1_3_0.md * Update rv_1_0_0.md
1 parent c36bcab commit 3d360a3

File tree

11 files changed

+72
-72
lines changed

11 files changed

+72
-72
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ about: Bug report about the Safe smart contracts
77
## Prerequisites
88

99
- First, many thanks for taking part in the community and helping us improve. We appreciate that a lot.
10-
- Support questions are better asked in our Gitter chat: https://gitter.im/gnosis/Safe
10+
- Support questions are better asked in our Discord: https://chat.safe.global
1111
- Please ensure the issue isn't already reported.
1212

1313
*Please delete the above section and the instructions in the sections below before submitting*

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ about: Suggest an idea or feature request for the Safe smart contracts project
77
## Prerequisites
88

99
- First, many thanks for taking part in the community and helping us improve. We appreciate that a lot.
10-
- Support questions are better asked in our Gitter chat: https://gitter.im/gnosis/Safe
10+
- Support questions are better asked in our Discord: https://chat.safe.global
1111
- Please ensure the issue isn't already reported.
1212

1313
*Please delete the above section and the instructions in the sections below before submitting*

CHANGELOG.md

Lines changed: 34 additions & 34 deletions
Large diffs are not rendered by default.

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
Gnosis Safe Contracts
2-
=====================
1+
Safe Contracts
2+
==============
33

44
[![npm version](https://badge.fury.io/js/%40gnosis.pm%2Fsafe-contracts.svg)](https://badge.fury.io/js/%40gnosis.pm%2Fsafe-contracts)
5-
[![Build Status](https://github.com/gnosis/safe-contracts/workflows/safe-contracts/badge.svg?branch=development)](https://github.com/gnosis/safe-contracts/actions)
6-
[![Coverage Status](https://coveralls.io/repos/github/gnosis/safe-contracts/badge.svg?branch=development)](https://coveralls.io/github/gnosis/safe-contracts)
5+
[![Build Status](https://github.com/safe-global/safe-contracts/workflows/safe-contracts/badge.svg?branch=development)](https://github.com/safe-global/safe-contracts/actions)
6+
[![Coverage Status](https://coveralls.io/repos/github/safe-global/safe-contracts/badge.svg?branch=development)](https://coveralls.io/github/safe-global/safe-contracts)
77

8-
> :warning: **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 Gnosis Safe team can be found in the [releases](https://github.com/gnosis/safe-contracts/releases).
8+
> :warning: **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](https://github.com/safe-global/safe-contracts/releases).
99
1010
Usage
1111
-----
@@ -24,15 +24,15 @@ yarn test
2424

2525
### Deployments
2626

27-
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.
27+
A collection of the different Safe contract deployments and their addresses can be found in the [Safe deployments](https://github.com/safe-global/safe-deployments) repository.
2828

29-
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.
29+
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/safe-global/safe-deployments) repository.
3030

3131
### Deploy
3232

33-
> :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).
33+
> :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 Safe team can be found in the [releases](https://github.com/safe-global/safe-contracts/releases).
3434
35-
> **Current version:** The latest release is [v1.3.0-libs.0](https://github.com/gnosis/safe-contracts/tree/v1.3.0-libs.0) on the commit [767ef36](https://github.com/gnosis/safe-contracts/commit/767ef36bba88bdbc0c9fe3708a4290cabef4c376)
35+
> **Current version:** The latest release is [v1.3.0-libs.0](https://github.com/safe-global/safe-contracts/tree/v1.3.0-libs.0) on the commit [767ef36](https://github.com/safe-global/safe-contracts/commit/767ef36bba88bdbc0c9fe3708a4290cabef4c376)
3636
3737
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.
3838

@@ -68,7 +68,7 @@ Note: Address will vary if contract code is changed or a different Solidity vers
6868

6969
Some networks require replay protection. This is not possible with the default deployment process as it relies on a presigned transaction without replay protection (see https://github.com/Arachnid/deterministic-deployment-proxy).
7070

71-
It is possible to enable deployment via a different determinisitic deployment proxy (https://github.com/gnosis/safe-singleton-factory). To enable this the `CUSTOM_DETERMINISTIC_DEPLOYMENT` env var has to be set to `true` (see `.env.sample`). To make sure that the latest version of this package is install, make sure to run `yarn add @gnosis.pm/safe-singleton-factory` before deployment.
71+
It is possible to enable deployment via a different determinisitic deployment proxy (https://github.com/safe-global/safe-singleton-factory). To enable this the `CUSTOM_DETERMINISTIC_DEPLOYMENT` env var has to be set to `true` (see `.env.sample`). To make sure that the latest version of this package is install, make sure to run `yarn add @gnosis.pm/safe-singleton-factory` before deployment.
7272

7373
Note: This will result in different addresses compared to the default deployment process.
7474

@@ -86,7 +86,7 @@ yarn hardhat --network <network> etherscan-verify
8686

8787
Documentation
8888
-------------
89-
- [Safe developer portal](http://docs.gnosis.io/safe)
89+
- [Safe developer portal](http://docs.safe.global)
9090
- [Error codes](docs/error_codes.md)
9191
- [Coding guidelines](docs/guidelines.md)
9292

docs/alexey_audit.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44
* Alexey Akhunov (<alexey@ledgerwatch.com>)
55

66
##### Notes
7-
The audit report was based on commit [942968d66a4fa200fe9757d02b377dbfc3c88636](https://github.com/gnosis/safe-contracts/commit/942968d66a4fa200fe9757d02b377dbfc3c88636)
7+
The audit report was based on commit [942968d66a4fa200fe9757d02b377dbfc3c88636](https://github.com/safe-global/safe-contracts/commit/942968d66a4fa200fe9757d02b377dbfc3c88636)
88

9-
Changes made until commit [898cc8969736bc190db1b7c446e050f49177f898](https://github.com/gnosis/safe-contracts/commit/898cc8969736bc190db1b7c446e050f49177f898) have been checked with symbolic execution and can be found in the attached pdf (see table `SecuredTokenTransfer::transferToken`).
9+
Changes made until commit [898cc8969736bc190db1b7c446e050f49177f898](https://github.com/safe-global/safe-contracts/commit/898cc8969736bc190db1b7c446e050f49177f898) have been checked with symbolic execution and can be found in the attached pdf (see table `SecuredTokenTransfer::transferToken`).
1010

1111
##### Files
1212
* [Audit Report](Gnosis_Safe_Audit_Report.pdf)
13-
* [Symbolic execution](Gnosis_Safe_Symbolic_Execution.pdf)
13+
* [Symbolic execution](Gnosis_Safe_Symbolic_Execution.pdf)

docs/audit_1_1_1.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@
66
* Nick Munoz-McDonald (@NickErrant)
77

88
##### Notes
9-
All changes for 1.1.1 until commit [2df0b2e0ad5d0f7ab5423e7f5baa72b2456d32ae](https://github.com/gnosis/safe-contracts/commit/2df0b2e0ad5d0f7ab5423e7f5baa72b2456d32ae) have been audited and the result were added to an ammended report.
9+
All changes for 1.1.1 until commit [2df0b2e0ad5d0f7ab5423e7f5baa72b2456d32ae](https://github.com/safe-global/safe-contracts/commit/2df0b2e0ad5d0f7ab5423e7f5baa72b2456d32ae) have been audited and the result were added to an ammended report.
1010

11-
All changes for 1.1.0 until commit [78494bcdbc61b3db52308a25f0556c42cf656ab1](https://github.com/gnosis/safe-contracts/commit/78494bcdbc61b3db52308a25f0556c42cf656ab1) have been audited and are considered in the audit report.
11+
All changes for 1.1.0 until commit [78494bcdbc61b3db52308a25f0556c42cf656ab1](https://github.com/safe-global/safe-contracts/commit/78494bcdbc61b3db52308a25f0556c42cf656ab1) have been audited and are considered in the audit report.
1212

13-
The audit was initially performed on commit [1a9e5ce768e134c556770ea50e114fd83666b8a8](https://github.com/gnosis/safe-contracts/commit/1a9e5ce768e134c556770ea50e114fd83666b8a8)
13+
The audit was initially performed on commit [1a9e5ce768e134c556770ea50e114fd83666b8a8](https://github.com/safe-global/safe-contracts/commit/1a9e5ce768e134c556770ea50e114fd83666b8a8)
1414

1515
##### Links
1616
* [Audit Report 1.1.1](https://github.com/g0-group/Audits/blob/master/G0Group-GnosisSafe-Ammended.pdf)
1717

1818
##### Files
1919
* [Audit Report 1.1.1](Gnosis_Safe_Audit_Report_1_1_1.pdf)
20-
* [Audit Report 1.1.0](Gnosis_Safe_Audit_Report_1_1_0.pdf)
20+
* [Audit Report 1.1.0](Gnosis_Safe_Audit_Report_1_1_0.pdf)

docs/audit_1_2_0.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
* Nick Munoz-McDonald (@NickErrant)
77

88
##### Notes
9-
The audit was performed on commit [62d4bd39925db65083b035115d6987772b2d2dca](https://github.com/gnosis/safe-contracts/commit/62d4bd39925db65083b035115d6987772b2d2dca)
9+
The audit was performed on commit [62d4bd39925db65083b035115d6987772b2d2dca](https://github.com/safe-global/safe-contracts/commit/62d4bd39925db65083b035115d6987772b2d2dca)
1010

1111
##### Files
12-
* [Audit Report 1.2.0](Gnosis_Safe_Audit_Report_1_2_0.pdf)
12+
* [Audit Report 1.2.0](Gnosis_Safe_Audit_Report_1_2_0.pdf)

docs/audit_1_3_0.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
* Adam Kolář (@adamkolar)
66

77
##### Notes
8-
An initial audit was performed on commit [4bfc0c8519f1893015d7edfd2c2780fca163c364](https://github.com/gnosis/safe-contracts/tree/4bfc0c8519f1893015d7edfd2c2780fca163c364) and contract changes until commit [9b305a0f80da7f1107d1181f52c844f089557d05](https://github.com/gnosis/safe-contracts/tree/9b305a0f80da7f1107d1181f52c844f089557d05) have been checked.
8+
An initial audit was performed on commit [4bfc0c8519f1893015d7edfd2c2780fca163c364](https://github.com/safe-global/safe-contracts/tree/4bfc0c8519f1893015d7edfd2c2780fca163c364) and contract changes until commit [9b305a0f80da7f1107d1181f52c844f089557d05](https://github.com/safe-global/safe-contracts/tree/9b305a0f80da7f1107d1181f52c844f089557d05) have been checked.
99

10-
The final audit was performed on commit [ad6c7355d5bdf4f7fa348fbfcb9f07431769a3c9](https://github.com/gnosis/safe-contracts/tree/ad6c7355d5bdf4f7fa348fbfcb9f07431769a3c9).
10+
The final audit was performed on commit [ad6c7355d5bdf4f7fa348fbfcb9f07431769a3c9](https://github.com/safe-global/safe-contracts/tree/ad6c7355d5bdf4f7fa348fbfcb9f07431769a3c9).
1111

1212

1313
##### Files
@@ -16,4 +16,4 @@ The final audit was performed on commit [ad6c7355d5bdf4f7fa348fbfcb9f07431769a3c
1616

1717
##### External links for Audit Reports
1818
* [Final Audit Report 1.3.0](https://github.com/g0-group/Audits/blob/9c18c800e65d28a8cf9f608c9dbbc13edbac70c8/GnosisSafeMay2021.pdf)
19-
* [Initial Audit Report 1.3.0](https://github.com/g0-group/Audits/blob/9c18c800e65d28a8cf9f608c9dbbc13edbac70c8/GnosisSafeApr2021.pdf)
19+
* [Initial Audit Report 1.3.0](https://github.com/g0-group/Audits/blob/9c18c800e65d28a8cf9f608c9dbbc13edbac70c8/GnosisSafeApr2021.pdf)

docs/rv_1_0_0.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
* Runtime Verification (https://github.com/runtimeverification)
55

66
##### Notes
7-
The formal verification was based on commit [427d6f7e779431333c54bcb4d4cde31e4d57ce96](https://github.com/gnosis/safe-contracts/commit/427d6f7e779431333c54bcb4d4cde31e4d57ce96)
7+
The formal verification was based on commit [427d6f7e779431333c54bcb4d4cde31e4d57ce96](https://github.com/safe-global/safe-contracts/commit/427d6f7e779431333c54bcb4d4cde31e4d57ce96)
88

9-
Critical findings have been fixed with https://github.com/gnosis/safe-contracts/pull/90
9+
Critical findings have been fixed with https://github.com/safe-global/safe-contracts/pull/90
1010

1111
##### Files
12-
* [Formal Verification Report](Gnosis_Safe_Formal_Verification_Report_1_0_0.pdf)
12+
* [Formal Verification Report](Gnosis_Safe_Formal_Verification_Report_1_0_0.pdf)

docs/safe_tx_gas.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
### Safe Transaction Gas Limit (safeTxGas)
2-
In this document will describe the behaviour of the internal gas limit (aka `safeTxGas`) for the [1.3.0](https://github.com/gnosis/safe-contracts/releases/tag/v1.3.0-libs.0) version of the Safe Contracts.
2+
In this document will describe the behaviour of the internal gas limit (aka `safeTxGas`) for the [1.3.0](https://github.com/safe-global/safe-contracts/releases/tag/v1.3.0-libs.0) version of the Safe Contracts.
33

4-
There have been changes to this behaviour with the [1.3.0](https://github.com/gnosis/safe-contracts/blob/main/CHANGELOG.md#version-130) version of the Safe contract (see [#274](https://github.com/gnosis/safe-contracts/issues/274))
4+
There have been changes to this behaviour with the [1.3.0](https://github.com/safe-global/safe-contracts/blob/main/CHANGELOG.md#version-130) version of the Safe contract (see [#274](https://github.com/safe-global/safe-contracts/issues/274))
55

66
The behaviour of `safeTxGas` depends on the `gasPrice` value of the Safe transaction.
77

88
#### With gas refund
99

1010
If `gasPrice` is set to a value `>0` the Safe contracts will issue a refund for the gas costs incured the execution of the Safe transaction. An example where this can be used are the relayers. These would execute the Safe transaction after it has been signed by the owners and then would get refunded for the execution.
1111

12-
The logic for this can be seen in [`GnosisSafe.sol`](https://github.com/gnosis/safe-contracts/blob/main/contracts/GnosisSafe.sol#L183-L185):
12+
The logic for this can be seen in [`GnosisSafe.sol`](https://github.com/safe-global/safe-contracts/blob/main/contracts/GnosisSafe.sol#L183-L185):
1313
```js
1414
if (gasPrice > 0) {
1515
payment = handlePayment(gasUsed, baseGas, gasPrice, gasToken, refundReceiver);
@@ -28,7 +28,7 @@ If `gasPrice` is set to `0` then the Safe contracts will **not** issue a refund
2828

2929
Therefore it is not necessary to be as strict on the gas being passed along with the execution of the Safe transaction. As no refund is triggered the Safe will not pay for the execution costs, based on this the Safe contracts will send along all available case when no refund is used.
3030

31-
Before the execution the Safe contracts always check if enough gas is available to satisfy the `safeTxGas`. This can be seen in [`GnosisSafe.sol`](hhttps://github.com/gnosis/safe-contracts/blob/main/contracts/GnosisSafe.sol#L168-L170):
31+
Before the execution the Safe contracts always check if enough gas is available to satisfy the `safeTxGas`. This can be seen in [`GnosisSafe.sol`](hhttps://github.com/safe-global/safe-contracts/blob/main/contracts/GnosisSafe.sol#L168-L170):
3232
```js
3333
require(gasleft() >= ((safeTxGas * 64) / 63).max(safeTxGas + 2500) + 500, "GS010");
3434
```
@@ -43,9 +43,9 @@ Most wallets will estimate Ethereum transaction by checking with what gas limit
4343

4444
To make it easier to set the `safeTxGas` value a change has been made with the 1.3.0 version of the Safe contracts:
4545

46-
**When `safeTxGas` is set to `0`, the Safe contract will revert if the internal Safe transaction fails** (see [#274](https://github.com/gnosis/safe-contracts/issues/274))
46+
**When `safeTxGas` is set to `0`, the Safe contract will revert if the internal Safe transaction fails** (see [#274](https://github.com/safe-global/safe-contracts/issues/274))
4747

48-
That means if `safeTxGas` is set to `0` the Safe contract sents along all awailable gas when performing the internal Safe transaction. If that transaction fails the Safe will revert and therefore also undo all State changes. This can be seen in [`GnosisSafe.sol`](https://github.com/gnosis/safe-contracts/blob/main/contracts/GnosisSafe.sol#L178-L180):
48+
That means if `safeTxGas` is set to `0` the Safe contract sents along all awailable gas when performing the internal Safe transaction. If that transaction fails the Safe will revert and therefore also undo all State changes. This can be seen in [`GnosisSafe.sol`](https://github.com/safe-global/safe-contracts/blob/main/contracts/GnosisSafe.sol#L178-L180):
4949
```js
5050
require(success || safeTxGas != 0 || gasPrice != 0, "GS013");
5151
```

0 commit comments

Comments
 (0)