メインコンテンツへスキップ

データ型

このセクションでは、OCAP Client API全体で使用されるすべてのカスタムデータ構造、入力パラメータ、および応答オブジェクトに関する包括的なリファレンスを提供します。これらの型を理解することは、OCAPブロックチェーンと効果的に対話するために不可欠です。

コアタイプ

これらは、さまざまなAPIコールで使用される基本的なデータ構造です。

Any

protobufメッセージ用の汎用コンテナで、柔軟なデータ構造を可能にします。

  • typeUrl string — シリアル化されたメッセージの型を一意に識別するURLのような文字列。
  • value string — シリアル化されたメッセージの内容を文字列として表したもの。

Multisig

マルチシグネチャを表し、複数の承認を必要とするトランザクションでよく使用されます。

  • signer string — 署名者のアドレス。
  • pk string — 署名者の公開鍵。
  • signature string — 署名者によって生成された署名。
  • delegator string — 署名が委任されている場合の委任者のアドレス。
  • data Any — 署名に関連付けられた任意のオプションデータ。

PageInfo

リストベースのクエリ応答のページネーション詳細を含みます。

  • cursor string — 結果の次のページを取得するためのカーソル。
  • next boolean — 結果の次のページがあるかどうかを示します。
  • total number — クエリに一致するアイテムの総数。

StateContext

ステートオブジェクトの作成と最終更新に関するコンテキストを提供します。

  • genesisTx TransactionInfo — このステートオブジェクトを作成したトランザクション。
  • renaissanceTx TransactionInfo — このステートオブジェクトを最後に更新したトランザクション。
  • genesisTime string — ステートオブジェクトが作成されたときのタイムスタンプ。
  • renaissanceTime string — ステートオブジェクトが最後に更新されたときのタイムスタンプ。

ウォレットオブジェクト

これらの型は、トランザクション署名に使用されるウォレットの構造を定義します。

WalletObject

  • publicKey string
  • secretKey string
  • type WalletTypeObject

WalletTypeObject

  • pk number
  • role number
  • hash number
  • address number — デフォルトはbase58btcです

WalletType

  • pk KeyType
  • hash HashType
  • address EncodingType
  • role RoleType

入力およびフィルタータイプ

これらのオブジェクトは、GraphQLクエリのパラメータとフィルターを提供するために使用されます。

一般的なフィルター入力

  • AccountFilterInput object
    • accounts array<string>
  • AddressFilterInput object
    • sender string
    • receiver string
    • direction Direction
  • AssetFilterInput object
    • assets array<string>
  • DelegationFilterInput object
    • delegations array<string>
  • FactoryFilterInput object
    • factories array<string>
  • RangeFilterInput object
    • from string
    • to string
  • RollupFilterInput object
    • rollups array<string>
  • StakeFilterInput object
    • stakes array<string>
  • TimeFilterInput object
    • startDateTime string
    • endDateTime string
    • field string
  • TokenFactoryFilterInput object
    • tokenFactories array<string>
  • TokenFilterInput object
    • tokens array<string>
  • TxFilterInput object
    • txs array<string>
  • TypeFilterInput object
    • types array<string>
  • ValidatorFilterInput object
    • validators array<string>
  • ValidityFilterInput object
    • validity Validity

ページネーション入力

PageInput

  • cursor string
  • size number
  • order array<PageOrderInput>

PageOrderInput

  • field string
  • type string

リクエスト固有の入力

これらのオブジェクトは、特定のクエリおよびミューテーションメソッドのパラメータとして使用されます。

  • RequestEstimateGasInput object
    • typeUrl string
    • tx string
  • RequestGetAccountStateInput object
    • address string
    • keys array<string>
    • height number
    • traceMigration boolean
  • RequestGetAccountTokensInput object
    • address string
    • token string
  • RequestGetBlockInput object
    • height number
  • RequestGetBlocksInput object
    • paging PageInput
    • heightFilter RangeFilterInput
    • emptyExcluded boolean
  • RequestListTransactionsInput object
    • paging PageInput
    • timeFilter TimeFilterInput
    • addressFilter AddressFilterInput
    • typeFilter TypeFilterInput
    • validityFilter ValidityFilterInput
    • factoryFilter FactoryFilterInput
    • tokenFilter TokenFilterInput
    • assetFilter AssetFilterInput
    • accountFilter AccountFilterInput
    • txFilter TxFilterInput
    • rollupFilter RollupFilterInput
    • stakeFilter StakeFilterInput
    • delegationFilter DelegationFilterInput
    • tokenFactoryFilter TokenFactoryFilterInput

ステートオブジェクト

これらの型は、アカウント、アセット、トークンなど、ブロックチェーン上のさまざまなエンティティの状態を表します。

AccountState

ユーザーアカウントの状態を表します。

  • balance string
  • nonce string
  • numTxs string
  • address string
  • pk string
  • type WalletType
  • moniker string
  • context StateContext
  • issuer string
  • gasBalance string
  • migratedTo array<string>
  • migratedFrom array<string>
  • numAssets string
  • tokens array<IndexedTokenInput>
  • data Any

AssetState

非代替性アセット（NFT）の状態を表します。

  • address string
  • owner string
  • moniker string
  • readonly boolean
  • transferrable boolean
  • ttl number
  • consumedTime string
  • issuer string
  • parent string
  • endpoint NFTEndpoint
  • display NFTDisplay
  • tags array<string>
  • context StateContext
  • data Any

AssetFactoryState

新しいアセットをミントするために使用されるアセットファクトリの状態を表します。

  • address string
  • owner string
  • name string
  • description string
  • settlement string
  • limit number
  • trustedIssuers array<string>
  • input IndexedFactoryInput
  • output CreateAssetTx
  • hooks array<AssetFactoryHook>
  • data Any
  • context StateContext
  • balance string
  • tokens array<IndexedTokenInput>
  • numMinted number
  • display NFTDisplay
  • lastSettlement string

DelegateState

あるアカウントが別のアカウントに代わってアクションを実行することを許可する、委任の状態を表します。

  • address string
  • ops array<DelegateState_OpsEntry>
  • from string
  • to string
  • context StateContext
  • data Any

StakeState

トークンやアセットを含むことができるステークの状態を表します。

  • address string
  • sender string
  • receiver string
  • tokens array<IndexedTokenInput>
  • assets array<string>
  • revocable boolean
  • message string
  • revokeWaitingPeriod number
  • revokedTokens array<IndexedTokenInput>
  • revokedAssets array<string>
  • slashers array<string>
  • nonce string
  • context StateContext
  • data Any

TokenState

代替可能なトークンの状態を表します。

  • address string
  • issuer string
  • name string
  • description string
  • symbol string
  • unit string
  • decimal number
  • icon string
  • totalSupply string
  • initialSupply string
  • maxTotalSupply string
  • foreignToken ForeignToken
  • tokenFactoryAddress string
  • context StateContext
  • data Any

TokenFactoryState

トークンのミントとバーンに使用されるトークンファクトリの状態を表します。

  • address string
  • tokenAddress string
  • reserveAddress string
  • currentSupply string
  • reserveBalance string
  • owner string
  • feeRate number
  • curve CurveConfig
  • context StateContext
  • token TokenState
  • reserveToken TokenState
  • data Any

トランザクションペイロード（ITX）

これらの型は、さまざまなトランザクションタイプに対する itx (内部トランザクション) オブジェクトを定義します。

AccountMigrateTx

  • pk string
  • type WalletType
  • address string
  • data Any

AcquireAssetV2Tx

  • factory string
  • address string
  • assets array<string>
  • variables array<VariableInput>
  • issuer NFTIssuer
  • data Any

CreateAssetTx

  • moniker string
  • data Any
  • readonly boolean
  • transferrable boolean
  • ttl number
  • parent string
  • address string
  • issuer string
  • endpoint NFTEndpoint
  • display NFTDisplay
  • tags array<string>

DelegateTx

  • address string
  • to string
  • ops array<DelegateOp>
  • data Any

ExchangeTx

  • to string
  • sender ExchangeInfo
  • receiver ExchangeInfo
  • expiredAt string
  • data Any

StakeTx

  • address string
  • receiver string
  • inputs array<TransactionInput>
  • locked boolean
  • message string
  • revokeWaitingPeriod number
  • slashers array<string>
  • nonce string
  • data Any

TransferTx

  • to string
  • value string
  • assets array<string>
  • data Any

応答ラッパー

これらの型は、APIクエリによって返されるトップレベルのオブジェクトであり、ステータスコードと要求されたデータを含みます。

ResponseGetAccountState

  • code string
  • state AccountState

ResponseGetAssetState

  • code string
  • state AssetState

ResponseGetBlock

  • code string
  • block BlockInfo

ResponseGetChainInfo

  • code string
  • info ChainInfo

ResponseGetTx

  • code string
  • info TransactionInfo

ResponseListTransactions

  • code string
  • page PageInfo
  • transactions array<IndexedTransaction>

ResponseSendTx

  • code string
  • hash string