Déployer et tester des API de wrapper pour des structures de jeton génériques

Déploiement du package API de wrapper Fungible Token Framework

Pour plus d'informations sur l'utilisation des collections Postman incluses dans chaque package, reportez-vous à Composants du package d'API wrapper.

Pour pouvoir déployer le package d'API de wrapper, vous devez mettre à jour les variables de configuration requises. Certaines variables de configuration ont des valeurs par défaut, mais vous devez mettre à jour manuellement toute variable contenant un espace réservé comme valeur par défaut. Les variables de configuration sont stockées dans le fichier terraform.tfvars dans l'archive d'API de wrapper. Pour plus d'informations sur le déploiement d'API de wrapper et sur les variables de configuration, reportez-vous à API de wrapper. Le tableau suivant répertorie les variables de configuration et leurs valeurs par défaut pour le package API de wrapper de structure de jetons non fongible. Si la valeur par défaut contient des espaces réservés, cela indique que l'utilisateur doit fournir manuellement les valeurs nécessaires.

Nom de variable	Valeur par défaut	Description
compartment_ocid	<compartment_ocid>	OCID du compartiment dans Oracle Cloud Infrastructure (OCI).
compartment_name	<compartment_name>	Nom du compartiment OCI.
identity_domain	<identity_domain>	Domaine d'identité à utiliser.
blockchain_channel	<blockchain_channel>	Nom du canal Oracle Blockchain Platform sur lequel le code chaîne est déployé.
blockchain_url	<blockchain_url>	URL Oracle Blockchain Platform associée au déploiement de code chaîne.
blockchain_chaincode	DepositToken	Nom du code chaîne pour lequel générer les API de wrapper.
blockchain_sync	true	Valeur de synchronisation à inclure dans la charge utile pour les appels d'API.
blockchain_timeout	6000	Valeur de délai d'expiration à inclure dans la charge utile pour les appels d'API.
vcn_display_name	DepositToken	Nom d'affichage du réseau cloud virtuel OCI.
application_display_name	DepositToken	Nom d'affichage de l'application OCI.
gateway_display_name	DepositToken	Nom d'affichage de la passerelle d'API.
deployment_display_name	DepositToken	Nom d'affichage du déploiement dans API Gateway.
deployment_path_prefix	/DepositToken	Préfixe de chemin de déploiement dans API Gateway, qui indique le chemin où les routages sont déployés. La variable deployment_path_prefix doit commencer par une barre oblique (/).
ocir_repo_name	deposittoken	Nom du référentiel OCI Registry. La variable ocir_repo_name doit être en minuscules.
policy_name	DepositToken	Nom de la stratégie qui permet une gestion contrôlée et un accès aux API via des droits d'accès définis pour les groupes et les compartiments au sein de l'organisation

Exemple de flux de processus Fungible Token Framework

Un flux de processus standard utilisant les API de wrapper de structure de jetons fongibles suit ces étapes de base.

1. Les administrateurs utilisent l'API initializeDepositToken pour initialiser le système de jeton de dépôt.
2. Les administrateurs utilisent les API createAccount et associateTokenToAccount pour créer des comptes et associer le jeton à des comptes pour tous les utilisateurs.
3. Les administrateurs utilisent l'API addRole pour affecter le rôle de mineur au créateur et le rôle de notaire à l'approbateur.
4. Le créateur de jeton utilise l'API requestMint pour soumettre une demande aux jetons de dépôt menthe.
5. L'approbateur utilise l'API approveMint pour vérifier et approuver la demande de jetons de dépôt. Les jetons de dépôt sont crédités sur le compte du créateur.
6. L'émetteur utilise l'API getAccountBalance pour vérifier que le montant crédité est exact.
7. Le créateur utilise l'API holdTokens pour demander le transfert des jetons à l'émetteur.
8. L'approbateur utilise l'API executeHoldTokens pour valider et approuver la demande de transfert. Les jetons de dépôt sont transférés sur le compte de l'émetteur.
9. L'émetteur utilise l'API transferTokens pour un utilisateur. Les jetons de dépôt sont crédités sur le compte du premier utilisateur.
10. Le premier utilisateur utilise l'API getAccountBalance pour vérifier le solde de son compte.
11. L'émetteur utilise l'API transferTokens pour un utilisateur. Les jetons de dépôt sont crédités sur le compte du deuxième utilisateur.
12. Le deuxième utilisateur utilise l'API getAccountBalance pour vérifier le solde de son compte.
13. Le deuxième utilisateur utilise l'API burnTokens pour échanger ses jetons de dépôt.

Déploiement du package API de wrapper de jetons non fongibles

Pour pouvoir déployer le package d'API de wrapper, vous devez mettre à jour les variables de configuration requises. Certaines variables de configuration ont des valeurs par défaut, mais vous devez mettre à jour manuellement toute variable contenant un espace réservé comme valeur par défaut. Les variables de configuration sont stockées dans le fichier terraform.tfvars dans l'archive d'API de wrapper. Pour plus d'informations sur le déploiement d'API de wrapper et sur les variables de configuration, reportez-vous à API de wrapper. Le tableau suivant répertorie les variables de configuration et leurs valeurs par défaut pour le package API de wrapper de structure de jetons non fongible. Si la valeur par défaut contient des espaces réservés, cela indique que l'utilisateur doit fournir manuellement les valeurs nécessaires.

Nom de variable	Valeur par défaut	Description
compartment_ocid	<compartment_ocid>	OCID du compartiment dans Oracle Cloud Infrastructure (OCI).
compartment_name	<compartment_name>	Nom du compartiment OCI.
identity_domain	<identity_domain>	Domaine d'identité à utiliser.
blockchain_channel	<blockchain_channel>	Nom du canal Oracle Blockchain Platform sur lequel le code chaîne est déployé.
blockchain_url	<blockchain_url>	URL Oracle Blockchain Platform associée au déploiement de code chaîne.
blockchain_chaincode	NFTCollectiblesWithERC721	Nom du code chaîne pour lequel générer les API de wrapper.
blockchain_sync	true	Valeur de synchronisation à inclure dans la charge utile pour les appels d'API.
blockchain_timeout	6000	Valeur de délai d'expiration à inclure dans la charge utile pour les appels d'API.
vcn_display_name	NFTCollectiblesWithERC721	Nom d'affichage du réseau cloud virtuel OCI.
application_display_name	NFTCollectiblesWithERC721	Nom d'affichage de l'application OCI.
gateway_display_name	NFTCollectiblesWithERC721	Nom d'affichage de la passerelle d'API.
deployment_display_name	NFTCollectiblesWithERC721	Nom d'affichage du déploiement dans API Gateway.
deployment_path_prefix	/NFTCollectiblesWithERC721	Préfixe de chemin de déploiement dans API Gateway, qui indique le chemin où les routages sont déployés. La variable deployment_path_prefix doit commencer par une barre oblique (/).
ocir_repo_name	nftcollectibleswitherc721	Nom du référentiel OCI Registry. La variable ocir_repo_name doit être en minuscules.
policy_name	NFTCollectiblesWithERC721	Nom de la stratégie qui permet une gestion contrôlée et un accès aux API via des droits d'accès définis pour les groupes et les compartiments au sein de l'organisation

Exemple de flux de processus de structure de jeton non fongible

Un flux de processus standard utilisant les API de wrapper de structure de jetons non fongibles suit ces étapes de base.

1. Les administrateurs utilisent l'API createAccount pour créer des comptes pour toutes les parties prenantes, y compris les musées/commissaires, les acheteurs et les vendeurs.
2. Les administrateurs utilisent l'API addRole pour affecter le rôle minter au superviseur, ce qui leur permet de frapper les NFT.
3. Les conservateurs utilisent l'API createArtCollectionToken pour frapper une collection d'art NFT.
4. Les conservateurs utilisent l'API post pour définir le prix d'un NFT et le publier pour vente sur le marché.
5. Les acheteurs utilisent l'API buy pour acheter le NFT en utilisant le paiement direct via une passerelle de paiement. Le NFT acheté est transféré sur le compte de l'acheteur et n'est plus en vente.
6. Les acheteurs peuvent éventuellement utiliser l'API post pour définir un nouveau prix pour un NFT et le publier pour revente sur le marché.

Déploiement du package d'API de wrapper de jeton combiné

Pour pouvoir déployer le package d'API de wrapper, vous devez mettre à jour les variables de configuration requises. Certaines variables de configuration ont des valeurs par défaut, mais vous devez mettre à jour manuellement toute variable contenant un espace réservé comme valeur par défaut. Les variables de configuration sont stockées dans le fichier terraform.tfvars dans l'archive d'API de wrapper. Pour plus d'informations sur le déploiement d'API de wrapper et sur les variables de configuration, reportez-vous à API de wrapper. Le tableau suivant répertorie les variables de configuration et leurs valeurs par défaut pour le package API de wrapper de structure de jetons combinée. Si la valeur par défaut contient des espaces réservés, cela indique que l'utilisateur doit fournir manuellement les valeurs nécessaires.

Nom de variable	Valeur par défaut	Description
compartment_ocid	<compartment_ocid>	OCID du compartiment dans Oracle Cloud Infrastructure (OCI).
compartment_name	<compartment_name>	Nom du compartiment OCI.
identity_domain	<identity_domain>	Domaine d'identité à utiliser.
blockchain_channel	<blockchain_channel>	Nom du canal Oracle Blockchain Platform sur lequel le code chaîne est déployé.
blockchain_url	<blockchain_url>	URL Oracle Blockchain Platform associée au déploiement de code chaîne.
blockchain_chaincode	WholesaleCBDC	Nom du code chaîne pour lequel générer les API de wrapper.
blockchain_sync	true	Valeur de synchronisation à inclure dans la charge utile pour les appels d'API.
blockchain_timeout	6000	Valeur de délai d'expiration à inclure dans la charge utile pour les appels d'API.
vcn_display_name	NFTCollectiblesWithERC1155	Nom d'affichage du réseau cloud virtuel OCI.
application_display_name	NFTCollectiblesWithERC1155	Nom d'affichage de l'application OCI.
gateway_display_name	NFTCollectiblesWithERC1155	Nom d'affichage d'API Gateway.
deployment_display_name	NFTCollectiblesWithERC1155	Nom d'affichage du déploiement dans API Gateway.
deployment_path_prefix	/NFTCollectiblesWithERC1155	Préfixe de chemin de déploiement dans API Gateway, qui indique le chemin où les routages sont déployés. La variable deployment_path_prefix doit commencer par une barre oblique (/).
ocir_repo_name	nftcollectibleswitherc1155	Nom du référentiel OCI Registry. La variable ocir_repo_name doit être en minuscules.
policy_name	NFTCollectiblesWithERC1155	Nom de la stratégie qui permet une gestion contrôlée et un accès aux API via des droits d'accès définis pour les groupes et les compartiments au sein de l'organisation

Exemple de flux de processus de la structure de jetons combinée

Un flux de processus standard utilisant les API de wrapper de structure de jetons combinés suit ces étapes de base.

1. Les administrateurs utilisent l'API createAccount pour créer des comptes de jetons fongibles et non fongibles pour toutes les parties prenantes, y compris les musées/commissaires, les acheteurs et les vendeurs.
2. Les administrateurs utilisent l'API addRole pour affecter le rôle minter au superviseur, ce qui leur permet de frapper les NFT.
3. Les conservateurs utilisent l'API mintBatch pour les NFT de collection d'art de menthe.
4. Les conservateurs utilisent l'API post pour définir le prix d'un NFT et le publier pour vente sur le marché.
5. Les acheteurs et les vendeurs utilisent l'API createTokenAccount pour créer des comptes de consommation pour les jetons fongibles et non fongibles sur la plate-forme.
6. Les acheteurs utilisent l'API buyWithEthCoin pour acheter le NFT avec Ethereum. Le NFT acheté est transféré sur le compte de l'acheteur et n'est plus en vente.
7. Les acheteurs peuvent éventuellement utiliser l'API post pour définir un nouveau prix pour un NFT et le publier pour revente sur le marché.
8. Les acheteurs peuvent éventuellement utiliser l'API burnBatch pour échanger le NFT ou le retirer définitivement de la circulation.