Distribuisci e testa API wrapper per framework token generici

Distribuzione del package API Wrapper Fungible Token Framework

Per informazioni sull'uso delle raccolte Postman incluse in ciascun pacchetto, vedere Componenti package API wrapper.

Prima di poter distribuire il package API wrapper, è necessario aggiornare le variabili di configurazione richieste. Alcune variabili di configurazione hanno valori predefiniti, ma è necessario aggiornare manualmente qualsiasi variabile che contiene un segnaposto come valore predefinito. Le variabili di configurazione vengono memorizzate nel file terraform.tfvars nell'archivio API del wrapper. Per ulteriori informazioni sulla distribuzione delle interfacce API wrapper e sulle variabili di configurazione, vedere API wrapper. Nella tabella seguente sono elencate le variabili di configurazione e i relativi valori predefiniti per il package API wrapper del framework token non fungibile. Se il valore predefinito contiene segnaposto, indica che l'utente deve fornire manualmente i valori necessari.

Nome variabile Valore predefinito Descrizione
compartment_ocid <compartment_ocid> OCID del compartimento in Oracle Cloud Infrastructure (OCI).
compartment_name <compartment_name> Nome del compartimento OCI.
identity_domain <identity_domain> Il dominio di Identity da utilizzare.
blockchain_channel <blockchain_channel> Nome del canale Oracle Blockchain Platform in cui viene distribuito il codice concatenato.
blockchain_url <blockchain_url> URL di Oracle Blockchain Platform associato alla distribuzione del codice concatenato.
blockchain_chaincode DepositToken Nome del codice concatenato per il quale generare le API wrapper.
blockchain_sync true Il valore di sincronizzazione da includere nel payload per le chiamate API.
blockchain_timeout 6000 Il valore di timeout da includere nel payload per le chiamate API.
vcn_display_name DepositToken Nome visualizzato della rete cloud virtuale OCI.
application_display_name DepositToken Il nome visualizzato dell'applicazione OCI.
gateway_display_name DepositToken Il nome visualizzato del gateway API.
deployment_display_name DepositToken Il nome visualizzato della distribuzione nel gateway API.
deployment_path_prefix /DepositToken Prefisso del percorso di distribuzione nel gateway API, che specifica il percorso in cui vengono distribuiti gli instradamenti. La variabile deployment_path_prefix deve iniziare con una barra (/).
ocir_repo_name deposittoken Nome del repository di OCI Registry. La variabile ocir_repo_name deve contenere tutte le lettere minuscole.
policy_name DepositToken Nome del criterio che abilita la gestione controllata e l'accesso alle API tramite autorizzazioni definite per gruppi e compartimenti all'interno dell'organizzazione

Flusso del processo di esempio del framework token fungibile

Un flusso di processo tipico che utilizza le API wrapper del framework di token fungibili segue questi passi di base.
  1. Gli amministratori utilizzano l'API initializeDepositToken per inizializzare il sistema dei token di deposito.
  2. Gli amministratori utilizzano le API createAccount e associateTokenToAccount per creare account e associare il token agli account per tutti gli utenti.
  3. Gli amministratori utilizzano l'API addRole per assegnare il ruolo minter all'autore e il ruolo notaio all'approvatore.
  4. Il creatore del token utilizza l'API requestMint per inviare una richiesta di mentatura dei token di deposito.
  5. L'approvatore utilizza l'API approveMint per rivedere e approvare la richiesta di conio dei token di deposito. I token di deposito vengono accreditati sul conto del creatore.
  6. L'emittente utilizza l'API getAccountBalance per verificare che l'importo accreditato sia accurato.
  7. L'autore utilizza l'API holdTokens per richiedere il trasferimento dei token all'emittente.
  8. L'approvatore utilizza l'API executeHoldTokens per convalidare e approvare la richiesta di trasferimento. I token di deposito vengono trasferiti sul conto dell'emittente.
  9. L'emittente utilizza l'API transferTokens per un utente. I token di deposito vengono accreditati sul conto del primo utente.
  10. Il primo utente utilizza l'API getAccountBalance per verificare il saldo del proprio account.
  11. L'emittente utilizza l'API transferTokens per un utente. I token di deposito vengono accreditati sul conto del secondo utente.
  12. Il secondo utente utilizza l'API getAccountBalance per verificare il saldo del proprio account.
  13. Il secondo utente utilizza l'API burnTokens per riscattare i token di deposito.

Distribuzione del package API wrapper token non fungibile

Prima di poter distribuire il package API wrapper, è necessario aggiornare le variabili di configurazione richieste. Alcune variabili di configurazione hanno valori predefiniti, ma è necessario aggiornare manualmente qualsiasi variabile che contiene un segnaposto come valore predefinito. Le variabili di configurazione vengono memorizzate nel file terraform.tfvars nell'archivio API del wrapper. Per ulteriori informazioni sulla distribuzione delle interfacce API wrapper e sulle variabili di configurazione, vedere API wrapper. Nella tabella seguente sono elencate le variabili di configurazione e i relativi valori predefiniti per il package API wrapper del framework token non fungibile. Se il valore predefinito contiene segnaposto, indica che l'utente deve fornire manualmente i valori necessari.

Nome variabile Valore predefinito Descrizione
compartment_ocid <compartment_ocid> OCID del compartimento in Oracle Cloud Infrastructure (OCI).
compartment_name <compartment_name> Nome del compartimento OCI.
identity_domain <identity_domain> Il dominio di Identity da utilizzare.
blockchain_channel <blockchain_channel> Nome del canale Oracle Blockchain Platform in cui viene distribuito il codice concatenato.
blockchain_url <blockchain_url> URL di Oracle Blockchain Platform associato alla distribuzione del codice concatenato.
blockchain_chaincode NFTCollectiblesWithERC721 Nome del codice concatenato per il quale generare le API wrapper.
blockchain_sync true Il valore di sincronizzazione da includere nel payload per le chiamate API.
blockchain_timeout 6000 Il valore di timeout da includere nel payload per le chiamate API.
vcn_display_name NFTCollectiblesWithERC721 Nome visualizzato della rete cloud virtuale OCI.
application_display_name NFTCollectiblesWithERC721 Il nome visualizzato dell'applicazione OCI.
gateway_display_name NFTCollectiblesWithERC721 Il nome visualizzato del gateway API.
deployment_display_name NFTCollectiblesWithERC721 Il nome visualizzato della distribuzione nel gateway API.
deployment_path_prefix /NFTCollectiblesWithERC721 Prefisso del percorso di distribuzione nel gateway API, che specifica il percorso in cui vengono distribuiti gli instradamenti. La variabile deployment_path_prefix deve iniziare con una barra (/).
ocir_repo_name nftcollectibleswitherc721 Nome del repository di OCI Registry. La variabile ocir_repo_name deve contenere tutte le lettere minuscole.
policy_name NFTCollectiblesWithERC721 Nome del criterio che abilita la gestione controllata e l'accesso alle API tramite autorizzazioni definite per gruppi e compartimenti all'interno dell'organizzazione

Flusso del processo di esempio del framework token non fungibile

Un flusso di processo tipico che utilizza le API wrapper del framework token non fungibili segue questi passi di base.
  1. Gli amministratori utilizzano l'API createAccount per creare account per tutte le parti coinvolte, inclusi musei/curatori, acquirenti e venditori.
  2. Gli amministratori utilizzano l'API addRole per assegnare il ruolo minter al gestore, consentendo loro di coniare gli NFT.
  3. I curatori utilizzano l'API createArtCollectionToken per coniare una collezione d'arte NFT.
  4. I curatori utilizzano l'API post per impostare il prezzo di un NFT e pubblicarlo per la vendita sul mercato.
  5. Gli acquirenti utilizzano l'API buy per acquistare l'NFT utilizzando il pagamento diretto tramite un gateway di pagamento. L'operazione NFT acquistata viene trasferita sul conto dell'acquirente e non è più in vendita.
  6. Facoltativamente, gli acquirenti possono utilizzare l'API post per impostare un nuovo prezzo per un NFT e pubblicarlo per la rivendita sul mercato.

Distribuzione del package API Token Wrapper combinato

Prima di poter distribuire il package API wrapper, è necessario aggiornare le variabili di configurazione richieste. Alcune variabili di configurazione hanno valori predefiniti, ma è necessario aggiornare manualmente qualsiasi variabile che contiene un segnaposto come valore predefinito. Le variabili di configurazione vengono memorizzate nel file terraform.tfvars nell'archivio API del wrapper. Per ulteriori informazioni sulla distribuzione delle interfacce API wrapper e sulle variabili di configurazione, vedere API wrapper. Nella tabella seguente sono elencate le variabili di configurazione e i relativi valori predefiniti per il package API wrapper del framework token combinato. Se il valore predefinito contiene segnaposto, indica che l'utente deve fornire manualmente i valori necessari.

Nome variabile Valore predefinito Descrizione
compartment_ocid <compartment_ocid> OCID del compartimento in Oracle Cloud Infrastructure (OCI).
compartment_name <compartment_name> Nome del compartimento OCI.
identity_domain <identity_domain> Dominio di identità da utilizzare.
blockchain_channel <blockchain_channel> Nome del canale Oracle Blockchain Platform in cui viene distribuito il codice concatenato.
blockchain_url <blockchain_url> URL di Oracle Blockchain Platform associato alla distribuzione del codice concatenato.
blockchain_chaincode WholesaleCBDC Nome del codice concatenato per il quale generare le API wrapper.
blockchain_sync true Il valore di sincronizzazione da includere nel payload per le chiamate API.
blockchain_timeout 6000 Il valore di timeout da includere nel payload per le chiamate API.
vcn_display_name NFTCollectiblesWithERC1155 Nome visualizzato della rete cloud virtuale OCI.
application_display_name NFTCollectiblesWithERC1155 Nome visualizzato dell'applicazione OCI.
gateway_display_name NFTCollectiblesWithERC1155 Nome visualizzato del gateway API.
deployment_display_name NFTCollectiblesWithERC1155 Nome visualizzato della distribuzione nel gateway API.
deployment_path_prefix /NFTCollectiblesWithERC1155 Prefisso del percorso di distribuzione nel gateway API, che specifica il percorso in cui vengono distribuiti gli instradamenti. La variabile deployment_path_prefix deve iniziare con una barra (/).
ocir_repo_name nftcollectibleswitherc1155 Nome del repository di OCI Registry. La variabile ocir_repo_name deve contenere tutte le lettere minuscole.
policy_name NFTCollectiblesWithERC1155 Nome del criterio che abilita la gestione controllata e l'accesso alle API tramite autorizzazioni definite per gruppi e compartimenti all'interno dell'organizzazione

Flusso del processo di esempio del framework token combinato

Un flusso di processo tipico che utilizza le API wrapper del framework token combinate segue questi passi di base.
  1. Gli amministratori utilizzano l'API createAccount per creare account di token fungibili e non fungibili per tutte le parti coinvolte, inclusi musei/curatori, acquirenti e venditori.
  2. Gli amministratori utilizzano l'API addRole per assegnare il ruolo minter al gestore, consentendo loro di coniare gli NFT.
  3. I curatori utilizzano l'API mintBatch per creare NFT per la raccolta di opere d'arte.
  4. I curatori utilizzano l'API post per impostare il prezzo di un NFT e pubblicarlo per la vendita sul mercato.
  5. Acquirenti e venditori utilizzano l'API createTokenAccount per creare account consumer per token fungibili e non fungibili sulla piattaforma.
  6. Gli acquirenti utilizzano l'API buyWithEthCoin per acquistare l'NFT con Ethereum. L'operazione NFT acquistata viene trasferita sul conto dell'acquirente e non è più in vendita.
  7. Facoltativamente, gli acquirenti possono utilizzare l'API post per impostare un nuovo prezzo per un NFT e pubblicarlo per la rivendita sul mercato.
  8. Facoltativamente, gli acquirenti possono utilizzare l'API burnBatch per riscattare il NFT o rimuoverlo definitivamente dalla circolazione.