用于令牌分类框架的基架 TypeScript 项目
Blockchain App Builder 从您的令牌规范文件中获取输入,并生成一个功能齐全的支架链代码项目。
该项目自动生成令牌生命周期类和函数,包括 CRUD 和非 CRUD 方法。自动支持参数验证、编集/解编集和透明持久性功能。
有关脚手架项目和与标记不直接相关的方法的信息,请参阅脚手架 TypeScript Chaincode Project 。
型号
每个标记化的模型类都扩展了 Token
类,而该类又扩展了 OchainModel
类。Token
类是从 ../lib/token
导入的。透明持久性功能(Transparent Persistence Capability,简称 ORM)捕获在 OchainModel
类中。
import * as yup from 'yup';
import { Id, Mandatory, Validate, ReadOnly } from '../lib/decorators';
import { Token } from '../lib/token';
@Id('token_id')
export class Digicur extends Token<Digicur> {
public readonly assetType = 'otoken';
@Mandatory()
@Validate(yup.string().required().matches(/^[A-Za-z0-9][A-Za-z0-9_-]*$/).max(16))
public token_id: string;
@ReadOnly('digicur')
public token_name: string;
@Validate(yup.string().trim().max(256))
public token_desc: string;
@ReadOnly('fungible')
public token_type: string;
@ReadOnly(["divisible","mintable","transferable","burnable","holdable","roles"])
public behaviors: string[];
@ReadOnly({minter_role_name: "minter", burner_role_name: "burner", notary_role_name: "notary"})
public roles: object;
@ReadOnly({max_mint_quantity: 20000})
public mintable: object;
@ReadOnly({decimal: 1})
public divisible: object;
@Validate(yup.number())
public token_to_currency_ratio: number;
@Validate(yup.string())
public currency_representation: string;
}
控制器
主控制器类扩展 OchainController
类。只有一个主控制器。
export class DigiCurrCCController extends OchainController{
可以创建任意数量的类、函数或文件,但只能调用在主控制器类中定义的那些方法。其他方法将被隐藏。
您可以使用令牌 SDK 方法为业务应用程序编写定制方法。
自动生成的标记方法
Blockchain App Builder 自动生成支持令牌和令牌生命周期的方法。您可以使用这些方法初始化令牌、管理角色和账户以及完成其他令牌生命周期任务,而无需进行任何其他编码。控制器方法必须具有可调用的 @Validator(...params)
修饰器。
访问控制管理的方法
-
addTokenAdmin
- 此方法将用户添加为链代码的
Token Admin
。此方法只能由链代码的Token Admin
调用。 -
removeTokenAdmin
- 此方法将删除用户作为链代码的
Token Admin
。此方法只能由链代码的Token Admin
调用。 -
isTokenAdmin
- 如果函数的调用方为
Token Admin
,则此方法返回布尔值true
,否则返回false
。Token Admin
或Org Admin
可以在区块链网络中的任何其他用户上调用此函数。其他用户只能在自己的帐户上调用此方法。 -
getAllTokenAdmins
- 此方法返回作为链代码
Token Admin
的所有用户的列表。此方法只能由链代码的Token Admin
或任何Org Admin
调用。 -
addOrgAdmin
- 此方法将用户添加为组织的
Org Admin
。此方法只能由链代码的Token Admin
或指定组织的Org Admin
调用。 -
removeOrgAdmin
- 此方法将删除用户作为组织的
Org Admin
。此方法只能由链代码的Token Admin
或指定组织的Org Admin
调用。 -
getOrgAdmins
- 此方法返回组织
Org Admin
的所有用户的列表。此方法只能由链代码的Token Admin
或任何组织的Org Admin
调用。
标记配置管理的方法
-
init
- 部署或升级链代码时将调用此方法。每个
Token Admin
都由必需的adminList
参数中的user_id
和org_id
信息标识。user_id
是实例所有者或登录到实例的用户的用户名或电子邮件 ID。org_id
是当前网络组织中用户的成员服务提供者 (membership service provider,MSP) ID。 -
initialize<Token Name>Token
- 此方法创建令牌并初始化令牌属性。资产及其属性保存在状态数据库中。此方法只能由链代码的
Token Admin
调用。 -
update<Token Name>Token
- 此方法更新令牌属性。创建令牌资产后,只能更新
token_desc
属性和定制属性。此方法只能由链代码的Token Admin
调用。 -
getTokenDecimals
- 此方法返回为小数标记配置的小数位数。如果未指定令牌的
divisible
行为,则默认值为 0。此方法只能由链代码的Token Admin
或Org Admin
调用。 -
getTokenById
- 如果标记对象存在于状态数据库中,则此方法返回该对象。此方法只能由链代码的
Token Admin
或Org Admin
调用。 -
getTokenHistory
- 此方法返回指定标记 ID 的标记历史记录。任何用户都可以调用此方法。
-
getAllTokens
- 此方法返回状态数据库中存储的所有标记。此方法只能由链代码的
Token Admin
或Org Admin
调用。此方法使用 Berkeley DB SQL 富查询,并且只能在连接到远程 Oracle Blockchain Platform 网络时调用。 -
getTokensByName
- 此方法返回具有指定名称的所有标记对象。此方法只能由链代码的
Token Admin
或Org Admin
调用。此方法使用 Berkeley DB SQL 富查询,并且只能在连接到远程 Oracle Blockchain Platform 网络时调用。
账户管理方法
-
createAccount
- 此方法为指定的用户和令牌创建帐户。必须为在任何时刻具有令牌的任何用户创建帐户。账户跟踪余额、暂挂余额和事务处理历史记录。帐户 ID 是字母数字字符集,以
oaccount~<token asset name>~
为前缀,后跟实例所有者或登录到实例的用户的用户名或电子邮件 ID (user_id
) 的散列,即当前网络组织中用户的成员服务提供者 ID (org_id
)。此方法只能由链代码的Token Admin
或指定组织的Org Admin
调用。 -
associateTokenToAccount
- 此方法将可替换令牌与帐户关联。此方法只能由链代码的
Token Admin
或相关组织的Org Admin
调用。 -
getAccount
- 此方法返回指定用户和令牌的帐户详细信息。此方法只能由链代码的
Token Admin
、指定组织的Org Admin
或帐户的AccountOwner
调用。 -
getAccountHistory
- 此方法返回指定用户和令牌的帐户历史记录详细信息。此方法只能由链代码的
Token Admin
或帐户的AccountOwner
调用。 -
getAccountOnHoldBalance
- 此方法返回指定账户和令牌的当前暂挂余额。此方法只能由链代码的
Token Admin
、指定组织的Org Admin
或帐户的AccountOwner
调用。 -
getAllAccounts
- 此方法返回所有帐户的列表。此方法只能由链代码的
Token Admin
调用。此方法使用 Berkeley DB SQL 富查询,并且只能在连接到远程 Oracle Blockchain Platform 网络时调用。 -
getUserByAccountId
- 此方法返回指定帐户的用户详细信息(
org_id
和user_id
)。链代码的任何用户都可以调用此方法。 -
getAccountBalance
- 此方法返回指定帐户和令牌的当前余额。此方法只能由链代码的
Token Admin
、指定组织的Org Admin
或帐户的AccountOwner
调用。 -
getAllOrgAccounts
- 此方法返回属于指定组织的所有令牌帐户的列表。此方法只能由链代码的
Token Admin
或指定组织的Org Admin
调用。
角色管理的方法
-
addRole
- 此方法向指定用户和令牌添加角色。此方法只能由链代码的
Token Admin
或具有指定角色的指定组织的Org Admin
调用。 -
removeRole
- 此方法将从指定用户和令牌中删除角色。此方法只能由链代码的
Token Admin
或具有指定角色的指定组织的Org Admin
调用。 -
getAccountsByRole
- 此方法返回指定角色和令牌的所有帐户 ID 的列表。此方法只能由链代码的
Token Admin
调用。 -
getAccountsByUser
- 此方法返回指定组织 ID 和用户 ID 的所有帐户 ID 的列表。此方法只能由链代码的
Token Admin
、指定组织的Org Admin
或参数中指定的Account Owner
调用。 -
getUsersByRole
- 此方法返回指定角色和令牌的所有用户的列表。此方法只能由链代码的
Token Admin
调用。 -
isInRole
- 此方法返回布尔值以指示用户和令牌是否具有指定的角色。此方法只能由链代码的
Token Admin
、帐户的AccountOwner
或指定组织的Org Admin
调用。 -
getOrgAccountsByRole
- 此方法返回有关在指定组织中具有指定角色的所有帐户的信息。此方法只能由链代码的
Token Admin
或指定组织的Org Admin
调用。 -
getOrgUsersByRole
- 此方法返回有关在指定组织中具有指定角色的所有用户的信息。此方法只能由链代码的
Token Admin
或指定组织的Org Admin
调用。
事务处理历史记录管理方法
-
getAccountTransactionHistory
- 此方法返回指定用户和令牌的帐户事务处理历史记录详细信息数组。此方法只能由链代码的
Token Admin
、指定组织的Org Admin
或帐户的AccountOwner
调用。 -
getAccountTransactionHistoryWithFilters
- 此方法返回指定用户和令牌的帐户事务处理历史记录详细信息数组。此方法只能由链代码的
Token Admin
、指定组织的Org Admin
或帐户的AccountOwner
调用。仅当连接到远程 Oracle Blockchain Platform 网络时才能调用此方法。 -
getSubTransactionById
- 此方法返回指定用户和令牌的帐户事务处理历史记录详细信息数组。此方法只能由链代码的
Token Admin
或帐户的AccountOwner
调用。 -
getSubTransactionsByIdWithFilters
- 此方法返回指定事务处理的账户子事务处理历史记录详细信息数组。
-
getTransactionById
- 此方法返回
Transaction
资产的历史记录。 -
deleteHistoricalTransactions
- 此方法从状态数据库中删除较早的事务处理。
标记行为管理的方法 - 可最小化行为
-
issueTokens
- 此方法铸币令牌,该令牌随后由方法的调用者拥有。调用方必须具有帐户和 minter 角色。可以铸造的标记数受规范文件中
mintable
行为的max_mint_quantity
属性的限制。如果未指定max_mint_quantity
属性,则可以铸造数量不限的标记。数量必须在规范文件中divisible
行为的decimal
参数指定的小数值内。此方法只能由具有 minter 角色的帐户的AccountOwner
调用。 -
getTotalMintedTokens
- 此方法返回指定令牌的铸造令牌总数。此方法只能由链代码的
Token Admin
或任何Org Admin
调用。 -
getNetTokens
- 此方法返回系统中指定令牌的可用令牌的总净数。净令牌总数是令牌被烧毁后剩余的令牌数量。在方程式形式:净代币 = 总铸造代币 - 总烧毁代币。如果没有刻录标记,则净标记的数量等于铸造标记的总数。此方法只能由链代码的
Token Admin
或任何Org Admin
调用。
标记行为管理的方法 - 可传输行为
-
transferTokens
- 此方法将令牌从调用方传输到指定的帐户。方法的调用方必须具有一个帐户。数量必须在规范文件中
divisible
行为的decimal
参数指定的小数值内。此方法只能由帐户的AccountOwner
调用。 -
bulkTransferTokens
- 此方法用于将标记从调用方帐户批量传输到
flow
对象中指定的帐户。数量必须位于此方法的规范 file.The 调用方中divisible
行为的decimal
参数指定的小数值内,且必须已创建账户。此方法只能由帐户的AccountOwner
调用。
标记行为管理的方法 - 可暂挂行为
-
holdTokens
- 此方法使用
to_account_id
帐户代表令牌的所有者创建暂挂。指定公证帐户,该帐户负责完成或释放暂挂。创建暂挂时,付款人的指定标记余额将被暂挂。在暂挂完成或释放之前,无法转移暂挂余额。此方法的调用方必须已创建账户。此方法只能由帐户的AccountOwner
调用。 -
executeHoldTokens
- 此方法完成对令牌的暂挂。令牌所有者以前持有的令牌数量将转移给接收者。如果
quantity
值小于实际暂挂值,则剩余金额将再次提供给令牌的原始所有者。此方法只能由具有指定操作 ID 的AccountOwner
ID 和notary
角色来调用。暂挂只能由公证人完成。 -
releaseHoldTokens
- 此方法释放对标记的暂挂。转移未完成,所有保留的令牌都再次可供原始所有者使用。此方法可由
AccountOwner
ID 在指定时间限制内具有notary
角色或者在指定时间限制后由付款人、受款人或公证人调用。 -
getOnHoldIds
- 此方法返回指定帐户的所有持有 ID 的列表。可以通过链代码的
Token Admin
、指定组织的Org Admin
或帐户的AccountOwner
调用此方法。 -
getOnHoldDetailsWithOperationId
- 此方法返回指定操作 ID 和标记的暂挂事务处理详细信息。任何人都可以调用此方法。
-
getOnHoldBalanceWithOperationId
- 此方法返回指定操作 ID 和标记的暂挂余额。任何人都可以调用此方法。
标记行为管理的方法 - 可刻录行为
定制方法
您可以使用令牌 SDK 方法为业务应用程序编写定制方法。
为避免双重支出,请勿组合对状态数据库中的相同键 - 值对运行的多个异步函数。而应使用 bulkTransferTokens
方法在一个方法中进行多个传输。
以下示例说明如何在定制方法中使用标记 SDK 方法。调用 buyTicket
方法时,它将 20 个令牌从调用者的帐户转移到卖方的帐户,并返回转移的事务处理消息。
@Validator(yup.string(), yup.string(), yup.string(), yup.string(), yup.string())
public async buyTicket(token_id: string, seller_org_id: string, seller_user_id: string) {
const token = await this.getTokenObject(token_id);
/**
* The following method this.Ctx.Account.generateAccountId(token_id, seller_org_id, seller_user_id) generates account id of the seller.
*/
const seller_account_id = await this.Ctx.Account.generateAccountId(token_id, seller_org_id, seller_user_id);
/**
* The following method this.Ctx.Token.transfer(seller_account_id, 20, token) transfers the quantity 20 from caller's
* account & to seller's account.
*/
const transaction = await this.Ctx.Token.transfer(seller_account_id, 20, token);
return transaction;
}
如果在定制方法中使用多个标记 SDK 方法,则不要使用会影响状态数据库中相同键 - 值对的方法。以下示例显示了进行多次传输的错误方式:
@Validator(yup.string(), yup.string(), yup.string(), yup.string(), yup.string())
public async sendTokens(token_id: string, user1_org_id: string, user1_user_id: string, user2_org_id: string, user2_user_id: string) {
const token = await this.getTokenObject(token_id);
const user1_account_id = await Account.generateAccountId(token_id, user1_org_id, user1_user_id);
const user2_account_id = await Account.generateAccountId(token_id, user2_org_id, user2_user_id);
await token.transfer(user1_account_id, 20);
await token.transfer(user2_account_id, 30);
}
而是使用 bulkTransferTokens
方法从调用者的帐户转移到多个帐户,如以下代码片段中所示。
bulkTransferTokens(token_id: string, flow: object[])
注意:
如果在定制方法中使用多个标记 SDK 方法,这些方法可能会影响状态数据库中的相同键 - 值对,请为标记链代码启用 MVCC 优化。有关更多信息,请参见 MVCC Optimization 。标记 SDK 方法
访问控制管理的方法
Token Admin
、Org Admin
或 AccountOwner
调用。您可以使用此功能确保仅由目标用户执行操作。任何未经授权的访问都会导致错误。要使用访问控制功能,请从 ../lib/auth
模块导入 Authorization
类。import { Authorization } from '../lib/auth';
-
addAdmin
- 此方法将用户添加为令牌链代码的
Token Admin
。 -
removeAdmin
- 此方法将删除用户作为标记链代码的
Token Admin
。 -
getAllAdmins
- 此方法返回作为标记链代码
Token Admin
的所有用户的列表。 -
checkAuthorization
- 使用此方法可将访问控制检查添加到操作。某些令牌方法只能由令牌的
Token Admin
或AccountOwner
或具有多个帐户的用户通过MultipleAccountOwner
运行。访问控制映射在../lib/constant.ts
文件中介绍。可以通过编辑../lib/constant.ts
文件来修改访问控制。要使用您自己的访问控制或禁用访问控制,请从自动生成的控制器方法和定制方法中删除访问控制代码。export const TOKENACCESS = { ADMIN: { isUserTokenAdmin: ["Admin", "OrgAdmin"], addTokenAdmin: ["Admin"], removeTokenAdmin: ["Admin"], getAllAdmins: ["Admin", "OrgAdmin"], addOrgAdmin: ["Admin", "OrgAdminForOrgId"], removeOrgAdmin: ["Admin", "OrgAdminForOrgId"], getOrgAdmins: ["Admin", "OrgAdmin"], }, TOKEN: { save: ["Admin"], getAllTokens: ["Admin", "OrgAdmin"], get: ["Admin", "OrgAdmin"], update: ["Admin"], getDecimals: ["Admin", "OrgAdmin"], getTokensByName: ["Admin", "OrgAdmin"], addRoleMember: ["Admin", "OrgAdminRoleCheck"], removeRoleMember: ["Admin", "OrgAdminRoleCheck"], isInRole: ["Admin", "OrgAdminForAccountId", "AccountOwner"], getTotalMintedTokens: ["Admin", "OrgAdmin"], getNetTokens: ["Admin", "OrgAdmin"], getTokenHistory: ["Admin", "OrgAdmin"], }, ROLE: { getAccountsByRole: ["Admin"], getOrgAccountsByRole: ["Admin", "OrgAdminForOrgId"], getUsersByRole: ["Admin"], getOrgUsersByRole: ["Admin", "OrgAdminForOrgId"], }, TRANSACTION: { deleteTransactions: ["Admin"], },ACCOUNT: { createAccount: ["Admin", "OrgAdminForOrgId"], associateToken: ["Admin", "OrgAdminForAccountId"], getAllAccounts: ["Admin"], getAllOrgAccounts: ["Admin", "OrgAdminForOrgId"], getAccountsByUser: ["Admin", "OrgAdminForOrgId", "MultipleAccountOwner"], getAccount: ["Admin", "OrgAdminForAccountId", "AccountOwner"], history: ["Admin", "AccountOwner"], getAccountTransactionHistory: ["Admin", "OrgAdminForAccountId", "AccountOwner"], getAccountTransactionHistoryWithFilters: ["Admin", "OrgAdminForAccountId", "AccountOwner"], getSubTransactionsById: ["Admin", "TransactionInvoker"], getSubTransactionsByIdWithFilters: ["Admin", "TransactionInvoker"], getAccountBalance: ["Admin", "OrgAdminForAccountId", "AccountOwner"], getAccountOnHoldBalance: ["Admin", "OrgAdminForAccountId", "AccountOwner"], getOnHoldIds: ["Admin", "OrgAdminForAccountId", "AccountOwner"], getConversionHistory: ["Admin", "OrgAdminForAccountId", "AccountOwner"], }, ACCOUNT_STATUS: { get: ["Admin", "OrgAdminForAccountId", "AccountOwner"], history: ["Admin", "OrgAdminForAccountId", "AccountOwner"], activateAccount: ["Admin", "OrgAdminForOrgId"], suspendAccount: ["Admin", "OrgAdminForOrgId"], deleteAccount: ["Admin", "OrgAdminForOrgId"], }, TOKEN_CONVERSION: { initializeExchangePoolUser: ["Admin"], addConversionRate: ["Admin"], updateConversionRate: ["Admin"], getConversionRate: ["Admin", "OrgAdmin", "AnyAccountOwner"], getConversionRateHistory: ["Admin", "OrgAdmin", "AnyAccountOwner"], tokenConversion: ["Admin", "AnyAccountOwner"], getExchangePoolUser: ["Admin"], }, }
-
isUserTokenAdmin
- 如果函数的调用方为
Token Admin
,则此方法返回布尔值true
。否则,方法返回false
。 -
addOrgAdmin
- 此方法将用户添加为组织的
Org Admin
。 -
removeOrgAdmin
- 此方法将删除用户作为组织的
Org Admin
。 -
getOrgAdmins
- 此方法返回组织
Org Admin
的所有用户的列表。
标记配置管理的方法
-
getTokenDecimals
- 此方法返回可用于小数标记的小数位数。如果未指定
divisible
行为,则默认值为 0。 -
getAllTokens
- 此方法返回状态数据库中保存的所有标记资产。此方法使用 Berkeley DB SQL 富查询,并且只能在连接到远程 Oracle Blockchain Platform 网络时调用。
-
getTokensByName
- 此方法返回具有指定名称的所有标记资产。此方法使用 Berkeley DB SQL 富查询,并且只能在连接到远程 Oracle Blockchain Platform 网络时调用。
-
get
- 如果标记对象存在于状态数据库中,则此方法返回该对象。
-
isTokenType
- 此方法指示是否存在具有指定 ID 的标记资产。
-
save
- 此方法创建令牌并将其属性保存在状态数据库中。
-
update
- 此方法更新令牌属性。创建令牌资产后,仅更新
token_desc
值及其定制属性。 -
getByRange
- 此方法在内部调用网状结构网络
getStateByRange
方法。即使从分类账返回具有给定 ID 的任何资产,此方法仍会将资产强制转换为调用方资产类型。 -
history
- 此方法返回指定标记的历史记录。
账户管理方法
-
getCallerAccountId
- 此方法返回调用者的帐户 ID。
-
generateAccountId
- 此方法返回帐户 ID,这是一组字母数字字符,前缀为
oaccount~<token asset name>~
,后跟实例所有者或登录到实例的用户的用户名或电子邮件 ID (user_id
)、当前网络组织中用户的成员服务提供者 ID (org_id
) 以及唯一令牌 ID (token_id
)。 -
createAccount
- 此方法为指定的用户和令牌创建帐户。每个在任何时候都有令牌的用户都必须有一个帐户。账户跟踪用户的余额、暂挂余额和事务处理历史记录。帐户 ID 是字母数字字符集,以
oaccount~<token asset name>~
为前缀,后跟实例所有者或登录到实例的用户的用户名或电子邮件 ID (user_id
) 的散列,即当前网络组织中用户的成员服务提供者 ID (org_id
)。此方法只能由链代码的Token Admin
或指定组织的Org Admin
调用。 -
associateTokenToAccount
- 此方法将可替换令牌与帐户关联。此方法只能由链代码的
Token Admin
或相关组织的Org Admin
调用。 -
getAccountWithStatus
- 此方法返回指定帐户的帐户详细信息,包括帐户状态。
-
getAccount
- 此方法返回指定帐户的帐户详细信息。
-
history
- 此方法返回指定帐户的帐户历史记录详细信息数组。
-
getAccountOnHoldBalance
- 此方法返回指定账户的暂挂余额。
-
getAllAccounts
- 此方法返回所有帐户的列表。此方法使用 Berkeley DB SQL 富查询,并且只能在连接到远程 Oracle Blockchain Platform 网络时调用。
-
getUserByAccountId
- 此方法返回指定帐户的用户详细信息。
-
getAccountBalance
- 此方法返回指定帐户的帐户余额。
-
getAllOrgAccounts
- 此方法返回属于指定组织的所有令牌帐户的列表。
角色管理的方法
-
addRoleMember
- 此方法向指定用户和令牌添加角色。
-
removeRoleMember
- 此方法将从指定用户和令牌中删除角色。
-
getAccountsByRole
- 此方法返回指定角色和令牌的所有帐户的列表。
-
getAccountsByUser
- 此方法返回指定用户的所有帐户 ID 的列表。
-
getUsersByRole
- 此方法返回指定角色和令牌的所有用户的列表。
-
isInRole
- 此方法指示用户和令牌是否具有指定的角色。
-
roleCheck
- 此方法检查提供的账户 ID 是否为任何角色的成员。
-
getOrgUsersByRole
- 此方法返回有关在指定组织中具有指定角色的所有用户的信息。
-
getOrgAccountsByRole
- 此方法返回有关在指定组织中具有指定角色的所有帐户的信息。
事务处理历史记录管理方法
-
getTransactionById
- 此方法返回
Transaction
资产的历史记录。 -
deleteHistoricalTransactions
- 此方法返回指定账户的事务处理历史记录详细信息数组。
-
getAccountTransactionHistory
- 此方法返回指定账户的事务处理历史记录详细信息数组。
-
getAccountTransactionHistoryWithFilters
- 此方法返回指定账户的事务处理历史记录详细信息数组。仅当连接到远程 Oracle Blockchain Platform 网络时才能调用此方法。
-
getSubTransactionHistory
- 此方法返回指定事务处理的事务处理历史记录详细信息数组。
-
getSubTransactionHistoryWithFilters
- 此方法返回指定事务处理的子事务处理历史记录详细信息数组。
标记行为管理
../lib/token
模块导入 Token
类。
import { Token } from '../lib/token';
标记行为管理的方法 - 可最小化行为
-
mint
- 此方法铸造一定数量的标记,然后这些标记由方法的调用方拥有。调用方必须具有帐户和 minter 角色。数量必须在规范文件中
divisible
行为的decimal
参数指定的小数值内。 -
getTotalMintedTokens
- 此方法返回铸造标记的总数。
-
getNetTokens
- 此方法返回系统中可用的令牌的净数量。净令牌是令牌燃烧后剩余的令牌数量。在方程式形式:净代币 = 总铸造代币 - 总烧毁代币。如果没有刻录标记,则净标记的数量等于铸造标记的总数。
-
getMaxMintQuantity
- 此方法返回令牌的最大可最小数量。如果未指定
max_mint_quantity
行为,则默认值为 0,这允许铸造任意数量的标记。
标记行为管理的方法 - 可传输行为
-
transfer
- 此方法将令牌从事务调用方传输到
to_account_id
帐户。此方法的调用方必须具有帐户,并且数量必须位于规范文件中divisible
行为的decimal
参数指定的小数值内。 -
bulkTransfer
- 此方法用于将标记从调用方帐户批量传输到
flow
对象中指定的帐户。此方法的调用方必须已创建账户。
标记行为管理的方法 - 可暂挂行为
-
hold
- 此方法使用
to_account_id
帐户代表令牌的所有者创建暂挂。指定公证帐户,该帐户负责完成或释放暂挂。创建暂挂时,付款人的指定标记余额将被暂挂。在暂挂完成或释放之前,无法转移暂挂余额。此方法的调用方必须已创建账户。 -
executeHold
- 此方法完成对令牌的暂挂,将以前暂挂的指定数量的令牌转移给接收方。如果
quantity
值小于实际暂挂值,则剩余金额将再次提供给令牌的原始所有者。此方法只能由具有指定操作 ID 的AccountOwner
ID 和notary
角色来调用。暂挂只能由公证人完成。 -
releaseHold
- 此方法释放对标记的暂挂。转移未完成,所有保留的令牌都再次可供原始所有者使用。此方法可由
AccountOwner
ID 在指定时间限制内具有notary
角色或者在指定时间限制后由付款人、受款人或公证人调用。 -
getOnHoldIds
- 此方法返回指定帐户的所有持有 ID 的列表。
-
getOnHoldDetailsWithOperationId
- 此方法返回指定操作 ID 和标记的暂挂事务处理详细信息。
-
getOnHoldBalanceWithOperationId
- 此方法返回指定操作 ID 和标记的暂挂余额。任何人都可以调用此方法。
标记行为管理的方法 - 可刻录行为