Wrapper-APIs für generische Token-Frameworks bereitstellen und testen

Wrapper-API-Package für das Fungible Token Framework bereitstellen

Informationen zur Verwendung der Postman-Sammlungen, die in den einzelnen Packages enthalten sind, finden Sie unter Wrapper-API-Packagekomponenten.

Bevor Sie das Wrapper-API-Package bereitstellen können, müssen Sie die erforderlichen Konfigurationsvariablen aktualisieren. Einige Konfigurationsvariablen haben Standardwerte. Sie müssen jedoch jede Variable, die einen Platzhalter als Standardwert enthält, manuell aktualisieren. Konfigurationsvariablen werden in der Datei terraform.tfvars im Wrapper-API-Archiv gespeichert. Weitere Informationen zum Deployment von Wrapper-APIs und zu Konfigurationsvariablen finden Sie unter Wrapper-APIs. In der folgenden Tabelle werden die Konfigurationsvariablen und ihre Standardwerte für das Wrapper-API-Package für nicht fungible Token Framework aufgeführt. Wenn der Standardwert Platzhalter enthält, gibt er an, dass der Benutzer die erforderlichen Werte manuell angeben muss.

Variablenname	Standardwert	Beschreibung
compartment_ocid	<compartment_ocid>	Die OCID des Compartments in Oracle Cloud Infrastructure (OCI).
compartment_name	<compartment_name>	Der Name des OCI-Compartments.
identity_domain	<identity_domain>	Die zu verwendende Identitätsdomain.
blockchain_channel	<blockchain_channel>	Der Name des Oracle Blockchain Platform-Kanals, in dem der Chaincode bereitgestellt wird.
blockchain_url	<blockchain_url>	Die Oracle Blockchain Platform-URL, die mit dem Chaincode-Deployment verknüpft ist.
blockchain_chaincode	DepositToken	Der Name des Chaincodes, für den Wrapper-APIs generiert werden sollen.
blockchain_sync	true	Der Synchronisierungswert, der in die Payload für API-Aufrufe aufgenommen werden soll.
blockchain_timeout	6000	Der Timeoutwert, der in die Payload für API-Aufrufe aufgenommen werden soll.
vcn_display_name	DepositToken	Der Anzeigename des virtuellen OCI-Cloud-Netzwerks.
application_display_name	DepositToken	Der Anzeigename der OCI-Anwendung.
gateway_display_name	DepositToken	Der Anzeigename des API-Gateways.
deployment_display_name	DepositToken	Der Anzeigename des Deployments in API Gateway.
deployment_path_prefix	/DepositToken	Das Deployment-Pfadpräfix in API Gateway, das den Pfad angibt, in dem Routen bereitgestellt werden. Die Variable deployment_path_prefix muss mit einem Schrägstrich (/) beginnen.
ocir_repo_name	deposittoken	Der Name des OCI Registry-Repositorys. Die Variable ocir_repo_name muss alle Kleinbuchstaben enthalten.
policy_name	DepositToken	Der Name der Policy, die über definierte Berechtigungen für Gruppen und Compartments innerhalb der Organisation eine kontrollierte Verwaltung und den Zugriff auf APIs ermöglicht

Beispielprozessablauf für Fungible Token Framework

Ein typischer Prozessfluss mit den fungiblen Token Framework Wrapper-APIs führt diese grundlegenden Schritte aus.

1. Administratoren verwenden die API initializeDepositToken, um das Einzahlungstokensystem zu initialisieren.
2. Administratoren verwenden die APIs createAccount und associateTokenToAccount, um Accounts zu erstellen und das Token Accounts für alle Benutzer zuzuordnen.
3. Administratoren verwenden die API addRole, um die Minter-Rolle dem Ersteller und die Notarrolle dem Genehmiger zuzuweisen.
4. Der Tokenersteller verwendet die API requestMint, um eine Anforderung an Münzeinzahlungstoken weiterzuleiten.
5. Der Genehmiger verwendet die API approveMint, um die Anforderung zum Minzen von Einzahlungstoken zu prüfen und zu genehmigen. Die Einzahlungstoken werden dem Konto des Erstellers gutgeschrieben.
6. Der Aussteller verwendet die API getAccountBalance, um zu prüfen, ob der gutgeschriebene Betrag korrekt ist.
7. Der Ersteller verwendet die API holdTokens, um die Übertragung der Token an den Aussteller anzufordern.
8. Der Genehmiger verwendet die API executeHoldTokens, um die Transferanforderung zu validieren und zu genehmigen. Die Einzahlungstoken werden auf das Konto des Emittenten überwiesen.
9. Der Aussteller verwendet die API transferTokens für einen Benutzer. Die Einzahlungstoken werden auf das Konto des ersten Benutzers gutgeschrieben.
10. Der erste Benutzer verwendet die API getAccountBalance, um seinen Kontosaldo zu prüfen.
11. Der Aussteller verwendet die API transferTokens für einen Benutzer. Die Einzahlungstoken werden auf das Konto des zweiten Benutzers gutgeschrieben.
12. Der zweite Benutzer verwendet die API getAccountBalance, um seinen Kontosaldo zu prüfen.
13. Der zweite Benutzer verwendet die API burnTokens, um seine Einzahlungstoken einzulösen.

Nicht-Fungible Token Wrapper-API-Package bereitstellen

Bevor Sie das Wrapper-API-Package bereitstellen können, müssen Sie die erforderlichen Konfigurationsvariablen aktualisieren. Einige Konfigurationsvariablen haben Standardwerte. Sie müssen jedoch jede Variable, die einen Platzhalter als Standardwert enthält, manuell aktualisieren. Konfigurationsvariablen werden in der Datei terraform.tfvars im Wrapper-API-Archiv gespeichert. Weitere Informationen zum Deployment von Wrapper-APIs und zu Konfigurationsvariablen finden Sie unter Wrapper-APIs. In der folgenden Tabelle werden die Konfigurationsvariablen und ihre Standardwerte für das Wrapper-API-Package für nicht fungible Token Framework aufgeführt. Wenn der Standardwert Platzhalter enthält, gibt er an, dass der Benutzer die erforderlichen Werte manuell angeben muss.

Variablenname	Standardwert	Beschreibung
compartment_ocid	<compartment_ocid>	Die OCID des Compartments in Oracle Cloud Infrastructure (OCI).
compartment_name	<compartment_name>	Der Name des OCI-Compartments.
identity_domain	<identity_domain>	Die zu verwendende Identitätsdomain.
blockchain_channel	<blockchain_channel>	Der Name des Oracle Blockchain Platform-Kanals, in dem der Chaincode bereitgestellt wird.
blockchain_url	<blockchain_url>	Die Oracle Blockchain Platform-URL, die mit dem Chaincode-Deployment verknüpft ist.
blockchain_chaincode	NFTCollectiblesWithERC721	Der Name des Chaincodes, für den Wrapper-APIs generiert werden sollen.
blockchain_sync	true	Der Synchronisierungswert, der in die Payload für API-Aufrufe aufgenommen werden soll.
blockchain_timeout	6000	Der Timeoutwert, der in die Payload für API-Aufrufe aufgenommen werden soll.
vcn_display_name	NFTCollectiblesWithERC721	Der Anzeigename des virtuellen OCI-Cloud-Netzwerks.
application_display_name	NFTCollectiblesWithERC721	Der Anzeigename der OCI-Anwendung.
gateway_display_name	NFTCollectiblesWithERC721	Der Anzeigename des API-Gateways.
deployment_display_name	NFTCollectiblesWithERC721	Der Anzeigename des Deployments in API Gateway.
deployment_path_prefix	/NFTCollectiblesWithERC721	Das Deployment-Pfadpräfix in API Gateway, das den Pfad angibt, in dem Routen bereitgestellt werden. Die Variable deployment_path_prefix muss mit einem Schrägstrich (/) beginnen.
ocir_repo_name	nftcollectibleswitherc721	Der Name des OCI Registry-Repositorys. Die Variable ocir_repo_name muss alle Kleinbuchstaben enthalten.
policy_name	NFTCollectiblesWithERC721	Der Name der Policy, die über definierte Berechtigungen für Gruppen und Compartments innerhalb der Organisation eine kontrollierte Verwaltung und den Zugriff auf APIs ermöglicht

Beispielprozessablauf für Framework für nicht-fungible Token

Ein typischer Prozessfluss mit den Wrapper-APIs für nicht fungible Token Frameworks führt diese grundlegenden Schritte aus.

1. Administratoren verwenden die createAccount-API, um Konten für alle Stakeholder zu erstellen, einschließlich Museen/Kuratoren, Käufern und Verkäufern.
2. Administratoren verwenden die API addRole, um dem Verwalter die Minterrolle zuzuweisen, sodass sie NFTs mintieren können.
3. Kuratoren verwenden die API createArtCollectionToken, um eine Kunstsammlung NFT zu prägen.
4. Kuratoren verwenden die API post, um den Preis für einen NFT festzulegen und ihn zum Verkauf auf dem Marktplatz zu veröffentlichen.
5. Käufer verwenden die buy API, um die NFT zu kaufen, indem sie Direktzahlungen über ein Zahlungsgateway verwenden. Die gekaufte NFT wird auf das Konto des Käufers übertragen und steht nicht mehr zum Verkauf.
6. Optional können Käufer die API post verwenden, um einen neuen Preis für einen NFT festzulegen und ihn zum Weiterverkauf auf dem Marktplatz zu buchen.

Kombiniertes Token Wrapper-API-Package bereitstellen

Bevor Sie das Wrapper-API-Package bereitstellen können, müssen Sie die erforderlichen Konfigurationsvariablen aktualisieren. Einige Konfigurationsvariablen haben Standardwerte. Sie müssen jedoch jede Variable, die einen Platzhalter als Standardwert enthält, manuell aktualisieren. Konfigurationsvariablen werden in der Datei terraform.tfvars im Wrapper-API-Archiv gespeichert. Weitere Informationen zum Deployment von Wrapper-APIs und zu Konfigurationsvariablen finden Sie unter Wrapper-APIs. In der folgenden Tabelle sind die Konfigurationsvariablen und ihre Standardwerte für das kombinierte API-Package für Token Framework Wrapper aufgeführt. Wenn der Standardwert Platzhalter enthält, gibt er an, dass der Benutzer die erforderlichen Werte manuell angeben muss.

Variablenname	Standardwert	Beschreibung
compartment_ocid	<compartment_ocid>	Die OCID des Compartments in Oracle Cloud Infrastructure (OCI).
compartment_name	<compartment_name>	Der Name des OCI-Compartments.
identity_domain	<identity_domain>	Die zu verwendende Identitätsdomain.
blockchain_channel	<blockchain_channel>	Der Name des Oracle Blockchain Platform-Kanals, in dem der Chaincode bereitgestellt wird.
blockchain_url	<blockchain_url>	Die Oracle Blockchain Platform-URL, die mit dem Chaincode-Deployment verknüpft ist.
blockchain_chaincode	WholesaleCBDC	Der Name des Chaincodes, für den Wrapper-APIs generiert werden sollen.
blockchain_sync	true	Der Synchronisierungswert, der in die Payload für API-Aufrufe aufgenommen werden soll.
blockchain_timeout	6000	Der Timeoutwert, der in die Payload für API-Aufrufe aufgenommen werden soll.
vcn_display_name	NFTCollectiblesWithERC1155	Der Anzeigename des virtuellen OCI-Cloud-Netzwerks.
application_display_name	NFTCollectiblesWithERC1155	Der Anzeigename der OCI-Anwendung.
gateway_display_name	NFTCollectiblesWithERC1155	Der Anzeigename von API Gateway.
deployment_display_name	NFTCollectiblesWithERC1155	Der Anzeigename des Deployments in API Gateway.
deployment_path_prefix	/NFTCollectiblesWithERC1155	Das Deployment-Pfadpräfix in API Gateway, das den Pfad angibt, in dem Routen bereitgestellt werden. Die Variable deployment_path_prefix muss mit einem Schrägstrich (/) beginnen.
ocir_repo_name	nftcollectibleswitherc1155	Der Name des OCI Registry-Repositorys. Die Variable ocir_repo_name muss alle Kleinbuchstaben enthalten.
policy_name	NFTCollectiblesWithERC1155	Der Name der Policy, die über definierte Berechtigungen für Gruppen und Compartments innerhalb der Organisation eine kontrollierte Verwaltung und den Zugriff auf APIs ermöglicht

Beispielprozessablauf für das Framework für kombinierte Token

Ein typischer Prozessfluss mit den kombinierten Token Framework Wrapper-APIs führt diese grundlegenden Schritte aus.

1. Administratoren verwenden die createAccount-API, um fungible und nicht fungible Token-Konten für alle Stakeholder zu erstellen, einschließlich Museen/Kuratoren, Käufern und Verkäufern.
2. Administratoren verwenden die API addRole, um dem Verwalter die Minterrolle zuzuweisen, sodass sie NFTs mintieren können.
3. Kuratoren verwenden die API mintBatch, um Kunstsammlungs-NFTs zu prägen.
4. Kuratoren verwenden die API post, um den Preis für einen NFT festzulegen und ihn zum Verkauf auf dem Marktplatz zu veröffentlichen.
5. Käufer und Verkäufer verwenden die API createTokenAccount, um Verbraucherkonten für fungible und nicht fungible Token auf der Plattform zu erstellen.
6. Käufer verwenden die buyWithEthCoin API, um die NFT mit Ethereum zu kaufen. Die gekaufte NFT wird auf das Konto des Käufers übertragen und steht nicht mehr zum Verkauf.
7. Optional können Käufer die API post verwenden, um einen neuen Preis für einen NFT festzulegen und ihn zum Weiterverkauf auf dem Marktplatz zu buchen.
8. Optional können Käufer die burnBatch-API verwenden, um die NFT einzulösen oder sie dauerhaft aus dem Umlauf zu entfernen.