Skip to content

Commit

Permalink
Adiciona docs e artefatos relacionados ao zether
Browse files Browse the repository at this point in the history
  • Loading branch information
@aldenio
aldenio committed Nov 28, 2023
1 parent 13b694c commit 78ae8ba
Show file tree
Hide file tree
Showing 6 changed files with 360 additions and 4 deletions.
75 changes: 75 additions & 0 deletions AnonymousZether.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
# Anonymous Zether

O Anonymous Zether é uma solução de privacidade e anonimidade desenvolvida pela JPMorgan e posteriormente incorporada pela Consensys.

Esta é baseada em um paper da Universidade de Stanford em parceira com a Visa, link [aqui](https://crypto.stanford.edu/~buenz/papers/zether.pdf).

A solução se baseia na criptografia ElGamal, que é uma criptografia assimétrica (possui um par de chave pública e privada) e homomórfica (permite cálculos entre números criptografados).

Além disso, o contrato consegue verificar que o valor subtraído é igual ao valor adicionado, usando provas de conhecimento zero.

Para mais detalhes, consulte as apresentações na pasta [docs](./docs)

#### Passo a passo

É necessário configurar o client do anonymous zether para realizar os testes de privacidade.
Esse client utiliza dependências do anonymous zether (server), por isso também será necessário configurar ele.
Para facilitar os testes foi disponibilizado alguns scripts que rodam no postman ou ferramenta similar (insomnia, etc).

#### 0 - Configurar o anonymous zether

* Clonar no mesmo diretório raiz, os repositórios da [Consensys](https://github.com/Consensys/anonymous-zether) e da [Kaleido](https://github.com/kaleido-io/anonymous-zether-client/tree/real-digital) (Importante: usar a branch real-digital).
* Instalar as dependências (`yarn` ou `npm install`) dos dois projetos.
* No projeto da Kaleido, configurar o arquivo `.env` da seguinte forma:
```
ERC20_ADDRESS='0x3A34C530700E3835794eaE04d2a4F22Ce750eF7e' (Endereço do contrato do Real Digital)
ZSC_ADDRESS='0x9ecbbA5758D719415F641192E542f8e4cc7934C3' (Endereço do contrato zether)
CHAIN_ID='381660001'
ADMIN_SIGNER='<Chave privada de uma carteira habilitada e com saldo>'
AUTHORITY_SIGNER='<Mesma chave do admin>'
ETH_URL='<URL websocket do seu nó>' (ex: 'ws://172.17.42.90:30200')
DATA_DIR='/tmp/zether'
```
* Execute a aplicação servidor através do comando (`npm start`) no anonymous-zether-client

#### 0.1 - Configurar scripts (Postman)

* Importe o arquivo [zether-client.json](./zether-client.json) no [Postman](https://www.postman.com/downloads/).
* Dentro do Postman, crie um ambiente e defina as seguintes variáveis:
* * `host1`: `http://localhost:3000` (servidor onde está rodando o cliente, o valor default é `http://localhost:3000`)
* * `zsc1`: `` (endereço do contrato de zether na rede)

#### 1 - Criar chaves Ethereum e ElGamal

* Agora precisamos criar as chaves Ethereum e ElGamal que serão utilizadas nessa camada de privacidade.
* Execute a chamada `Create Participant Account`, alterando o corpo da requisição.
* * Nome da conta do participante: Favor informar o CNPJ8 do participante. Esse nome não poderá ser duplicado, portanto, no piloto convencionamos como padrão o uso do CNPJ8.
* Esta chamada criará um par de chaves Ethereum e ElGamal e vai gravar no postman nas variavéis participantEth e participantShielded com os valores das chaves. Você pode consultar esses dados no ambiente que você criou no passo anterior.
* Para confirmar que as chaves foram criadas com sucesso, execute a chamada `Get accounts`

#### 2 - Registrar chaves ElGamal no contrato Zether

* Registre a sua chave no contrato de zether através da chamada `Register Participant in Real Digital ZSC`, alterando o corpo da requisição
* * Nome da conta do participante: Favor informar o CNPJ8 do participante. Esse nome não poderá ser duplicado, portanto, no piloto convencionamos como padrão o uso do CNPJ8.
* * ZSC1: variável de ambiente com o endereço do contrato ZSC criado na rede do piloto. (Poderá obter no address discover com nome ZSCRestricted)
* Confirme que o registro foi feito através da chamada `Get shielded accounts in Real Digital ZSC`
* Use os exemplos do RealDigitalEnableAccount e do STR para habilitar e mintar Real Digital na carteira gerada pelo cliente no primeiro passo

#### 3 - Mover fundos para o contrato Zether

* Execute a chamada `Participant funds shielded account in Real Digital ZSC` para mover o saldo em Real Digital para o contrato Zether
* Cheque o seu saldo em zether com a chamada `Participant checks shielded balance in Real Digital ZSC`

#### 4 - Transferir Real Digital via Zether

* Escolha um outro participante registrado e execute a chamada `Participant A transfers 50 Real Digital zether to Participant B` para mover Real Digital. No corpo da requisição, o campo `sender` e `receiver` devem estar no formato abaixo, ou seja, apenas uma string com as duas partes da chave ElGamal separadas por uma vírgula:
```
0x159679aa94befe3c67c951cb659f6f4f8746d2503163cdd4300407fe2ce53c2a,0x245e09c47e3c8d1394333e780163a210b9ffff4ca150b7987fd878ba9bd613bf
```
* Cheque o seu saldo em zether com a chamada `Participant checks shielded balance in Real Digital ZSC`
* Refaça a transação caso ocorra um dos erros "Sigma protocol challenge equality failure." ou "Recovery failure for B^w * A.". Provavelmente, as provas estão vinculadas a uma época anterior.

#### 5 - Mover Real Digital de volta para a carteira Ethereum

* Execute a chamada `Participant withdraws Real Digital zether` para mover os fundos em Zether de volta para a carteira Ethereum.
* Refaça a transação caso ocorra um dos erros "Sigma protocol challenge equality failure." ou "Recovery failure for B^w * A.". Provavelmente, as provas estão vinculadas a uma época anterior.
3 changes: 2 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Kit Onboarding - Piloto Real Digital (#6d6da5767e6dfe60099a473e47f33fd13419e0a8)
# Kit Onboarding - Piloto Real Digital (#b5ec9c6f117f342c9e57500fd8cb033bc0374678)

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.

Expand All @@ -8,3 +8,4 @@ Este repositório contém as informações necessárias para a participação no
* [Smart Contracts - Real Digital, Real Tokenizado](smartcontracts.md)
* [Smart Contracts - Título Público Federal Tokenizado e Operações com títulos](smartcontractsTitulos.md)
* [Exemplos de interação com os smart contracts](exemplos/README.md)
* [Privacidade - Anonymous Zether](AnonymousZether.md)
6 changes: 3 additions & 3 deletions config.toml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ nat-method="NONE"
min-gas-price=0

# Transaction Pool
tx-pool-retention-hours=999
tx-pool-limit-by-account-percentage=1
tx-pool-max-size=20000
# tx-pool-retention-hours=999
# tx-pool-limit-by-account-percentage=1
# tx-pool-max-size=20000

# P2P network
p2p-enabled=true
Expand Down
Binary file added docs/20231109_zether.pptx
View file
Binary file not shown.
Binary file added docs/Anonymous Zether for DREX technical deep dive.pptx
View file
Binary file not shown.
280 changes: 280 additions & 0 deletions zether-client.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,280 @@
{
"info": {
"_postman_id": "ec082d1b-e72c-4ec9-9e31-8f9e84f8100d",
"name": "zether-client",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "Get accounts",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{host1}}/api/v1/accounts",
"host": [
"{{host1}}"
],
"path": [
"api",
"v1",
"accounts"
]
}
},
"response": []
},
{
"name": "Get shielded accounts in Real Digital ZSC",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{host1}}/api/v1/shieldedAccounts?zsc={{zsc1}}",
"host": [
"{{host1}}"
],
"path": [
"api",
"v1",
"shieldedAccounts"
],
"query": [
{
"key": "zsc",
"value": "{{zsc1}}"
}
]
}
},
"response": []
},
{
"name": "Create Participant account",
"event": [
{
"listen": "test",
"script": {
"exec": [
"var jsonData = JSON.parse(responseBody);",
"postman.setEnvironmentVariable(\"participantEth\", jsonData.eth);",
"postman.setEnvironmentVariable(\"participantShielded\", jsonData.shielded.join(','));"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Participant\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{host1}}/api/v1/accounts",
"host": [
"{{host1}}"
],
"path": [
"api",
"v1",
"accounts"
]
}
},
"response": []
},
{
"name": "Register Participant in Real Digital ZSC",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Participant\",\n \"zsc\": \"{{zsc1}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{host1}}/api/v1/accounts/{{participantShielded}}/register",
"host": [
"{{host1}}"
],
"path": [
"api",
"v1",
"accounts",
"{{participantShielded}}",
"register"
]
}
},
"response": []
},
{
"name": "Participant funds shielded account in Real Digital ZSC",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"ethAddress\": \"{{participantEth}}\",\n \"amount\": 100,\n \"zsc\": \"{{zsc1}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{host1}}/api/v1/fund",
"host": [
"{{host1}}"
],
"path": [
"api",
"v1",
"fund"
]
}
},
"response": []
},
{
"name": "Participant A transfers 50 Real Digital zether to Participant B",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"sender\": \"{{participantShielded}}\",\n \"receiver\": \"{{participantBShielded}}\",\n \"decoys\": [],\n \"amount\": 50,\n \"zsc\": \"{{zsc1}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{host1}}/api/v1/transfer",
"host": [
"{{host1}}"
],
"path": [
"api",
"v1",
"transfer"
]
}
},
"response": []
},
{
"name": "Participant checks RealDigital balance",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [],
"body": {
"mode": "raw",
"raw": "{}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{host1}}/api/v1/accounts/{{participantEth}}/balance",
"host": [
"{{host1}}"
],
"path": [
"api",
"v1",
"accounts",
"{{participantEth}}",
"balance"
]
}
},
"response": []
},
{
"name": "Participant checks shielded balance in Real Digital ZSC",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [],
"body": {
"mode": "raw",
"raw": "{}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{host1}}/api/v1/accounts/{{participantShielded}}/balance?zsc={{zsc1}}",
"host": [
"{{host1}}"
],
"path": [
"api",
"v1",
"accounts",
"{{participantShielded}}",
"balance"
],
"query": [
{
"key": "zsc",
"value": "{{zsc1}}"
}
]
}
},
"response": []
},
{
"name": "Participant withdraws Real Digital zether",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"ethAddress\": \"{{participantEth}}\",\n \"amount\": 50,\n \"zsc\": \"{{zsc1}}\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{host1}}/api/v1/withdraw",
"host": [
"{{host1}}"
],
"path": [
"api",
"v1",
"withdraw"
]
}
},
"response": []
}
]
}

0 comments on commit 78ae8ba

Please sign in to comment.