Deploy and Test Wrapper APIs for Generic Token Frameworks
Deploying the Fungible Token Framework Wrapper API Package
For information about using the Postman collections included with each package, see Wrapper API Package Components in Blockchain App Builder for Oracle Blockchain Platform.
Before you can deploy the wrapper API package, you must update the required configuration variables. Some configuration variables have default values, but you must manually update any variable that contains a placeholder as its default value. Configuration variables are stored in the terraform.tfvars file in the wrapper API archive. For more information about deploying wrapper APIs and about configuration variables, see Wrapper APIs in Blockchain App Builder for Oracle Blockchain Platform. The following table lists the configuration variables and their defaults values for the non-fungible token framework wrapper API package. If the default value contains placeholders, it indicates that the user must manually provide the necessary values.
| Variable name | Default value | Description |
|---|---|---|
compartment_ocid |
<compartment_ocid> |
The OCID of the compartment in Oracle Cloud Infrastructure (OCI). |
compartment_name |
<compartment_name> |
The name of the OCI compartment. |
identity_domain |
<identity_domain> |
The identity domain to use. |
blockchain_channel |
<blockchain_channel> |
The name of the Oracle Blockchain Platform channel where the chaincode is deployed. |
blockchain_url |
<blockchain_url> |
The Oracle Blockchain Platform URL associated with the chaincode deployment. |
blockchain_chaincode |
DepositToken |
The name of the chaincode to generate wrapper APIs for. |
blockchain_sync |
true |
The sync value to include in the payload for API calls. |
blockchain_timeout |
6000 |
The timeout value to include in the payload for API calls. |
vcn_display_name |
DepositToken |
The display name of the OCI virtual cloud network. |
application_display_name |
DepositToken |
The display name of the OCI application. |
gateway_display_name |
DepositToken |
The display name of API Gateway. |
deployment_display_name |
DepositToken |
The display name of the deployment in API Gateway. |
deployment_path_prefix |
/DepositToken |
The deployment path prefix in API Gateway, which specifies the path where routes are deployed. The deployment_path_prefix variable must begin with a slash (/).
|
ocir_repo_name |
deposittoken |
The OCI Registry repository name. The ocir_repo_name variable must be all lowercase letters.
|
policy_name |
DepositToken |
The name of the policy that enables controlled management and access to APIs through defined permissions for groups and compartments in the organization |
Deploying the Non-Fungible Token Wrapper API Package
Before you can deploy the wrapper API package, you must update the required configuration variables. Some configuration variables have default values, but you must manually update any variable that contains a placeholder as its default value. Configuration variables are stored in the terraform.tfvars file in the wrapper API archive. For more information about deploying wrapper APIs and about configuration variables, see Wrapper APIs in Blockchain App Builder for Oracle Blockchain Platform. The following table lists the configuration variables and their defaults values for the non-fungible token framework wrapper API package. If the default value contains placeholders, it indicates that the user must manually provide the necessary values.
| Variable name | Default value | Description |
|---|---|---|
compartment_ocid |
<compartment_ocid> |
The OCID of the compartment in Oracle Cloud Infrastructure (OCI). |
compartment_name |
<compartment_name> |
The name of the OCI compartment. |
identity_domain |
<identity_domain> |
The identity domain to use. |
blockchain_channel |
<blockchain_channel> |
The name of the Oracle Blockchain Platform channel where the chaincode is deployed. |
blockchain_url |
<blockchain_url> |
The Oracle Blockchain Platform URL associated with the chaincode deployment. |
blockchain_chaincode |
NFTCollectiblesWithERC721 |
The name of the chaincode to generate wrapper APIs for. |
blockchain_sync |
true |
The sync value to include in the payload for API calls. |
blockchain_timeout |
6000 |
The timeout value to include in the payload for API calls. |
vcn_display_name |
NFTCollectiblesWithERC721 |
The display name of the OCI virtual cloud network. |
application_display_name |
NFTCollectiblesWithERC721 |
The display name of the OCI application. |
gateway_display_name |
NFTCollectiblesWithERC721 |
The display name of API Gateway. |
deployment_display_name |
NFTCollectiblesWithERC721 |
The display name of the deployment in API Gateway. |
deployment_path_prefix |
/NFTCollectiblesWithERC721 |
The deployment path prefix in API Gateway, which specifies the path where routes are deployed. The deployment_path_prefix variable must begin with a slash (/).
|
ocir_repo_name |
nftcollectibleswitherc721 |
The OCI Registry repository name. The ocir_repo_name variable must be all lowercase letters.
|
policy_name |
NFTCollectiblesWithERC721 |
The name of the policy that enables controlled management and access to APIs through defined permissions for groups and compartments in the organization |
Deploying the Combined Token Wrapper API Package
Before you can deploy the wrapper API package, you must update the required configuration variables. Some configuration variables have default values, but you must manually update any variable that contains a placeholder as its default value. Configuration variables are stored in the terraform.tfvars file in the wrapper API archive. For more information about deploying wrapper APIs and about configuration variables, see Wrapper APIs in Blockchain App Builder for Oracle Blockchain Platform. The following table lists the configuration variables and their defaults values for the combined token framework wrapper API package. If the default value contains placeholders, it indicates that the user must manually provide the necessary values.
| Variable name | Default value | Description |
|---|---|---|
compartment_ocid |
<compartment_ocid> |
The OCID of the compartment in Oracle Cloud Infrastructure (OCI). |
compartment_name |
<compartment_name> |
The name of the OCI compartment. |
identity_domain |
<identity_domain> |
The identity domain to use. |
blockchain_channel |
<blockchain_channel> |
The name of the Oracle Blockchain Platform channel where the chaincode is deployed. |
blockchain_url |
<blockchain_url> |
The Oracle Blockchain Platform URL associated with the chaincode deployment. |
blockchain_chaincode |
WholesaleCBDC |
The name of the chaincode to generate wrapper APIs for. |
blockchain_sync |
true |
The sync value to include in the payload for API calls. |
blockchain_timeout |
6000 |
The timeout value to include in the payload for API calls. |
vcn_display_name |
NFTCollectiblesWithERC1155 |
The display name of the OCI virtual cloud network. |
application_display_name |
NFTCollectiblesWithERC1155 |
The display name of the OCI application. |
gateway_display_name |
NFTCollectiblesWithERC1155 |
The display name of API Gateway. |
deployment_display_name |
NFTCollectiblesWithERC1155 |
The display name of the deployment in API Gateway. |
deployment_path_prefix |
/NFTCollectiblesWithERC1155 |
The deployment path prefix in API Gateway, which specifies the path where routes are deployed. The deployment_path_prefix variable must begin with a slash (/).
|
ocir_repo_name |
nftcollectibleswitherc1155 |
The OCI Registry repository name. The ocir_repo_name variable must be all lowercase letters.
|
policy_name |
NFTCollectiblesWithERC1155 |
The name of the policy that enables controlled management and access to APIs through defined permissions for groups and compartments in the organization |