Skip to content

Commit

Permalink
doc: adding and updating readme-s
Browse files Browse the repository at this point in the history
  • Loading branch information
kupermind committed Oct 12, 2023
1 parent 692eb1c commit 0717709
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,13 @@ Run the tests:
npx hardhat test
```

## Deployment and redeployment
The deployment of contracts to the test- and main-net is split into step-by-step series of scripts for more control and checkpoint convenience.
The description of deployment procedure can be found here: [deployment](https://github.com/valory-xyz/ai-registry-mech/blob/main/scripts/deployment).

The finalized contract ABIs for deployment and their number of optimization passes are located here: [ABIs](https://github.com/valory-xyz/ai-registry-mech/blob/main/abis).
Each folder there contains contracts compiled with the solidity version before their deployment.

## Acknowledgements
The registries contracts were inspired and based on the following sources:
- [Rari-Capital Solmate](https://github.com/Rari-Capital/solmate).
Expand Down
5 changes: 5 additions & 0 deletions scripts/deployment/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,3 +44,8 @@ Each script controls the obtained values by checking them against the expected o
If a contract is deployed with arguments, these arguments are taken from the corresponding `verify_number_and_name` file, where `number_and_name` corresponds to the deployment script number and name.

To verify a mech use `e_check_04_agent_mech.js` and first ensure that `globals.json` contains the mech data, e.g: `"agentMechAddress":"0x3504fb5053ec12f748017248a395b4ed31739705","agentId":1,"price":"10000000000000000"`

## Redeployment in case of changing AgentMech or AgentFactory
Each AgentMech contract is created via the AgentFactory, essentially inheriting the AgentMech contract bytecode. If AgentMech
and / or AgentFactory is changed, the AgentFactory contract must be redeployed (`deploy_02_agent_factory.js`). Moreover,
the manager of the AgentRegistry must be updated with a new deployed AgentFactory contract address (`deploy_03_change_manager.js`).

0 comments on commit 0717709

Please sign in to comment.