Account

代表帳戶在帳本上的狀態。

JSON 表示法
{
  "sequenceNumber": string,
  "publicKey": string,
  "roundId": string,
  "comment": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "userDetails": {
    object (UserDetails)
  },
  "accountManagerDetails": {
    object (AccountManagerDetails)
  },
  "tokenManagerDetails": {
    object (TokenManagerDetails)
  },
  "contractTokenManagerDetails": {
    object (ContractTokenManagerDetails)
  },
  "contractDetails": {
    object (ContractDetails)
  },
  "clearinghouseDetails": {
    object (ClearingHouseDetails)
  },
  "currencyOperatorDetails": {
    object (CurrencyOperatorDetails)
  },
  "platformOperatorDetails": {
    object (PlatformOperatorDetails)
  }
  // End of mutually exclusive fields.
}
欄位
sequenceNumber

string (int64 format)

僅供輸出。這個帳戶的序號。這個帳戶每傳送一筆交易,這個數字就會遞增。

publicKey

string (bytes format)

僅供輸出。與這個帳戶相關聯的主要公開金鑰,用於驗證簽章。

Base64 編碼字串。

roundId

string (int64 format)

僅供輸出。執行輪次 (類似於區塊「高度」) 的 ID,提供的帳戶資訊在此輪次中是正確的。

comment

string

僅供輸出。建立這個帳戶時儲存的帳戶註解。

根據帳戶類型提供具體詳細資料。以下是互斥欄位清單。回應中最多會設定下列其中一個欄位:
userDetails

object (UserDetails)

僅供輸出。標準使用者帳戶的詳細資料。

accountManagerDetails

object (AccountManagerDetails)

僅供輸出。客戶經理帳戶的詳細資料。

tokenManagerDetails

object (TokenManagerDetails)

僅供輸出。權杖管理員帳戶的詳細資料。

contractTokenManagerDetails

object (ContractTokenManagerDetails)

僅供輸出。合約權杖管理員帳戶的詳細資料。

contractDetails

object (ContractDetails)

僅供輸出。智慧型合約帳戶的詳細資料。

clearinghouseDetails

object (ClearingHouseDetails)

僅供輸出。結算所帳戶的詳細資料。

currencyOperatorDetails

object (CurrencyOperatorDetails)

僅供輸出。貨幣運算子帳戶的詳細資料。

platformOperatorDetails

object (PlatformOperatorDetails)

僅供輸出。平台營運商帳戶的詳細資料。

互斥欄位結束。

UserDetails

使用者帳戶專屬的詳細資料。

JSON 表示法
{
  "accountManagerId": string,
  "tokenManagerId": string,
  "roles": [
    enum (Role)
  ],
  "accountStatus": enum (AccountStatus),
  "balance": {
    object (CurrencyValue)
  },
  "contractAccountFields": {
    string: {
      object (Fields)
    },
    ...
  }
}
欄位
accountManagerId

string

僅供輸出。這位使用者的客戶經理 ID。

tokenManagerId

string

僅供輸出。這位使用者的權杖管理員 ID。

roles[]

enum (Role)

僅供輸出。授予這個帳戶的角色清單。

accountStatus

enum (AccountStatus)

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

balance

object (CurrencyValue)

僅供輸出。這個使用者帳戶的代幣餘額。

contractAccountFields

map (key: string, value: object (Fields))

僅供輸出。這位使用者的合約帳戶欄位 (合約 ID -> 欄位)。

包含 "key": value 組合清單的物件,範例:{ "name": "wrench", "mass": "1.3kg", "count": "3" }。

角色

一般角色組合。

列舉
ROLE_UNSPECIFIED 角色無效。
ROLE_PAYER 這個角色可讓帳戶發起付款交易。
ROLE_RECEIVER 可讓帳戶收款的角色。
ROLE_CONTRACT_CREATOR 允許帳戶部署合約的角色。
ROLE_CONTRACT_PARTICIPANT 這個角色可讓帳戶與已部署的合約互動。

AccountStatus

帳戶狀態。

列舉
ACCOUNT_STATUS_UNSPECIFIED 狀態無效。
ACCOUNT_STATUS_ACTIVE 帳戶處於有效狀態,可執行角色允許的操作。
ACCOUNT_STATUS_INACTIVE 帳戶處於閒置狀態,禁止所有交易。帳戶管理員仍可傳送帳戶管理交易。

CurrencyValue

代表貨幣金額 (即金錢)。請注意,這則訊息不含計價幣別。相關幣別由傳送交易的帳戶決定。每個帳戶都有專屬且不可變更的幣別。

JSON 表示法
{
  "value": string
}
欄位
value

string (int64 format)

這是必要旗標,貨幣的輔幣單位數量。

這個最小有效面額稱為「次要單位」,並在 ISO 4217 中指定。舉例來說,如果是美元,這個值會是美分數,如果是英鎊,則會是便士數。日圓沒有輔幣單位,因此會以日圓金額表示。

欄位

合約中的欄位對應 (欄位名稱 -> 值),用於表示合約欄位或帳戶欄位。

JSON 表示法
{
  "fields": {
    string: {
      object (Value)
    },
    ...
  }
}
欄位
fields

map (key: string, value: object (Value))

僅供輸出。欄位名稱與其值的對應。

包含 "key": value 組合清單的物件,範例:{ "name": "wrench", "mass": "1.3kg", "count": "3" }。

值

某種類型的具體值。

JSON 表示法
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "noneValue": enum (NoneValue),
  "boolValue": boolean,
  "int64Value": string,
  "stringValue": string,
  "dictValue": {
    object (DictValue)
  },
  "contractValue": {
    object (ContractValue)
  },
  "listValue": {
    object (ListValue)
  },
  "qualifiedCurrencyValue": {
    object (QualifiedCurrencyValue)
  },
  "accountValue": {
    object (AccountValue)
  },
  "amountValue": {
    object (AmountValue)
  }
  // End of mutually exclusive fields.
}
欄位
實際值。以下是互斥欄位清單。回應中最多會設定下列其中一個欄位:
noneValue

enum (NoneValue)

選用。代表 None 值。

boolValue

boolean

選用。布林值。

int64Value

string (int64 format)

選用。int64 值。

stringValue

string

選用。字串值。

dictValue

object (DictValue)

選用。字典值。

contractValue

object (ContractValue)

選用。合約參考資料。

listValue

object (ListValue)

選用。清單值。

qualifiedCurrencyValue

object (QualifiedCurrencyValue)

選用。有效的貨幣值。

accountValue

object (AccountValue)

選用。帳戶值。

amountValue

object (AmountValue)

選用。金額值。

互斥欄位結束。

NoneValue

代表 None 值的單例列舉。

列舉
NONE_VALUE_UNSPECIFIED None 值。

DictValue

索引會將鍵對應至值。例如,keys[0] 鍵對應至 values[0]。

JSON 表示法
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "boolKeys": {
    object (BoolList)
  },
  "stringKeys": {
    object (StringList)
  },
  "int64Keys": {
    object (Int64List)
  },
  "genericKeys": {
    object (RepeatedValue)
  }
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "boolValues": {
    object (BoolList)
  },
  "stringValues": {
    object (StringList)
  },
  "int64Values": {
    object (Int64List)
  },
  "genericValues": {
    object (RepeatedValue)
  }
  // End of mutually exclusive fields.
}
欄位
每個鍵只能有一種。以下是互斥欄位清單。回應中最多會設定下列其中一個欄位:
boolKeys

object (BoolList)

選用。布林值索引鍵清單。

stringKeys

object (StringList)

選用。字串索引鍵清單。

int64Keys

object (Int64List)

選用。int64 鍵清單。

genericKeys

object (RepeatedValue)

選用。一般金鑰清單。

互斥欄位結束。
每個值只能有一種。以下是互斥欄位清單。回應中最多會設定下列其中一個欄位:
boolValues

object (BoolList)

選用。布林值清單。

stringValues

object (StringList)

選用。字串值清單。

int64Values

object (Int64List)

選用。int64 值清單。

genericValues

object (RepeatedValue)

選用。一般值清單。

互斥欄位結束。

BoolList

布林值清單。

JSON 表示法
{
  "values": [
    boolean
  ]
}
欄位
values[]

boolean

選用。布林值。

StringList

字串清單。

JSON 表示法
{
  "values": [
    string
  ]
}
欄位
values[]

string

選用。字串值。

Int64List

int64 清單。

JSON 表示法
{
  "values": [
    string
  ]
}
欄位
values[]

string (int64 format)

選用。int64 值。

RepeatedValue

一般值清單。

JSON 表示法
{
  "values": [
    {
      object (Value)
    }
  ]
}
欄位
values[]

object (Value)

選用。清單中的值。

ContractValue

代表合約參照。

JSON 表示法
{
  "contractId": string
}
欄位
contractId

string

這是必要旗標,合約 ID。

ListValue

值清單。

JSON 表示法
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "boolValues": {
    object (BoolList)
  },
  "stringValues": {
    object (StringList)
  },
  "int64Values": {
    object (Int64List)
  },
  "genericValues": {
    object (RepeatedValue)
  }
  // End of mutually exclusive fields.
}
欄位
每個值只能有一種。以下是互斥欄位清單。回應中最多會設定下列其中一個欄位:
boolValues

object (BoolList)

選用。布林值清單。

stringValues

object (StringList)

選用。字串值清單。

int64Values

object (Int64List)

選用。int64 值清單。

genericValues

object (RepeatedValue)

選用。一般值清單。

互斥欄位結束。

QualifiedCurrencyValue

代表帳本上的貨幣,由貨幣運算子限定。

JSON 表示法
{
  "operatorId": string
}
欄位
operatorId

string

這是必要旗標,管理貨幣的貨幣營運商 ID。

AccountValue

參照帳本上的帳戶。

這個參照會由帳本的執行階段換成完整的 gcul.Account 物件。詳情請參閱 GCULpy 語言參考資料中的 gcul.Account 類別。

JSON 表示法
{
  "accountId": string
}
欄位
accountId

string

這是必要旗標,帳戶 ID。

AmountValue

代表以某種貨幣計價的金額。

JSON 表示法
{
  "currency": {
    object (QualifiedCurrencyValue)
  },
  "amountValue": string
}
欄位
currency

object (QualifiedCurrencyValue)

這是必要旗標,金額的幣別。

amountValue

string (int64 format)

這是必要旗標,貨幣的輔幣單位數量。

AccountManagerDetails

客戶經理專屬詳細資料。

JSON 表示法
{
  "numAccounts": integer,
  "tokenManagerId": string
}
欄位
numAccounts

integer

僅供輸出。這位客戶經理建立的帳戶數量。

tokenManagerId

string

僅供輸出。這個帳戶管理員建立的帳戶,其預設權杖管理員 ID。

TokenManagerDetails

權杖管理員專屬的詳細資料。

JSON 表示法
{
  "issuanceLimit": {
    object (CurrencyValue)
  },
  "issuedTokens": {
    object (CurrencyValue)
  }
}
欄位
issuanceLimit

object (CurrencyValue)

僅供輸出。這個代幣管理工具可鑄造的代幣數量。

issuedTokens

object (CurrencyValue)

僅供輸出。這個代幣管理工具鑄造的代幣數量。鑄造時,這個數字會增加;銷毀時,這個數字會減少。

ContractTokenManagerDetails

合約權杖管理員專屬詳細資料。

JSON 表示法
{
  "issuanceLimit": {
    object (CurrencyValue)
  },
  "issuedTokens": {
    object (CurrencyValue)
  },
  "previousContractTokenManagerId": string,
  "accountStatus": enum (AccountStatus)
}
欄位
issuanceLimit

object (CurrencyValue)

僅供輸出。這份合約代幣管理工具可提供的代幣數量。

合約代碼管理員無法提高或降低核發上限,因此這個值應等於 issuedTokens。

issuedTokens

object (CurrencyValue)

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

這等於合約中所有幣別餘額的總和,加上結算矩陣中的淨部位。

previousContractTokenManagerId

string

僅供輸出。這個幣別的前一個合約代碼管理員帳戶 ID。這會形成稽核追蹤記錄,可供遍歷以找出所有先前的管理員。如果這是該幣別的第一個合約代幣管理工具,則會留空。

accountStatus

enum (AccountStatus)

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

ContractDetails

智慧合約專屬詳細資料。

JSON 表示法
{
  "ownerId": string,
  "code": string,
  "contractFields": {
    object (Fields)
  },
  "currencyBalances": {
    string: {
      object (CurrencyValue)
    },
    ...
  }
}
欄位
ownerId

string

僅供輸出。合約擁有者的 ID。

code

string (bytes format)

僅供輸出。序列化合約代碼。

Base64 編碼字串。

contractFields

object (Fields)

僅供輸出。這份合約的合約欄位 (欄位名稱 -> 值)。

currencyBalances

map (key: string, value: object (CurrencyValue))

僅供輸出。合約持有的貨幣餘額 (貨幣運算子 -> 餘額)。

包含 "key": value 組合清單的物件,範例:{ "name": "wrench", "mass": "1.3kg", "count": "3" }。

ClearingHouseDetails

Clearinghouse 專屬詳細資料。

JSON 表示法
{
  "accountStatus": enum (AccountStatus),
  "balances": [
    {
      object (BalanceToSettle)
    }
  ],
  "settlementMode": enum (SettlementMode)
}
欄位
accountStatus

enum (AccountStatus)

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

balances[]

object (BalanceToSettle)

僅供輸出。這個結算所目前追蹤的結算餘額。

settlementMode

enum (SettlementMode)

僅供輸出。這個結算所的結算模式。

BalanceToSettle

兩個代碼管理工具之間要結算的餘額。

JSON 表示法
{
  "balancePayerId": string,
  "balanceReceiverId": string,
  "balance": {
    object (CurrencyValue)
  }
}
欄位
balancePayerId

string

僅供輸出。要結清餘額的帳戶 ID。

balanceReceiverId

string

僅供輸出。待結算餘額的帳戶 ID。

balance

object (CurrencyValue)

僅供輸出。要結清的餘額。必須為正數。

SettlementMode

結算所的結算模式。

列舉
SETTLEMENT_MODE_UNSPECIFIED 未指定結算模式。這個值無效,不應使用。
SETTLEMENT_MODE_DEFERRED 結算所負責追蹤帳外資金的擁有權,並定期發出 SettlementRequest 交易,讓帳本上的對應餘額保持同步。
SETTLEMENT_MODE_INSTANT 結算所會維護單一資金池,而總帳則是代幣管理員之間分配這些資金的黃金來源。這種結算模式也可稱為「即時總額結算」。

CurrencyOperatorDetails

貨幣運算子的專屬詳細資料。

JSON 表示法
{
  "currencyCode": string,
  "accountStatus": enum (AccountStatus),
  "previousCurrencyOperatorId": string,
  "platformOperatorId": string,
  "contractTokenManagerId": string,
  "clearinghouseId": string
}
欄位
currencyCode

string

僅供輸出。與這個帳戶相關聯的貨幣 ID,以 3 個字母的 ISO 4217 代碼表示。

accountStatus

enum (AccountStatus)

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

previousCurrencyOperatorId

string

僅供輸出。先前將貨幣操作者角色擁有權轉移給這個帳戶的貨幣操作者 ID。如果這是該貨幣的第一個貨幣運算子,則此欄位會留空。

platformOperatorId

string

僅供輸出。建立這個貨幣運算子的平台運算子 ID。

contractTokenManagerId

string

僅供輸出。與這個貨幣運算子相關聯的合約代幣管理工具 ID。

clearinghouseId

string

僅供輸出。與這個貨幣營運商相關聯的結算所 ID。

PlatformOperatorDetails

平台操作人員專屬的詳細資料。

JSON 表示法
{
  "accountStatus": enum (AccountStatus),
  "previousPlatformOperatorId": string
}
欄位
accountStatus

enum (AccountStatus)

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

previousPlatformOperatorId

string

僅供輸出。原平台營運商的 ID,該營運商已將平台營運商角色的擁有權轉移給這個帳戶。如果這是第一個平台運算子,則會留空。