Package google.cloud.universalledger.v1

索引

• UniversalLedger（接口）
• Account（消息）
• AccountIdList（消息）
• AccountManagerDetails（消息）
• AccountStatus（枚举）
• ActivateAccount（消息）
• AddRoles（消息）
• AmountValue（消息）
• BalanceToSettle（消息）
• BoolList（消息）
• Burn（消息）
• ChangeAccountManager（消息）
• ClearingHouseDetails（消息）
• ClientTransaction（消息）
• ContractDetails（消息）
• ContractPermission（枚举）
• ContractTokenManagerDetails（消息）
• CreateAccount（消息）
• CreateAccountManager（消息）
• CreateClearinghouse（消息）
• CreateContract（消息）
• CreateContractTokenManager（消息）
• CreateCurrencyOperator（消息）
• CreateSnapshot（消息）
• CreateTokenManager（消息）
• CurrencyOperatorDetails（消息）
• CurrencyValue（消息）
• DeactivateAccount（消息）
• DecreaseTokenIssuanceLimit（消息）
• DictList（消息）
• DictValue（消息）
• Endpoint（消息）
• Entity（消息）
• EventDetails（消息）
• EventType（枚举）
• ExecutionDetails（消息）
• Fields（消息）
• GetEndpointRequest（消息）
• GrantContractPermissions（消息）
• IncreaseTokenIssuanceLimit（消息）
• Int64List（消息）
• InvokeContractMethod（消息）
• KeyFormat（枚举）
• KeySlot（枚举）
• ListEndpointsRequest（消息）
• ListEndpointsResponse（消息）
• MerkleTree（消息）
• Mint（消息）
• NoneValue（枚举）
• PlatformOperatorDetails（消息）
• ProofOfInclusion（消息）
• ProofOfInclusion.MerkleTreeNode（消息）
• QualifiedCurrencyValue（消息）
• QueryAccountRequest（消息）
• QueryAccountResponse（消息）
• QueryDataRequest（消息）
• QueryDataResponse（消息）
• QueryTransactionStateRequest（消息）
• QueryTransactionStateResponse（消息）
• RedactedField（消息）
• RemoveRoles（消息）
• RemoveSigningPublicKey（消息）
• ReplaceSigningPublicKey（消息）
• Role（枚举）
• RoundCertificate（消息）
• SettlementMode（枚举）
• SettlementRequest（消息）
• SignedTransaction（消息）
• StatusEvent（消息）
• StringList（消息）
• SubmitOperationalTransactionRequest（消息）
• SubmitOperationalTransactionResponse（消息）
• SubmitTransactionRequest（消息）
• SubmitTransactionResponse（消息）
• TokenManagerDetails（消息）
• TransactionAttempt（消息）
• TransactionAttempt.TransactionStatus（枚举）
• TransactionCertificate（消息）
• TransactionChain（消息）
• TransactionEffect（消息）
• TransactionEffects（消息）
• TransactionEvent（消息）
• TransactionEvent.EventAttribute（消息）
• TransactionState（消息）
• TransactionStatus（消息）
• Transfer（消息）
• TransferContractTokenManager（消息）
• TransferCurrencyOperator（消息）
• TransferPlatformOperator（消息）
• UserDetails（消息）
• Value（消息）

UniversalLedger

用于与 Google Cloud Universal Ledger 交互的服务。端点由 Google 预先创建和管理，用户无法修改。公共文档中将提供可用端点的名称。端点是 Universal Ledger 网络中的区域级资源。发送到端点的请求可能会被路由到给定网络中给定区域内的不同验证器。

GetEndpoint
rpc GetEndpoint(GetEndpointRequest) returns (Endpoint) 获取特定端点的详细信息。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

ListEndpoints
rpc ListEndpoints(ListEndpointsRequest) returns (ListEndpointsResponse) 列出给定项目和位置的所有端点。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

QueryAccount
rpc QueryAccount(QueryAccountRequest) returns (QueryAccountResponse) 查询网络中存储的与账号相关的所有信息。返回的账号详细信息在不同调用之间可能会有所不同，因为端点可能会将请求路由到网络和区域内的不同验证器，而验证器在任何给定时间可能不在同一轮 ID 中。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

QueryData
rpc QueryData(QueryDataRequest) returns (QueryDataResponse) 查询账本上存储的信息（例如账号和交易）。 系统可能会根据请求中签名所派生的发送者身份，限制对某些敏感字段（例如账户余额）的访问权限。如果发送者缺少权限，系统会从响应中隐去敏感字段，并在 redacted_fields 字段中报告。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

QueryTransactionState
rpc QueryTransactionState(QueryTransactionStateRequest) returns (QueryTransactionStateResponse) 查询交易的状态。可以针对提交到网络的任何交易调用此方法。返回的交易详情可能因调用而异，因为端点可能会将请求路由到网络和区域内的不同验证器，而验证器在任何给定时间可能都不处于同一轮 ID。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

SubmitOperationalTransaction
rpc SubmitOperationalTransaction(SubmitOperationalTransactionRequest) returns (SubmitOperationalTransactionResponse) 向网络提交操作交易。此方法仅在交易已在网络中的大多数验证器之间复制后返回，或者在交易失败时返回。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

SubmitTransaction
rpc SubmitTransaction(SubmitTransactionRequest) returns (SubmitTransactionResponse) 向网络提交交易。系统会先验证请求的基本正确性。如果验证失败，请求将立即失败。如果验证成功，此方法仅在交易已在网络中的大多数验证器之间复制后返回，或者直到请求失败才返回。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

账号

表示账本中账号的状态。

字段
sequence_number	int64 仅限输出。相应账号的序列号。此数字会随着相应账号发送的每笔交易而递增。
public_key	bytes 仅限输出。与此账号关联的用于签名验证的主公钥。
round_id	int64 仅限输出。所提供的账号信息准确无误的执行轮次（类似于块“高度”）的 ID。
comment	string 仅限输出。创建相应账号时存储的账号注释。
联合字段 account_details。具体详情取决于账号类型。account_details 只能是下列其中一项：
user_details	UserDetails 仅限输出。标准用户账号的详细信息。
account_manager_details	AccountManagerDetails 仅限输出。客户经理账号的详细信息。
token_manager_details	TokenManagerDetails 仅限输出。令牌管理账号的详细信息。
contract_token_manager_details	ContractTokenManagerDetails 仅限输出。合约代币管理器账号的详细信息。
contract_details	ContractDetails 仅限输出。智能合约账号的详细信息。
clearinghouse_details	ClearingHouseDetails 仅限输出。清算机构账号的详细信息。
currency_operator_details	CurrencyOperatorDetails 仅限输出。币种运营商账号的详细信息。
platform_operator_details	PlatformOperatorDetails 仅限输出。平台运营商账号的详细信息。

AccountIdList

账号 ID 列表。

字段
values[]	string 可选。账号 ID 值。

AccountManagerDetails

特定于客户经理的详细信息。

字段
token_manager (deprecated)	Entity 此项已弃用！ 仅限输出。已弃用：请改用 token_manager_id。此账号管理器所创建账号的默认令牌管理器。
num_accounts	int32 仅限输出。相应客户经理创建的账号数量。
token_manager_id	string 仅限输出。相应账号管理器所创建账号的默认令牌管理器的 ID。

AccountStatus

账号的状态。

枚举
ACCOUNT_STATUS_UNSPECIFIED	状态无效。
ACCOUNT_STATUS_ACTIVE	有效状态，表示账号可以执行其角色允许的操作。
ACCOUNT_STATUS_INACTIVE	一种不活跃状态，表示禁止对相应账号进行所有交易。账号的经理仍然可以发送账号管理交易。

ActivateAccount

将账号标记为 ACCOUNT_STATUS_ACTIVE。发件人必须是待激活账号的客户经理。

账号所有者可以恢复账号上角色允许的正常操作。

字段
account (deprecated)	Entity 此项已弃用！ 可选。已弃用：请改用 account_id。要激活的账号的 ID。
account_id	string 可选。要激活的账号的 ID。必须指定 account 或 account_id。该值的长度上限为 60 个字符。

AddRoles

向账号添加指定角色。发件人必须是要修改的账号的客户经理。

字段
account (deprecated)	Entity 此项已弃用！ 可选。已弃用：请改用 account_id。要修改的账号的 ID。
account_id	string 可选。要修改的账号的 ID。必须指定 account 或 account_id。该值的长度上限为 60 个字符。
roles[]	Role 必需。要添加的角色。

AmountValue

表示以某种货币计价的金额。

字段
currency	QualifiedCurrencyValue 必需。金额的币种。
amount_value	int64 必需。相应币种的次要单位数量。

BalanceToSettle

两个令牌管理器之间待结算的余额。

字段
balance_payer (deprecated)	Entity 此项已弃用！ 仅限输出。已弃用：请改用 balance_payer_id。欠款待结的账号。
balance_payer_id	string 仅限输出。欠款待结算的账号的 ID。
balance_receiver (deprecated)	Entity 此项已弃用！ 仅限输出。已弃用：请改用 balance_receiver_id。应结算余额的账号。
balance_receiver_id	string 仅限输出。应结算余额的账号的 ID。
balance	CurrencyValue 仅限输出。要结算的余额。必须为正值。

BoolList

一个布尔值列表。

字段
values[]	bool 可选。布尔值。

烧伤

销毁币种令牌。发送者必须是令牌管理器，并且提供要销毁的令牌的账号还必须对交易进行签名。

预期流程是，令牌管理器将拥有其指定的销毁账号，客户会将令牌转移到该账号，然后令牌会被销毁。或者，客户可以直接签署交易，在这种情况下，交易将充当原子“转移和销毁”交易。

字段
burn_amount	CurrencyValue 必需。要消耗的金额。
payer (deprecated)	Entity 此项已弃用！ 可选。已弃用：请改用 payer_id。提供要销毁的令牌的账号。账号必须启用 ROLE_PAYER。
payer_id	string 可选。提供要销毁的令牌的账号的 ID。付款人账号必须启用 ROLE_PAYER。必须指定 payer 或 payer_id。

ChangeAccountManager

将管理特定账号的责任转移给其他经理。发件人必须是相应账号的当前客户经理，并且新客户经理也必须签署此交易，才能表示同意。

字段
account (deprecated)	Entity 此项已弃用！ 可选。已弃用：请改用 account_id。要更改经理账号的账号的 ID。
account_id	string 可选。要更改经理账号的账号的 ID。必须指定 account 或 account_id。该值的长度上限为 60 个字符。
next_manager (deprecated)	Entity 此项已弃用！ 可选。已弃用：请改用 next_manager_id。新提议的客户经理的 ID。验证要求新经理也签署此交易。
next_manager_id	string 可选。新提议的客户经理的 ID。验证要求新管理员也已签署此交易。必须指定 next_manager 或 next_manager_id。该值的长度上限为 60 个字符。

ClearingHouseDetails

清算中心的具体详细信息。

字段
account_status	AccountStatus 仅限输出。相应账号的状态。
balances[]	BalanceToSettle 仅限输出。此清算机构目前正在跟踪以进行结算的余额。
settlement_mode	SettlementMode 仅限输出。相应清算机构的结算模式。

ClientTransaction

表示由客户端发起的交易。

字段
source (deprecated)	Entity 此项已弃用！ 可选。交易发送者。已弃用：请改用 sender_id。
sender_id	string 可选。发送相应交易的账号的 ID。对于 source 和 sender_id，必须设置其中之一。
signatories[] (deprecated)	Entity 此项已弃用！ 可选。除了发送者之外，已为此交易签名的账号。已弃用：请改用 other_signatory_ids。
other_signatory_ids[]	string 可选。除了发送者之外，已为此交易签名的账号的 ID。
sequence_number	int64 必需。一个从 0 开始的唯一单调递增的数字。 对于同一交易发送者之前向网络提交的每笔交易，此编号都必须增加 1。 请注意，这不包括可能已作为链的一部分提交的任何交易单元，这些交易单元不得设置序列号。但它确实包含交易链本身的发送者。
chained_unit	bool 如果此客户端交易是交易链的一部分，则必须设置为 true。否则，必须将其设置为 false。 这是为了防止旨在成为链式交易一部分的已签名交易被单独提交。
联合字段 kind。特定于客户端交易的消息。kind 只能是下列其中一项：
app (deprecated)	Any 此项已弃用！ 可选。已弃用：请改用特定于消息的字段。特定于客户端交易的消息。应为以下任意一项： TransferPlatformOperator CreateCurrencyOperator TransferCurrencyOperator CreateAccountManager CreateTokenManager CreateClearinghouse IncreaseTokenIssuanceLimit DecreaseTokenIssuanceLimit SettlementRequest Mint Burn CreateAccount DeactivateAccount ActivateAccount AddRoles RemoveRoles ChangeAccountManager Transfer CreateContract GrantContractPermissions InvokeContractMethod CreateContractTokenManager TransferContractTokenManager
operational	Any 可选。运营交易消息。请注意，此消息只能由平台运营商发送。应为以下任意一项： CreateSnapshot
transfer_platform_operator_transaction	TransferPlatformOperator 可选。用于将平台运营商角色转移到新账号的消息。
create_currency_operator_transaction	CreateCurrencyOperator 可选。用于创建新币种运算符的消息。
transfer_currency_operator_transaction	TransferCurrencyOperator 可选。用于将币种运营商角色转移到新账号的消息。
create_clearinghouse_transaction	CreateClearinghouse 可选。用于创建新清算机构的消息。
create_account_manager_transaction	CreateAccountManager 可选。用于创建新客户经理的消息。
create_token_manager_transaction	CreateTokenManager 可选。用于创建与发送请求的运营商的币种相关联的新令牌管理器的消息。
increase_token_issuance_limit_transaction	IncreaseTokenIssuanceLimit 可选。通知网络目标账号已存入准备金，并提高其令牌发行限额。
decrease_token_issuance_limit_transaction	DecreaseTokenIssuanceLimit 可选。通知网络目标账号希望提取储备资金，并降低其代币发行限额。
settlement_request_transaction	SettlementRequest 可选。用于发起结算操作的消息。
mint_transaction	Mint 可选。用于铸造币种令牌并将其转移到账号的消息。
burn_transaction	Burn 可选。用于从账号中销毁币种令牌的消息。
create_account_transaction	CreateAccount 可选。用于创建新用户账号的消息。
deactivate_account_transaction	DeactivateAccount 可选。用于停用用户账号的消息。
activate_account_transaction	ActivateAccount 可选。用于激活用户账号的消息。
add_roles_transaction	AddRoles 可选。用于向账号添加角色的消息。
remove_roles_transaction	RemoveRoles 可选。用于从账号中移除角色的消息。
change_account_manager_transaction	ChangeAccountManager 可选。用于更改账号的客户经理的消息。
transfer_transaction	Transfer 可选。用于将令牌从一个用户账号转移到另一个用户账号的消息。
create_contract_transaction	CreateContract 可选。用于在账本上创建新合约的消息。
grant_contract_permissions_transaction	GrantContractPermissions 可选。用于授予合同权限的消息。
invoke_contract_method_transaction	InvokeContractMethod 可选。用于调用合约方法执行的消息。
create_contract_token_manager_transaction	CreateContractTokenManager 可选。用于创建与发送请求的运营商的币种相关联的新令牌管理器的消息。
transfer_contract_token_manager_transaction	TransferContractTokenManager 可选。用于将币种的令牌管理器角色从一个账号转移到另一个账号的消息。
remove_signing_public_key_transaction	RemoveSigningPublicKey 可选。用于移除账号签名密钥的消息。
replace_signing_public_key_transaction	ReplaceSigningPublicKey 可选。用于替换账号签名密钥的消息。
chain	TransactionChain 可选。包含多个按顺序执行的交易单元的交易链的消息。

ContractDetails

智能合约特有的详细信息。

字段
owner (deprecated)	Entity 此项已弃用！ 仅限输出。已弃用：请改用 owner_id。合约的所有者。
owner_id	string 仅限输出。合同所有者的 ID。
code	bytes 仅限输出。序列化的合约代码。
contract_fields	Fields 仅限输出。相应合同的合同字段（字段名称 -> 值）。
currency_balances	map<string, CurrencyValue> 仅限输出。合约持有的币种余额（币种运算符 -> 余额）。

ContractPermission

可授予合约的权限集。预计将来会添加更多值。

枚举
CONTRACT_PERMISSION_UNSPECIFIED	权限无效。
CONTRACT_PERMISSION_STORAGE	允许合约读取和写入授予权限的账号所拥有的存储空间。合约只能读取和写入之前写入的属性。 请注意，这不允许合约读取或写入由其他合约管理的数据；也不允许合约直接更新其他账号属性（例如，账号以其本币表示的余额）。

ContractTokenManagerDetails

特定于 Contract Token Manager 的详细信息。

字段
issuance_limit	CurrencyValue 仅限输出。相应合约令牌管理器可为之提供支持的令牌数量。 由于合约代币管理器无法增加或减少其发行限额，因此该值应等于 issued_tokens。
issued_tokens	CurrencyValue 仅限输出。相应合约代币管理器提供支持的代币数量（即其总负债）。 这等于合约中持有的相应币种的所有余额之和，加上结算矩阵中的净头寸。
previous_contract_token_manager_id	string 仅限输出。相应币种之前合约令牌管理器的账号 ID。这样便形成了一个可用于发现所有先前管理者的审核跟踪记录。如果这是相应币种的第一个合约令牌管理器，则此字段为空。
account_status	AccountStatus 仅限输出。相应账号的状态。

CreateAccount

创建新的用户账号。发件人必须是客户经理。

如果交易成功，则会在最终交易的 TransactionCertificate 中以事件的形式返回新创建的账号的 ID。

字段
public_key	bytes 必需。账号所有者的公钥。请注意，这不是发送者的公钥。这是新账号所有者的公钥，将存储在账本中。它将用于验证从所创建账号发出的交易的签名。 公钥的格式由 key_format 字段定义。视为公开信息。
key_format	KeyFormat 可选。不可变。公钥的密钥格式。如果未指定，则默认为采用 Tink 序列化格式的二进制序列化密钥集。视为公开信息。
roles[]	Role 可选。要向相应账号授予的角色列表。
account_status	AccountStatus 可选。要创建的账号的状态。默认情况下，新创建的账号的状态为 ACCOUNT_STATUS_ACTIVE。
account_comment	string 可选。不可变。一个不透明的注释字段，系统不会对其进行解读，但会将其存储在账号的账本中。视为公开信息。长度上限为 128 个字符。可以留空。创建后，此字段便不可更改。
token_manager (deprecated)	Entity 此项已弃用！ 可选。已弃用：请改用 token_manager_id。相应账号的令牌管理器。此字段是可选字段，如果未提供，系统将使用与账号管理器（即此交易的发送者）关联的默认令牌管理器。
token_manager_id	string 可选。相应账号的令牌管理器的 ID。此字段为可选字段，如果未提供，系统将使用与账号管理器（即此交易的发送者）关联的默认令牌管理器。该值的长度上限为 60 个字符。

CreateAccountManager

创建新的客户经理。汇款方必须是货币运营商。

如果交易成功，则会在最终交易的 TransactionCertificate 中以事件的形式返回新创建的账号的 ID。

字段
public_key	bytes 必需。新账号管理器的公钥。请注意，此密钥不是运营商的公钥。此公钥将与账号管理器相关联，并存储在账本中。它将用于验证来自客户经理账号的交易的签名。 公钥的格式由 key_format 字段定义。视为公开信息。
key_format	KeyFormat 可选。不可变。公钥的密钥格式。如果未指定，则默认为采用 Tink 序列化格式的二进制序列化密钥集。视为公开信息。
default_token_manager (deprecated)	Entity 此项已弃用！ 可选。已弃用：请改用 default_token_manager_id。此经理账号将创建的账号的默认令牌管理器。
default_token_manager_id	string 可选。相应经理账号将创建的账号的默认令牌管理器的 ID。该值的长度上限为 60 个字符。
account_comment	string 可选。不可变。一个不透明的注释字段，系统不会对其进行解读，但会将其存储在账号的账本中。视为公开信息。长度上限为 128 个字符。可以留空。创建后，此字段便不可更改。

CreateClearinghouse

创建新的清算机构。汇款方必须是货币运营商。

如果交易成功，则会在最终交易的 TransactionCertificate 中以事件的形式返回新创建的账号的 ID。

字段
public_key	bytes 必需。新清算机构的公钥。请注意，此密钥不是运营商的公钥。此公钥将与清算机构相关联，并存储在账本中。它将用于验证清算机构账号发出的交易的签名。 公钥的格式由 key_format 字段定义。视为公开信息。
key_format	KeyFormat 可选。不可变。公钥的密钥格式。如果未指定，则默认为采用 Tink 序列化格式的二进制序列化密钥集。视为公开信息。
account_comment	string 可选。不可变。一个不透明的注释字段，系统不会对其进行解读，但会将其存储在账号的账本中。视为公开信息。长度上限为 128 个字符。可以留空。创建后，此字段便不可更改。
settlement_mode	SettlementMode 必需。相应清算机构的结算模式。必需。视为公开信息。

CreateContract

在账本上存储合约。

字段
contract_bytes	bytes 序列化合同字节。
arguments (deprecated)	map<string, Value> 此项已弃用！ 可选。不可变。已弃用：请改用 init_arguments。__init__ 方法的实参。
init_arguments	map<string, Value> 可选。不可变。包含 __init__ 方法的实参。
contract_comment	string 可选。不可变。一个不透明的注释字段，不会被系统解读，但会存储在合约的账本中。视为公开信息。长度上限为 128 个字符。可以留空。创建后，此字段便不可更改。

CreateContractTokenManager

创建与发送请求的运营商的币种相关联的新合约令牌管理器。汇款方必须是货币运营商。新创建的合同令牌管理器默认处于有效状态。如果必须替换合同令牌管理器，则应改为发送 TransferContractTokenManager 交易。如果存在与同一币种关联的其他合同令牌管理器，此交易将失败。

与常规令牌管理器不同，合约令牌管理器不允许执行铸造或销毁等交易。不过，他们可以参与结算操作。

如果交易成功，则会在最终交易的 TransactionCertificate 中以事件的形式返回新创建的账号的 ID。

字段
public_key	bytes 必需。新合约令牌管理器的公钥。请注意，此密钥不是运营商的公钥。此公钥将与合约令牌管理器相关联，并存储在账本中。它将用于验证来自合约令牌管理器账号的交易的签名。 公钥的格式由 key_format 字段定义。视为公开信息。
account_comment	string 可选。不可变。一个不透明的注释字段，系统不会对其进行解读，但会将其存储在账号的账本中。视为公开信息。长度上限为 128 个字符。可以留空。创建后，此字段便不可更改。
key_format	KeyFormat 可选。不可变。公钥的密钥格式。如果未指定，则默认为采用 Tink 序列化格式的二进制序列化密钥集。视为公开信息。

CreateCurrencyOperator

创建新的币种运算符。发送者必须是平台运营商。

如果交易成功，则会在最终交易的 TransactionCertificate 中以事件的形式返回新创建的账号的 ID。

此交易必须在系统中引入新的币种。如果指定的币种已存在，则此交易将失败。如果必须替换币种运算符，则应改为发送 TransferCurrencyOperator 交易。

字段
public_key	bytes 必需。新币种运营商的公钥。此公钥将与币种运营商相关联，并存储在账本中。它将用于验证运营商账号发出的交易的签名。 公钥的格式由 key_format 字段定义。视为公开信息。
key_format	KeyFormat 可选。不可变。公钥的密钥格式。如果未指定，则默认为采用 Tink 序列化格式的二进制序列化密钥集。视为公开信息。
account_comment	string 可选。不可变。一个不透明的注释字段，系统不会对其进行解读，但会将其存储在账号的账本中。视为公开信息。长度上限为 128 个字符。可以留空。创建后，此字段便不可更改。
currency (deprecated)	string 此项已弃用！ 可选。已弃用：请改用 currency_code。与相应运营商关联的法定货币，以 3 个大写字母的 ISO 4217 代码表示。视为公开信息。
currency_code	string 可选。与相应运营商关联的法定货币，以 3 个大写字母的 ISO 4217 代码表示。视为公开信息。

CreateSnapshot

此类型没有字段。

触发创建网络快照的操作。发送者必须是平台运营商。

CreateTokenManager

创建与发送请求的运营商的币种相关联的新令牌管理器。汇款方必须是货币运营商。

如果交易成功，则会在最终交易的 TransactionCertificate 中以事件的形式返回新创建的账号的 ID。

字段
public_key	bytes 必需。新令牌管理器的公钥。请注意，此密钥不是运营商的公钥。此公钥将与令牌管理器相关联，并存储在账本中。它将用于验证来自令牌管理器账号的交易的签名。 公钥的格式由 key_format 字段定义。视为公开信息。
key_format	KeyFormat 可选。不可变。公钥的密钥格式。如果未指定，则默认为采用 Tink 序列化格式的二进制序列化密钥集。视为公开信息。
account_comment	string 可选。不可变。一个不透明的注释字段，系统不会对其进行解读，但会将其存储在账号的账本中。视为公开信息。长度上限为 128 个字符。可以留空。创建后，此字段便不可更改。

CurrencyOperatorDetails

特定于币种运算符的详细信息。

字段
currency (deprecated)	string 此项已弃用！ 仅限输出。已弃用：请改用 currency_code。与相应账号关联的币种，以 3 个字母的 ISO 4217 代码表示。
currency_code	string 仅限输出。与相应账号关联的币种的 ID，以 3 个字母的 ISO 4217 代码表示。
account_status	AccountStatus 仅限输出。相应账号的状态。
previous_entity_id (deprecated)	Entity 此项已弃用！ 仅限输出。已弃用：请改用 previous_currency_operator_id。之前负责管理币种操作员的角色并将币种操作员角色所有权转移给此账号的币种操作员。如果这是相应币种的第一个币种运算符，则此字段为空。
previous_currency_operator_id	string 仅限输出。之前将币种运营商角色的所有权转移到此账号的币种运营商的 ID。如果这是相应币种的第一个币种运算符，则此字段为空。
platform_operator_entity_id (deprecated)	Entity 此项已弃用！ 仅限输出。已弃用：请改用 platform_operator_id。创建此币种运算符的平台运营商。
platform_operator_id	string 仅限输出。创建相应币种运营商的平台运营商的 ID。
contract_token_manager (deprecated)	Entity 此项已弃用！ 仅限输出。已弃用：请改用 contract_token_manager_id。与此币种运算符关联的合同令牌管理器。
contract_token_manager_id	string 仅限输出。与此币种运营商关联的合约令牌管理器的 ID。
clearinghouse_id	string 仅限输出。与相应币种运营商关联的清算机构的 ID。

CurrencyValue

表示货币金额（即资金）。请注意，此消息中不包含币种。相关币种由发送交易的账号决定。每个账号都关联着一种唯一的不可变币种。

字段
value	int64 必需。相应币种的次要单位数量。 这种最小有效面额称为“次级单位”，在 ISO 4217 中指定。例如，对于美元，该值将为美分数；对于英镑，该值将为便士数。对于没有次级单位的日元，该值将是日元的数量。

DeactivateAccount

将账号标记为 ACCOUNT_STATUS_INACTIVE。发送者必须是要停用的账号的客户经理。

这意味着，无论账号所有者拥有何种角色，都无法在该账号中进行任何交易。

字段
account (deprecated)	Entity 此项已弃用！ 可选。已弃用：请改用 account_id。要停用的账号的 ID。
account_id	string 可选。要停用的账号的 ID。必须指定 account 或 account_id。该值的长度上限为 60 个字符。

DecreaseTokenIssuanceLimit

通知网络目标账号希望提取储备资金，并降低其令牌发行限额。发件人必须是清算机构账号。

请注意，只有在成功完成此交易后，才能提取预留资金。这是必需的，因为交易可能会失败（例如，如果铸造的金额已高于请求的减少限额）。

字段
token_manager (deprecated)	Entity 此项已弃用！ 可选。已弃用：请改用 token_manager_id。要降低铸造限额的机构账号的 ID。此账号必须是令牌管理器，交易才能有效。
token_manager_id	string 可选。要降低铸造限额的机构账号的 ID。此账号必须是令牌管理器，交易才能有效。必须指定 token_manager_id（首选）或 token_manager（已弃用）。
amount	CurrencyValue 必需。要降低的限额。金额必须为正数。如果减少后的限额低于当前已发行的令牌，交易将失败。

DictList

字典列表。

字段
values[]	DictValue 可选。DictValue 值。所有嵌套字典都必须具有相同的具体类型。

DictValue

索引将键映射到值。例如，keys[0] 键映射到 values[0]。

字段
联合字段 keys。每个键只能是一种类型。keys 只能是下列其中一项：
bool_keys	BoolList 可选。布尔值键的列表。
string_keys	StringList 可选。字符串键的列表。
int64_keys	Int64List 可选。int64 键的列表。
account_id_keys	AccountIdList 可选。账号 ID 键的列表。
联合字段 values。每个值只能是一种类型。values 只能是下列其中一项：
bool_values	BoolList 可选。布尔值列表。
string_values	StringList 可选。字符串值的列表。
int64_values	Int64List 可选。一个 int64 值列表。
dict_values	DictList 可选。值是嵌套字典的列表。

端点

表示 Universal Ledger 端点。

字段
name	string 标识符。端点的资源名称。格式：projects/{project}/locations/{location}/endpoints/{endpoint}

实体

Universal Ledger 网络中的实体。所有账号都与某个实体相关联。实体 ID（也常称为账号 ID）在整个广告资源网中是唯一且不可变的。

字段
id	string 仅限输出。分配给实体的 ID。此 ID 由网络在创建账号时分配。

EventDetails

表示状态事件的其他详细信息。

字段
联合字段 event_details。活动的详细信息。event_details 只能是下列其中一项：
execution_details	ExecutionDetails 仅限输出。执行事件的其他详细信息。

EventType

表示交易处理过程中事件的类型，由请求路由到的验证器观察到。

枚举
EVENT_TYPE_UNSPECIFIED	未知或未指定的事件。
EVENT_TYPE_RECEIVED	交易由相应验证器直接从客户端接收。
EVENT_TYPE_BROADCASTED	交易由此广播给其他验证者。
EVENT_TYPE_ORDERED	交易由相应验证器排序并安排执行。
EVENT_TYPE_EXECUTION_STARTED	事务的执行已开始。
EVENT_TYPE_EXECUTION_COMPLETED	交易的执行已完成。
EVENT_TYPE_FINALIZED	相应交易已由该验证者最终确定。

ExecutionDetails

执行事件的其他详细信息。

字段
round_id	int64 仅限输出。执行事件发生的轮次 ID。

字段

一个字段（字段名称 -> 值）映射，用于表示合同字段或账号字段。

字段
fields	map<string, Value> 仅限输出。字段名称到其值的映射。

GetEndpointRequest

针对 GetEndpoint 的请求消息。

字段
name	string 必需。要检索的端点的名称。格式：projects/{project}/locations/{location}/endpoints/{endpoint}

GrantContractPermissions

通过交易发送者向合约授予权限。如果指定了 delegate_contract_id，则权限和相应存储空间将仅授予 delegate_contract_id 合约，而不是发送者。

请注意，不支持撤消权限。

字段
contract (deprecated)	Entity 此项已弃用！ 可选。已弃用：请改用 contract_id。要授予权限的合同的 ID。
contract_id	string 可选。要授予权限的合同的 ID。必须指定 contract 或 contract_id。
permissions[]	ContractPermission 要授予的权限。
delegate_contract_id	string 可选。要授予权限的合同的 ID。交易发送者必须是相应合约的所有者。

IncreaseTokenIssuanceLimit

用于代币发行和铸造的交易。通知网络目标账号已存入准备金，并提高其令牌发行限额。发件人必须是清算机构账号。

字段
token_manager (deprecated)	Entity 此项已弃用！ 可选。已弃用：请改用 token_manager_id。要提高铸造限额的机构账号的 ID。此账号必须是令牌管理器，交易才能有效。
token_manager_id	string 可选。要提高铸造限额的机构账号的 ID。此账号必须是令牌管理器，交易才能有效。必须指定 token_manager 或 token_manager_id。
amount	CurrencyValue 必需。要提高的限额。金额必须为正数。

Int64List

一个 int64 列表。

字段
values[]	int64 可选。int64 值。

InvokeContractMethod

调用合约方法的执行。

字段
contract (deprecated)	Entity 此项已弃用！ 可选。已弃用：请改用 contract_id。要运行的合约的 ID。
contract_id	string 可选。要运行的合约的 ID。必须指定 contract 或 contract_id。
method_name	string 要运行的方法的名称。
arguments (deprecated)	map<string, Value> 此项已弃用！ 可选。不可变。已弃用：请改用 method_arguments。方法的实参。
method_arguments	map<string, Value> 可选。不可变。包含要传递给方法的实参。
payment	CurrencyValue 待付金额。调用可付款方法时必须大于零；对于不可付款方法，则必须为零。

KeyFormat

指定公钥的提供格式。将来可能会向此枚举添加新值。

枚举
KEY_FORMAT_UNSPECIFIED	密钥格式未指定。此值无效，不应使用。
KEY_FORMAT_TINK_WIRE_FORMAT	采用 Tink 传输格式的二进制序列化密钥集。
KEY_FORMAT_PEM_EC_P256_SHA256	使用 P-256 曲线和 SHA256 摘要的 PEM 编码椭圆曲线签名密钥。签名必须以 DER 格式提供。

KeySlot

可用于存放账号密钥的 slot 的标识符。

枚举
KEY_SLOT_UNSPECIFIED	未指定密钥槽。
KEY_SLOT_PRIMARY	主键 slot。
KEY_SLOT_ALTERNATE	备用密钥槽。

ListEndpointsRequest

ListEndpoints 的请求消息。

字段
parent	string 必需。拥有此端点集合的父级。格式：projects/{project}/locations/{location}
page_size	int32 可选。要返回的端点数量上限。服务返回的值可能小于此值。如果未指定，则最多返回 50 个端点。最大值为 1,000；大于 1,000 的值将被强制转换为 1,000。
page_token	string 可选。从之前的 ListEndpoints 调用接收的页面令牌。利用其进行后续页面检索。

ListEndpointsResponse

针对 ListEndpoints 的响应消息。

字段
endpoints[]	Endpoint 指定项目和位置的端点。
next_page_token	string 可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。

MerkleTree

一种具有根节点加密摘要的 Merkle 树。

字段
root_hash_hex (deprecated)	string 此项已弃用！ 仅限输出。根节点的加密摘要。已弃用：请改用 root_digest_hex。
root_digest_hex	string 仅限输出。根节点摘要的十六进制表示形式。格式：一个 64 字符的十六进制字符串。
num_transactions	int64 仅限输出。树中的交易数量。

Mint

铸造币种令牌并将其转移到指定账号。发件人必须是令牌管理器。

字段
mint_amount	CurrencyValue 必需。要铸造的金额。该金额必须确保令牌管理器铸造的令牌总数不超过铸造限额。如果金额高于此值，则必须拒绝交易
beneficiary (deprecated)	Entity 此项已弃用！ 可选。已弃用：请改用 beneficiary_id。铸造的金额应转入的账号。受益人账号必须已启用 ROLE_RECEIVER。
beneficiary_id	string 可选。铸造金额应转移到的账号的 ID。接收账号必须已启用 ROLE_RECEIVER。必须指定 beneficiary 或 beneficiary_id。

NoneValue

用于表示 None 值的单例枚举。

枚举
NONE_VALUE_UNSPECIFIED	None 值。

PlatformOperatorDetails

特定于平台运营商的详细信息。

字段
account_status	AccountStatus 仅限输出。相应账号的状态。
previous_entity_id (deprecated)	Entity 此项已弃用！ 仅限输出。已弃用：请改用 previous_platform_operator_id。之前将平台运营者角色的所有权转移给此账号的平台运营者。如果这是第一个平台运营商，则此字段为空。
previous_platform_operator_id	string 仅限输出。之前将平台操作员角色的所有权转移给此账号的平台操作员的 ID。如果这是第一个平台运营商，则此字段为空。

ProofOfInclusion

用于证明交易效应已纳入世界状态的证书。

字段
transaction_certificate	TransactionCertificate 仅限输出。特定轮次中包含交易效应的证书。
round_certificate	RoundCertificate 仅限输出。轮次执行的证书。
path_to_round_root[]	MerkleTreeNode 仅限输出。执行轮次中包含交易效应的加密证明。 它以从给定叶（交易摘要）到执行轮次的根的路径的形式给出。该路径表示为（左子节点、右子节点）对的列表，其中第一个对是给定叶节点的父节点的左子节点和右子节点。例如，假设 Merkle 树是使用 8 个叶摘要 [t0, t1, t2, t3, t4, t5, t6, t7] 构建的，其结构如下： _____root_digest____ | | __ h20__ __h21__ | | | | h10 h11 h12 h13 | | | | | | | | t0 t1 t2 t3 t4 t5 t6 t7 在此处，t0 的 path_to_round_root 将包含：[(t0, t1), (h10, h11), (h20, h21)]。 可以连续计算每个路径节点的 SHA-256 摘要，以验证路径的摘要是否生成与 round_certificate.merkle_tree.root_digest_hex 相同的值。因此，验证了相应叶是否包含在相应轮次的 Merkle 树中。

MerkleTreeNode

表示 Merkle 树路径中的节点。

字段
left_child_hash_hex (deprecated)	string 此项已弃用！ 仅限输出。节点的左子节点的摘要的十六进制表示形式。已弃用：请改用 left_child_digest_hex。
right_child_hash_hex (deprecated)	string 此项已弃用！ 仅限输出。节点的右子级摘要的十六进制表示形式。已弃用：请改用 right_child_digest_hex。
left_child_digest_hex	string 仅限输出。节点的左子节点的摘要的十六进制表示形式。格式：一个 64 字符的十六进制字符串。
right_child_digest_hex	string 仅限输出。节点的右子级摘要的十六进制表示形式。格式：一个 64 字符的十六进制字符串。

QualifiedCurrencyValue

表示账本上的币种，由其币种运算符限定。

字段
operator_id	string 必需。管理相应币种的货币运营商 ID。

QueryAccountRequest

QueryAccount 的请求消息。

字段
endpoint	string 必需。用于处理请求的端点。格式：projects/{project}/locations/{location}/endpoints/{endpoint} 位置是区域。
account_id	string 必需。要获取其相关信息的账号 ID。该值的长度上限为 60 个字符。
round_id	int64 可选。要请求数据的执行轮次（类似于块“高度”）的 ID。返回的账号信息将准确反映此执行轮次的世界状态。如果未指定，则使用服务验证器已知的最新最终确定轮次。给定轮次 ID 的状态始终是一致且规范的。

QueryAccountResponse

针对 QueryAccount 的响应消息。

字段
account	Account 账号信息，以及获取该信息时的高度。

QueryDataRequest

针对 QueryData 的请求消息。

字段
endpoint	string 必需。用于处理请求的端点。格式：projects/{project}/locations/{location}/endpoints/{endpoint} 位置是区域。
serialized_signed_query_request	bytes 必需。用于查询 Universal Ledger 网络的序列化 protobuf SignedQueryRequest。

QueryDataResponse

针对 QueryData 的响应消息。

字段
redacted_fields[]	RedactedField 指明因权限限制而从响应中隐去了哪些字段。
联合字段 kind。特定于查询的结果。kind 只能是下列其中一项：
account	Account 账号信息（如果查询是针对账号的）。
transaction_state	TransactionState 交易的状态（如果查询的是交易）。

QueryTransactionStateRequest

针对 QueryTransactionState 的请求消息。

字段
endpoint	string 必需。用于处理请求的端点。格式：projects/{project}/locations/{location}/endpoints/{endpoint} 位置是区域。
transaction_digest_hex	string 必需。要获取状态的交易 ID。

QueryTransactionStateResponse

针对 QueryTransactionState 的响应消息。

字段
transaction_attempts[]	TransactionAttempt 每个已知交易提交给处理请求的验证器的条目。

RedactedField

有关响应中已遮盖字段的信息。

字段
redacted_path	FieldMask 仅限输出。从载荷中编辑掉的完全限定字段路径。
reason	string 仅限输出。有关字段为何被遮盖的人类可读说明。
reason_code	Code 仅限输出。用于说明字段被隐去的原因的机器可读代码。

RemoveRoles

从账号中移除指定角色。发件人必须是要修改的账号的客户经理。

字段
account (deprecated)	Entity 此项已弃用！ 可选。已弃用：请改用 account_id。要修改的账号的 ID。
account_id	string 可选。要修改的账号的 ID。必须指定 account 或 account_id。该值的长度上限为 60 个字符。
roles[]	Role 必需。要移除的角色。

RemoveSigningPublicKey

从指定 slot 中移除账号签名密钥。另一个 slot 不得为空，且必须包含用于对 ClientTransaction 进行签名的密钥。

字段
key_slot	KeySlot 必需。要从中移除密钥的密钥槽。如果此值已为空，则交易将失败。

ReplaceSigningPublicKey

替换指定 slot 中的账号签名密钥。另一个 slot 不得为空，且必须包含用于对 ClientTransaction 进行签名的密钥。

字段
key_slot	KeySlot 必需。我们要替换密钥的密钥槽。
new_public_key	bytes 必需。将替换指定 slot 中的公钥的新公钥。 公钥的格式由 new_key_format 字段定义。视为公开信息。
new_key_format	KeyFormat 必需。新公钥的密钥格式。如需查看支持的格式列表，请参阅 KeyFormat 的定义。视为公开信息。

角色

常规角色集。

枚举
ROLE_UNSPECIFIED	角色无效。
ROLE_PAYER	允许账号发起付款交易的角色。
ROLE_RECEIVER	允许账号接收付款的角色。
ROLE_CONTRACT_CREATOR	允许账号部署合约的角色。
ROLE_CONTRACT_PARTICIPANT	允许账号与已部署的合约进行交互的角色。

RoundCertificate

特定验证者执行一轮的证书。

字段
round_id	int64 仅限输出。证书所针对的轮次的 ID。
validator_id	string 仅限输出。人类可读的验证器标识符。用于查找验证 validator_signatures 所用的公钥。
round_state_checksum_hex	string 仅限输出。应用此轮效果后，世界状态的同态摘要的十六进制表示形式。
round_delta_checksum_hex	string 仅限输出。相应轮次的汇总交易效应的同态摘要的十六进制表示形式。
merkle_tree	MerkleTree 仅限输出。以相应轮次为根节点，以（在相应轮次中执行的）交易批次为叶节点的 Merkle 树。
validator_signatures[]	bytes 可选。验证器的签名。此签名基于相应记录的前一个载荷的摘要。
is_finalized	bool 仅限输出。一个布尔值，用于指示相应轮次是否已最终确定，即是否有足够多的验证者已使用同一证书对相应轮次进行认证。

SettlementMode

清算机构的结算模式。

枚举
SETTLEMENT_MODE_UNSPECIFIED	结算模式未指定。此值无效，不应使用。
SETTLEMENT_MODE_DEFERRED	清算机构负责跟踪链下资金的所有权，并定期发布 SettlementRequest 交易，以使账本上的相应余额保持同步。
SETTLEMENT_MODE_INSTANT	清算机构维护一个单一的资金池，而账本则充当令牌管理器之间资金分配的黄金来源。此结算模式也可描述为“即时总额结算”。

SettlementRequest

在两个令牌管理器之间启动结算操作。发件人必须是清算机构账号。

在清算机构持有令牌管理器资金的延迟结算 SettlementMode 中，这是唯一需要发送的交易，用于在两个令牌管理器之间执行结算。

字段
payer (deprecated)	Entity 此项已弃用！ 可选。不可变。已弃用：请改用 payer_id。需要进行资金转移的方的账号 ID。
payer_id	string 可选。不可变。需要进行资金转移的方的账号 ID。必须指定 payer 或 payer_id。
beneficiary (deprecated)	Entity 此项已弃用！ 可选。不可变。已弃用：请改用 beneficiary_id。需要付款的方的账号 ID。
beneficiary_id	string 可选。不可变。将接收资金的当事方的账号 ID。必须指定 beneficiary 或 beneficiary_id。
balance	CurrencyValue 必需。不可变。payer 账号需要在账本上转移到 beneficiary 账号的已发行令牌余额。
round_id	int64 必需。不可变。计算此结算金额时的轮次 ID。

SignedTransaction

包含附加签名的交易。如需提交交易，应将此消息序列化并包含在 SubmitTransactionRequest 中。

字段
serialized_client_transaction	bytes 必需。包含交易详情的序列化 ClientTransaction。
sender_signature	bytes 必需。交易发送者的签名。 签名应通过使用自己的私钥对 serialized_client_transaction 字节进行签名来计算。 对于交易链，要签名的字节计算为以下各项的串联：- 整个链的序列化客户端交易的摘要。- 链中每个单元的序列化签名交易的摘要，按它们在链中出现的顺序排列。摘要使用 SHA-256 计算得出。
sender_signing_key_slot	KeySlot 可选。用于为交易签名的发送者的密钥槽。如果未指定，则使用发件人账号的主卡位。
other_signatures[]	bytes 可选。列为额外交易签署人的账号的签名。这些签名的数量和顺序必须与 ClientTransaction 中的 signatories 字段一致。 待签名的字节与 sender_signature 的字节相同，每位签署者都应使用自己的私钥进行签名。 其他签署人的数量和身份取决于具体的交易类型。对于交易链，每个作为链中某个单元的发送者或签署者的账号都需要一个签名。
other_signing_key_slots[]	KeySlot 可选。列为额外交易签署者的账号的密钥槽。如果设置，这些密钥槽的数量和顺序必须与 SignedTransaction 中的 other_signatures 字段一致。如果未指定，则默认为每个账号的主要广告资源。

StatusEvent

表示单个验证器在处理交易时观察到的事件。

报告的所有值都是从处理请求的验证器的角度来看的，可能与其他验证器的视图不同。

字段
event_time	Timestamp 仅限输出。相应事件被此验证器记录的时间。
event_type	EventType 仅限输出。事件的类型。
event_details	EventDetails 仅限输出。与活动相关的其他详细信息。

StringList

字符串列表。

字段
values[]	string 可选。字符串值。

SubmitOperationalTransactionRequest

针对 SubmitOperationalTransaction 的请求消息。

字段
endpoint	string 必需。用于处理请求的端点。格式：projects/{project}/locations/{location}/endpoints/{endpoint} 位置是区域。
serialized_signed_operational_transaction	bytes 必需。要提交给账本的序列化 protobuf SignedTransaction。封装的客户端交易必须是运营交易，并且发送者必须是平台运营商。使用序列化格式可确保所有验证器计算出的交易 ID 都相同，即序列化字节的 SHA-256 摘要。

SubmitOperationalTransactionResponse

针对 SubmitOperationalTransaction 的响应消息。

字段
transaction_digest_hex	string 唯一表示提交的操作交易的标识符。它是 serialized_signed_operational_transaction 的 SHA-256 摘要的十六进制表示形式。提供此交易 ID 的目的是让客户端能够跟踪交易，而无需自行实现哈希处理逻辑。该标识符可直接用于后续 API 调用，例如用于查询交易状态。

SubmitTransactionRequest

针对 SubmitTransaction 的请求消息。

字段
endpoint	string 必需。用于提交交易的端点。格式：projects/{project}/locations/{location}/endpoints/{endpoint} 位置是区域。
serialized_signed_transaction	bytes 必需。要提交给账本的序列化 protobuf SignedTransaction。使用序列化格式可确保所有验证器计算出的交易 ID 都是序列化字节的 SHA-256 摘要。

SubmitTransactionResponse

针对 SubmitTransaction 的响应消息。

字段
transaction_digest_hex	string 唯一表示提交的交易的标识符。它是 serialized_signed_transaction 的 SHA-256 摘要的十六进制表示形式。提供此交易 ID 的目的是让客户端能够跟踪交易，而无需自行实现哈希处理逻辑。该标识符可直接用于后续 API 调用，例如用于查询交易状态。

TokenManagerDetails

特定于令牌管理器的详细信息。

字段
issuance_limit	CurrencyValue 仅限输出。相应令牌管理器允许创建的令牌数量。
issued_tokens	CurrencyValue 仅限输出。相应令牌管理器铸造的令牌数量。铸造时，此数值会增加；销毁时，此数值会减少。

TransactionAttempt

尝试提交的交易的状态。

字段
status	TransactionStatus 仅限输出。交易尝试的当前状态。
proof_of_inclusion	ProofOfInclusion 仅限输出。将交易效应纳入世界状态的证书。仅当状态为 FINALIZED 时提供。
status_events[]	StatusEvent 仅限输出。为交易尝试记录的已排序状态事件。

TransactionStatus

交易尝试的状态。

枚举
TRANSACTION_STATUS_UNSPECIFIED	未知或未初始化状态。
PENDING	此验证器已知此交易，但尚未最终确定。
FINALIZED	交易已最终确定。其效果已永久记录在区块链上，无法撤消。

TransactionCertificate

一轮中特定交易的执行证书。

字段
transaction_digest_hex	string 仅限输出。相应证书所对应的交易的 ID。
round_id	int64 仅限输出。相应交易的执行轮次的 ID。
transaction_effects	TransactionEffects 仅限输出。交易执行带来的影响。
events[]	TransactionEvent 仅限输出。交易产生的事件。
transaction_effects_state_checksum_hex	string 仅限输出。效应的同态校验和。以十六进制字符串形式编码的 2048 字节值。
certification_results_digest_hex	string 仅限输出。所有先前字段的加密摘要（按顺序）。用于为纳入证明构建 Merkle 树。

TransactionChain

包含多个按顺序执行的交易单元的交易链。

各单元将按列出的顺序依次执行。如果所有单元都成功，则它们的累积效应将以原子方式提交到世界状态。否则，如果其中任何一个失败，整个链都会失败，并且不会应用任何效果。

字段
units[]	bytes 链条的各个单元。每个单元都必须是序列化的 SignedTransaction。 请注意，需要序列化字节才能确定要为链本身签名的字节。

TransactionEffect

表示某个交易对世界状态的更新。

如果它具有 delta_val，则假定为应用于给定键上先前存储的值的增量（整数偏移量）。在这种情况下，new_val 和 old_val 应为空。

否则，系统会假定该广告至少包含一个 old_val 或 new_val（或两者兼有）。空 old_val 表示已插入值。空 new_val 表示相应值已被删除。

字段
key	bytes 仅限输出。已更新的世界状态中的键。
old_val	bytes 仅限输出。执行交易之前键的值。
new_val	bytes 仅限输出。交易执行后键的值。
delta_val	int64 仅限输出。应用于之前存储的值的整数偏移量。

TransactionEffects

执行交易的效果。

字段
status	TransactionStatus 仅限输出。交易执行的最终状态。
effects[] (deprecated)	TransactionEffect 此项已弃用！ 仅限输出。已弃用：请改为查询网络状态，以确定世界状态的任何变化。交易在世界状态中的效果。

TransactionEvent

交易产生的事件。

字段
type	string 仅限输出。事件的类型。类型为 transaction_output 的特殊事件包含交易产生的输出，例如新创建的账号的账号 ID。
attributes[]	EventAttribute 仅限输出。事件属性，以任意键值对的形式表示。

EventAttribute

单个属性，以键值对的形式表示。

字段
key	string 仅限输出。属性的键。
value	string 仅限输出。属性的值。

TransactionState

交易的状态。

字段
transaction_attempts[]	TransactionAttempt 每个已知交易提交给处理请求的验证器的条目。

TransactionStatus

表示交易执行的状态。

字段
code	int32 仅限输出。状态代码，一个数值，其含义由相应的 gRPC 状态代码定义。
message	bytes 仅限输出。错误消息（如果有）。仅当代码不是 OK 时才设置。这是编码为 UTF-8 字节的字符串。以字节形式存储，以防止出现任何编码确定性问题。

转移

将代币从一个用户账号转移到另一个用户账号。发件人必须是常规用户账号，而不是令牌管理器或账号管理器等具有特殊权限的账号。

此外，交易发送方必须启用 ROLE_PAYER，而接收方必须启用 ROLE_RECEIVER。

字段
beneficiary (deprecated)	Entity 此项已弃用！ 可选。已弃用：请改用 beneficiary_id。接收令牌的账号。
beneficiary_id	string 可选。接收令牌的账号的 ID。必须指定 beneficiary 或 beneficiary_id。
amount	CurrencyValue 必需。要转移的金额。金额必须为正数。

TransferContractTokenManager

将合约令牌管理器的所有权转移到新账号。发件人必须是相应币种的当前货币运营商。

如果交易成功，则停用相应币种的当前合约令牌管理器，并将新创建的账号的 ID 作为最终交易的 TransactionCertificate 中的事件返回。

字段
public_key	bytes 必需。新合约令牌管理器的公钥。请注意，此密钥不是运营商的公钥。这是新合约令牌管理器的公钥，将存储在账本上。它将用于验证来自合约令牌管理器账号的交易的签名。 公钥的格式由 key_format 字段定义。视为公开信息。
account_comment	string 可选。不可变。一个不透明的注释字段，系统不会对其进行解读，但会将其存储在账号的账本中。视为公开信息。长度上限为 128 个字符。可以留空。创建后，此字段便不可更改。
key_format	KeyFormat 可选。不可变。公钥的密钥格式。如果未指定，则默认为采用 Tink 序列化格式的二进制序列化密钥集。视为公开信息。

TransferCurrencyOperator

将指定币种运营商的所有权转移到新账号。发送者必须是平台运营商。

如果交易成功，则停用给定的币种运营商，并将新创建的账号的 ID 作为最终交易的 TransactionCertificate 中的事件返回。

字段
public_key	bytes 必需。新币种运营商的公钥。此公钥将与币种运营商相关联，并存储在账本中。它将用于验证货币运营商账号发出的交易的签名。 公钥的格式由 key_format 字段定义。视为公开信息。
key_format	KeyFormat 可选。不可变。公钥的密钥格式。如果未指定，则默认为采用 Tink 序列化格式的二进制序列化密钥集。视为公开信息。
account_comment	string 可选。不可变。一个不透明的注释字段，系统不会对其进行解读，但会将其存储在账号的账本中。视为公开信息。长度上限为 128 个字符。可以留空。创建后，此字段便不可更改。
currency_operator (deprecated)	Entity 此项已弃用！ 可选。已弃用：请改用 currency_operator_id。要替换的币种运算符。必须处于有效状态。
currency_operator_id	string 可选。要替换的币种运算符的 ID。必须处于有效状态。必须指定 currency_operator 或 currency_operator_id。该值的长度上限为 60 个字符。

TransferPlatformOperator

将平台运营商的所有权转移到新账号。发送者必须是当前平台运营商。

如果交易成功，则停用当前平台运营商，并将新创建的账号的 ID 作为最终交易的 TransactionCertificate 中的事件返回。

字段
public_key	bytes 必需。新平台运营商的公钥。此公钥将与平台运营商相关联，并存储在账本中。它将用于验证平台运营商账号发起的交易的签名。 公钥的格式由 key_format 字段定义。视为公开信息。
key_format	KeyFormat 可选。不可变。公钥的密钥格式。如果未指定，则默认为采用 Tink 序列化格式的二进制序列化密钥集。视为公开信息。
account_comment	string 可选。不可变。一个不透明的注释字段，系统不会对其进行解读，但会将其存储在账号的账本中。视为公开信息。长度上限为 128 个字符。可以留空。创建后，此字段便不可更改。

UserDetails

特定于用户账号的详细信息。

字段
account_manager (deprecated)	Entity 此项已弃用！ 仅限输出。已弃用：请改用 account_manager_id。相应用户的客户经理。
account_manager_id	string 仅限输出。相应用户的客户经理的 ID。
token_manager (deprecated)	Entity 此项已弃用！ 仅限输出。已弃用：请改用 token_manager_id。相应用户的令牌管理器。
token_manager_id	string 仅限输出。相应用户的令牌管理器的 ID。
roles[]	Role 仅限输出。授予相应账号的角色列表。
account_status	AccountStatus 仅限输出。相应账号的状态。
balance	CurrencyValue 仅限输出。相应用户账号的令牌余额。
account_fields (deprecated)	map<string, Fields> 此项已弃用！ 仅限输出。已弃用：请改用 contract_account_fields。相应用户的合同账号字段（合同 ID -> 字段）。
contract_account_fields	map<string, Fields> 仅限输出。相应用户的合同账号字段（合同 ID -> 字段）。

值

某种类型的具体值。

字段
联合字段 value。实际值。value 只能是下列其中一项：
none_value	NoneValue 可选。表示 None 值。
bool_value	bool 可选。布尔值。
int64_value	int64 可选。一个 int64 值。
string_value	string 可选。一个字符串值。
account_id	string 可选。账号 ID。
dict_value	DictValue 可选。字典值。
qualified_currency_value	QualifiedCurrencyValue 可选。符合条件的币种值。
amount_value	AmountValue 可选。金额值。