From 2c8dc15bf6d7dd841baa32b8c45bc8c557ec411a Mon Sep 17 00:00:00 2001 From: gretzke Date: Mon, 11 Dec 2023 14:06:02 +0100 Subject: [PATCH 1/4] Update libraries --- .gitmodules | 9 --------- CONTRIBUTING.md | 6 +++--- lib/contract-deployer-template | 1 - lib/deployment-log-generator | 1 - lib/storage-layout-checker | 1 - 5 files changed, 3 insertions(+), 15 deletions(-) delete mode 160000 lib/contract-deployer-template delete mode 160000 lib/deployment-log-generator delete mode 160000 lib/storage-layout-checker diff --git a/.gitmodules b/.gitmodules index 37d7187..15e3ba1 100644 --- a/.gitmodules +++ b/.gitmodules @@ -10,12 +10,3 @@ [submodule "lib/solady"] path = lib/solady url = https://github.com/vectorized/solady -[submodule "lib/deployment-log-generator"] - path = lib/deployment-log-generator - url = https://github.com/0xPolygon/deployment-log-generator -[submodule "lib/contract-deployer-template"] - path = lib/contract-deployer-template - url = https://github.com/0xPolygon/contract-deployer-template -[submodule "lib/storage-layout-checker"] - path = lib/storage-layout-checker - url = https://github.com/0xPolygon/storage-layout-checker diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d1eb1dc..9d7e286 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -118,7 +118,7 @@ Interfaces should be the entrypoint for all contracts. When exploring the a cont ## Versioning -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. +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. 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. @@ -126,7 +126,7 @@ Whenever contracts are modified, only the version of the changed contracts shoul ### Deployer Template -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). +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). ## Deployment @@ -134,7 +134,7 @@ This repo utilizes versioned deployments. Any changes to a contract should updat ### Deployer Template -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). +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). ### Deployment diff --git a/lib/contract-deployer-template b/lib/contract-deployer-template deleted file mode 160000 index 3101afc..0000000 --- a/lib/contract-deployer-template +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 3101afcefef8a677dec4562d1a1b73c74b4364d8 diff --git a/lib/deployment-log-generator b/lib/deployment-log-generator deleted file mode 160000 index f3fc0bf..0000000 --- a/lib/deployment-log-generator +++ /dev/null @@ -1 +0,0 @@ -Subproject commit f3fc0bfd4a7caee49cf6eb6ac172bc012a339fc1 diff --git a/lib/storage-layout-checker b/lib/storage-layout-checker deleted file mode 160000 index 7e29a31..0000000 --- a/lib/storage-layout-checker +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 7e29a3174c518ee520d2d16282d13927d54f8f72 From 0e58f33b8855b9bd9d30442dd3e6d322799cd748 Mon Sep 17 00:00:00 2001 From: gretzke Date: Mon, 11 Dec 2023 14:06:47 +0100 Subject: [PATCH 2/4] forge install: storage-delta 0.2.0 --- .gitmodules | 3 +++ lib/storage-delta | 1 + 2 files changed, 4 insertions(+) create mode 160000 lib/storage-delta diff --git a/.gitmodules b/.gitmodules index 15e3ba1..1adefe0 100644 --- a/.gitmodules +++ b/.gitmodules @@ -10,3 +10,6 @@ [submodule "lib/solady"] path = lib/solady url = https://github.com/vectorized/solady +[submodule "lib/storage-delta"] + path = lib/storage-delta + url = https://github.com/0xPolygon/storage-delta diff --git a/lib/storage-delta b/lib/storage-delta new file mode 160000 index 0000000..936c4ba --- /dev/null +++ b/lib/storage-delta @@ -0,0 +1 @@ +Subproject commit 936c4ba2562b40a307876dc44b1100aa243cf929 From 37cace3b75ee42aa3413f993c053a9b61873488b Mon Sep 17 00:00:00 2001 From: gretzke Date: Mon, 11 Dec 2023 14:07:34 +0100 Subject: [PATCH 3/4] forge install: deployer-kit 0.2.0 --- .gitmodules | 3 +++ lib/deployer-kit | 1 + 2 files changed, 4 insertions(+) create mode 160000 lib/deployer-kit diff --git a/.gitmodules b/.gitmodules index 1adefe0..ec6ccbb 100644 --- a/.gitmodules +++ b/.gitmodules @@ -13,3 +13,6 @@ [submodule "lib/storage-delta"] path = lib/storage-delta url = https://github.com/0xPolygon/storage-delta +[submodule "lib/deployer-kit"] + path = lib/deployer-kit + url = https://github.com/0xPolygon/deployer-kit diff --git a/lib/deployer-kit b/lib/deployer-kit new file mode 160000 index 0000000..5ed82de --- /dev/null +++ b/lib/deployer-kit @@ -0,0 +1 @@ +Subproject commit 5ed82de055ed1a96943d9958e9ba4301b41829d9 From 810fcd945525006830ef626c76f479dcee9d1dfe Mon Sep 17 00:00:00 2001 From: gretzke Date: Mon, 11 Dec 2023 14:07:55 +0100 Subject: [PATCH 4/4] forge install: forge-chronicles 0.2.0 --- .gitmodules | 3 +++ lib/forge-chronicles | 1 + 2 files changed, 4 insertions(+) create mode 160000 lib/forge-chronicles diff --git a/.gitmodules b/.gitmodules index ec6ccbb..beb9ef4 100644 --- a/.gitmodules +++ b/.gitmodules @@ -16,3 +16,6 @@ [submodule "lib/deployer-kit"] path = lib/deployer-kit url = https://github.com/0xPolygon/deployer-kit +[submodule "lib/forge-chronicles"] + path = lib/forge-chronicles + url = https://github.com/0xPolygon/forge-chronicles diff --git a/lib/forge-chronicles b/lib/forge-chronicles new file mode 160000 index 0000000..c2be7a4 --- /dev/null +++ b/lib/forge-chronicles @@ -0,0 +1 @@ +Subproject commit c2be7a462d87b8e3a72f7e2b739cdf12807a71e4