Déployer et tester des API d'encapsuleur pour les cadres de jetons génériques

Déploiement du paquetage d'API d'encapsuleur de cadre de jeton fongible

Pour plus d'informations sur l'utilisation des collections Postman incluses avec chaque ensemble, voir Composants d'ensemble d'API d'encapsuleur.

Avant de déployer l'ensemble d'API 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 qui contient un paramètre fictif comme valeur par défaut. Les variables de configuration sont stockées dans le fichier terraform.tfvars dans l'archive d'API de l'encapsuleur. Pour plus d'informations sur le déploiement des API d'encapsuleur et sur les variables de configuration, voir API d'encapsuleur. Le tableau suivant répertorie les variables de configuration et leurs valeurs par défaut pour le paquetage d'API d'encapsulation de cadre de jeton non fongible. Si la valeur par défaut contient des paramètres fictifs, elle 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 dans lequel le code de chaîne est déployé.
blockchain_url	<blockchain_url>	URL Oracle Blockchain Platform associée au déploiement de code de chaîne.
blockchain_chaincode	DepositToken	Nom du code de chaîne pour lequel générer les API d'encapsulation.
blockchain_sync	true	Valeur de synchronisation à inclure dans les données utiles pour les appels d'API.
blockchain_timeout	6000	Valeur de temporisation à inclure dans les données utiles pour les appels d'API.
vcn_display_name	DepositToken	Nom d'affichage du réseau en nuage 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 la passerelle d'API.
deployment_path_prefix	/DepositToken	Préfixe du chemin de déploiement dans la passerelle d'API, qui spécifie le chemin où les routes sont déployées. La variable deployment_path_prefix doit commencer par une barre oblique (/).
ocir_repo_name	deposittoken	Nom du référentiel du registre OCI. La variable ocir_repo_name doit contenir toutes des lettres minuscules.
policy_name	DepositToken	Nom de la politique qui permet une gestion contrôlée et l'accès aux API au moyen d'autorisations définies pour les groupes et les compartiments de l'organisation.

Flux de traitement de l'exemple de cadre de jeton fongible

Un flux de processus type utilisant les API d'encapsulation du cadre de jeton fongible 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 aux comptes de 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 du jeton utilise l'API requestMint pour soumettre une demande d'extraction de jetons de dépôt.
5. L'approbateur utilise l'API approveMint pour vérifier et approuver la demande de suppression des 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 paquetage d'API d'encapsulation de jeton non fongible

Avant de déployer l'ensemble d'API 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 qui contient un paramètre fictif comme valeur par défaut. Les variables de configuration sont stockées dans le fichier terraform.tfvars dans l'archive d'API de l'encapsuleur. Pour plus d'informations sur le déploiement des API d'encapsuleur et sur les variables de configuration, voir API d'encapsuleur. Le tableau suivant répertorie les variables de configuration et leurs valeurs par défaut pour le paquetage d'API d'encapsulation de cadre de jeton non fongible. Si la valeur par défaut contient des paramètres fictifs, elle 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 dans lequel le code de chaîne est déployé.
blockchain_url	<blockchain_url>	URL Oracle Blockchain Platform associée au déploiement de code de chaîne.
blockchain_chaincode	NFTCollectiblesWithERC721	Nom du code de chaîne pour lequel générer les API d'encapsulation.
blockchain_sync	true	Valeur de synchronisation à inclure dans les données utiles pour les appels d'API.
blockchain_timeout	6000	Valeur de temporisation à inclure dans les données utiles pour les appels d'API.
vcn_display_name	NFTCollectiblesWithERC721	Nom d'affichage du réseau en nuage 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 la passerelle d'API.
deployment_path_prefix	/NFTCollectiblesWithERC721	Préfixe du chemin de déploiement dans la passerelle d'API, qui spécifie le chemin où les routes sont déployées. La variable deployment_path_prefix doit commencer par une barre oblique (/).
ocir_repo_name	nftcollectibleswitherc721	Nom du référentiel du registre OCI. La variable ocir_repo_name doit contenir toutes des lettres minuscules.
policy_name	NFTCollectiblesWithERC721	Nom de la politique qui permet une gestion contrôlée et l'accès aux API au moyen d'autorisations définies pour les groupes et les compartiments de l'organisation.

Flux de traitement de l'exemple de cadre de jeton non fongible

Un flux de processus type utilisant les API d'encapsulation de cadre de jeton 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 / curateurs, les acheteurs et les vendeurs.
2. Les administrateurs utilisent l'API addRole pour affecter le rôle de mineur au curateur, ce qui leur permet de gérer les transactions NFT.
3. Les conservateurs utilisent l'API createArtCollectionToken pour extraire une collection d'art NFT.
4. Les conservateurs utilisent l'API post pour définir le prix d'une NFT et la publier sur le marché.
5. Les acheteurs utilisent l'API buy pour acheter la NFT en utilisant le paiement direct via une passerelle de paiement. La NFT achetée est transférée sur le compte de l'acheteur et n'est plus à vendre.
6. Facultativement, les acheteurs peuvent utiliser l'API post pour définir un nouveau prix pour un NFT et le publier pour la revente sur le marché.

Déploiement du paquetage d'API d'encapsulation de jeton combiné

Avant de déployer l'ensemble d'API 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 qui contient un paramètre fictif comme valeur par défaut. Les variables de configuration sont stockées dans le fichier terraform.tfvars dans l'archive d'API de l'encapsuleur. Pour plus d'informations sur le déploiement des API d'encapsuleur et sur les variables de configuration, voir API d'encapsuleur. Le tableau suivant répertorie les variables de configuration et leurs valeurs par défaut pour le paquetage d'API d'encapsulation de cadre de jeton combiné. Si la valeur par défaut contient des paramètres fictifs, elle 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 dans lequel le code de chaîne est déployé.
blockchain_url	<blockchain_url>	URL Oracle Blockchain Platform associée au déploiement de code de chaîne.
blockchain_chaincode	WholesaleCBDC	Nom du code de chaîne pour lequel générer les API d'encapsulation.
blockchain_sync	true	Valeur de synchronisation à inclure dans les données utiles pour les appels d'API.
blockchain_timeout	6000	Valeur de temporisation à inclure dans les données utiles pour les appels d'API.
vcn_display_name	NFTCollectiblesWithERC1155	Nom d'affichage du réseau en nuage virtuel OCI.
application_display_name	NFTCollectiblesWithERC1155	Nom d'affichage de l'application OCI.
gateway_display_name	NFTCollectiblesWithERC1155	Nom d'affichage de la passerelle d'API.
deployment_display_name	NFTCollectiblesWithERC1155	Nom d'affichage du déploiement dans la passerelle d'API.
deployment_path_prefix	/NFTCollectiblesWithERC1155	Préfixe du chemin de déploiement dans la passerelle d'API, qui spécifie le chemin où les routes sont déployées. La variable deployment_path_prefix doit commencer par une barre oblique (/).
ocir_repo_name	nftcollectibleswitherc1155	Nom du référentiel du registre OCI. La variable ocir_repo_name doit contenir toutes des lettres minuscules.
policy_name	NFTCollectiblesWithERC1155	Nom de la politique qui permet une gestion contrôlée et l'accès aux API au moyen d'autorisations définies pour les groupes et les compartiments de l'organisation.

Cadre de jeton combiné - Exemple de flux de traitement

Un flux de processus type utilisant les API d'encapsulation de cadre de jeton combiné 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 / curateurs, les acheteurs et les vendeurs.
2. Les administrateurs utilisent l'API addRole pour affecter le rôle de mineur au curateur, ce qui leur permet de gérer les transactions NFT.
3. Les curateurs utilisent l'API mintBatch pour extraire les fichiers NFT de collection d'art.
4. Les conservateurs utilisent l'API post pour définir le prix d'une NFT et la publier sur le marché.
5. Les acheteurs et les vendeurs utilisent l'API createTokenAccount pour créer des comptes de consommateurs pour les jetons fongibles et non fongibles sur la plate-forme.
6. Les acheteurs utilisent l'API buyWithEthCoin pour acheter la NFT avec Ethereum. La NFT achetée est transférée sur le compte de l'acheteur et n'est plus à vendre.
7. Facultativement, les acheteurs peuvent utiliser l'API post pour définir un nouveau prix pour un NFT et le publier pour la revente sur le marché.
8. Facultativement, les acheteurs peuvent utiliser l'API burnBatch pour échanger le NFT ou le retirer définitivement de la circulation.