部署和测试通用令牌框架的包装器 API
部署 Fungible Token Framework Wrapper API 程序包
有关使用每个软件包随附的 Postman 集合的信息,请参见 Wrapper API Package Components 。
必须先更新所需的配置变量,然后才能部署包装器 API 程序包。某些配置变量具有默认值,但您必须手动更新包含占位符作为其默认值的任何变量。配置变量存储在包装器 API 归档文件的 terraform.tfvars
文件中。有关部署包装器 API 以及有关配置变量的更多信息,请参见包装器 API 。下表列出了不可替换标记框架包装器 API 程序包的配置变量及其默认值。如果默认值包含占位符,则表示用户必须手动提供必要的值。
变量名称 | 默认值 | 说明 |
---|---|---|
compartment_ocid |
<compartment_ocid> |
Oracle Cloud Infrastructure (OCI) 中区间的 OCID。 |
compartment_name |
<compartment_name> |
OCI 区间的名称。 |
identity_domain |
<identity_domain> |
要使用的身份域。 |
blockchain_channel |
<blockchain_channel> |
部署链代码的 Oracle Blockchain Platform 渠道的名称。 |
blockchain_url |
<blockchain_url> |
与链代码部署关联的 Oracle Blockchain Platform URL。 |
blockchain_chaincode |
DepositToken |
要为其生成包装器 API 的链代码的名称。 |
blockchain_sync |
true |
要包括在 API 调用的有效负载中的同步值。 |
blockchain_timeout |
6000 |
要包括在 API 调用的有效负载中的超时值。 |
vcn_display_name |
DepositToken |
OCI 虚拟云网络的显示名称。 |
application_display_name |
DepositToken |
OCI 应用程序的显示名称。 |
gateway_display_name |
DepositToken |
API 网关的显示名称。 |
deployment_display_name |
DepositToken |
API 网关中部署的显示名称。 |
deployment_path_prefix |
/DepositToken |
API 网关中的部署路径前缀,用于指定路由的部署路径。deployment_path_prefix 变量必须以斜杠 (/) 开头。
|
ocir_repo_name |
deposittoken |
OCI 注册表资料档案库名称。ocir_repo_name 变量必须全部为小写字母。
|
policy_name |
DepositToken |
通过为组织内的组和区间定义的权限,可以进行受控管理和访问 API 的策略的名称 |
Fungible Token Framework 示例流程流
使用可替换令牌框架包装器 API 的典型流程流遵循以下基本步骤。- 管理员使用
initializeDepositToken
API 初始化存款令牌系统。 - 管理员使用
createAccount
和associateTokenToAccount
API 为所有用户创建帐户并将令牌与帐户关联。 - 管理员使用
addRole
API 将 minter 角色分配给创建者,将公证人角色分配给审批者。 - 令牌创建者使用
requestMint
API 提交对铸币存款令牌的请求。 - 审批人使用
approveMint
API 审核和批准铸造存款令牌的请求。存款令牌将贷记到创建者的帐户。 - 发行人使用
getAccountBalance
API 验证贷记金额是否准确。 - 创建者使用
holdTokens
API 请求将令牌传输给发布者。 - 审批者使用
executeHoldTokens
API 验证和批准传输请求。存款令牌将转移到发行人的账户。 - 发布者对用户使用
transferTokens
API。存款令牌是贷记到第一个用户的帐户。 - 第一个用户使用
getAccountBalance
API 验证其账户余额。 - 发布者对用户使用
transferTokens
API。存款令牌是贷记到第二个用户的帐户。 - 第二个用户使用
getAccountBalance
API 验证其账户余额。 - 第二个用户使用
burnTokens
API 兑换其存款令牌。
部署不可替代的令牌包装器 API 程序包
必须先更新所需的配置变量,然后才能部署包装器 API 程序包。某些配置变量具有默认值,但您必须手动更新包含占位符作为其默认值的任何变量。配置变量存储在包装器 API 归档文件的 terraform.tfvars
文件中。有关部署包装器 API 以及有关配置变量的更多信息,请参见包装器 API 。下表列出了不可替换标记框架包装器 API 程序包的配置变量及其默认值。如果默认值包含占位符,则表示用户必须手动提供必要的值。
变量名称 | 默认值 | 说明 |
---|---|---|
compartment_ocid |
<compartment_ocid> |
Oracle Cloud Infrastructure (OCI) 中区间的 OCID。 |
compartment_name |
<compartment_name> |
OCI 区间的名称。 |
identity_domain |
<identity_domain> |
要使用的身份域。 |
blockchain_channel |
<blockchain_channel> |
部署链代码的 Oracle Blockchain Platform 渠道的名称。 |
blockchain_url |
<blockchain_url> |
与链代码部署关联的 Oracle Blockchain Platform URL。 |
blockchain_chaincode |
NFTCollectiblesWithERC721 |
要为其生成包装器 API 的链代码的名称。 |
blockchain_sync |
true |
要包括在 API 调用的有效负载中的同步值。 |
blockchain_timeout |
6000 |
要包括在 API 调用的有效负载中的超时值。 |
vcn_display_name |
NFTCollectiblesWithERC721 |
OCI 虚拟云网络的显示名称。 |
application_display_name |
NFTCollectiblesWithERC721 |
OCI 应用程序的显示名称。 |
gateway_display_name |
NFTCollectiblesWithERC721 |
API 网关的显示名称。 |
deployment_display_name |
NFTCollectiblesWithERC721 |
API 网关中部署的显示名称。 |
deployment_path_prefix |
/NFTCollectiblesWithERC721 |
API 网关中的部署路径前缀,用于指定路由的部署路径。deployment_path_prefix 变量必须以斜杠 (/) 开头。
|
ocir_repo_name |
nftcollectibleswitherc721 |
OCI 注册表资料档案库名称。ocir_repo_name 变量必须全部为小写字母。
|
policy_name |
NFTCollectiblesWithERC721 |
通过为组织内的组和区间定义的权限,可以进行受控管理和访问 API 的策略的名称 |
不可替代的令牌框架示例流程流
使用不可替代的令牌框架包装器 API 的典型进程流遵循以下基本步骤。- 管理员使用
createAccount
API 为所有利益相关者(包括博物馆/策展人、买家和卖家)创建账户。 - 管理员使用
addRole
API 将 minter 角色分配给管理者,使其能够 mint NFT。 - 策展人使用
createArtCollectionToken
API 铸造艺术收藏 NFT。 - 策展人使用
post
API 设置 NFT 的价格,并将其发布到市场中销售。 - 购买者使用
buy
API 通过支付网关直接付款来购买 NFT。购买的 NFT 将转移到买方的账户,不再销售。 - (可选)购买者可以使用
post
API 为 NFT 设置新价格,并将其发布到市场中转售。
部署组合标记包装器 API 程序包
必须先更新所需的配置变量,然后才能部署包装器 API 程序包。某些配置变量具有默认值,但您必须手动更新包含占位符作为其默认值的任何变量。配置变量存储在包装器 API 归档文件的 terraform.tfvars
文件中。有关部署包装器 API 以及有关配置变量的更多信息,请参见包装器 API 。下表列出了组合标记框架包装器 API 程序包的配置变量及其默认值。如果默认值包含占位符,则表示用户必须手动提供必要的值。
变量名称 | 默认值 | 说明 |
---|---|---|
compartment_ocid |
<compartment_ocid> |
Oracle Cloud Infrastructure (OCI) 中区间的 OCID。 |
compartment_name |
<compartment_name> |
OCI 区间的名称。 |
identity_domain |
<identity_domain> |
要使用的身份域。 |
blockchain_channel |
<blockchain_channel> |
部署链代码的 Oracle Blockchain Platform 渠道的名称。 |
blockchain_url |
<blockchain_url> |
与链代码部署关联的 Oracle Blockchain Platform URL。 |
blockchain_chaincode |
WholesaleCBDC |
要为其生成包装器 API 的链代码的名称。 |
blockchain_sync |
true |
要包含在 API 调用有效负载中的同步值。 |
blockchain_timeout |
6000 |
要包括在 API 调用的有效负载中的超时值。 |
vcn_display_name |
NFTCollectiblesWithERC1155 |
OCI 虚拟云网络的显示名称。 |
application_display_name |
NFTCollectiblesWithERC1155 |
OCI 应用程序的显示名称。 |
gateway_display_name |
NFTCollectiblesWithERC1155 |
API 网关的显示名称。 |
deployment_display_name |
NFTCollectiblesWithERC1155 |
API 网关中部署的显示名称。 |
deployment_path_prefix |
/NFTCollectiblesWithERC1155 |
API 网关中的部署路径前缀,用于指定路由的部署路径。deployment_path_prefix 变量必须以斜杠 (/) 开头。
|
ocir_repo_name |
nftcollectibleswitherc1155 |
OCI 注册表资料档案库名称。ocir_repo_name 变量必须全部为小写字母。
|
policy_name |
NFTCollectiblesWithERC1155 |
通过为组织内的组和区间定义的权限,可以进行受控管理和访问 API 的策略的名称 |
组合标记框架示例流程流
使用组合标记框架包装器 API 的典型进程流遵循以下基本步骤。- 管理员使用
createAccount
API 为所有利益相关者(包括博物馆/策展人、买家和卖家)创建可替代和非可替代的令牌账户。 - 管理员使用
addRole
API 将 minter 角色分配给管理者,使其能够 mint NFT。 - 策展人使用
mintBatch
API 制作艺术收藏 NFT。 - 策展人使用
post
API 设置 NFT 的价格,并将其发布到市场中销售。 - 买方和卖方使用
createTokenAccount
API 在平台上为可替换和不可替换的令牌创建消费者账户。 - 买家使用
buyWithEthCoin
API 购买以太坊的 NFT。购买的 NFT 将转移到买方的账户,不再销售。 - (可选)购买者可以使用
post
API 为 NFT 设置新价格,并将其发布到市场中转售。 - (可选)购买者可以使用
burnBatch
API 兑换 NFT 或将其从流通中永久删除。