Despliegue y prueba de API de envoltorio para marcos de token genéricos

Despliegue del paquete de API de envoltorio de marco de token fungible

Para obtener información sobre el uso de las recopilaciones Postman incluidas en cada paquete, consulte Componentes de paquete de API de envoltorio.

Para poder desplegar el paquete de API de envoltorio, debe actualizar las variables de configuración necesarias. Algunas variables de configuración tienen valores por defecto, pero debe actualizar manualmente cualquier variable que contenga un marcador de posición como valor por defecto. Las variables de configuración se almacenan en el archivo terraform.tfvars en el archivo de la API del envoltorio. Para obtener más información sobre el despliegue de API de envoltorio y sobre las variables de configuración, consulte API de envoltorio. En la siguiente tabla, se muestran las variables de configuración y sus valores por defecto para el paquete de API de envoltorio de marco de token no fungible. Si el valor por defecto contiene marcadores de posición, indica que el usuario debe proporcionar manualmente los valores necesarios.

Nombre de la variable Valor por defecto Descripción
compartment_ocid <compartment_ocid> OCID del compartimento en Oracle Cloud Infrastructure (OCI).
compartment_name <compartment_name> Nombre del compartimento de OCI.
identity_domain <identity_domain> Dominio de identidad que se va a utilizar.
blockchain_channel <blockchain_channel> Nombre del canal de Oracle Blockchain Platform en el que se despliega el código de cadena.
blockchain_url <blockchain_url> URL de Oracle Blockchain Platform asociada al despliegue del código de cadena.
blockchain_chaincode DepositToken Nombre del código de cadenas para el que se van a generar las API de envoltorio.
blockchain_sync true Valor de sincronización que se incluirá en la carga útil para llamadas de API.
blockchain_timeout 6000 Valor de timeout que se va a incluir en la carga útil para llamadas de API.
vcn_display_name DepositToken Nombre mostrado de la red virtual en la nube de OCI.
application_display_name DepositToken Nombre mostrado de la aplicación de OCI.
gateway_display_name DepositToken Nombre mostrado de API Gateway.
deployment_display_name DepositToken Nombre mostrado del despliegue en API Gateway.
deployment_path_prefix /DepositToken Prefijo de ruta de acceso de despliegue en API Gateway, que especifica la ruta de acceso donde se despliegan las rutas. La variable deployment_path_prefix debe comenzar con una barra inclinada (/).
ocir_repo_name deposittoken Nombre del repositorio de OCI Registry. La variable ocir_repo_name debe estar todas en minúsculas.
policy_name DepositToken Nombre de la política que permite la gestión controlada y el acceso a las API mediante permisos definidos para grupos y compartimentos de la organización

Flujo de proceso de ejemplo de marco de token fungible

Un flujo de proceso típico que utiliza las API de envoltorio de marco de token fungible sigue estos pasos básicos.
  1. Los administradores utilizan la API initializeDepositToken para inicializar el sistema de token de depósito.
  2. Los administradores utilizan las API createAccount y associateTokenToAccount para crear cuentas y asociar el token a las cuentas de todos los usuarios.
  3. Los administradores utilizan la API addRole para asignar el rol mínimo al creador y el rol de notario al aprobador.
  4. El creador del token utiliza la API requestMint para enviar una solicitud para acuñar tokens de depósito.
  5. El aprobador utiliza la API approveMint para revisar y aprobar la solicitud de acuñar tokens de depósito. Los tokens de depósito se acreditan en la cuenta del creador.
  6. El emisor utiliza la API getAccountBalance para verificar que el importe acreditado sea exacto.
  7. El creador utiliza la API holdTokens para solicitar la transferencia de los tokens al emisor.
  8. El aprobador utiliza la API executeHoldTokens para validar y aprobar la solicitud de transferencia. Los tokens de depósito se transfieren a la cuenta del emisor.
  9. El emisor utiliza la API transferTokens para un usuario. Los tokens de depósito son créditos a la cuenta del primer usuario.
  10. El primer usuario utiliza la API getAccountBalance para verificar el saldo de su cuenta.
  11. El emisor utiliza la API transferTokens para un usuario. Los tokens de depósito se acreditan a la cuenta del segundo usuario.
  12. El segundo usuario utiliza la API getAccountBalance para verificar el saldo de su cuenta.
  13. El segundo usuario utiliza la API burnTokens para canjear sus tokens de depósito.

Despliegue del paquete de API de envoltorio de token no fungible

Para poder desplegar el paquete de API de envoltorio, debe actualizar las variables de configuración necesarias. Algunas variables de configuración tienen valores por defecto, pero debe actualizar manualmente cualquier variable que contenga un marcador de posición como valor por defecto. Las variables de configuración se almacenan en el archivo terraform.tfvars en el archivo de la API del envoltorio. Para obtener más información sobre el despliegue de API de envoltorio y sobre las variables de configuración, consulte API de envoltorio. En la siguiente tabla, se muestran las variables de configuración y sus valores por defecto para el paquete de API de envoltorio de marco de token no fungible. Si el valor por defecto contiene marcadores de posición, indica que el usuario debe proporcionar manualmente los valores necesarios.

Nombre de la variable Valor por defecto Descripción
compartment_ocid <compartment_ocid> OCID del compartimento en Oracle Cloud Infrastructure (OCI).
compartment_name <compartment_name> Nombre del compartimento de OCI.
identity_domain <identity_domain> Dominio de identidad que se va a utilizar.
blockchain_channel <blockchain_channel> Nombre del canal de Oracle Blockchain Platform en el que se despliega el código de cadena.
blockchain_url <blockchain_url> URL de Oracle Blockchain Platform asociada al despliegue del código de cadena.
blockchain_chaincode NFTCollectiblesWithERC721 Nombre del código de cadenas para el que se van a generar las API de envoltorio.
blockchain_sync true Valor de sincronización que se incluirá en la carga útil para llamadas de API.
blockchain_timeout 6000 Valor de timeout que se va a incluir en la carga útil para llamadas de API.
vcn_display_name NFTCollectiblesWithERC721 Nombre mostrado de la red virtual en la nube de OCI.
application_display_name NFTCollectiblesWithERC721 Nombre mostrado de la aplicación de OCI.
gateway_display_name NFTCollectiblesWithERC721 Nombre mostrado de API Gateway.
deployment_display_name NFTCollectiblesWithERC721 Nombre mostrado del despliegue en API Gateway.
deployment_path_prefix /NFTCollectiblesWithERC721 Prefijo de ruta de acceso de despliegue en API Gateway, que especifica la ruta de acceso donde se despliegan las rutas. La variable deployment_path_prefix debe comenzar con una barra inclinada (/).
ocir_repo_name nftcollectibleswitherc721 Nombre del repositorio de OCI Registry. La variable ocir_repo_name debe estar todas en minúsculas.
policy_name NFTCollectiblesWithERC721 Nombre de la política que permite la gestión controlada y el acceso a las API mediante permisos definidos para grupos y compartimentos de la organización

Flujo de proceso de ejemplo de marco de token no fungible

Un flujo de proceso típico que utiliza las API de envoltorio de marco de token no fungibles sigue estos pasos básicos.
  1. Los administradores utilizan la API createAccount para crear cuentas para todas las partes interesadas, incluidos museos/curadores, compradores y vendedores.
  2. Los administradores utilizan la API addRole para asignar el rol mínimo al gestor, lo que les permite acuñar NFT.
  3. Los curadores utilizan la API createArtCollectionToken para acuñar una colección de arte NFT.
  4. Los curadores utilizan la API post para establecer el precio de un NFT y publicarlo para su venta en el mercado.
  5. Los compradores utilizan la API buy para comprar la NFT mediante el pago directo a través de una pasarela de pago. La NFT comprada se transfiere a la cuenta del comprador y ya no está a la venta.
  6. Opcionalmente, los compradores pueden utilizar la API post para establecer un nuevo precio para un NFT y publicarlo para su reventa en el mercado.

Despliegue del paquete de API Combined Token Wrapper

Para poder desplegar el paquete de API de envoltorio, debe actualizar las variables de configuración necesarias. Algunas variables de configuración tienen valores por defecto, pero debe actualizar manualmente cualquier variable que contenga un marcador de posición como valor por defecto. Las variables de configuración se almacenan en el archivo terraform.tfvars en el archivo de la API del envoltorio. Para obtener más información sobre el despliegue de API de envoltorio y sobre las variables de configuración, consulte API de envoltorio. En la siguiente tabla, se muestran las variables de configuración y sus valores por defecto para el paquete de API de envoltorio de marco de token combinado. Si el valor por defecto contiene marcadores de posición, indica que el usuario debe proporcionar manualmente los valores necesarios.

Nombre de la variable Valor por defecto Descripción
compartment_ocid <compartment_ocid> OCID del compartimento en Oracle Cloud Infrastructure (OCI).
compartment_name <compartment_name> Nombre del compartimento de OCI.
identity_domain <identity_domain> Dominio de identidad que se va a utilizar.
blockchain_channel <blockchain_channel> Nombre del canal de Oracle Blockchain Platform en el que se despliega el código de cadena.
blockchain_url <blockchain_url> URL de Oracle Blockchain Platform asociada al despliegue del código de cadena.
blockchain_chaincode WholesaleCBDC Nombre del código de cadenas para el que se van a generar las API de envoltorio.
blockchain_sync true Valor de sincronización que se incluirá en la carga útil para llamadas de API.
blockchain_timeout 6000 Valor de timeout que se va a incluir en la carga útil para llamadas de API.
vcn_display_name NFTCollectiblesWithERC1155 Nombre mostrado de la red virtual en la nube de OCI.
application_display_name NFTCollectiblesWithERC1155 Nombre mostrado de la aplicación de OCI.
gateway_display_name NFTCollectiblesWithERC1155 Nombre mostrado de API Gateway.
deployment_display_name NFTCollectiblesWithERC1155 Nombre mostrado del despliegue en API Gateway.
deployment_path_prefix /NFTCollectiblesWithERC1155 Prefijo de ruta de acceso de despliegue en API Gateway, que especifica la ruta de acceso donde se despliegan las rutas. La variable deployment_path_prefix debe comenzar con una barra inclinada (/).
ocir_repo_name nftcollectibleswitherc1155 Nombre del repositorio de OCI Registry. La variable ocir_repo_name debe estar todas en minúsculas.
policy_name NFTCollectiblesWithERC1155 Nombre de la política que permite la gestión controlada y el acceso a las API mediante permisos definidos para grupos y compartimentos de la organización

Flujo de proceso de ejemplo de marco de token combinado

Un flujo de proceso típico que utiliza las API de envoltorio de marco de token combinado sigue estos pasos básicos.
  1. Los administradores utilizan la API createAccount para crear cuentas de token fungibles y no fungibles para todas las partes interesadas, incluidos museos/curadores, compradores y vendedores.
  2. Los administradores utilizan la API addRole para asignar el rol mínimo al gestor, lo que les permite acuñar NFT.
  3. Los curadores utilizan la API mintBatch para acuñar NFT de la colección de arte.
  4. Los curadores utilizan la API post para establecer el precio de un NFT y publicarlo para su venta en el mercado.
  5. Los compradores y vendedores utilizan la API createTokenAccount para crear cuentas de consumo de tokens fungibles y no fungibles en la plataforma.
  6. Los compradores utilizan la API buyWithEthCoin para comprar la NFT con Ethereum. La NFT comprada se transfiere a la cuenta del comprador y ya no está a la venta.
  7. Opcionalmente, los compradores pueden utilizar la API post para establecer un nuevo precio para un NFT y publicarlo para su reventa en el mercado.
  8. Opcionalmente, los compradores pueden utilizar la API burnBatch para canjear el NFT o eliminarlo permanentemente de la circulación.