Implantar e Testar APIs Wrapper para Estruturas Genéricas de Token
Implantando o Pacote de API do Wrapper do Token Fungível Framework
Para obter informações sobre o uso das coleções Postman incluídas com cada pacote, consulte Componentes do Pacote da API Wrapper.
Para poder implantar o pacote de API do wrapper, atualize as variáveis de configuração necessárias. Algumas variáveis de configuração têm valores padrão, mas você deve atualizar manualmente qualquer variável que contenha um espaço reservado como seu valor padrão. As variáveis de configuração são armazenadas no arquivo terraform.tfvars
no arquivo compactado da API do wrapper. Para obter mais informações sobre a implantação de APIs do wrapper e sobre variáveis de configuração, consulte APIs do wrapper. A tabela a seguir lista as variáveis de configuração e seus valores padrão para o pacote de API do encapsulador de estrutura de token não fungível. Se o valor padrão contiver espaços reservados, isso indica que o usuário deve fornecer manualmente os valores necessários.
Nome da variável | Valor padrão | Descrição |
---|---|---|
compartment_ocid |
<compartment_ocid> |
O OCID do compartimento no OCI (Oracle Cloud Infrastructure). |
compartment_name |
<compartment_name> |
O nome do compartimento do OCI. |
identity_domain |
<identity_domain> |
O domínio de identidades a ser usado. |
blockchain_channel |
<blockchain_channel> |
O nome do canal do Oracle Blockchain Platform no qual o chaincode é implantado. |
blockchain_url |
<blockchain_url> |
O URL do Oracle Blockchain Platform associado à implantação de chaincode. |
blockchain_chaincode |
DepositToken |
O nome do chaincode para o qual gerar APIs wrapper. |
blockchain_sync |
true |
O valor de sincronização a ser incluído no payload para chamadas de API. |
blockchain_timeout |
6000 |
O valor de timeout a ser incluído no payload para chamadas de API. |
vcn_display_name |
DepositToken |
O nome para exibição da rede virtual na nuvem do OCI. |
application_display_name |
DepositToken |
O nome para exibição do aplicativo OCI. |
gateway_display_name |
DepositToken |
O nome para exibição do Gateway de API. |
deployment_display_name |
DepositToken |
O nome para exibição da implantação no Gateway de API. |
deployment_path_prefix |
/DepositToken |
O prefixo do caminho de implantação no Gateway de API, que especifica o caminho no qual as rotas são implantadas. A variável deployment_path_prefix deve começar com uma barra (/).
|
ocir_repo_name |
deposittoken |
O nome do repositório do OCI Registry. A variável ocir_repo_name deve ter todas letras minúsculas.
|
policy_name |
DepositToken |
O nome da política que permite o gerenciamento controlado e o acesso a APIs por meio de permissões definidas para grupos e compartimentos dentro da organização |
Fluxo do Processo de Amostra da Estrutura de Token Fungível
Um fluxo de processo típico usando as APIs wrapper da estrutura de token fungível segue estas etapas básicas.- Os administradores usam a API
initializeDepositToken
para inicializar o sistema de token de depósito. - Os administradores usam as APIs
createAccount
eassociateTokenToAccount
para criar contas e associar o token às contas de todos os usuários. - Os administradores usam a API
addRole
para designar a atribuição de minerador ao criador e a atribuição de notário ao aprovador. - O criador do token usa a API
requestMint
para enviar uma solicitação para gerar tokens de depósito. - O aprovador usa a API
approveMint
para revisar e aprovar a solicitação para gerar tokens de depósito. Os tokens de depósito são creditados na conta do criador. - O emissor usa a API
getAccountBalance
para verificar se o valor creditado é preciso. - O criador usa a API
holdTokens
para solicitar a transferência dos tokens para o emissor. - O aprovador usa a API
executeHoldTokens
para validar e aprovar a solicitação de transferência. Os tokens de depósito são transferidos para a conta do emissor. - O emissor usa a API
transferTokens
para um usuário. Os tokens de depósito são creditados na conta do primeiro usuário. - O primeiro usuário usa a API
getAccountBalance
para verificar o saldo da conta. - O emissor usa a API
transferTokens
para um usuário. Os tokens de depósito são creditados na conta do segundo usuário. - O segundo usuário usa a API
getAccountBalance
para verificar o saldo da conta. - O segundo usuário usa a API
burnTokens
para resgatar seus tokens de depósito.
Implantando o Pacote de API Non-Fungible Token Wrapper
Para poder implantar o pacote de API do wrapper, atualize as variáveis de configuração necessárias. Algumas variáveis de configuração têm valores padrão, mas você deve atualizar manualmente qualquer variável que contenha um espaço reservado como seu valor padrão. As variáveis de configuração são armazenadas no arquivo terraform.tfvars
no arquivo compactado da API do wrapper. Para obter mais informações sobre a implantação de APIs do wrapper e sobre variáveis de configuração, consulte APIs do wrapper. A tabela a seguir lista as variáveis de configuração e seus valores padrão para o pacote de API do encapsulador de estrutura de token não fungível. Se o valor padrão contiver espaços reservados, isso indica que o usuário deve fornecer manualmente os valores necessários.
Nome da variável | Valor padrão | Descrição |
---|---|---|
compartment_ocid |
<compartment_ocid> |
O OCID do compartimento no OCI (Oracle Cloud Infrastructure). |
compartment_name |
<compartment_name> |
O nome do compartimento do OCI. |
identity_domain |
<identity_domain> |
O domínio de identidades a ser usado. |
blockchain_channel |
<blockchain_channel> |
O nome do canal do Oracle Blockchain Platform no qual o chaincode é implantado. |
blockchain_url |
<blockchain_url> |
O URL do Oracle Blockchain Platform associado à implantação de chaincode. |
blockchain_chaincode |
NFTCollectiblesWithERC721 |
O nome do chaincode para o qual gerar APIs wrapper. |
blockchain_sync |
true |
O valor de sincronização a ser incluído no payload para chamadas de API. |
blockchain_timeout |
6000 |
O valor de timeout a ser incluído no payload para chamadas de API. |
vcn_display_name |
NFTCollectiblesWithERC721 |
O nome para exibição da rede virtual na nuvem do OCI. |
application_display_name |
NFTCollectiblesWithERC721 |
O nome para exibição do aplicativo OCI. |
gateway_display_name |
NFTCollectiblesWithERC721 |
O nome para exibição do Gateway de API. |
deployment_display_name |
NFTCollectiblesWithERC721 |
O nome para exibição da implantação no Gateway de API. |
deployment_path_prefix |
/NFTCollectiblesWithERC721 |
O prefixo do caminho de implantação no Gateway de API, que especifica o caminho no qual as rotas são implantadas. A variável deployment_path_prefix deve começar com uma barra (/).
|
ocir_repo_name |
nftcollectibleswitherc721 |
O nome do repositório do OCI Registry. A variável ocir_repo_name deve ter todas letras minúsculas.
|
policy_name |
NFTCollectiblesWithERC721 |
O nome da política que permite o gerenciamento controlado e o acesso a APIs por meio de permissões definidas para grupos e compartimentos dentro da organização |
Fluxo do Processo de Amostra da Estrutura de Token Não Fungível
Um fluxo de processo típico usando as APIs wrapper de estrutura de token não fungíveis segue estas etapas básicas.- Os administradores usam a API
createAccount
para criar contas para todas as partes interessadas, incluindo museus/curadores, compradores e vendedores. - Os administradores usam a API
addRole
para designar a atribuição de minter ao curador, permitindo que eles cunhem NFTs. - Os curadores usam a API
createArtCollectionToken
para criar uma coleção de arte NFT. - Os curadores usam a API
post
para definir o preço de um NFT e publicá-lo para venda no mercado. - Os compradores usam a API
buy
para comprar o NFT usando pagamento direto por meio de um gateway de pagamento. O NFT adquirido é transferido para a conta do comprador e não está mais à venda. - Opcionalmente, os compradores podem usar a API
post
para definir um novo preço para um NFT e publicá-lo para revenda no mercado.
Implantando o Pacote de API do Encapsulador de Token Combinado
Para poder implantar o pacote de API do wrapper, atualize as variáveis de configuração necessárias. Algumas variáveis de configuração têm valores padrão, mas você deve atualizar manualmente qualquer variável que contenha um espaço reservado como seu valor padrão. As variáveis de configuração são armazenadas no arquivo terraform.tfvars
no arquivo compactado da API do wrapper. Para obter mais informações sobre a implantação de APIs do wrapper e sobre variáveis de configuração, consulte APIs do wrapper. A tabela a seguir lista as variáveis de configuração e seus valores padrão para o pacote de API do wrapper da estrutura de token combinado. Se o valor padrão contiver espaços reservados, isso indica que o usuário deve fornecer manualmente os valores necessários.
Nome da variável | Valor padrão | Descrição |
---|---|---|
compartment_ocid |
<compartment_ocid> |
O OCID do compartimento no OCI (Oracle Cloud Infrastructure). |
compartment_name |
<compartment_name> |
O nome do compartimento do OCI. |
identity_domain |
<identity_domain> |
O domínio de identidades a ser usado. |
blockchain_channel |
<blockchain_channel> |
O nome do canal do Oracle Blockchain Platform no qual o chaincode é implantado. |
blockchain_url |
<blockchain_url> |
O URL do Oracle Blockchain Platform associado à implantação de chaincode. |
blockchain_chaincode |
WholesaleCBDC |
O nome do chaincode para o qual gerar APIs wrapper. |
blockchain_sync |
true |
O valor de sincronização a ser incluído no payload para chamadas de API. |
blockchain_timeout |
6000 |
O valor de timeout a ser incluído no payload para chamadas de API. |
vcn_display_name |
NFTCollectiblesWithERC1155 |
O nome para exibição da rede virtual na nuvem do OCI. |
application_display_name |
NFTCollectiblesWithERC1155 |
O nome para exibição do aplicativo OCI. |
gateway_display_name |
NFTCollectiblesWithERC1155 |
O nome para exibição do Gateway de API. |
deployment_display_name |
NFTCollectiblesWithERC1155 |
O nome para exibição da implantação no Gateway de API. |
deployment_path_prefix |
/NFTCollectiblesWithERC1155 |
O prefixo do caminho de implantação no Gateway de API, que especifica o caminho no qual as rotas são implantadas. A variável deployment_path_prefix deve começar com uma barra (/).
|
ocir_repo_name |
nftcollectibleswitherc1155 |
O nome do repositório do OCI Registry. A variável ocir_repo_name deve ter todas letras minúsculas.
|
policy_name |
NFTCollectiblesWithERC1155 |
O nome da política que permite o gerenciamento controlado e o acesso a APIs por meio de permissões definidas para grupos e compartimentos dentro da organização |
Fluxo do Processo de Amostra da Estrutura de Token Combinado
Um fluxo de processo típico usando as APIs combinadas do encapsulador de estrutura de token segue estas etapas básicas.- Os administradores usam a API
createAccount
para criar contas de token fungíveis e não fungíveis para todas as partes interessadas, incluindo museus/curadores, compradores e vendedores. - Os administradores usam a API
addRole
para designar a atribuição de minter ao curador, permitindo que eles cunhem NFTs. - Os curadores usam a API
mintBatch
para criar NFTs de coleção de arte. - Os curadores usam a API
post
para definir o preço de um NFT e publicá-lo para venda no mercado. - Compradores e vendedores usam a API
createTokenAccount
para criar contas de consumidores para tokens fungíveis e não fungíveis na plataforma. - Os compradores usam a API
buyWithEthCoin
para comprar o NFT com Ethereum. O NFT adquirido é transferido para a conta do comprador e não está mais à venda. - Opcionalmente, os compradores podem usar a API
post
para definir um novo preço para um NFT e publicá-lo para revenda no mercado. - Opcionalmente, os compradores podem usar a API
burnBatch
para resgatar o NFT ou removê-lo permanentemente da circulação.