ERC-1155 的脚手架 TypeScript 标记项目
Blockchain App Builder 从您的令牌规范文件中获取输入,并生成一个功能完备的链码项目。
该项目自动生成令牌生命周期类和函数,包括 CRUD 和非 CRUD 方法。自动支持参数验证、编集/解编集以及透明的持久性功能。
有关与令牌不直接相关的基架项目和方法的信息,请参见 Scaffolded TypeScript Chaincode Project 。
型号
每个标记化的模型类都扩展了 OchainModel
类。透明持久性功能(或简化的 ORM)在 OchainModel
类中捕获。以下模型显示了一个完全不可变的标记。
import * as yup from "yup";
import { Id, Mandatory, Validate, Default, Embedded, Derived, ReadOnly } from "../../lib/decorators";
import { OchainModel } from "../../lib/ochain-model";
import { STRATEGY } from "../../lib/utils";
import { EmbeddedModel } from "../../lib/ochain-embedded-model";
export class ArtCollectionMetadata extends EmbeddedModel<ArtCollectionMetadata> {
@Validate(yup.string())
public painting_name: string;
@Validate(yup.string())
public description: string;
@Validate(yup.string())
public image: string;
@Validate(yup.string())
public painter_name: string;
}
@Id("tokenId")
export class ArtCollection extends OchainModel<ArtCollection> {
public readonly assetType = "otoken";
@Mandatory()
@Validate(
yup
.string()
.required()
.matches(/^[A-Za-z0-9][A-Za-z0-9_-]*$/)
.max(16)
)
public tokenId: string;
@ReadOnly("artcollection")
public tokenName: string;
@Validate(yup.string().trim().max(256))
public tokenDesc: string;
@ReadOnly("erc1155+")
public tokenStandard: string;
@ReadOnly("nonfungible")
public tokenType: string;
@ReadOnly("whole")
public tokenUnit: string;
@ReadOnly(["indivisible","singleton","mintable","transferable","burnable","roles"])
public behaviors: string[];
@ReadOnly({ minter_role_name: "minter" })
public roles: object;
@ReadOnly({ max_mint_quantity: 20000 })
public mintable: object;
@Validate(yup.string())
public owner: string;
@Validate(yup.string())
public createdBy: string;
@Validate(yup.string())
public transferredBy: string;
@Validate(yup.string())
public creationDate: string;
@Validate(yup.string())
public transferredDate: string;
@Validate(yup.bool())
public isBurned: boolean;
@Validate(yup.string())
public burnedBy: string;
@Validate(yup.string())
public burnedDate: string;
@Mandatory()
@Validate(yup.string().required().max(2000))
public tokenUri: string;
@Embedded(ArtCollectionMetadata)
public tokenMetadata: ArtCollectionMetadata;
@Validate(yup.number())
public price: number;
@Validate(yup.boolean())
public on_sale_flag: boolean;
}
@Id("tokenId")
export class Loyalty extends OchainModel<Loyalty> {
public readonly assetType = "otoken";
@Mandatory()
@Validate(
yup
.string()
.required()
.matches(/^[A-Za-z0-9][A-Za-z0-9_-]*$/)
.max(16)
)
public tokenId: string;
@ReadOnly("loyalty")
public tokenName: string;
@Validate(yup.string().trim().max(256))
public tokenDesc: string;
@ReadOnly("erc1155+")
public tokenStandard: string;
@ReadOnly("fungible")
public tokenType: string;
@ReadOnly("fractional")
public tokenUnit: string;
@ReadOnly(["divisible","mintable","transferable","burnable","roles"])
public behaviors: string[];
@ReadOnly({ minter_role_name: "minter" })
public roles: object;
@ReadOnly({ max_mint_quantity: 10000 })
public mintable: object;
@ReadOnly({ decimal: 2 })
public divisible: object;
@Validate(yup.string())
public currency_name: string;
@Validate(yup.number())
public token_to_currency_ratio: number;
}
以下模型显示了小数不可变标记。export class RealEstatePropertyMetadata extends EmbeddedModel<RealEstatePropertyMetadata> {
@Validate(yup.string())
public propertyType: string;
@Validate(yup.string())
public propertyName: string;
@Validate(yup.string())
public propertyAddress: string;
@Validate(yup.string())
public propertyImage: string;
}
@Id("tokenId")
export class RealEstateProperty extends OchainModel<RealEstateProperty> {
public readonly assetType = "otoken";
@Mandatory()
@Validate(
yup
.string()
.required()
.matches(/^[A-Za-z0-9][A-Za-z0-9_-]*$/)
.max(16)
)
public tokenId: string;
@ReadOnly("realestateproperty")
public tokenName: string;
@Validate(yup.string().trim().max(256))
public tokenDesc: string;
@ReadOnly("erc1155+")
public tokenStandard: string;
@ReadOnly("nonfungible")
public tokenType: string;
@ReadOnly("fractional")
public tokenUnit: string;
@ReadOnly(["divisible","mintable","transferable","roles"])
public behaviors: string[];
@ReadOnly({ minter_role_name: "minter" })
public roles: object;
@ReadOnly({ max_mint_quantity: 0 })
public mintable: object;
@Validate(yup.number().positive())
public quantity: number;
@Validate(yup.string())
public createdBy: string;
@Validate(yup.string())
public creationDate: string;
@ReadOnly({ decimal: 0 })
public divisible: object;
@Validate(yup.bool())
public isBurned: boolean;
@Mandatory()
@Validate(yup.string().required().max(2000))
public tokenUri: string;
@Embedded(RealEstatePropertyMetadata)
public tokenMetadata: RealEstatePropertyMetadata;
@Validate(yup.number())
public propertySellingPrice: number;
@Validate(yup.number())
public propertyRentingPrice: number;
}
控制器
主控制器类扩展了 OchainController
类。只有一个主控制器。
export class DigiCurrCCController extends OchainController{
您可以创建任意数量的类、函数或文件,但只能调用在主控制器类中定义的那些方法。其他方法被隐藏。
您可以使用令牌 SDK 方法为业务应用程序编写定制方法。
自动生成的令牌方法
Blockchain App Builder 自动生成支持令牌和令牌生命周期的方法。您可以使用这些方法来初始化令牌、管理角色和账户,以及完成其他令牌生命周期任务,而无需额外编码。控制器方法必须具有可调用的 @Validator(...params)
装饰器。
访问控制管理的方法
-
isTokenAdmin
- 如果函数的调用方为
Token Admin
,则此方法返回布尔值true
,否则返回false
。此方法只能由链代码的Token Admin
调用。 -
addTokenAdmin
- 此方法将用户添加为链代码的
Token Admin
。此方法只能由链代码的Token Admin
调用。 -
removeTokenAdmin
- 此方法将用户删除为链代码的
Token Admin
。此方法只能由链代码的Token Admin
调用。您无法将自己删除为Token Admin
。 -
getAllTokenAdmins
- 此方法返回链代码为
Token Admin
的所有用户的列表。此方法只能由链代码的Token Admin
调用。
标记配置管理的方法
-
init
- 实例化链代码时会调用此方法。每个
Token Admin
都由adminList
参数中的userId
和orgId
信息标识。userId
是实例所有者或登录到实例的用户的用户名或电子邮件 ID。orgId
是当前网络组织中用户的成员服务提供商 (Membership Service Provider,MSP) ID。首次部署链代码时,adminList
参数是必需的。如果要升级链代码,请传递空列表 ([]
)。如果您是最初部署链代码的用户,则还可以在升级链代码时在adminList
参数中指定新管理员。升级期间将忽略adminList
参数中的任何其他信息。 -
create<Token Name>Token
- 此方法创建令牌。所定义的每个标记都有其自己的创建方法。对于可变令牌,此方法只能由链代码的
Token Admin
调用。对于非可换代币,如果在规范文件中定义了 minter 角色,则具有 minter 角色的任何用户都可以调用此方法来创建 NFT。如果未定义 minter 角色,任何用户都可以使用此方法创建 (mint) NFT。调用此方法的用户将成为 NFT 的所有者。 -
update<Token Name>Token
- 此方法更新标记。定义的每个标记都有自己的更新方法。无法更新标记元数据或不可换代标记的标记 URI。对于可变令牌,此方法只能由链代码的
Token Admin
调用。对于不可替代的令牌,此方法只能由令牌所有者调用。 -
getTokenHistory
- 此方法返回指定令牌 ID 的历史记录。任何人都可以调用此方法。
-
getAllTokens
- 此方法返回保存在状态数据库中的所有令牌资产。此方法只能由链代码的
Token Admin
调用。此方法使用 Berkeley DB SQL 丰富的查询,并且只能在连接到远程 Oracle Blockchain Platform 网络时调用。 -
getTokenById
- 如果令牌存在于状态数据库中,则此方法将返回令牌对象。对于小数 NFT,也会返回所有者列表。此方法只能由链代码的
Token Admin
或令牌所有者调用。 -
getAllTokensByUser
- 此方法返回指定用户拥有的所有令牌资产。此方法使用 Berkeley DB SQL 丰富的查询,并且只能在连接到远程 Oracle Blockchain Platform 网络时调用。此方法只能由链代码的
Token Admin
或帐户所有者调用。 -
ownerOf
- 此方法返回指定令牌 ID 的所有者的账户 ID、组织 ID 和用户 ID。任何人都可以调用此方法。
-
URI
- 此方法返回指定标记的 URI。任何人都可以调用此方法。
-
name
- 此方法返回令牌类的名称。任何人都可以调用此方法。
-
totalSupply
- 此方法返回铸币的总数。可替换标记由标记 ID 指定。非实物标记由标记名称指定。此方法只能由链代码的
Token Admin
调用。 -
totalNetSupply
- 此方法返回铸造的令牌总数减去烧毁的令牌数。可替换标记由标记 ID 指定。非实物标记由标记名称指定。此方法只能由链代码的
Token Admin
调用。 -
getTokensByName
- 此方法返回指定标记名称的所有标记资产。此方法使用 Berkeley DB SQL 丰富的查询,并且只能在连接到远程 Oracle Blockchain Platform 网络时调用。此方法只能由链代码的
Token Admin
调用。 -
getTokenDecimal
- 此方法返回指定标记的小数位数。此方法只能由链代码的
Token Admin
调用。
账户管理方法
-
createAccount
- 此方法为指定用户创建帐户,并为可变或非可变标记创建关联的令牌帐户。必须为在任何时候将具有令牌的任何用户创建账户。用户帐户跟踪 NFT 帐户和用户持有的可变令牌帐户。用户必须在网络中具有帐户才能完成与令牌相关的操作。此方法只能由链代码的
Token Admin
调用。用户帐户具有唯一的 ID,该 ID 由
orgId
参数和userId
参数的 SHA-256 散列构成。用户可以具有多个具有唯一账户 ID 的可替换令牌账户。可替换令牌帐户 ID 由
orgId
参数的 SHA-256 散列、userId
参数、由波浪号 (~
) 分隔的常量字符串ft
和表示由波浪号 (~
) 分隔创建的可替换帐户索引的计数器编号构成。用户只能有一个不可替代的令牌账户。非易变令牌帐户 ID 是唯一的,由
orgId
参数的 SHA-256 散列、userId
参数和以波浪号 (~
) 分隔的常量字符串nft
构成。用户拥有的所有非可换代币(无论是整数还是小数)都将链接到此账户。用户帐户 ID 以
ouaccount~
开头。标记帐户 ID 以oaccount~
开头。 -
createUserAccount
- 此方法为指定的用户创建帐户。必须为在任何时候将具有令牌的任何用户创建账户。用户帐户跟踪 NFT 帐户和用户拥有的可替换令牌帐户。用户必须在网络中具有帐户才能完成与令牌相关的操作。
帐户 ID 是
orgId
参数和userId
参数的 SHA-256 散列。此方法只能由链代码的Token Admin
调用。 -
createTokenAccount
- 此方法创建可替换或不可替换的令牌帐户以与用户帐户关联。
用户可以具有多个具有唯一账户 ID 的可替换令牌账户。可替换令牌帐户 ID 由
orgId
参数的 SHA-256 散列、userId
参数、由波浪号 (~
) 分隔的常量字符串ft
和表示由波浪号 (~
) 分隔创建的可替换帐户索引的计数器编号构成。用户只能有一个不可替代的令牌账户。非易变令牌帐户 ID 是唯一的,由
orgId
参数的 SHA-256 散列、userId
参数和以波浪号 (~
) 分隔的常量字符串nft
构成。用户拥有的所有非可换代币(无论是整数还是小数)都将链接到此账户。此方法只能由链代码的
Token Admin
调用。 -
associateFungibleTokenAccount
- 此方法将用户的可交换令牌帐户与特定可交换令牌相关联。
此方法只能由链代码的
Token Admin
调用。 -
getAccountHistory
- 此方法返回指定令牌帐户的历史记录。这是一种异步方法。此方法只能由链代码的
Token Admin
或帐户所有者调用。 -
getAccount
- 此方法返回指定用户的令牌帐户详细信息。此方法只能由链代码的
Token Admin
或帐户的Account Owner
调用。 -
getAllAccounts
- 此方法返回所有用户帐户的详细信息。此方法只能由链代码的
Token Admin
调用。 -
getAccountDetailsByUser
- 此方法返回指定用户的帐户摘要以及与用户关联的可替换和不可替换标记的详细信息。此方法只能由链代码的
Token Admin
或帐户的Account Owner
调用。 -
getUserByAccountId
- 此方法返回指定帐户 ID 的用户详细信息。此方法可由任何用户调用。
角色管理的方法
-
addRole
- 此方法将角色添加到指定的用户和令牌。此方法只能由链代码的
Token Admin
调用。可替换标记由标记 ID 指定。非实物标记由标记名称指定。指定的用户必须具有与可交换令牌关联的令牌帐户,或者具有 NFT 角色的非可交换令牌帐户。指定的角色必须存在于标记的规范文件中。 -
isInRole
- 此方法返回布尔值以指示用户是否具有指定的角色。可替换标记由标记 ID 指定。非实物标记由标记名称指定。此方法只能由链代码的
Token Admin
或帐户的Account Owner
调用。指定的用户必须具有与可交换令牌关联的令牌帐户,或者具有 NFT 角色的非可交换令牌帐户。指定的角色必须存在于标记的规范文件中。 -
removeRole
- 此方法从指定用户和令牌中删除角色。可替换标记由标记 ID 指定。非实物标记由标记名称指定。此方法只能由链代码的
Token Admin
调用。指定的用户必须具有与可交换令牌关联的令牌帐户,或者具有 NFT 角色的非可交换令牌帐户。指定的角色必须存在于标记的规范文件中。 -
getAccountsByRole
- 此方法返回指定角色和令牌的所有账户 ID 的列表。可替换标记由标记 ID 指定。非实物标记由标记名称指定。此方法只能由链代码的
Token Admin
调用。 -
getUsersByRole
- 此方法返回指定角色和令牌的所有用户的列表。可替换标记由标记 ID 指定。非实物标记由标记名称指定。此方法只能由链代码的
Token Admin
调用。
事务处理历史记录管理的方法
-
getAccountTransactionHistory
- 此方法返回账户事务处理历史记录。此方法只能由链代码的
Token Admin
或帐户所有者调用。对于不可替代的令牌,只有在连接到远程 Oracle Blockchain Platform 网络时才能调用此方法。 -
getTransactionById
- 此方法返回指定事务处理 ID 的事务处理详细信息。任何人都可以调用此方法。
-
deleteHistoricalTransactions
- 此方法从状态数据库中删除指定时间戳之前的事务处理。此方法只能由链代码的
Token Admin
调用。
令牌行为管理方法 - 可铸造行为
-
mintBatch
- 此方法在批处理操作中创建 (mint) 多个标记。此方法仅创建可替换令牌或小数非可替换令牌。
对于可变令牌,如果 minter 角色在规范文件中定义,则具有 minter 角色的任何用户都可以调用此方法。如果没有,任何用户都可以使用此方法来创建标记。如果该属性是在创建或更新令牌时指定的,则不能超过令牌的
max_mint_quantity
属性。对于非可换代币,如果在规范文件中定义了 minter 角色,则具有 minter 角色的任何用户都可以调用此方法。如果没有,任何用户都可以使用此方法来创建标记。此外,调用者还必须是令牌的创建者。可以铸造的小数非实物代币的数量没有上限。
不能使用此方法来模拟整个不可替换标记。
令牌行为管理的方法 - 可转移行为
-
batchTransferFrom
- 此方法完成将令牌 ID 列表中指定的令牌从一个用户传输到另一个用户的批处理操作。
对于 NFT,由于该方法转移了 NFT 的所有权,因此 NFT 的发送者必须拥有该令牌。
对于小数 NFT,如果用户(包括令牌的创建者)传输他们拥有的所有共享资源,则他们将失去令牌的所有权。如果令牌的任何共享资源传输给用户,则该用户将自动成为小数 NFT 的所有者之一。
此方法不会验证该方法的调用方是否为指定的发送方。此方法可由任何用户调用。
-
safeBatchTransferFrom
- 此方法完成将令牌 ID 列表中指定的令牌从一个用户传输到另一个用户的批处理操作。
对于 NFT,由于该方法转移了 NFT 的所有权,因此 NFT 的发送者必须拥有该令牌。
对于小数 NFT,如果用户(包括令牌的创建者)传输他们拥有的所有共享资源,则他们将失去令牌的所有权。如果令牌的任何共享资源传输给用户,则该用户将自动成为小数 NFT 的所有者之一。
方法的调用方必须是指定的发送方。此方法可由任何用户调用。
-
balanceOfBatch
- 此方法完成获取令牌帐户余额的批处理操作。账户详细信息在三个单独的组织 ID、用户 ID 和令牌 ID 列表中指定。此方法只能由链代码的
Token Admin
或帐户所有者调用。账户所有者只能查看他们拥有的账户的余额详细信息。 -
exchangeToken
- 此方法在指定帐户之间交换令牌。此方法仅支持在 NFT 和可交换令牌或可交换令牌与 NFT 之间进行交换。NFT 可以是整数或小数。此方法只能由账户所有者调用。
令牌行为管理的方法 - 可燃行为
SDK 方法
访问控制管理的方法
-
isUserTokenAdmin
- 如果指定用户为
Token Admin
,则此方法返回布尔值true
,否则返回false
。该方法只能由令牌链代码的Token Admin
调用。 -
addAdmin
- 此方法将用户添加为令牌链代码的
Token Admin
。该方法只能由令牌链代码的Token Admin
调用。 -
removeAdmin
- 此方法将用户删除为令牌链代码的
Token Admin
。该方法只能由令牌链代码的Token Admin
调用。您无法将自己删除为Token Admin
。 -
getAllAdmins
- 此方法返回所有
Token Admin
用户的列表。 -
checkAuthorization
- 使用此方法可将访问控制检查添加到操作。这是一个异步函数。某些令牌方法只能由令牌的
Token Admin
或AccountOwner
运行,也可以由具有多个帐户的用户使用MultipleAccountOwner
运行。访问控制映射在../lib/constant.ts
文件中进行了介绍。您可以通过编辑../lib/constant.ts
文件来修改访问控制。要使用您自己的访问控制或禁用访问控制,请从自动生成的控制器方法和定制方法中删除访问控制代码。ADMIN: { isUserTokenAdmin: ["Admin"], addAdmin: ["Admin"], removeAdmin: ["Admin"], getAllAdmins: ["Admin"], }, TOKEN: { save: ["Admin"], getAllTokens: ["Admin"], get: ["Admin"], update: ["Admin"], getDecimals: ["Admin"], getTokensByName: ["Admin"], addRoleMember: ["Admin"], removeRoleMember: ["Admin"], isInRole: ["Admin", "AccountOwner"], getTotalMintedTokens: ["Admin"], getNetTokens: ["Admin"], getTokenHistory: ["Admin"], }, ROLE: { getAccountsByRole: ["Admin"], getUsersByRole: ["Admin"], }, TRANSACTION: { deleteTransactions: ["Admin"], }, ACCOUNT: { createAccount: ["Admin"], associateToken: ["Admin"], getAllAccounts: ["Admin"], getAccountsByUser: ["Admin", "MultipleAccountOwner"], getAccount: ["Admin", "AccountOwner"], history: ["Admin", "AccountOwner"], getAccountTransactionHistory: ["Admin", "AccountOwner"], getAccountTransactionHistoryWithFilters: ["Admin", "AccountOwner"], getSubTransactionsById: ["Admin", TRANSACTION_INVOKER], getSubTransactionsByIdWithFilters: ["Admin", TRANSACTION_INVOKER], getAccountBalance: ["Admin", "AccountOwner"], getAccountOnHoldBalance: ["Admin", "AccountOwner"], getOnHoldIds: ["Admin", "AccountOwner"], getConversionHistory: ["Admin", "AccountOwner"], }, ACCOUNT_STATUS: { get: ["Admin", "AccountOwner"], history: ["Admin", "AccountOwner"], activateAccount: ["Admin"], suspendAccount: ["Admin"], deleteAccount: ["Admin"], }, TOKEN_CONVERSION: { initializeExchangePoolUser: ["Admin"], addConversionRate: ["Admin"], updateConversionRate: ["Admin"], getConversionRate: ["Admin", "AnyAccountOwner"], getConversionRateHistory: ["Admin", "AnyAccountOwner"], tokenConversion: ["Admin", "AnyAccountOwner"], getExchangePoolUser: ["Admin"], }, ERC721ADMIN: { isUserTokenAdmin: ["Admin"], addAdmin: ["Admin"], removeAdmin: ["Admin"], getAllAdmins: ["Admin"], }, ERC721TOKEN: { getAllTokens: ["Admin"], getAllTokensByUser: ["Admin", "AccountOwner"], get: ["Admin", TOKEN_OWNER], getTokensByName: ["Admin"], addRoleMember: ["Admin"], removeRoleMember: ["Admin"], isInRole: ["Admin", "AccountOwner"], totalSupply: ["Admin"], totalNetSupply: ["Admin"], history: ["Admin"], }, ERC721ROLE: { getAccountsByRole: ["Admin"], getUsersByRole: ["Admin"], }, ERC721TRANSACTION: { deleteTransactions: ["Admin"], }, ERC721ACCOUNT: { createAccount: ["Admin"], getAllAccounts: ["Admin"], getAccountByUser: ["Admin", "MultipleAccountOwner"], history: ["Admin", "AccountOwner"], getAccountTransactionHistory: ["Admin", "AccountOwner"], getAccountTransactionHistoryWithFilters: ["Admin", "AccountOwner"], balanceOf: ["Admin", "MultipleAccountOwner"], }, ERC1155ADMIN: { isUserTokenAdmin: ["Admin"], addAdmin: ["Admin"], removeAdmin: ["Admin"], getAllAdmins: ["Admin"], }, ERC1155TOKEN: { getAllTokens: ["Admin"], get: ["Admin", TOKEN_OWNER], getAllTokensByUser: ["Admin", "AccountOwner"], totalSupply: ["Admin"], totalNetSupply: ["Admin"], getTokensByName: ["Admin"], getDecimals: ["Admin"], addRoleMember: ["Admin"], removeRoleMember: ["Admin"], isInRole: ["Admin", "AccountOwner"], save: ["Admin"], update: ["Admin"], }, ERC1155ACCOUNT: { createAccount: ["Admin"], createUserAccount: ["Admin"], createTokenAccount: ["Admin"], associateFungibleTokenToAccount: ["Admin", "AccountOwner"], getAccountsByUser: ["Admin", "AccountOwner"], getAccount: ["Admin", "AccountOwner"], history: ["Admin", "AccountOwner"], getAllAccounts: ["Admin"], balanceOfBatch: ["Admin"], getAccountTransactionHistory: ["Admin", "AccountOwner"], getAccountTransactionHistoryWithFilters: ["Admin", "AccountOwner"], exchangeToken: ["AccountOwner"], getAccountDetailsByUser: ["Admin", "AccountOwner"], }, ERC1155ROLE: { getAccountsByRole: ["Admin"], getUsersByRole: ["Admin"], },
标记配置管理的方法
-
save
- 此方法创建令牌。所定义的每个标记都有其自己的创建方法。对于非可换代币,如果 minter 角色在规范文件中定义,则具有 minter 角色的任何用户都可以调用此方法来创建 NFT。如果没有,任何用户都可以使用此方法创建 (mint) NFT。调用此方法的用户将成为 NFT 的所有者(整数或小数)。
-
update
- 此方法更新标记。无法更新标记元数据或不可换代标记的标记 URI。
-
history (Token)
- 此方法返回指定令牌 ID 的历史记录。
-
getAllTokens
- 此方法返回保存在状态数据库中的所有令牌资产。此方法只能由链代码的
Token Admin
调用。此方法使用 Berkeley DB SQL 丰富的查询,并且只能在连接到远程 Oracle Blockchain Platform 网络时调用。 -
get (Token)
- 如果令牌存在于状态数据库中,则此方法将返回令牌对象。此方法只能由链代码的
Token Admin
或令牌所有者调用。 -
getAllTokensByUser
- 此方法返回指定用户拥有的所有令牌资产。此方法使用 Berkeley DB SQL 丰富的查询,并且只能在连接到远程 Oracle Blockchain Platform 网络时调用。
-
ownerOf
- 此方法返回指定令牌 ID 的所有者的账户 ID、组织 ID 和用户 ID。
-
tokenURI
- 此方法返回指定标记的 URI。任何人都可以调用此方法。
-
name
- 此方法返回令牌类的名称。任何人都可以调用此方法。
-
totalSupply
- 此方法返回铸币的总数。可替换标记由标记 ID 指定。非实物标记由标记名称指定。
-
totalNetSupply
- 此方法返回铸造的令牌总数减去烧毁的令牌数。可替换标记由标记 ID 指定。非实物标记由标记名称指定。
-
getTokensByName
- 此方法返回指定标记名称的所有标记资产。此方法使用 Berkeley DB SQL 丰富的查询,并且只能在连接到远程 Oracle Blockchain Platform 网络时调用。
-
getDecimals
- 此方法返回指定标记的小数位数。如果未为标记指定可整除行为,则返回小数位数为零的默认值。
账户管理方法
-
createAccount
- 此方法为指定用户创建帐户,并为可变或非可变标记创建关联的令牌帐户。必须为在任何时候将具有令牌的任何用户创建账户。用户帐户跟踪 NFT 帐户和用户拥有的可替换令牌帐户。用户必须在网络中具有帐户才能完成与令牌相关的操作。此方法只能由链代码的
Token Admin
调用。用户帐户具有唯一的 ID,该 ID 由
orgId
参数和userId
参数的 SHA-256 散列构成。用户可以具有多个具有唯一账户 ID 的可替换令牌账户。可替换令牌帐户 ID 由
orgId
参数的 SHA-256 散列、userId
参数、由波浪号 (~
) 分隔的常量字符串ft
和表示由波浪号 (~
) 分隔创建的可替换帐户索引的计数器编号构成。用户只能有一个不可替代的令牌账户。非易变令牌帐户 ID 是唯一的,由
orgId
参数的 SHA-256 散列、userId
参数和以波浪号 (~
) 分隔的常量字符串nft
构成。用户拥有的所有非可换代币(无论是整体代币还是小数代币)都链接到此单个不可换代代币账户。 -
createUserAccount
- 此方法为指定的用户创建帐户。必须为在任何时候将具有令牌的任何用户创建账户。用户帐户跟踪 NFT 帐户和用户拥有的可替换令牌帐户。用户必须在网络中具有帐户才能完成与令牌相关的操作。
帐户 ID 是
orgId
参数和userId
参数的 SHA-256 散列。此方法只能由链代码的Token Admin
调用。 -
createTokenAccount
- 此方法创建可替换或不可替换的令牌帐户以与用户帐户关联。
用户可以具有多个具有唯一账户 ID 的可替换令牌账户。可替换令牌帐户 ID 由
orgId
参数的 SHA-256 散列、userId
参数、由波浪号 (~
) 分隔的常量字符串ft
和表示由波浪号 (~
) 分隔创建的可替换帐户索引的计数器编号构成。用户只能有一个不可替代的令牌账户。非易变令牌帐户 ID 是唯一的,由
orgId
参数的 SHA-256 散列、userId
参数和以波浪号 (~
) 分隔的常量字符串nft
构成。用户拥有的所有非可换代币(无论是整体代币还是小数代币)都链接到此单个不可换代代币账户。此方法只能由链代码的
Token Admin
调用。 -
associateTokenToToken
- 此方法将用户的可交换令牌帐户与特定可交换令牌相关联。
-
getAccountHistory
- 此方法返回指定令牌帐户的历史记录。
-
getAccountWithStatus
- 此方法返回指定用户的令牌帐户详细信息,包括帐户状态。此方法只能由链代码的
Token Admin
或帐户的Account Owner
调用。 -
getAccount
- 此方法返回指定用户的令牌帐户详细信息。此方法只能由链代码的
Token Admin
或帐户的Account Owner
调用。 -
getAllAccounts
- 此方法返回所有用户帐户的详细信息。
-
getAccountDetailsByUser
- 此方法返回指定用户的帐户摘要以及与用户关联的可替换和不可替换标记的详细信息。
-
getUserByAccountId
- 此方法返回指定帐户 ID 的用户详细信息。
角色管理的方法
-
AddRoleMember
- 此方法将角色添加到指定的用户和令牌。可替换标记由标记 ID 指定。非实物标记由标记名称指定。
-
isInRole
- 此方法返回布尔值以指示用户是否具有指定的角色。可替换标记由标记 ID 指定。非实物标记由标记名称指定。
-
removeRoleMember
- 此方法从指定用户和令牌中删除角色。可替换标记由标记 ID 指定。非实物标记由标记名称指定。
-
getAccountsByRole
- 此方法返回指定角色和令牌的所有账户 ID 的列表。可替换标记由标记 ID 指定。非实物标记由标记名称指定。
-
getUsersByRole
- 此方法返回指定角色和令牌的所有用户的列表。可替换标记由标记 ID 指定。非实物标记由标记名称指定。
事务处理历史记录管理的方法
-
getAccountTransactionHistory
- 此方法返回账户事务处理历史记录。此方法只能由链代码的
Token Admin
或帐户所有者调用。对于不可替代的令牌,只有在连接到远程 Oracle Blockchain Platform 网络时才能调用此方法。 -
getTransactionById
- 此方法返回指定事务处理 ID 的事务处理详细信息。
-
deleteTransactions
- 此方法从状态数据库中删除指定时间戳之前的事务处理。
令牌行为管理方法 - 可铸造行为
-
mintBatch
- 此方法在批处理操作中创建 (mint) 多个标记。此方法仅创建可替换令牌或小数非可替换令牌。
对于可变令牌,如果 minter 角色在规范文件中定义,则具有 minter 角色的任何用户都可以调用此方法。如果没有,任何用户都可以使用此方法来创建标记。如果该属性是在创建或更新令牌时指定的,则不能超过令牌的
max_mint_quantity
属性。对于非可换代币,如果在规范文件中定义了 minter 角色,则具有 minter 角色的任何用户都可以调用此方法。如果没有,任何用户都可以使用此方法来创建标记。此外,调用者还必须是令牌的创建者。可以铸造的小数非实物代币的数量没有上限。
不能使用此方法来模拟整个不可替换标记。
令牌行为管理的方法 - 可转移行为
-
batchTransferFrom
- 此方法完成将令牌 ID 列表中指定的令牌从一个用户传输到另一个用户的批处理操作。
对于 NFT,由于该方法转移了 NFT 的所有权,因此 NFT 的发送者必须拥有该令牌。
对于小数 NFT,如果用户(包括令牌的创建者)传输他们拥有的所有共享资源,则他们将失去令牌的所有权。如果令牌的任何共享资源传输给用户,则该用户将自动成为小数 NFT 的所有者之一。
此方法不会验证该方法的调用方是否为指定的发送方。
-
safeBatchtransferFrom
- 此方法完成将令牌 ID 列表中指定的令牌从一个用户传输到另一个用户的批处理操作。
对于 NFT,由于该方法转移了 NFT 的所有权,因此 NFT 的发送者必须拥有该令牌。
对于小数 NFT,如果用户(包括令牌的创建者)传输他们拥有的所有共享资源,则他们将失去令牌的所有权。如果令牌的任何共享资源传输给用户,则该用户将自动成为小数 NFT 的所有者之一。
方法的调用方必须是指定的发送方。
-
balanceOfBatch
- 此方法完成获取令牌帐户余额的批处理操作。账户详细信息在三个单独的组织 ID、用户 ID 和令牌 ID 列表中指定。此方法只能由链代码的
Token Admin
或帐户所有者调用。账户所有者只能查看他们拥有的账户的余额详细信息。 -
exchangeToken
- 此方法在指定帐户之间交换令牌。此方法仅支持在 NFT(整体或小数)与可交换令牌或可交换令牌与 NFT(整体或小数)之间交换。此方法只能由账户所有者调用。
令牌行为管理的方法 - 可燃行为