Package google.cloud.universalledger.v1

索引

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 開始的專屬單調遞增數字。

如果同一交易傳送者先前已向網路提交交易，則這個號碼必須增加一。

請注意，這不包括可能已做為鏈結一部分提交的任何交易單元，這類單元不得設定序號。但會包含交易鏈本身的傳送者。
chained_unit

bool

如果這個用戶端交易屬於交易鏈，則必須設為 true。否則必須設為 false。

這是為了避免將原本要加入鏈結的已簽署交易，單獨提交。
聯集欄位 kind。用戶端交易專屬訊息。kind 只能是下列其中一個設定：
app
(deprecated)

Any

選用。已淘汰：請改用訊息專屬欄位。與用戶端交易相關的訊息。應為下列任一項：
operational

Any

選用。作業交易訊息。請注意，只有平台營運者才能傳送這類訊息。應為下列任一項：
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

合約權杖管理工具的專屬詳細資料。

欄位
issuance_limit

CurrencyValue

僅供輸出。這個合約權杖管理員可提供的擔保權杖數量。

由於合約代幣管理員無法提高或降低發行上限，因此這應等於 issued_tokens。
issued_tokens

CurrencyValue

僅供輸出。這份合約代幣管理工具提供的擔保代幣數量 (即總負債)。

這等於以該幣別計價的所有合約餘額總和，加上結算矩陣中的淨部位。
previous_contract_token_manager_id

string

僅供輸出。此幣別先前合約權杖管理員的帳戶 ID。這會形成稽核追蹤記錄，可供您找出所有先前的管理員。如果這是該幣別的第一個合約代幣管理員，這個欄位會是空白。
account_status

AccountStatus

僅供輸出。這個帳戶的狀態。

CreateAccount

建立新的使用者帳戶。傳送者必須是帳戶管理員。

如果交易成功，系統會將新建立帳戶的 ID 做為事件，傳回至最終交易的 TransactionCertificate。

欄位
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

建立新的帳戶管理員。匯款方必須是貨幣業者。

如果交易成功，系統會將新建立帳戶的 ID 做為事件，傳回至最終交易的 TransactionCertificate。

欄位
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

建立新的結算中心。匯款方必須是貨幣業者。

如果交易成功，系統會將新建立帳戶的 ID 做為事件，傳回至最終交易的 TransactionCertificate。

欄位
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 交易。如果存在與相同幣別相關聯的其他合約權杖管理員，這項交易就會失敗。

與一般權杖管理員不同，合約權杖管理員不得執行鑄造或銷毀等交易。但可以參與結算作業。

如果交易成功，系統會將新建立帳戶的 ID 做為事件，傳回至最終交易的 TransactionCertificate。

欄位
public_key

bytes

這是必要旗標，新合約權杖管理工具的公開金鑰。請注意，這不是運算子的公開金鑰。這個公開金鑰會與合約權杖管理員建立關聯，並儲存在帳本中。這項資訊可用於驗證合約權杖管理員帳戶發出的交易簽章。

公開金鑰的格式由 key_format 欄位定義。視為公開資訊。
account_comment

string

選用。不可變動。系統不會解讀這個不透明的註解欄位，但會將其儲存在帳戶的帳本中。視為公開資訊。長度上限為 128 個半形字元。可以留空。建立後即無法變更。
key_format

KeyFormat

選用。不可變動。公開金鑰的金鑰格式。如未指定，預設為 Tink 線路格式的二進位序列化鍵集。視為公開資訊。

CreateCurrencyOperator

建立新的貨幣運算子。傳送者必須是平台業者。

如果交易成功，系統會將新建立帳戶的 ID 做為事件，傳回至最終交易的 TransactionCertificate。

這筆交易必須在系統中導入新的幣別。如果指定的幣別已存在，這項交易就會失敗。如需更換貨幣運算子，請改為傳送 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

建立與傳送要求運營商幣別相關聯的新權杖管理員。匯款方必須是貨幣業者。

如果交易成功，系統會將新建立帳戶的 ID 做為事件，傳回至最終交易的 TransactionCertificate。

欄位
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

ID。端點的資源名稱。格式：projects/{project}/locations/{location}/endpoints/{endpoint}

實體

Universal Ledger 網路中的實體。所有帳戶都附加至實體。實體 ID (也常稱為帳戶 ID) 是網路中專屬且不可變更的 ID。

欄位
id

string

僅供輸出。指派給實體的 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

帳戶中可保留金鑰的插槽 ID。

列舉
KEY_SLOT_UNSPECIFIED 未指定金鑰位置。
KEY_SLOT_PRIMARY 主鍵位置。
KEY_SLOT_ALTERNATE 替代鍵插槽。

ListEndpointsRequest

ListEndpoints 的要求訊息。

欄位
parent

string

這是必要旗標，擁有這個端點集合的父項。格式：projects/{project}/locations/{location}
page_size

int32

選用。要傳回的端點數量上限。服務傳回的產品數量可能會少於這個值。如未指定，最多將傳回 50 個端點。許可的最大值為 1000；超出的數值將一律指定為 1000。
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_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 樹狀結構是以八個葉節摘要 [t0, t1, t2, t3, t4, t5, t6, t7] 建構而成，結構如下：

       _____root_digest____
      |                    |
   __ h20__             __h21__
  |        |           |       |
 h10     h11          h12     h13
 | |     | |          | |     | |
t0 t1   t2 t3        t4 t5   t6 t7

在此處，path_to_round_root 的 t0 會包含：[(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

這是必要旗標，已序列化為 protobuf 的 SignedQueryRequest，用於查詢 Universal Ledger 網路。

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

從指定插槽移除帳戶簽署金鑰。另一個插槽不得為空白，且必須保留用於簽署 ClientTransaction 的金鑰。

欄位
key_slot

KeySlot

這是必要旗標，要移除金鑰的金鑰插槽。如果這個欄位已為空白，交易就會失敗。

ReplaceSigningPublicKey

取代指定位置的帳戶簽署金鑰。另一個插槽不得為空白，且必須保留用於簽署 ClientTransaction 的金鑰。

欄位
key_slot

KeySlot

這是必要旗標，要更換金鑰的金鑰位置。
new_public_key

bytes

這是必要旗標，新的公開金鑰，將取代指定位置的公開金鑰。

公開金鑰的格式是由 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

僅供輸出。人類可讀的驗證器 ID。這項資訊可用於查閱公開金鑰，並驗證 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

可明確代表所提交作業交易的 ID。這是 serialized_signed_operational_transaction 的 SHA-256 摘要十六進位表示法。提供這項交易 ID，方便用戶端追蹤交易，不必自行實作雜湊邏輯。這個 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

可明確代表所提交交易的 ID。這是 serialized_signed_transaction 的 SHA-256 摘要十六進位表示法。提供這項交易 ID，方便用戶端追蹤交易，不必自行實作雜湊邏輯。這個 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

將合約權杖管理員的擁有權轉移至新帳戶。匯款方必須是該幣別的現任貨幣經營者。

如果交易成功，系統會停用該幣別的現有合約權杖管理員，並在最終交易的 TransactionCertificate 中，以事件形式傳回新建立帳戶的 ID。

欄位
public_key

bytes

這是必要旗標，新合約權杖管理工具的公開金鑰。請注意，這不是運算子的公開金鑰。這是新合約權杖管理員的公開金鑰，會儲存在帳本中。這項資訊可用於驗證合約權杖管理員帳戶發出的交易簽章。

公開金鑰的格式由 key_format 欄位定義。視為公開資訊。
account_comment

string

選用。不可變動。系統不會解讀這個不透明的註解欄位，但會將其儲存在帳戶的帳本中。視為公開資訊。長度上限為 128 個半形字元。可以留空。建立後即無法變更。
key_format

KeyFormat

選用。不可變動。公開金鑰的金鑰格式。如未指定，預設為 Tink 線路格式的二進位序列化鍵集。視為公開資訊。

TransferCurrencyOperator

將指定貨幣營運商的擁有權轉移至新帳戶。傳送者必須是平台業者。

如果交易成功，系統會停用指定的幣別運算子，並在最終交易的 TransactionCertificate 中，以事件形式傳回新建立帳戶的 ID。

欄位
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

將平台營運者的擁有權轉移至新帳戶。寄件者必須是目前的平台營運者。

如果交易成功，系統會停用目前的平台營運商，並在最終交易的 TransactionCertificate 中以事件形式傳回新建立帳戶的 ID。

欄位
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

選用。金額值。