Skip to content

Commit 862b14e

Browse files
authored
Merge pull request #6 from 0xPolygon/staging
Update libraries
2 parents feefd5a + 810fcd9 commit 862b14e

File tree

8 files changed

+15
-15
lines changed

8 files changed

+15
-15
lines changed

.gitmodules

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@
1010
[submodule "lib/solady"]
1111
path = lib/solady
1212
url = https://github.com/vectorized/solady
13-
[submodule "lib/deployment-log-generator"]
14-
path = lib/deployment-log-generator
15-
url = https://github.com/0xPolygon/deployment-log-generator
16-
[submodule "lib/contract-deployer-template"]
17-
path = lib/contract-deployer-template
18-
url = https://github.com/0xPolygon/contract-deployer-template
19-
[submodule "lib/storage-layout-checker"]
20-
path = lib/storage-layout-checker
21-
url = https://github.com/0xPolygon/storage-layout-checker
13+
[submodule "lib/storage-delta"]
14+
path = lib/storage-delta
15+
url = https://github.com/0xPolygon/storage-delta
16+
[submodule "lib/deployer-kit"]
17+
path = lib/deployer-kit
18+
url = https://github.com/0xPolygon/deployer-kit
19+
[submodule "lib/forge-chronicles"]
20+
path = lib/forge-chronicles
21+
url = https://github.com/0xPolygon/forge-chronicles

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -118,23 +118,23 @@ Interfaces should be the entrypoint for all contracts. When exploring the a cont
118118

119119
## Versioning
120120

121-
This repo utilizes [semantic versioning](https://semver.org/) for smart contracts. An `IVersioned` interface is included in the [interfaces directory](src/interface/IVersioned.sol) exposing a unified versioning interface for all contracts. This version MUST be included in all contracts, whether they are upgradeable or not, to be able to easily match deployed versions. For example, in the case of a non-upgradeable contract one version could be deployed to a network and later a new version might be deployed to another network. The exposed `version()` function is also used by the [Deployment Log Generator](https://github.com/0xPolygon/deployment-log-generator#readme) to extract information about the version.
121+
This repo utilizes [semantic versioning](https://semver.org/) for smart contracts. An `IVersioned` interface is included in the [interfaces directory](src/interface/IVersioned.sol) exposing a unified versioning interface for all contracts. This version MUST be included in all contracts, whether they are upgradeable or not, to be able to easily match deployed versions. For example, in the case of a non-upgradeable contract one version could be deployed to a network and later a new version might be deployed to another network. The exposed `version()` function is also used by the [Deployment Log Generator](https://github.com/0xPolygon/forge-chronicles#readme) to extract information about the version.
122122

123123
Whenever contracts are modified, only the version of the changed contracts should be updated. Unmodified contracts should remain on the version of their last change.
124124

125125
## Testing
126126

127127
### Deployer Template
128128

129-
This repo provides a deployer template library for consistency between scripts and unit tests. For more information on how to use the template, check [here](https://github.com/0xPolygon/contract-deployer-template#readme).
129+
This repo provides a deployer template library for consistency between scripts and unit tests. For more information on how to use the template, check [here](https://github.com/0xPolygon/deployer-kit#readme).
130130

131131
## Deployment
132132

133133
This repo utilizes versioned deployments. Any changes to a contract should update the version of this specific contract. A script is provided that extracts deployment information from the `run-latest.json` file within the `broadcast` directory generated while the forge script runs. From this information a JSON and markdown file is generated containing various information about the deployment itself as well as past deployments.
134134

135135
### Deployer Template
136136

137-
This repo provides a deployer template library for consistency between scripts and unit tests. For more information on how to use the template, check [here](https://github.com/0xPolygon/contract-deployer-template#readme).
137+
This repo provides a deployer template library for consistency between scripts and unit tests. For more information on how to use the template, check [here](https://github.com/0xPolygon/deployer-kit#readme).
138138

139139
### Deployment
140140

lib/contract-deployer-template

Lines changed: 0 additions & 1 deletion
This file was deleted.

lib/deployer-kit

Submodule deployer-kit added at 5ed82de

lib/deployment-log-generator

Lines changed: 0 additions & 1 deletion
This file was deleted.

lib/forge-chronicles

Submodule forge-chronicles added at c2be7a4

lib/storage-delta

Submodule storage-delta added at 936c4ba

lib/storage-layout-checker

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)