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)

アカウントやトランザクションなど、台帳に保存されている情報をネットワークにクエリします。

アカウント残高などの特定の機密フィールドへのアクセスは、リクエストの署名から派生した送信者の ID に基づいて制限される場合があります。送信者に権限がない場合、機密性の高いフィールドはレスポンスから削除され、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

2 つのトークン マネージャー間で決済する残高。

フィールド
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

省略可。非推奨: 代わりに、メッセージ固有のフィールドのいずれかを使用してください。クライアント トランザクション固有のメッセージ。次のいずれかにする必要があります。

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

Contract Token Manager に固有の詳細。

フィールド
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

省略可。この MCC によって作成されるアカウントのデフォルトのトークン マネージャーの 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。各キーは 1 種類のみにできます。keys は次のいずれかになります。
bool_keys

BoolList

省略可。ブール値のキーのリスト。

string_keys

StringList

省略可。文字列キーのリスト。

int64_keys

Int64List

省略可。int64 キーのリスト。

account_id_keys

AccountIdList

省略可。アカウント ID キーのリスト。

共用体フィールド values。各値は 1 種類のみにできます。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

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

支払われる金額。支払可能なメソッドを呼び出す場合は 0 より大きい値にする必要があります。支払不可能なメソッドの場合は 0 にします。

KeyFormat

公開鍵の形式を指定します。今後、この列挙型に新しい値が追加される可能性があります。

列挙型
KEY_FORMAT_UNSPECIFIED 鍵の形式が指定されていません。この値は無効であり、使用しないでください。
KEY_FORMAT_TINK_WIRE_FORMAT Tink ワイヤー形式のバイナリ シリアル化された鍵セット。
KEY_FORMAT_PEM_EC_P256_SHA256 SHA256 ダイジェストで P-256 曲線を使用する PEM エンコードの楕円曲線署名鍵。署名は DER 形式で指定する必要があります。

KeySlot

アカウントで鍵を保持できるスロットの識別子。

列挙型
KEY_SLOT_UNSPECIFIED キースロットが指定されていません。
KEY_SLOT_PRIMARY 主キー スロット。
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

出力専用。ルートノードのダイジェストの 16 進数表現。形式: 64 文字の 16 進数文字列。

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

出力専用。実行ラウンドでのトランザクション効果の包含の暗号証明。

これは、指定されたリーフ(トランザクション ダイジェスト)から実行ラウンドのルートまでのパスとして指定されます。パスは(左の子、右の子)のペアのリストとして表され、最初のペアは指定されたリーフの親ノードの左の子と右の子です。たとえば、8 個のリーフ ダイジェスト [t0, t1, t2, t3, t4, t5, t6, t7] で構築された Merkle ツリーが次の構造であるとします。

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

ここで、t0path_to_round_root には [(t0, t1), (h10, h11), (h20, h21)] が含まれます。

各パスノードの SHA-256 ダイジェストを連続して計算し、パスのダイジェストが round_certificate.merkle_tree.root_digest_hex と同じ値を生成することを確認できます。これにより、リーフがラウンドの Merkle ツリーに含まれていることを確認します。

MerkleTreeNode

マークルツリー パスのノードを表します。

フィールド
left_child_hash_hex
(deprecated)

string

出力専用。ノードの左の子のダイジェストの 16 進数表現。非推奨: 代わりに、left_child_digest_hex を使用してください。

right_child_hash_hex
(deprecated)

string

出力専用。ノードの右の子のダイジェストの 16 進数表現。非推奨: 代わりに、right_child_digest_hex を使用してください。

left_child_digest_hex

string

出力専用。ノードの左の子のダイジェストの 16 進数表現。形式: 64 文字の 16 進数文字列。

right_child_digest_hex

string

出力専用。ノードの右の子のダイジェストの 16 進数表現。形式: 64 文字の 16 進数文字列。

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

リクエストを処理するバリデータへのトランザクションの既知の送信ごとに 1 つのエントリ。

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

出力専用。このラウンドの効果が適用された後のワールド状態に対する準同型ダイジェストの 16 進数表現。

round_delta_checksum_hex

string

出力専用。このラウンドの集計されたトランザクション効果に対する準同型ダイジェストの 16 進表現。

merkle_tree

MerkleTree

出力専用。このラウンドをルートノードとし、トランザクション バッチ(ラウンドで実行)をリーフとする Merkle ツリー。

validator_signatures[]

bytes

省略可。検証ツールの署名。これは、このレコードの前のペイロードのダイジェストで署名されます。

is_finalized

bool

出力専用。ラウンドが確定したかどうかを示すブール値。つまり、十分な数のバリデーターが同じ証明書でこのラウンドを認証したかどうかを示します。

SettlementMode

クリアリングハウスの決済モード。

列挙型
SETTLEMENT_MODE_UNSPECIFIED 決済モードが指定されていません。この値は無効であり、使用しないでください。
SETTLEMENT_MODE_DEFERRED クリアリングハウスは、オフ台帳の資金の所有権を追跡し、定期的に SettlementRequest トランザクションを発行して、台帳上の対応する残高を同期させる役割を担います。
SETTLEMENT_MODE_INSTANT クリアリングハウスは単一の資金プールを維持し、元帳はトークン マネージャー間の資金の割り当てのゴールデン ソースとして機能します。この決済モードは「即時総額決済」とも呼ばれます。

SettlementRequest

2 つのトークン マネージャー間の決済オペレーションを開始します。送信者はクリアリングハウス アカウントである必要があります。

クリアリングハウスがトークン マネージャーの資金を保管している遅延 SettlementMode では、2 つのトークン マネージャー間の決済を実行するために送信する必要があるのはこのトランザクションのみです。

フィールド
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

省略可。追加の取引署名者として記載されているアカウントの署名。これらのシグネチャの数と順序は、ClientTransactionsignatories フィールドと一致している必要があります。

署名するバイトは sender_signature のバイトと同じです。各署名者は独自の秘密鍵で署名する必要があります。

追加の署名者の数と ID は、特定の取引の種類によって異なります。トランザクション チェーンの場合、チェーン内の送信者またはユニットの署名者として表示されるアカウントごとに 1 つの署名が必要です。

other_signing_key_slots[]

KeySlot

省略可。追加のトランザクション署名者としてリストされているアカウントのキー スロット。設定されている場合、これらのキー スロットの数と順序は、SignedTransactionother_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。添付されたクライアント トランザクションは運用トランザクションである必要があり、送信者はプラットフォーム オペレーターである必要があります。シリアル化された形式を使用すると、すべてのバリデータがシリアル化されたバイトの SHA-256 ダイジェストとして同じトランザクション ID を計算します。

SubmitOperationalTransactionResponse

SubmitOperationalTransaction のレスポンス メッセージ。

フィールド
transaction_digest_hex

string

送信された運用トランザクションを一意に表す識別子。これは、serialized_signed_operational_transaction の SHA-256 ダイジェストを 16 進数で表したものです。このトランザクション ID は、クライアントがハッシュ ロジックを実装しなくてもトランザクションを追跡できるように提供されます。この識別子は、後続の API 呼び出しで直接使用できます(トランザクションの状態をクエリするなど)。

SubmitTransactionRequest

SubmitTransaction のリクエスト メッセージ。

フィールド
endpoint

string

必須。トランザクションの送信先エンドポイント。形式: projects/{project}/locations/{location}/endpoints/{endpoint}。ロケーションはリージョンです。

serialized_signed_transaction

bytes

必須。台帳に送信するシリアル化された protobuf SignedTransaction。シリアル化された形式を使用すると、すべてのバリデータがシリアル化されたバイトの SHA-256 ダイジェストとして同じトランザクション ID を計算します。

SubmitTransactionResponse

SubmitTransaction のレスポンス メッセージ。

フィールド
transaction_digest_hex

string

送信されたトランザクションを一意に表す識別子。これは、serialized_signed_transaction の SHA-256 ダイジェストを 16 進数で表したものです。このトランザクション ID は、クライアントがハッシュ ロジック自体を実装しなくてもトランザクションを追跡できるように提供されます。この識別子は、後続の API 呼び出しで直接使用できます(トランザクションの状態をクエリするなど)。

TokenManagerDetails

Token Manager に固有の詳細。

フィールド
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

出力専用。効果の準同型チェックサム。16 進数の文字列としてエンコードされた 2,048 バイトの値。

certification_results_digest_hex

string

出力専用。前のすべてのフィールドの暗号化ダイジェスト。包含証明の Merkle ツリーを構築するために使用されます。

TransactionChain

複数のトランザクション ユニットを順番に実行するトランザクション チェーン。

ユニットは、リストに表示されている順序で順次実行されます。すべてのユニットが成功すると、それらの累積効果がアトミックにワールド状態にコミットされます。いずれかのステップが失敗した場合は、チェーン全体が失敗し、その効果は適用されません。

フィールド
units[]

bytes

チェーンの個々のユニット。各ユニットはシリアル化された SignedTransaction である必要があります。

チェーン自体で署名されるバイトを特定するには、シリアル化されたバイトが必要です。

TransactionEffect

ワールド状態に対するトランザクションによる更新を表します。

delta_val がある場合、特定のキーに以前に保存された値に適用されるデルタ(整数オフセット)と見なされます。その場合、new_valold_val は空にする必要があります。

それ以外の場合は、old_val または new_val(または両方)の少なくとも 1 つがあると想定されます。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

出力専用。任意の Key-Value ペアとしてのイベント属性。

EventAttribute

Key-Value ペアとしての個々の属性。

フィールド
key

string

出力専用。属性のキー。

value

string

出力専用。属性の値。

TransactionState

トランザクションの状態。

フィールド
transaction_attempts[]

TransactionAttempt

リクエストを処理するバリデータへのトランザクションの既知の送信ごとに 1 つのエントリ。

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

省略可。金額の値。