From 4712ccd3d20d80c77016a3a47da14d20d79852db Mon Sep 17 00:00:00 2001 From: Dan Oved Date: Tue, 7 Jan 2025 09:43:09 -0800 Subject: [PATCH] removed the developing page as its out of date (#997) --- DEVELOPING.md | 45 --------------------------------------------- README.md | 12 ++++-------- 2 files changed, 4 insertions(+), 53 deletions(-) delete mode 100644 DEVELOPING.md diff --git a/DEVELOPING.md b/DEVELOPING.md deleted file mode 100644 index 8f5bf9225..000000000 --- a/DEVELOPING.md +++ /dev/null @@ -1,45 +0,0 @@ -# Developer Workflow - -## Deploying to a new chain - -Within a contracts package folder (i.e. `packages/1155-contracts`): - -1. Setup new `chainConfigs` file setting 1. fee recipient, and 2. owner for factory contracts -2. Generate signatures for deploying the upgrade gate at a deterministic address and transferring ownership to the factory owner: - - pnpm tsx script/signDeploymentTransactions.ts - -3. Deploy upgrade gate and implementation contracts: - - forge script script/DeployMintersAndImplementations.s.sol $(chains {CHAINNAME} --deploy) --interactives 1 --broadcast --verify - -4. Copy deployed addresses to `addresses/{CHAINID}.json`: - - pnpm tsx script/copy-deployed-contracts.ts - -5. Generate signatures to deploy proxy contracts at deterministic address: - - pnpm tsx script/signDeploymentTransactions.ts - -6. Deploy proxy contracts: - - forge script script/DeployProxiesToNewChain.s.sol $(chains {CHAINNAME} --deploy) --interactives 1 --broadcast --verify - -7. Ensure contracts are verified on block explorer. -8. Add a changeset with `pnpm changeset` -9. Make PR with new addresses json files and changeset. - -# Publishing the package; Generating changesets, versioning, building and Publishing. - -Publishing happens in the following steps: - -* Some changes are made to the repo; this can include smart contract changes or additions, if smart contracts are changed, tests should be created or updated to reflect the changes. -* The changes are committed to a branch that is **pushed** to **github**. -* A **pr** is **opened** for this branch. -* The changes are reviewed, if they are **approved**: -* *If there are changes to the smart contracts that should be deployed*: the contract should be. Deploying the contract results in the addresses of the deployed contracts being updated in the corresponding `./addresses/{chainId}.json` file. This file should be committed and pushed to github. -* Running the command `pnpm changeset` will generate **a new changeset** in the `./changesets` directory. This changeset will be used to determine the next version of the bundled packages; this commit should then be pushed. -* The changeset and smart contract addresses are pushed to the branch. -* The pr is merged into main - any changesets in the PR are detected by a github action `release`, which will then **open a new PR** with proper versions and readme updated in each each package. If more changesets are pushed to main before this branch is merged, the PR will continuously update the version of the packages according to the changeset specification. -* That version is merged into main along with the new versions. -* The package is then published to npm with the command: `pnpm run publish-packages` and the package is published. diff --git a/README.md b/README.md index a6ece480e..7ecf53ddb 100644 --- a/README.md +++ b/README.md @@ -44,17 +44,13 @@ Run in development mode (watch tests): 5 ETH for any critical bugs that could result in loss of funds. Rewards will be given for smaller bugs or ideas. -## Development workflow - -See [DEVELOPING.md](./DEVELOPING.md) - ## Updating Build / Release Process After updating build settings with pnpm, run: -* `pnpm install` -* `pnpm run build:js` -* `pnpm run release` +- `pnpm install` +- `pnpm run build:js` +- `pnpm run release` -This tests the full build and release flow. +This tests the full build and release flow. Without authentication packages will not be published but staged for publish.