From f3f69c937fed06b16fa209039afac6ddbdf05826 Mon Sep 17 00:00:00 2001 From: lash Date: Mon, 21 Feb 2022 16:24:18 +0000 Subject: [PATCH] Mo better docs --- python/README.md | 24 +++++++++++------------- 1 file changed, 11 insertions(+), 13 deletions(-) diff --git a/python/README.md b/python/README.md index 56ec896..7c90055 100644 --- a/python/README.md +++ b/python/README.md @@ -4,25 +4,23 @@ Okota implements smart contract registries for the CIC network with the [Address For every entry added to the registry, a declaration is added aswell. - -## Contract declaration translations - -| registry call | declarator | subject | proof | -|---|---|---|---| -| ContractRegistry.set(registry\_identifier, contract\_address) | sender | contract\_address | registry\_identifier | -| AccountsIndex.register(wallet\_address) | sender | wallet\_address | token address of accounts index | -| TokenRegistry.registry(token\_address) | sender | token\_address | sha256(token symbol) | - - -## Using the CLI - -In the below, all in hex: +In all the below: * `contract_address` is the address of the deployed Address Declarator contract. * `subject_address` is the address a declaration is being made about. * `declarer` is the entity making a declaration about the `subject_address`. * `proof` a 256-bit proof + +## Contract declaration translations + +| registry call | declarer | subject | proof | +|---|---|---|---| +| ContractRegistry.set(registry\_identifier, contract\_address) | sender | contract\_address | registry\_identifier | +| AccountsIndex.register(wallet\_address) | sender | wallet\_address | token address of accounts index | +| TokenRegistry.registry(token\_address) | sender | token\_address | sha256(token symbol) | + + ## Query the declarator with CLI `eth-accounts-index-view -e -a `