Adiciona exemplo e documentação.

A documentação foi atualizada para tornar-se mais clara. Um novo exemplo foi adicionadio.
emersonXavier · Aug 30, 2023 · 63ad257 · 63ad257
1 parent 2cf9dd0
commit 63ad257
Show file tree

Hide file tree

Showing 6 changed files with 21 additions and 11 deletions.
diff --git a/AddressDiscovery.md b/AddressDiscovery.md
@@ -2,7 +2,7 @@
 
 ## AddressDiscovery
 
-_Smart Contract_ utilitário para facilitar a descoberta dos demais endereços de contratos na rede do Piloto RD.
+_Smart Contract_ utilitário para facilitar a descoberta dos demais endereços de contratos na rede do Piloto RD. Pode ser acessado a partir do endereço 0xE42c25480b04CE6ff82734C587633e777EbD9eBA.
 
 ### ACCESS_ROLE
 
@@ -41,7 +41,7 @@ Construtor
 function updateAddress(bytes32 smartContract, address newAddress) public
 ```
 
-Atualiza o endereço de um contrato, permitido apenas para a autoridade.
+Atualiza o endereço de um contrato, permitido apenas para a autoridade (BCB).
 
 #### Parameters
 

diff --git a/KeyDictionary.md b/KeyDictionary.md
@@ -4,7 +4,7 @@
 
 Contrato que representa a consulta de carteiras de clientes. É um contrato de simulação de um diretório de informações.
 
-Este contrato será usado somente durante o piloto. 
+Este contrato será usado somente durante o piloto. Os métodos desse contrato podem ser chamados por qualquer endereço habilitado a receber CBDC.
 
 ### CBDC
 

diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# Kit Onboarding - Piloto Real Digital (#1994f4822ca32ab7a843c99c6d76af95a0e0f46b)
+# Kit Onboarding - Piloto Real Digital (#51f40ec5dd5e00c9feea02ba5cf960ceaaad395b)
 
 Este repositório contém as informações necessárias para a participação no piloto do Real Digital. A documentação será complementada conforme o _feedback_ dos participantes.
 

diff --git a/RealDigitalDefaultAccount.md b/RealDigitalDefaultAccount.md
@@ -63,7 +63,7 @@ constructor(contract RealDigital token, address _authority, address _admin) publ
 function addDefaultAccount(uint256 cnpj8, address wallet) public
 ```
 
-Adiciona a primeira carteira _default_ para um participante. É permitido apenas para a autoridade.
+Adiciona a primeira carteira _default_ para um participante. É permitido apenas para a autoridade. (BCB)
 
 #### Parameters
 
@@ -81,7 +81,7 @@ Adiciona a primeira carteira _default_ para um participante. É permitido apenas
 function updateDefaultWallet(uint256 cnpj8, address newWallet) public
 ```
 
-Permite ao participante trocar sua carteira _default_. 
+Permite ao participante trocar sua carteira _default_. Deve ser chamado a partir do endereço default.
 
 #### Parameters
 

diff --git a/RealTokenizado.md b/RealTokenizado.md
@@ -4,7 +4,7 @@
 
 Implementação do contrato do Real Tokenizado (DVt e MEt).
 
-Este contrato herda do Real Digital e todas as funções implementadas.
+Este contrato herda do Real Digital e todas as funções implementadas. As funções de autoridade são designadas ao participante do piloto.
 
 ### participant
 
@@ -36,15 +36,15 @@ constructor(string _name, string _symbol, address _authority, address _admin, st
 
 Construtor do token do Real Tokenizado.
 
-Invoca o construtor do ERC20 e dá permissão de autoridade para a carteira do BCB.
+Invoca o construtor do ERC20 e dá permissão de autoridade para a carteira do participante e admin para o BCB.
 
 #### Parameters
 
 | Name | Type | Description |
 | ---- | ---- | ----------- |
-| _name | string | Nome do token: Real Tokenizado (Instituiçâo) |
-| _symbol | string | Símbolo do token: BRL |
-| _authority | address | Carteira responsável por emitir, resgatar, mover e congelar fundos (BCB) |
+| _name | string | Nome do token: RealTokenizado@CNPJ8 |
+| _symbol | string | Símbolo do token: DREX@CNPJ8 |
+| _authority | address | Carteira responsável por emitir, resgatar, mover e congelar fundos |
 | _admin | address | Carteira responsável por administrar o controle de acessos (BCB) |
 | _participant | string | Identificação do participante como string. |
 | _cnpj8 | uint256 | Primeiros 8 digitos do CNPJ da instituição |

diff --git a/exemplos/example4.ts b/exemplos/example4.ts
@@ -0,0 +1,10 @@
+import { ethers } from "hardhat";
+import abiAddressDiscovery from '../abi/AddressDiscovery.json';
+
+// busca o endereço do contrato do RealDigital
+async function example4() {
+    const contract = await ethers.getContractAt(abiAddressDiscovery, '<Endereço contrato Address Discovery>');
+    const realDigitalAddress = await contract.addressDiscovery(ethers.utils.id('RealDigital'));
+
+    console.log(realDigitalAddress);
+}