You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+42-42Lines changed: 42 additions & 42 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,74 +16,74 @@ a group of agent instances.
16
16
17
17
In order to generalize `components` / `agents` / `services`, they are referred sometimes as `units`.
18
18
19
-
A graphical overview is available [here](https://github.com/valory-xyz/autonolas-registries/blob/main/docs/flowchart.md).
19
+
A graphical overview is available [here](./docs/flowchart.md).
20
20
21
-
For reference purposes only, an older version of the general Autonolas architecture is available [here](https://github.com/valory-xyz/autonolas-registries/blob/main/docs/On-chain_architecture_v6.png).
21
+
For reference purposes only, an older version of the general Autonolas architecture is available [here](./docs/On-chain_architecture_v6.png).
22
22
23
23
An overview of the design, details on how securing services with ETH or a custom ERC20 token, how service owners can opt for a set of authorized operators,
24
-
as well as how DAOs can manage their autonomous services are provided [here](https://github.com/valory-xyz/autonolas-registries/blob/main/docs/AgentServicesFunctionality.pdf).
24
+
as well as how DAOs can manage their autonomous services are provided [here](./docs/AgentServicesFunctionality.pdf).
25
25
26
26
We have a core periphery architecture for both the components/agents and services. The core contracts are ERC721s primarily accessed via the peripheral manager contracts.
27
27
28
-
An overview of the state machine governing service management and usage is provided [here](https://github.com/valory-xyz/autonolas-registries/blob/main/docs/FSM.md).
28
+
An overview of the state machine governing service management and usage is provided [here](./docs/FSM.md).
29
29
30
-
A more detailed set of registries definitions are provided [here](https://github.com/valory-xyz/autonolas-registries/blob/main/docs/definitions.md).
30
+
A more detailed set of registries definitions are provided [here](./docs/definitions.md).
31
31
32
-
An overview of the registries contracts related to staking can be found [here](https://github.com/valory-xyz/autonolas-registries/blob/main/docs/StakingSmartContracts.pdf). Details on Olas staking are provided [here](https://staking.olas.network/poaa-whitepaper.pdf).
32
+
An overview of the registries contracts related to staking can be found [here](./docs/StakingSmartContracts.pdf). Details on Olas staking are provided [here](https://staking.olas.network/poaa-whitepaper.pdf).
33
33
34
34
Note that by default the contracts do not work with:
35
35
- Fee on transfer tokens;
36
36
- Balance changes outside token transfers.
37
37
38
38
The following list represents registries contracts:
In order to deploy a service, its registered agent instances form a consensus mechanism via the means of multisigs using the generic multisig interface.
68
68
One of the most well-known multisigs is [Safe](https://safe.global/). The Safe interface implementation of a generic multisig interface is provided here:
Another multisig implementation allows to upgrade / downgrade the number of agent instances that govern the same Safe multisig instance between different service re-deployments.
75
75
Please note that the initial multisig instance must already exist from a previous service deployment.
76
76
In order to use that option, registered agent instances forming a consensus are required to return the multisig instance ownership to the service owner.
77
77
Then, the service owner must terminate the service, update the number of desired agent instances and move it into a new `active-registration` state.
78
78
Once all agent instances are registered, the service owner re-deploys the service by giving up their ownership of the multisig with registered agent instances and by setting a new multisig instance threshold.
79
79
The implementation of such multisig is provided here:
To verify the multisig data when redeploying the service using the GnosisSafeSameAddressMultisig contract while changing service multisig owners (with updated agent instance addresses),
86
-
see the guidelines and corresponding scripts [here](https://github.com/valory-xyz/autonolas-registries/blob/main/scripts/multisig/)
86
+
see the guidelines and corresponding scripts [here](./scripts/multisig/)
87
87
88
88
As more multisigs come into play, their underlying implementation of the generic multisig will be added.
[Scribble](https://docs.scribble.codes/) annotated contracts are located in https://github.com/valory-xyz/autonolas-registries/blob/main/contracts/scribble.
145
+
[Scribble](https://docs.scribble.codes/) annotated contracts are located in ./contracts/scribble.
146
146
147
147
Install Scribble in order to instrument the code:
148
148
```
@@ -183,18 +183,18 @@ several steps in order to be verified. Those include:
183
183
184
184
## Deployment
185
185
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.
186
-
The description of deployment procedure can be found here: [deployment](https://github.com/valory-xyz/autonolas-registries/blob/main/scripts/deployment).
186
+
The description of deployment procedure can be found here: [deployment](./scripts/deployment).
187
187
188
-
The finalized contract ABIs for deployment and their number of optimization passes are located here: [ABIs](https://github.com/valory-xyz/autonolas-registries/blob/main/abis).
188
+
The finalized contract ABIs for deployment and their number of optimization passes are located here: [ABIs](./abis).
189
189
Each folder there contains contracts compiled with the solidity version before their deployment.
190
190
191
-
For testing purposes, the hardhat node deployment script is located [here](https://github.com/valory-xyz/autonolas-registries/blob/main/deploy).
191
+
For testing purposes, the hardhat node deployment script is located [here](./deploy).
192
192
193
-
If you want to use custom contracts in the registry image, read [here](https://github.com/valory-xyz/autonolas-registries/blob/main/docs/running_with_custom_contracts.md).
193
+
If you want to use custom contracts in the registry image, read [here](./docs/running_with_custom_contracts.md).
194
194
195
195
### Audits
196
-
- The audit is provided as development matures. The latest audit report can be found here: [audits](https://github.com/valory-xyz/autonolas-registries/blob/main/audits).
197
-
- A list of known vulnerabilities can be found here: [Vulnerabilities list](https://github.com/valory-xyz/autonolas-registries/blob/main/docs/Vulnerabilities_list_registries.pdf)
196
+
- The audit is provided as development matures. The latest audit report can be found here: [audits](./audits).
197
+
- A list of known vulnerabilities can be found here: [Vulnerabilities list](./docs/Vulnerabilities_list_registries.md)
198
198
199
199
#### Static audit
200
200
The static audit checks all the deployed contracts on-chain info correctness and can be run using the following script:
The list of contract addresses for different chains and their full contract configuration can be found [here](https://github.com/valory-xyz/autonolas-registries/blob/main/docs/configuration.json).
206
+
The list of contract addresses for different chains and their full contract configuration can be found [here](./docs/configuration.json).
207
207
208
208
In order to test the protocol setup on all the deployed chains, the audit script is implemented. Make sure to export
209
209
required API keys for corresponding chains (see the script for more information). The audit script can be run as follows:
In order to get the current snapshot of all the registries, the following script is provided [here](https://github.com/valory-xyz/autonolas-registries/blob/main/scripts/mainnet_snapshot.js).
215
+
In order to get the current snapshot of all the registries, the following script is provided [here](./scripts/mainnet_snapshot.js).
216
216
The script can be run with the following command:
217
217
```
218
218
npx hardhat run scripts/mainnet_snapshot.js --network mainnet
@@ -223,12 +223,12 @@ NOTE: whilst the snapshot does maintain the exact dependency structure between c
223
223
224
224
## Protocol-owned-services
225
225
A specific service can be owned by a DAO-governed protocol. In order to construct a DAO proposal for the service (re-)deployment,
226
-
the following step-by-step guide is advised to be observed [here](https://github.com/valory-xyz/autonolas-registries/blob/main/docs/DAO_service_deloyment_FSM.pdf).
226
+
the following step-by-step guide is advised to be observed [here](./docs/DAO_service_deloyment_FSM.pdf).
227
227
228
228
## Integrations on non-EVM blockchains
229
229
### Solana
230
230
The light protocol with a similar functionality to ServiceRegistryL2 is implemented as part of the Solana integration network.
231
-
The ServiceRegistrySolana program is developed [here](https://github.com/valory-xyz/autonolas-registries/blob/main/integrations/solana).
231
+
The ServiceRegistrySolana program is developed [here](./integrations/solana).
Copy file name to clipboardExpand all lines: audits/README.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,6 +43,8 @@ contracts is located in this folder: [internal audit 13](https://github.com/valo
43
43
An internal audit with a focus on next update of ERC-8004 bridge (IdentityRegistryBridger)
44
44
contracts is located in this folder: [internal audit 14](https://github.com/valory-xyz/autonolas-registries/blob/main/audits/internal14).
45
45
46
+
Full internal audit. Verify all C4A findings fixed. Identify new vulnerabilities: [internal audit 15](https://github.com/valory-xyz/autonolas-registries/blob/main/audits/internal15).
47
+
46
48
### External audit
47
49
48
50
Following the initial contracts [audit report](https://github.com/valory-xyz/autonolas-registries/blob/main/audits/Valory%20Review%20Final.pdf),
0 commit comments