diff --git a/content/api/grpc.md b/content/api/grpc.md index 5bf86ee..67b54bf 100644 --- a/content/api/grpc.md +++ b/content/api/grpc.md @@ -25,203 +25,203 @@ For seamless integration with Pactus, you can use these client libraries:
  • Blockchain Service +
  • Network Service +
  • Utils Service +
  • Wallet Service +
    • - +
    @@ -245,23 +245,24 @@ For seamless integration with Pactus, you can use these client libraries: id string - The unique ID of the transaction to retrieve. + The unique ID of the transaction to retrieve. verbosity TransactionVerbosity - (Enum)The verbosity level for transaction details. -
    Available values: + (Enum)The verbosity level for transaction details.
    Available values: + -

    GetTransactionResponse Response

    + +

    GetTransactionResponse Response

    @@ -272,273 +273,258 @@ For seamless integration with Pactus, you can use these client libraries: - + - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - + + + + + + + + + + - - + + +
    block_height uint32 - The height of the block containing the transaction. + The height of the block containing the transaction.
    block_time uint32 - The UNIX timestamp of the block containing the transaction. + The UNIX timestamp of the block containing the transaction.
    transaction TransactionInfo - Detailed information about the transaction. + Detailed information about the transaction.
    transaction.id string - The unique ID of the transaction. -
    transaction.data string - The raw transaction data in hexadecimal format. -
    transaction.version int32 - The version of the transaction. -
    transaction.lock_time uint32 - The lock time for the transaction. -
    transaction.value int64 - The value of the transaction in NanoPAC. -
    transaction.fee int64 - The fee for the transaction in NanoPAC. -
    transaction.payload_type PayloadType - (Enum)The type of transaction payload. -
    Available values:
      -
    • PAYLOAD_TYPE_UNSPECIFIED = 0 (Unspecified payload type.)
      • -
    • PAYLOAD_TYPE_TRANSFER = 1 (Transfer payload type.)
      • -
    • PAYLOAD_TYPE_BOND = 2 (Bond payload type.)
      • -
    • PAYLOAD_TYPE_SORTITION = 3 (Sortition payload type.)
      • -
    • PAYLOAD_TYPE_UNBOND = 4 (Unbond payload type.)
      • -
    • PAYLOAD_TYPE_WITHDRAW = 5 (Withdraw payload type.)
      • -
    • PAYLOAD_TYPE_BATCH_TRANSFER = 6 (Batch transfer payload type.)
      • -
    -
    transaction.transfer PayloadTransfer - (OneOf)Transfer transaction payload. -
    transaction.transfer.sender string - The sender's address. -
    transaction.transfer.receiver string - The receiver's address. -
    transaction.transfer.amount int64 - The amount to be transferred in NanoPAC. -
    transaction.bond PayloadBond - (OneOf)Bond transaction payload. -
    transaction.bond.sender string - The sender's address. -
    transaction.bond.receiver string - The receiver's address. -
    transaction.bond.stake int64 - The stake amount in NanoPAC. -
    transaction.bond.public_key string - The public key of the validator. -
    transaction.sortition PayloadSortition - (OneOf)Sortition transaction payload. -
    transaction.sortition.address string - The validator address associated with the sortition proof. -
    transaction.sortition.proof string - The proof for the sortition. -
    transaction.unbond PayloadUnbond - (OneOf)Unbond transaction payload. -
    transaction.unbond.validator string - The address of the validator to unbond from. -
    transaction.withdraw PayloadWithdraw - (OneOf)Withdraw transaction payload. -
    transaction.withdraw.validator_address string - The address of the validator to withdraw from. -
    transaction.withdraw.account_address string - The address of the account to withdraw to. -
    transaction.withdraw.amount int64 - The withdrawal amount in NanoPAC. -
    transaction.batch_transfer PayloadBatchTransfer - (OneOf)Batch Transfer transaction payload. -
    transaction.batch_transfer.sender string - The sender's address. -
    transaction.batch_transfer.recipientsrepeated Recipient - The list of recipients with their amounts. -
    transaction.memo string - A memo string for the transaction. -
    transaction.public_key string - The public key associated with the transaction. -
    transaction.signature string - The signature for the transaction. -
    transaction.block_height uint32 - The block height containing the transaction. +
    transaction.id string + The unique ID of the transaction. +
    transaction.data string + The raw transaction data in hexadecimal format. +
    transaction.version int32 + The version of the transaction. +
    transaction.lock_time uint32 + The lock time for the transaction. +
    transaction.value int64 + The value of the transaction in NanoPAC. +
    transaction.fee int64 + The fee for the transaction in NanoPAC. +
    transaction.payload_type PayloadType + (Enum)The type of transaction payload. +
    Available values:
      +
    • PAYLOAD_TYPE_UNSPECIFIED = 0 (Unspecified payload type.)
      • +
    • PAYLOAD_TYPE_TRANSFER = 1 (Transfer payload type.)
      • +
    • PAYLOAD_TYPE_BOND = 2 (Bond payload type.)
      • +
    • PAYLOAD_TYPE_SORTITION = 3 (Sortition payload type.)
      • +
    • PAYLOAD_TYPE_UNBOND = 4 (Unbond payload type.)
      • +
    • PAYLOAD_TYPE_WITHDRAW = 5 (Withdraw payload type.)
      • +
    • PAYLOAD_TYPE_BATCH_TRANSFER = 6 (Batch transfer payload type.)
      • +
    +
    transaction.transfer PayloadTransfer + (OneOf)Transfer transaction payload. +
    transaction.transfer.sender string + The sender's address. +
    transaction.transfer.receiver string + The receiver's address. +
    transaction.transfer.amount int64 + The amount to be transferred in NanoPAC. +
    transaction.bond PayloadBond + (OneOf)Bond transaction payload. +
    transaction.bond.sender string + The sender's address. +
    transaction.bond.receiver string + The receiver's address. +
    transaction.bond.stake int64 + The stake amount in NanoPAC. +
    transaction.bond.public_key string + The public key of the validator. +
    transaction.sortition PayloadSortition + (OneOf)Sortition transaction payload. +
    transaction.sortition.address string + The validator address associated with the sortition proof. +
    transaction.sortition.proof string + The proof for the sortition. +
    transaction.unbond PayloadUnbond + (OneOf)Unbond transaction payload. +
    transaction.unbond.validator string + The address of the validator to unbond from. +
    transaction.withdraw PayloadWithdraw + (OneOf)Withdraw transaction payload. +
    transaction.withdraw.validator_address string + The address of the validator to withdraw from. +
    transaction.withdraw.account_address string + The address of the account to withdraw to. +
    transaction.withdraw.amount int64 + The withdrawal amount in NanoPAC. +
    transaction.batch_transfer PayloadBatchTransfer + (OneOf)Batch Transfer transaction payload. +
    transaction.batch_transfer.sender string + The sender's address. +
    transaction.batch_transfer.recipientsrepeated Recipient + The list of recipients with their amounts. +
    transaction.memo string + A memo string for the transaction. +
    transaction.public_key string + The public key associated with the transaction. +
    transaction.signature string + The signature for the transaction. +
    transaction.block_height uint32 + The block height containing the transaction. A value of zero means the transaction is unconfirmed and may still in the transaction pool. -
    transaction.confirmed bool - Indicates whether the transaction is confirmed. -
    transaction.confirmations int32 - The number of blocks that have been added to the chain after this transaction was included in a block. +
    transaction.confirmed bool + Indicates whether the transaction is confirmed. +
    transaction.confirmations int32 + The number of blocks that have been added to the chain after this transaction was included in a block. A value of zero means the transaction is unconfirmed and may still in the transaction pool. -
    #### CalculateFee @@ -556,35 +542,36 @@ A value of zero means the transaction is unconfirmed and may still in the transa amount int64 - The amount involved in the transaction, specified in NanoPAC. + The amount involved in the transaction, specified in NanoPAC. payload_type PayloadType - (Enum)The type of transaction payload. -
    Available values: + (Enum)The type of transaction payload.
    Available values: + fixed_amount bool - Indicates if the amount should be fixed and include the fee. + Indicates if the amount should be fixed and include the fee. -

    CalculateFeeResponse Response

    + +

    CalculateFeeResponse Response

    @@ -595,17 +582,17 @@ A value of zero means the transaction is unconfirmed and may still in the transa - + - +
    amount int64 - The calculated amount in NanoPAC. + The calculated amount in NanoPAC.
    fee int64 - The calculated transaction fee in NanoPAC. + The calculated transaction fee in NanoPAC.
    #### BroadcastTransaction @@ -623,12 +610,13 @@ A value of zero means the transaction is unconfirmed and may still in the transa signed_raw_transaction string - The signed raw transaction data to be broadcasted. + The signed raw transaction data to be broadcasted. -

    BroadcastTransactionResponse Response

    + +

    BroadcastTransactionResponse Response

    @@ -639,10 +627,10 @@ A value of zero means the transaction is unconfirmed and may still in the transa - +
    id string - The unique ID of the broadcasted transaction. + The unique ID of the broadcasted transaction.
    #### GetRawTransferTransaction @@ -660,47 +648,48 @@ A value of zero means the transaction is unconfirmed and may still in the transa lock_time uint32 - The lock time for the transaction. If not set, defaults to the last block height. + The lock time for the transaction. If not set, defaults to the last block height. sender string - The sender's account address. + The sender's account address. receiver string - The receiver's account address. + The receiver's account address. amount int64 - The amount to be transferred, specified in NanoPAC. Must be greater than 0. + The amount to be transferred, specified in NanoPAC. Must be greater than 0. fee int64 - The transaction fee in NanoPAC. If not set, it is set to the estimated fee. + The transaction fee in NanoPAC. If not set, it is set to the estimated fee. memo string - A memo string for the transaction. + A memo string for the transaction. -

    GetRawTransactionResponse Response

    + +

    GetRawTransactionResponse Response

    @@ -711,17 +700,17 @@ A value of zero means the transaction is unconfirmed and may still in the transa - + - +
    raw_transaction string - The raw transaction data in hexadecimal format. + The raw transaction data in hexadecimal format.
    id string - The unique ID of the transaction. + The unique ID of the transaction.
    #### GetRawBondTransaction @@ -739,54 +728,55 @@ A value of zero means the transaction is unconfirmed and may still in the transa lock_time uint32 - The lock time for the transaction. If not set, defaults to the last block height. + The lock time for the transaction. If not set, defaults to the last block height. sender string - The sender's account address. + The sender's account address. receiver string - The receiver's validator address. + The receiver's validator address. stake int64 - The stake amount in NanoPAC. Must be greater than 0. + The stake amount in NanoPAC. Must be greater than 0. public_key string - The public key of the validator. Optional, but required when registering a new validator. + The public key of the validator. Optional, but required when registering a new validator. fee int64 - The transaction fee in NanoPAC. If not set, it is set to the estimated fee. + The transaction fee in NanoPAC. If not set, it is set to the estimated fee. memo string - A memo string for the transaction. + A memo string for the transaction. -

    GetRawTransactionResponse Response

    + +

    GetRawTransactionResponse Response

    @@ -797,17 +787,17 @@ A value of zero means the transaction is unconfirmed and may still in the transa - + - +
    raw_transaction string - The raw transaction data in hexadecimal format. + The raw transaction data in hexadecimal format.
    id string - The unique ID of the transaction. + The unique ID of the transaction.
    #### GetRawUnbondTransaction @@ -825,26 +815,27 @@ A value of zero means the transaction is unconfirmed and may still in the transa lock_time uint32 - The lock time for the transaction. If not set, defaults to the last block height. + The lock time for the transaction. If not set, defaults to the last block height. validator_address string - The address of the validator to unbond from. + The address of the validator to unbond from. memo string - A memo string for the transaction. + A memo string for the transaction. -

    GetRawTransactionResponse Response

    + +

    GetRawTransactionResponse Response

    @@ -855,17 +846,17 @@ A value of zero means the transaction is unconfirmed and may still in the transa - + - +
    raw_transaction string - The raw transaction data in hexadecimal format. + The raw transaction data in hexadecimal format.
    id string - The unique ID of the transaction. + The unique ID of the transaction.
    #### GetRawWithdrawTransaction @@ -883,47 +874,48 @@ A value of zero means the transaction is unconfirmed and may still in the transa lock_time uint32 - The lock time for the transaction. If not set, defaults to the last block height. + The lock time for the transaction. If not set, defaults to the last block height. validator_address string - The address of the validator to withdraw from. + The address of the validator to withdraw from. account_address string - The address of the account to withdraw to. + The address of the account to withdraw to. amount int64 - The withdrawal amount in NanoPAC. Must be greater than 0. + The withdrawal amount in NanoPAC. Must be greater than 0. fee int64 - The transaction fee in NanoPAC. If not set, it is set to the estimated fee. + The transaction fee in NanoPAC. If not set, it is set to the estimated fee. memo string - A memo string for the transaction. + A memo string for the transaction. -

    GetRawTransactionResponse Response

    + +

    GetRawTransactionResponse Response

    @@ -934,17 +926,17 @@ A value of zero means the transaction is unconfirmed and may still in the transa - + - +
    raw_transaction string - The raw transaction data in hexadecimal format. + The raw transaction data in hexadecimal format.
    id string - The unique ID of the transaction. + The unique ID of the transaction.
    #### GetRawBatchTransferTransaction @@ -962,40 +954,41 @@ A value of zero means the transaction is unconfirmed and may still in the transa lock_time uint32 - The lock time for the transaction. If not set, defaults to the last block height. + The lock time for the transaction. If not set, defaults to the last block height. sender string - The sender's account address. + The sender's account address. recipients repeated Recipient - The list of recipients with their amounts. Minimum 2 recipients required. + The list of recipients with their amounts. Minimum 2 recipients required. fee int64 - The transaction fee in NanoPAC. If not set, it is set to the estimated fee. + The transaction fee in NanoPAC. If not set, it is set to the estimated fee. memo string - A memo string for the transaction. + A memo string for the transaction. -

    GetRawTransactionResponse Response

    + +

    GetRawTransactionResponse Response

    @@ -1006,17 +999,17 @@ A value of zero means the transaction is unconfirmed and may still in the transa - + - +
    raw_transaction string - The raw transaction data in hexadecimal format. + The raw transaction data in hexadecimal format.
    id string - The unique ID of the transaction. + The unique ID of the transaction.
    #### DecodeRawTransaction @@ -1034,12 +1027,13 @@ A value of zero means the transaction is unconfirmed and may still in the transa raw_transaction string - The raw transaction data in hexadecimal format. + The raw transaction data in hexadecimal format. -

    DecodeRawTransactionResponse Response

    + +

    DecodeRawTransactionResponse Response

    @@ -1050,681 +1044,909 @@ A value of zero means the transaction is unconfirmed and may still in the transa - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    transaction TransactionInfo - The decoded transaction information. + The decoded transaction information.
    transaction.id string - The unique ID of the transaction. -
    transaction.data string - The raw transaction data in hexadecimal format. -
    transaction.version int32 - The version of the transaction. -
    transaction.lock_time uint32 - The lock time for the transaction. -
    transaction.value int64 - The value of the transaction in NanoPAC. -
    transaction.fee int64 - The fee for the transaction in NanoPAC. -
    transaction.payload_type PayloadType - (Enum)The type of transaction payload. -
    Available values:
      -
    • PAYLOAD_TYPE_UNSPECIFIED = 0 (Unspecified payload type.)
      • -
    • PAYLOAD_TYPE_TRANSFER = 1 (Transfer payload type.)
      • -
    • PAYLOAD_TYPE_BOND = 2 (Bond payload type.)
      • -
    • PAYLOAD_TYPE_SORTITION = 3 (Sortition payload type.)
      • -
    • PAYLOAD_TYPE_UNBOND = 4 (Unbond payload type.)
      • -
    • PAYLOAD_TYPE_WITHDRAW = 5 (Withdraw payload type.)
      • -
    • PAYLOAD_TYPE_BATCH_TRANSFER = 6 (Batch transfer payload type.)
      • -
    -
    transaction.transfer PayloadTransfer - (OneOf)Transfer transaction payload. -
    transaction.transfer.sender string - The sender's address. -
    transaction.transfer.receiver string - The receiver's address. -
    transaction.transfer.amount int64 - The amount to be transferred in NanoPAC. -
    transaction.bond PayloadBond - (OneOf)Bond transaction payload. -
    transaction.bond.sender string - The sender's address. -
    transaction.bond.receiver string - The receiver's address. -
    transaction.bond.stake int64 - The stake amount in NanoPAC. -
    transaction.bond.public_key string - The public key of the validator. -
    transaction.sortition PayloadSortition - (OneOf)Sortition transaction payload. -
    transaction.sortition.address string - The validator address associated with the sortition proof. -
    transaction.sortition.proof string - The proof for the sortition. -
    transaction.unbond PayloadUnbond - (OneOf)Unbond transaction payload. -
    transaction.unbond.validator string - The address of the validator to unbond from. -
    transaction.withdraw PayloadWithdraw - (OneOf)Withdraw transaction payload. -
    transaction.withdraw.validator_address string - The address of the validator to withdraw from. -
    transaction.withdraw.account_address string - The address of the account to withdraw to. -
    transaction.withdraw.amount int64 - The withdrawal amount in NanoPAC. -
    transaction.batch_transfer PayloadBatchTransfer - (OneOf)Batch Transfer transaction payload. -
    transaction.batch_transfer.sender string - The sender's address. -
    transaction.batch_transfer.recipientsrepeated Recipient - The list of recipients with their amounts. -
    transaction.memo string - A memo string for the transaction. -
    transaction.public_key string - The public key associated with the transaction. -
    transaction.signature string - The signature for the transaction. -
    transaction.block_height uint32 - The block height containing the transaction. -A value of zero means the transaction is unconfirmed and may still in the transaction pool. -
    transaction.confirmed bool - Indicates whether the transaction is confirmed. -
    transaction.confirmations int32 - The number of blocks that have been added to the chain after this transaction was included in a block. -A value of zero means the transaction is unconfirmed and may still in the transaction pool. -
    - -### Blockchain Service - -

    Blockchain service defines RPC methods for interacting with the blockchain.

    - -#### GetBlock - -

    GetBlock retrieves information about a block based on the provided request parameters.

    - -

    GetBlockRequest Request

    - - - - - - - - - + + + - - - + + + - -
    FieldTypeDescription
    height uint32
    transaction.id string - The height of the block to retrieve. + The unique ID of the transaction.
    verbosity BlockVerbosity
    transaction.data string - (Enum)The verbosity level for block information. -
    Available values:
      -
    • BLOCK_VERBOSITY_DATA = 0 (Request only block data.)
      • -
    • BLOCK_VERBOSITY_INFO = 1 (Request block information and transaction IDs.)
      • -
    • BLOCK_VERBOSITY_TRANSACTIONS = 2 (Request block information and detailed transaction data.)
      • -
    + The raw transaction data in hexadecimal format.
    -

    GetBlockResponse Response

    - - - - - - - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldTypeDescription
    height uint32
    transaction.version int32 - The height of the block. + The version of the transaction.
    hash string
    transaction.lock_time uint32 - The hash of the block. + The lock time for the transaction.
    data string
    transaction.value int64 - Block data, available only if verbosity level is set to BLOCK_VERBOSITY_DATA. + The value of the transaction in NanoPAC.
    block_time uint32
    transaction.fee int64 - The timestamp of the block. + The fee for the transaction in NanoPAC.
    header BlockHeaderInfo
    transaction.payload_type PayloadType - Header information of the block. + (Enum)The type of transaction payload. +
    Available values:
      +
    • PAYLOAD_TYPE_UNSPECIFIED = 0 (Unspecified payload type.)
      • +
    • PAYLOAD_TYPE_TRANSFER = 1 (Transfer payload type.)
      • +
    • PAYLOAD_TYPE_BOND = 2 (Bond payload type.)
      • +
    • PAYLOAD_TYPE_SORTITION = 3 (Sortition payload type.)
      • +
    • PAYLOAD_TYPE_UNBOND = 4 (Unbond payload type.)
      • +
    • PAYLOAD_TYPE_WITHDRAW = 5 (Withdraw payload type.)
      • +
    • PAYLOAD_TYPE_BATCH_TRANSFER = 6 (Batch transfer payload type.)
      • +
    header.version int32 - The version of the block. -
    header.prev_block_hash string - The hash of the previous block. -
    header.state_root string - The state root hash of the blockchain. -
    header.sortition_seed string - The sortition seed of the block. -
    header.proposer_address string - The address of the proposer of the block. -
    prev_cert CertificateInfo
    transaction.transfer PayloadTransfer - Certificate information of the previous block. + (OneOf)Transfer transaction payload.
    prev_cert.hash string - The hash of the certificate. -
    prev_cert.round int32 - The round of the certificate. -
    prev_cert.committersrepeated int32 - List of committers in the certificate. -
    prev_cert.absenteesrepeated int32 - List of absentees in the certificate. -
    prev_cert.signature string - The signature of the certificate. -
    transaction.transfer.sender string + The sender's address. +
    transaction.transfer.receiver string + The receiver's address. +
    transaction.transfer.amount int64 + The amount to be transferred in NanoPAC. +
    transaction.bond PayloadBond + (OneOf)Bond transaction payload. +
    transaction.bond.sender string + The sender's address. +
    transaction.bond.receiver string + The receiver's address. +
    transaction.bond.stake int64 + The stake amount in NanoPAC. +
    transaction.bond.public_key string + The public key of the validator. +
    transaction.sortition PayloadSortition + (OneOf)Sortition transaction payload. +
    transaction.sortition.address string + The validator address associated with the sortition proof. +
    transaction.sortition.proof string + The proof for the sortition. +
    transaction.unbond PayloadUnbond + (OneOf)Unbond transaction payload. +
    transaction.unbond.validator string + The address of the validator to unbond from. +
    transaction.withdraw PayloadWithdraw + (OneOf)Withdraw transaction payload. +
    transaction.withdraw.validator_address string + The address of the validator to withdraw from. +
    transaction.withdraw.account_address string + The address of the account to withdraw to. +
    transaction.withdraw.amount int64 + The withdrawal amount in NanoPAC. +
    transaction.batch_transfer PayloadBatchTransfer + (OneOf)Batch Transfer transaction payload. +
    transaction.batch_transfer.sender string + The sender's address. +
    transaction.batch_transfer.recipientsrepeated Recipient + The list of recipients with their amounts. +
    transaction.memo string + A memo string for the transaction. +
    transaction.public_key string + The public key associated with the transaction. +
    transaction.signature string + The signature for the transaction. +
    transaction.block_height uint32 + The block height containing the transaction. +A value of zero means the transaction is unconfirmed and may still in the transaction pool. +
    transaction.confirmed bool + Indicates whether the transaction is confirmed. +
    transaction.confirmations int32 + The number of blocks that have been added to the chain after this transaction was included in a block. +A value of zero means the transaction is unconfirmed and may still in the transaction pool. +
    + +### Blockchain Service + +

    Blockchain service defines RPC methods for interacting with the blockchain.

    + +#### GetBlock + +

    GetBlock retrieves information about a block based on the provided request parameters.

    + +

    GetBlockRequest Request

    + + + + + + + + + + + + + + + + + +
    FieldTypeDescription
    height uint32 + The height of the block to retrieve. +
    verbosity BlockVerbosity + (Enum)The verbosity level for block information.
    Available values: +
      +
    • BLOCK_VERBOSITY_DATA = 0 (Request only block data.)
      • +
    • BLOCK_VERBOSITY_INFO = 1 (Request block information and transaction IDs.)
      • +
    • BLOCK_VERBOSITY_TRANSACTIONS = 2 (Request block information and detailed transaction data.)
      • +
    +
    + +

    GetBlockResponse Response

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldTypeDescription
    height uint32 + The height of the block. +
    hash string + The hash of the block. +
    data string + Block data, available only if verbosity level is set to BLOCK_VERBOSITY_DATA. +
    block_time uint32 + The timestamp of the block. +
    header BlockHeaderInfo + Header information of the block. +
    header.version int32 + The version of the block. +
    header.prev_block_hash string + The hash of the previous block. +
    header.state_root string + The state root hash of the blockchain. +
    header.sortition_seed string + The sortition seed of the block. +
    header.proposer_address string + The address of the proposer of the block. +
    prev_cert CertificateInfo + Certificate information of the previous block. +
    prev_cert.hash string + The hash of the certificate. +
    prev_cert.round int32 + The round of the certificate. +
    prev_cert.committersrepeated int32 + List of committers in the certificate. +
    prev_cert.absenteesrepeated int32 + List of absentees in the certificate. +
    prev_cert.signature string + The signature of the certificate. +
    txs repeated TransactionInfo - List of transactions in the block, available when verbosity level is set to -BLOCK_VERBOSITY_TRANSACTIONS. + List of transactions in the block, available when verbosity level is set to +BLOCK_VERBOSITY_TRANSACTIONS. +
    txs[].id string + The unique ID of the transaction. +
    txs[].data string + The raw transaction data in hexadecimal format. +
    txs[].version int32 + The version of the transaction. +
    txs[].lock_time uint32 + The lock time for the transaction. +
    txs[].value int64 + The value of the transaction in NanoPAC. +
    txs[].fee int64 + The fee for the transaction in NanoPAC. +
    txs[].payload_type PayloadType + (Enum)The type of transaction payload. +
    Available values:
      +
    • PAYLOAD_TYPE_UNSPECIFIED = 0 (Unspecified payload type.)
      • +
    • PAYLOAD_TYPE_TRANSFER = 1 (Transfer payload type.)
      • +
    • PAYLOAD_TYPE_BOND = 2 (Bond payload type.)
      • +
    • PAYLOAD_TYPE_SORTITION = 3 (Sortition payload type.)
      • +
    • PAYLOAD_TYPE_UNBOND = 4 (Unbond payload type.)
      • +
    • PAYLOAD_TYPE_WITHDRAW = 5 (Withdraw payload type.)
      • +
    • PAYLOAD_TYPE_BATCH_TRANSFER = 6 (Batch transfer payload type.)
      • +
    +
    txs[].transfer PayloadTransfer + (OneOf)Transfer transaction payload. +
    txs[].transfer.sender string + The sender's address. +
    txs[].transfer.receiver string + The receiver's address. +
    txs[].transfer.amount int64 + The amount to be transferred in NanoPAC. +
    txs[].bond PayloadBond + (OneOf)Bond transaction payload. +
    txs[].bond.sender string + The sender's address. +
    txs[].bond.receiver string + The receiver's address. +
    txs[].bond.stake int64 + The stake amount in NanoPAC. +
    txs[].bond.public_key string + The public key of the validator. +
    txs[].sortition PayloadSortition + (OneOf)Sortition transaction payload. +
    txs[].sortition.address string + The validator address associated with the sortition proof. +
    txs[].sortition.proof string + The proof for the sortition. +
    txs[].unbond PayloadUnbond + (OneOf)Unbond transaction payload. +
    txs[].unbond.validator string + The address of the validator to unbond from. +
    txs[].withdraw PayloadWithdraw + (OneOf)Withdraw transaction payload. +
    txs[].withdraw.validator_address string + The address of the validator to withdraw from. +
    txs[].withdraw.account_address string + The address of the account to withdraw to. +
    txs[].withdraw.amount int64 + The withdrawal amount in NanoPAC. +
    txs[].batch_transfer PayloadBatchTransfer + (OneOf)Batch Transfer transaction payload. +
    txs[].batch_transfer.sender string + The sender's address. +
    txs[].batch_transfer.recipientsrepeated Recipient + The list of recipients with their amounts. +
    txs[].memo string + A memo string for the transaction. +
    txs[].public_key string + The public key associated with the transaction. +
    txs[].signature string + The signature for the transaction. +
    txs[].block_height uint32 + The block height containing the transaction. +A value of zero means the transaction is unconfirmed and may still in the transaction pool. +
    txs[].confirmed bool + Indicates whether the transaction is confirmed. +
    txs[].confirmations int32 + The number of blocks that have been added to the chain after this transaction was included in a block. +A value of zero means the transaction is unconfirmed and may still in the transaction pool. +
    + +#### GetBlockHash + +

    GetBlockHash retrieves the hash of a block at the specified height.

    + +

    GetBlockHashRequest Request

    + + + + + + + + + + + + +
    FieldTypeDescription
    height uint32 + The height of the block to retrieve the hash for. +
    + +

    GetBlockHashResponse Response

    + + + + + + + + + + + + +
    FieldTypeDescription
    hash string + The hash of the block. +
    + +#### GetBlockHeight + +

    GetBlockHeight retrieves the height of a block with the specified hash.

    + +

    GetBlockHeightRequest Request

    + + + + + + + + + + + + +
    FieldTypeDescription
    hash string + The hash of the block to retrieve the height for. +
    + +

    GetBlockHeightResponse Response

    + + + + + + + + + + + + +
    FieldTypeDescription
    height uint32 + The height of the block. +
    + +#### GetBlockchainInfo + +

    GetBlockchainInfo retrieves general information about the blockchain.

    + +

    GetBlockchainInfoRequest Request

    +Request Message has no fields. + +

    GetBlockchainInfoResponse Response

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldTypeDescription
    last_block_height uint32 + The height of the last block in the blockchain. +
    last_block_hash string + The hash of the last block in the blockchain. +
    total_accounts int32 + The total number of accounts in the blockchain. +
    total_validators int32 + The total number of validators in the blockchain. +
    active_validators int32 + The number of active (not unbonded) validators in the blockchain. +
    total_power int64 + The total power of the blockchain. +
    committee_power int64 + The power of the committee. +
    committee_validatorsrepeated ValidatorInfo + List of committee validators. +
    committee_validators[].hash string + The hash of the validator. +
    committee_validators[].data string + The serialized data of the validator. +
    committee_validators[].public_key string + The public key of the validator. +
    committee_validators[].number int32 + The unique number assigned to the validator.
    txs[].id string - The unique ID of the transaction. -
    txs[].data string - The raw transaction data in hexadecimal format. -
    txs[].version int32 - The version of the transaction. -
    txs[].lock_time uint32 - The lock time for the transaction. -
    txs[].value int64 - The value of the transaction in NanoPAC. -
    txs[].fee int64 - The fee for the transaction in NanoPAC. -
    txs[].payload_type PayloadType - (Enum)The type of transaction payload. -
    Available values:
      -
    • PAYLOAD_TYPE_UNSPECIFIED = 0 (Unspecified payload type.)
      • -
    • PAYLOAD_TYPE_TRANSFER = 1 (Transfer payload type.)
      • -
    • PAYLOAD_TYPE_BOND = 2 (Bond payload type.)
      • -
    • PAYLOAD_TYPE_SORTITION = 3 (Sortition payload type.)
      • -
    • PAYLOAD_TYPE_UNBOND = 4 (Unbond payload type.)
      • -
    • PAYLOAD_TYPE_WITHDRAW = 5 (Withdraw payload type.)
      • -
    • PAYLOAD_TYPE_BATCH_TRANSFER = 6 (Batch transfer payload type.)
      • -
    -
    txs[].transfer PayloadTransfer - (OneOf)Transfer transaction payload. -
    txs[].transfer.sender string - The sender's address. -
    txs[].transfer.receiver string - The receiver's address. -
    txs[].transfer.amount int64 - The amount to be transferred in NanoPAC. -
    txs[].bond PayloadBond - (OneOf)Bond transaction payload. -
    txs[].bond.sender string - The sender's address. -
    txs[].bond.receiver string - The receiver's address. -
    txs[].bond.stake int64 - The stake amount in NanoPAC. -
    txs[].bond.public_key string - The public key of the validator. -
    txs[].sortition PayloadSortition - (OneOf)Sortition transaction payload. -
    txs[].sortition.address string - The validator address associated with the sortition proof. -
    txs[].sortition.proof string - The proof for the sortition. -
    txs[].unbond PayloadUnbond - (OneOf)Unbond transaction payload. -
    txs[].unbond.validator string - The address of the validator to unbond from. -
    txs[].withdraw PayloadWithdraw - (OneOf)Withdraw transaction payload. -
    txs[].withdraw.validator_address string - The address of the validator to withdraw from. -
    txs[].withdraw.account_address string - The address of the account to withdraw to. -
    txs[].withdraw.amount int64 - The withdrawal amount in NanoPAC. -
    txs[].batch_transfer PayloadBatchTransfer - (OneOf)Batch Transfer transaction payload. -
    txs[].batch_transfer.sender string - The sender's address. -
    txs[].batch_transfer.recipientsrepeated Recipient - The list of recipients with their amounts. -
    txs[].memo string - A memo string for the transaction. -
    txs[].public_key string - The public key associated with the transaction. -
    txs[].signature string - The signature for the transaction. -
    txs[].block_height uint32 - The block height containing the transaction. -A value of zero means the transaction is unconfirmed and may still in the transaction pool. -
    txs[].confirmed bool - Indicates whether the transaction is confirmed. -
    txs[].confirmations int32 - The number of blocks that have been added to the chain after this transaction was included in a block. -A value of zero means the transaction is unconfirmed and may still in the transaction pool. -
    committee_validators[].stake int64 + The stake of the validator in NanoPAC. +
    committee_validators[].last_bonding_height uint32 + The height at which the validator last bonded. +
    committee_validators[].last_sortition_height uint32 + The height at which the validator last participated in sortition. +
    committee_validators[].unbonding_height uint32 + The height at which the validator will unbond. +
    committee_validators[].address string + The address of the validator. +
    committee_validators[].availability_score double + The availability score of the validator. +
    committee_validators[].protocol_version int32 + The protocol version of the validator. +
    is_pruned bool + If the blocks are subject to pruning. +
    pruning_height uint32 + Lowest-height block stored (only present if pruning is enabled) +
    last_block_time int64 + Timestamp of the last block in Unix format +
    committee_protocol_versions map<int32, double> + Map of protocol versions and their percentages in the committee. +
    -#### GetBlockHash +#### GetConsensusInfo -

    GetBlockHash retrieves the hash of a block at the specified height.

    +

    GetConsensusInfo retrieves information about the consensus instances.

    -

    GetBlockHashRequest Request

    +

    GetConsensusInfoRequest Request

    +Request Message has no fields. + +

    GetConsensusInfoResponse Response

    @@ -1732,15 +1954,151 @@ A value of zero means the transaction is unconfirmed and may still in the transa - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    heightproposal ProposalInfo + The proposal of the consensus info. +
    proposal.height uint32 + The height of the proposal. +
    proposal.round int32 + The round of the proposal. +
    proposal.block_data string + The block data of the proposal. +
    proposal.signature string + The signature of the proposal, signed by the proposer. +
    instancesrepeated ConsensusInfo + List of consensus instances. +
    instances[].address string + The address of the consensus instance. +
    instances[].active bool + Indicates whether the consensus instance is active and part of the committee. +
    instances[].height uint32 - The height of the block to retrieve the hash for. + The height of the consensus instance. +
    instances[].round int32 + The round of the consensus instance. +
    instances[].votesrepeated VoteInfo + List of votes in the consensus instance. +
    instances[].votes[].type VoteType + (Enum)The type of the vote. +
    Available values:
      +
    • VOTE_TYPE_UNSPECIFIED = 0 (Unspecified vote type.)
      • +
    • VOTE_TYPE_PREPARE = 1 (Prepare vote type.)
      • +
    • VOTE_TYPE_PRECOMMIT = 2 (Precommit vote type.)
      • +
    • VOTE_TYPE_CP_PRE_VOTE = 3 (Change-proposer:pre-vote vote type.)
      • +
    • VOTE_TYPE_CP_MAIN_VOTE = 4 (Change-proposer:main-vote vote type.)
      • +
    • VOTE_TYPE_CP_DECIDED = 5 (Change-proposer:decided vote type.)
      • +
    +
    instances[].votes[].voter string + The address of the voter. +
    instances[].votes[].block_hash string + The hash of the block being voted on. +
    instances[].votes[].round int32 + The consensus round of the vote. +
    instances[].votes[].cp_round int32 + The change-proposer round of the vote. +
    instances[].votes[].cp_value int32 + The change-proposer value of the vote. +
    + +#### GetAccount + +

    GetAccount retrieves information about an account based on the provided address.

    + +

    GetAccountRequest Request

    + + + + + + + + + +
    FieldTypeDescription
    address string + The address of the account to retrieve information for.
    -

    GetBlockHashResponse Response

    + +

    GetAccountResponse Response

    @@ -1748,20 +2106,55 @@ A value of zero means the transaction is unconfirmed and may still in the transa - + + + + + + + + + + + + + + + + + + + + + + + + + + - +
    hashaccount AccountInfo + Detailed information about the account. +
    account.hash string + The hash of the account. +
    account.data string + The serialized data of the account. +
    account.number int32 + The unique number assigned to the account. +
    account.balance int64 + The balance of the account in NanoPAC. +
    account.address string - The hash of the block. + The address of the account.
    -#### GetBlockHeight +#### GetValidator -

    GetBlockHeight retrieves the height of a block with the specified hash.

    +

    GetValidator retrieves information about a validator based on the provided address.

    -

    GetBlockHeightRequest Request

    +

    GetValidatorRequest Request

    @@ -1769,15 +2162,16 @@ A value of zero means the transaction is unconfirmed and may still in the transa - +
    hashaddress string - The hash of the block to retrieve the height for. + The address of the validator to retrieve information for.
    -

    GetBlockHeightResponse Response

    + +

    GetValidatorResponse Response

    @@ -1785,23 +2179,114 @@ A value of zero means the transaction is unconfirmed and may still in the transa - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    heightvalidator ValidatorInfo + Detailed information about the validator. +
    validator.hash string + The hash of the validator. +
    validator.data string + The serialized data of the validator. +
    validator.public_key string + The public key of the validator. +
    validator.number int32 + The unique number assigned to the validator. +
    validator.stake int64 + The stake of the validator in NanoPAC. +
    validator.last_bonding_height uint32 + The height at which the validator last bonded. +
    validator.last_sortition_height uint32 + The height at which the validator last participated in sortition. +
    validator.unbonding_height uint32 - The height of the block. + The height at which the validator will unbond. +
    validator.address string + The address of the validator. +
    validator.availability_score double + The availability score of the validator. +
    validator.protocol_version int32 + The protocol version of the validator. +
    + +#### GetValidatorByNumber + +

    GetValidatorByNumber retrieves information about a validator based on the provided number.

    + +

    GetValidatorByNumberRequest Request

    + + + + + + + + + + - +
    FieldTypeDescription
    number int32 + The unique number of the validator to retrieve information for.
    -#### GetBlockchainInfo - -

    GetBlockchainInfo retrieves general information about the blockchain.

    - -

    GetBlockchainInfoRequest Request

    - -Message has no fields. -

    GetBlockchainInfoResponse Response

    +

    GetValidatorResponse Response

    @@ -1809,177 +2294,100 @@ Message has no fields. - - + + - - + + - - - + + + - - - + + + - - + + - - + + - - - + + + - - - + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + - - - + + + - - - + + + - - - + + + - +
    last_block_height uint32validator ValidatorInfo - The height of the last block in the blockchain. + Detailed information about the validator.
    last_block_hash
    validator.hash string - The hash of the last block in the blockchain. + The hash of the validator.
    total_accounts int32
    validator.data string - The total number of accounts in the blockchain. + The serialized data of the validator.
    total_validators int32
    validator.public_key string - The total number of validators in the blockchain. + The public key of the validator.
    active_validators
    validator.number int32 - The number of active (not unbonded) validators in the blockchain. + The unique number assigned to the validator.
    total_power
    validator.stake int64 - The total power of the blockchain. + The stake of the validator in NanoPAC.
    committee_power int64
    validator.last_bonding_height uint32 - The power of the committee. + The height at which the validator last bonded.
    committee_validatorsrepeated ValidatorInfo
    validator.last_sortition_height uint32 - List of committee validators. + The height at which the validator last participated in sortition.
    committee_validators[].hash string - The hash of the validator. -
    committee_validators[].data string - The serialized data of the validator. -
    committee_validators[].public_key string - The public key of the validator. -
    committee_validators[].number int32 - The unique number assigned to the validator. -
    committee_validators[].stake int64 - The stake of the validator in NanoPAC. -
    committee_validators[].last_bonding_height uint32 - The height at which the validator last bonded. -
    committee_validators[].last_sortition_height uint32 - The height at which the validator last participated in sortition. -
    committee_validators[].unbonding_height uint32 - The height at which the validator will unbond. -
    committee_validators[].address string - The address of the validator. -
    committee_validators[].availability_score double - The availability score of the validator. -
    committee_validators[].protocol_version int32 - The protocol version of the validator. -
    is_pruned bool
    validator.unbonding_height uint32 - If the blocks are subject to pruning. + The height at which the validator will unbond.
    pruning_height uint32
    validator.address string - Lowest-height block stored (only present if pruning is enabled) + The address of the validator.
    last_block_time int64
    validator.availability_score double - Timestamp of the last block in Unix format + The availability score of the validator.
    committee_protocol_versions map<int32, double>
    validator.protocol_version int32 - Map of protocol versions and their percentages in the committee. + The protocol version of the validator.
    -#### GetConsensusInfo +#### GetValidatorAddresses -

    GetConsensusInfo retrieves information about the consensus instances.

    +

    GetValidatorAddresses retrieves a list of all validator addresses.

    -

    GetConsensusInfoRequest Request

    +

    GetValidatorAddressesRequest Request

    +Request Message has no fields. -Message has no fields. -

    GetConsensusInfoResponse Response

    +

    GetValidatorAddressesResponse Response

    @@ -1987,140 +2395,20 @@ Message has no fields. - - - - - - - - - - - - - - - - - - - - - - - - - - - + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
    proposal ProposalInfo - The proposal of the consensus info. -
    proposal.height uint32 - The height of the proposal. -
    proposal.round int32 - The round of the proposal. -
    proposal.block_data string - The block data of the proposal. -
    proposal.signature string - The signature of the proposal, signed by the proposer. -
    instancesrepeated ConsensusInfoaddressesrepeated string - List of consensus instances. + List of validator addresses.
    instances[].address string - The address of the consensus instance. -
    instances[].active bool - Indicates whether the consensus instance is active and part of the committee. -
    instances[].height uint32 - The height of the consensus instance. -
    instances[].round int32 - The round of the consensus instance. -
    instances[].votesrepeated VoteInfo - List of votes in the consensus instance. -
    instances[].votes[].type VoteType - (Enum)The type of the vote. -
    Available values:
      -
    • VOTE_TYPE_UNSPECIFIED = 0 (Unspecified vote type.)
      • -
    • VOTE_TYPE_PREPARE = 1 (Prepare vote type.)
      • -
    • VOTE_TYPE_PRECOMMIT = 2 (Precommit vote type.)
      • -
    • VOTE_TYPE_CP_PRE_VOTE = 3 (Change-proposer:pre-vote vote type.)
      • -
    • VOTE_TYPE_CP_MAIN_VOTE = 4 (Change-proposer:main-vote vote type.)
      • -
    • VOTE_TYPE_CP_DECIDED = 5 (Change-proposer:decided vote type.)
      • -
    -
    instances[].votes[].voter string - The address of the voter. -
    instances[].votes[].block_hash string - The hash of the block being voted on. -
    instances[].votes[].round int32 - The consensus round of the vote. -
    instances[].votes[].cp_round int32 - The change-proposer round of the vote. -
    instances[].votes[].cp_value int32 - The change-proposer value of the vote. -
    -#### GetAccount +#### GetPublicKey -

    GetAccount retrieves information about an account based on the provided address.

    +

    GetPublicKey retrieves the public key of an account based on the provided address.

    -

    GetAccountRequest Request

    +

    GetPublicKeyRequest Request

    @@ -2131,12 +2419,13 @@ Message has no fields.
    address string - The address of the account to retrieve information for. + The address for which to retrieve the public key.
    -

    GetAccountResponse Response

    + +

    GetPublicKeyResponse Response

    @@ -2144,55 +2433,20 @@ Message has no fields. - - + + - - - - - - - - - - - - - - - - - - - - - - - - - - +
    account AccountInfopublic_key string - Detailed information about the account. + The public key associated with the provided address.
    account.hash string - The hash of the account. -
    account.data string - The serialized data of the account. -
    account.number int32 - The unique number assigned to the account. -
    account.balance int64 - The balance of the account in NanoPAC. -
    account.address string - The address of the account. -
    -#### GetValidator +#### GetTxPoolContent -

    GetValidator retrieves information about a validator based on the provided address.

    +

    GetTxPoolContent retrieves current transactions in the transaction pool.

    -

    GetValidatorRequest Request

    +

    GetTxPoolContentRequest Request

    @@ -2200,15 +2454,25 @@ Message has no fields. - - + +
    address stringpayload_type PayloadType - The address of the validator to retrieve information for. + (Enum)The type of transactions to retrieve from the transaction pool. 0 means all types.
    Available values: +
      +
    • PAYLOAD_TYPE_UNSPECIFIED = 0 (Unspecified payload type.)
      • +
    • PAYLOAD_TYPE_TRANSFER = 1 (Transfer payload type.)
      • +
    • PAYLOAD_TYPE_BOND = 2 (Bond payload type.)
      • +
    • PAYLOAD_TYPE_SORTITION = 3 (Sortition payload type.)
      • +
    • PAYLOAD_TYPE_UNBOND = 4 (Unbond payload type.)
      • +
    • PAYLOAD_TYPE_WITHDRAW = 5 (Withdraw payload type.)
      • +
    • PAYLOAD_TYPE_BATCH_TRANSFER = 6 (Batch transfer payload type.)
      • +
    -

    GetValidatorResponse Response

    + +

    GetTxPoolContentResponse Response

    @@ -2216,560 +2480,247 @@ Message has no fields. - - + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    validator ValidatorInfotxsrepeated TransactionInfo - Detailed information about the validator. + List of transactions currently in the pool.
    validator.hash string - The hash of the validator. -
    validator.data string - The serialized data of the validator. -
    validator.public_key string - The public key of the validator. -
    validator.number int32 - The unique number assigned to the validator. -
    validator.stake int64 - The stake of the validator in NanoPAC. -
    validator.last_bonding_height uint32 - The height at which the validator last bonded. -
    validator.last_sortition_height uint32 - The height at which the validator last participated in sortition. -
    validator.unbonding_height uint32 - The height at which the validator will unbond. -
    validator.address string - The address of the validator. -
    validator.availability_score double - The availability score of the validator. -
    validator.protocol_version int32 - The protocol version of the validator. -
    - -#### GetValidatorByNumber - -

    GetValidatorByNumber retrieves information about a validator based on the provided number.

    - -

    GetValidatorByNumberRequest Request

    - - - - - - - - + + + + + + + + + + + + - -
    FieldTypeDescription
    number
    txs[].id string + The unique ID of the transaction. +
    txs[].data string + The raw transaction data in hexadecimal format. +
    txs[].version int32 - The unique number of the validator to retrieve information for. + The version of the transaction.
    -

    GetValidatorResponse Response

    - - - - - - - - - + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeDescription
    validator ValidatorInfo
    txs[].lock_time uint32 - Detailed information about the validator. + The lock time for the transaction.
    validator.hash string - The hash of the validator. -
    validator.data string - The serialized data of the validator. -
    validator.public_key string - The public key of the validator. -
    validator.number int32 - The unique number assigned to the validator. -
    validator.stake int64 - The stake of the validator in NanoPAC. -
    validator.last_bonding_height uint32 - The height at which the validator last bonded. -
    validator.last_sortition_height uint32 - The height at which the validator last participated in sortition. -
    validator.unbonding_height uint32 - The height at which the validator will unbond. -
    validator.address string - The address of the validator. -
    validator.availability_score double - The availability score of the validator. -
    validator.protocol_version int32 - The protocol version of the validator. -
    - -#### GetValidatorAddresses - -

    GetValidatorAddresses retrieves a list of all validator addresses.

    - -

    GetValidatorAddressesRequest Request

    - -Message has no fields. -

    GetValidatorAddressesResponse Response

    - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - -
    FieldTypeDescription
    addressesrepeated string
    txs[].value int64 + The value of the transaction in NanoPAC. +
    txs[].fee int64 + The fee for the transaction in NanoPAC. +
    txs[].payload_type PayloadType + (Enum)The type of transaction payload. +
    Available values:
      +
    • PAYLOAD_TYPE_UNSPECIFIED = 0 (Unspecified payload type.)
      • +
    • PAYLOAD_TYPE_TRANSFER = 1 (Transfer payload type.)
      • +
    • PAYLOAD_TYPE_BOND = 2 (Bond payload type.)
      • +
    • PAYLOAD_TYPE_SORTITION = 3 (Sortition payload type.)
      • +
    • PAYLOAD_TYPE_UNBOND = 4 (Unbond payload type.)
      • +
    • PAYLOAD_TYPE_WITHDRAW = 5 (Withdraw payload type.)
      • +
    • PAYLOAD_TYPE_BATCH_TRANSFER = 6 (Batch transfer payload type.)
      • +
    +
    txs[].transfer PayloadTransfer + (OneOf)Transfer transaction payload. +
    txs[].transfer.sender string + The sender's address. +
    txs[].transfer.receiver string + The receiver's address. +
    txs[].transfer.amount int64 + The amount to be transferred in NanoPAC. +
    txs[].bond PayloadBond + (OneOf)Bond transaction payload. +
    txs[].bond.sender string + The sender's address. +
    txs[].bond.receiver string + The receiver's address. +
    txs[].bond.stake int64 + The stake amount in NanoPAC. +
    txs[].bond.public_key string + The public key of the validator. +
    txs[].sortition PayloadSortition + (OneOf)Sortition transaction payload. +
    txs[].sortition.address string + The validator address associated with the sortition proof. +
    txs[].sortition.proof string + The proof for the sortition. +
    txs[].unbond PayloadUnbond + (OneOf)Unbond transaction payload. +
    txs[].unbond.validator string + The address of the validator to unbond from. +
    txs[].withdraw PayloadWithdraw + (OneOf)Withdraw transaction payload. +
    txs[].withdraw.validator_address string + The address of the validator to withdraw from. +
    txs[].withdraw.account_address string + The address of the account to withdraw to. +
    txs[].withdraw.amount int64 + The withdrawal amount in NanoPAC. +
    txs[].batch_transfer PayloadBatchTransfer + (OneOf)Batch Transfer transaction payload. +
    txs[].batch_transfer.sender string - List of validator addresses. + The sender's address. +
    txs[].batch_transfer.recipientsrepeated Recipient + The list of recipients with their amounts. +
    txs[].memo string + A memo string for the transaction.
    - -#### GetPublicKey - -

    GetPublicKey retrieves the public key of an account based on the provided address.

    - -

    GetPublicKeyRequest Request

    - - - - - - - - + + - -
    FieldTypeDescription
    address
    txs[].public_key string - The address for which to retrieve the public key. + The public key associated with the transaction.
    -

    GetPublicKeyResponse Response

    - - - - - - - - + + - -
    FieldTypeDescription
    public_key
    txs[].signature string - The public key associated with the provided address. + The signature for the transaction.
    - -#### GetTxPoolContent - -

    GetTxPoolContent retrieves current transactions in the transaction pool.

    - -

    GetTxPoolContentRequest Request

    - - - - - - - - - + + + - -
    FieldTypeDescription
    payload_type PayloadType
    txs[].block_height uint32 - (Enum)The type of transactions to retrieve from the transaction pool. 0 means all types. -
    Available values:
      -
    • PAYLOAD_TYPE_UNSPECIFIED = 0 (Unspecified payload type.)
      • -
    • PAYLOAD_TYPE_TRANSFER = 1 (Transfer payload type.)
      • -
    • PAYLOAD_TYPE_BOND = 2 (Bond payload type.)
      • -
    • PAYLOAD_TYPE_SORTITION = 3 (Sortition payload type.)
      • -
    • PAYLOAD_TYPE_UNBOND = 4 (Unbond payload type.)
      • -
    • PAYLOAD_TYPE_WITHDRAW = 5 (Withdraw payload type.)
      • -
    • PAYLOAD_TYPE_BATCH_TRANSFER = 6 (Batch transfer payload type.)
      • -
    + The block height containing the transaction. +A value of zero means the transaction is unconfirmed and may still in the transaction pool.
    -

    GetTxPoolContentResponse Response

    - - - - - - - - - + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + - - + + +
    FieldTypeDescription
    txsrepeated TransactionInfo
    txs[].confirmed bool - List of transactions currently in the pool. + Indicates whether the transaction is confirmed.
    txs[].id string - The unique ID of the transaction. -
    txs[].data string - The raw transaction data in hexadecimal format. -
    txs[].version int32 - The version of the transaction. -
    txs[].lock_time uint32 - The lock time for the transaction. -
    txs[].value int64 - The value of the transaction in NanoPAC. -
    txs[].fee int64 - The fee for the transaction in NanoPAC. -
    txs[].payload_type PayloadType - (Enum)The type of transaction payload. -
    Available values:
      -
    • PAYLOAD_TYPE_UNSPECIFIED = 0 (Unspecified payload type.)
      • -
    • PAYLOAD_TYPE_TRANSFER = 1 (Transfer payload type.)
      • -
    • PAYLOAD_TYPE_BOND = 2 (Bond payload type.)
      • -
    • PAYLOAD_TYPE_SORTITION = 3 (Sortition payload type.)
      • -
    • PAYLOAD_TYPE_UNBOND = 4 (Unbond payload type.)
      • -
    • PAYLOAD_TYPE_WITHDRAW = 5 (Withdraw payload type.)
      • -
    • PAYLOAD_TYPE_BATCH_TRANSFER = 6 (Batch transfer payload type.)
      • -
    -
    txs[].transfer PayloadTransfer - (OneOf)Transfer transaction payload. -
    txs[].transfer.sender string - The sender's address. -
    txs[].transfer.receiver string - The receiver's address. -
    txs[].transfer.amount int64 - The amount to be transferred in NanoPAC. -
    txs[].bond PayloadBond - (OneOf)Bond transaction payload. -
    txs[].bond.sender string - The sender's address. -
    txs[].bond.receiver string - The receiver's address. -
    txs[].bond.stake int64 - The stake amount in NanoPAC. -
    txs[].bond.public_key string - The public key of the validator. -
    txs[].sortition PayloadSortition - (OneOf)Sortition transaction payload. -
    txs[].sortition.address string - The validator address associated with the sortition proof. -
    txs[].sortition.proof string - The proof for the sortition. -
    txs[].unbond PayloadUnbond - (OneOf)Unbond transaction payload. -
    txs[].unbond.validator string - The address of the validator to unbond from. -
    txs[].withdraw PayloadWithdraw - (OneOf)Withdraw transaction payload. -
    txs[].withdraw.validator_address string - The address of the validator to withdraw from. -
    txs[].withdraw.account_address string - The address of the account to withdraw to. -
    txs[].withdraw.amount int64 - The withdrawal amount in NanoPAC. -
    txs[].batch_transfer PayloadBatchTransfer - (OneOf)Batch Transfer transaction payload. -
    txs[].batch_transfer.sender string - The sender's address. -
    txs[].batch_transfer.recipientsrepeated Recipient - The list of recipients with their amounts. -
    txs[].memo string - A memo string for the transaction. -
    txs[].public_key string - The public key associated with the transaction. -
    txs[].signature string - The signature for the transaction. -
    txs[].block_height uint32 - The block height containing the transaction. -A value of zero means the transaction is unconfirmed and may still in the transaction pool. -
    txs[].confirmed bool - Indicates whether the transaction is confirmed. -
    txs[].confirmations int32 - The number of blocks that have been added to the chain after this transaction was included in a block. +
    txs[].confirmations int32 + The number of blocks that have been added to the chain after this transaction was included in a block. A value of zero means the transaction is unconfirmed and may still in the transaction pool. -
    ### Network Service @@ -2791,12 +2742,13 @@ A value of zero means the transaction is unconfirmed and may still in the transa only_connected bool - If true, returns only peers that are currently connected. + If true, returns only peers that are currently connected. -

    GetNetworkInfoResponse Response

    + +

    GetNetworkInfoResponse Response

    @@ -2807,274 +2759,263 @@ A value of zero means the transaction is unconfirmed and may still in the transa - + - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    network_name string - Name of the network. + Name of the network.
    connected_peers_count uint32 - Number of connected peers. + Number of connected peers.
    connected_peers repeated PeerInfo - List of connected peers. + List of connected peers.
    connected_peers[].status int32 - Current status of the peer (e.g., connected, disconnected). -
    connected_peers[].moniker string - Moniker or Human-Readable name of the peer. -
    connected_peers[].agent string - Version and agent details of the peer. -
    connected_peers[].peer_id string - Peer ID of the peer in P2P network. -
    connected_peers[].consensus_keysrepeated string - List of consensus keys used by the peer. -
    connected_peers[].consensus_addressesrepeated string - List of consensus addresses used by the peer. -
    connected_peers[].services uint32 - Bitfield representing the services provided by the peer. -
    connected_peers[].last_block_hash string - Hash of the last block the peer knows. -
    connected_peers[].height uint32 - Blockchain height of the peer. -
    connected_peers[].last_sent int64 - Unix timestamp of the last bundle sent to the peer (UTC). -
    connected_peers[].last_received int64 - Unix timestamp of the last bundle received from the peer (UTC). -
    connected_peers[].address string - Network address of the peer. -
    connected_peers[].direction Direction - (Enum)Connection direction (e.g., inbound, outbound). -
    Available values:
      -
    • DIRECTION_UNKNOWN = 0 (Unknown direction (default value).)
      • -
    • DIRECTION_INBOUND = 1 (Inbound connection - peer connected to us.)
      • -
    • DIRECTION_OUTBOUND = 2 (Outbound connection - we connected to peer.)
      • -
    -
    connected_peers[].protocolsrepeated string - List of protocols supported by the peer. -
    connected_peers[].total_sessions int32 - Total download sessions with the peer. -
    connected_peers[].completed_sessions int32 - Completed download sessions with the peer. -
    connected_peers[].metric_info MetricInfo - Metrics related to peer activity. -
    connected_peers[].metric_info.total_invalid CounterInfo - Total number of invalid bundles. -
    connected_peers[].metric_info.total_sent CounterInfo - Total number of bundles sent. -
    connected_peers[].metric_info.total_received CounterInfo - Total number of bundles received. -
    connected_peers[].metric_info.message_sent map<int32, CounterInfo> - Number of sent bundles categorized by message type. -
    connected_peers[].metric_info.message_received map<int32, CounterInfo> - Number of received bundles categorized by message type. -
    connected_peers[].outbound_hello_sent bool - Whether the hello message was sent from the outbound connection. -
    connected_peers[].status int32 + Current status of the peer (e.g., connected, disconnected). +
    connected_peers[].moniker string + Moniker or Human-Readable name of the peer. +
    connected_peers[].agent string + Version and agent details of the peer. +
    connected_peers[].peer_id string + Peer ID of the peer in P2P network. +
    connected_peers[].consensus_keysrepeated string + List of consensus keys used by the peer. +
    connected_peers[].consensus_addressesrepeated string + List of consensus addresses used by the peer. +
    connected_peers[].services uint32 + Bitfield representing the services provided by the peer. +
    connected_peers[].last_block_hash string + Hash of the last block the peer knows. +
    connected_peers[].height uint32 + Blockchain height of the peer. +
    connected_peers[].last_sent int64 + Unix timestamp of the last bundle sent to the peer (UTC). +
    connected_peers[].last_received int64 + Unix timestamp of the last bundle received from the peer (UTC). +
    connected_peers[].address string + Network address of the peer. +
    connected_peers[].direction Direction + (Enum)Connection direction (e.g., inbound, outbound). +
    Available values:
      +
    • DIRECTION_UNKNOWN = 0 (Unknown direction (default value).)
      • +
    • DIRECTION_INBOUND = 1 (Inbound connection - peer connected to us.)
      • +
    • DIRECTION_OUTBOUND = 2 (Outbound connection - we connected to peer.)
      • +
    +
    connected_peers[].protocolsrepeated string + List of protocols supported by the peer. +
    connected_peers[].total_sessions int32 + Total download sessions with the peer. +
    connected_peers[].completed_sessions int32 + Completed download sessions with the peer. +
    connected_peers[].metric_info MetricInfo + Metrics related to peer activity. +
    connected_peers[].metric_info.total_invalid CounterInfo + Total number of invalid bundles. +
    connected_peers[].metric_info.total_sent CounterInfo + Total number of bundles sent. +
    connected_peers[].metric_info.total_received CounterInfo + Total number of bundles received. +
    connected_peers[].metric_info.message_sent map<int32, CounterInfo> + Number of sent bundles categorized by message type. +
    connected_peers[].metric_info.message_received map<int32, CounterInfo> + Number of received bundles categorized by message type. +
    connected_peers[].outbound_hello_sent bool + Whether the hello message was sent from the outbound connection. +
    metric_info MetricInfo - Metrics related to node activity. + Metrics related to node activity.
    metric_info.total_invalid CounterInfo - Total number of invalid bundles. -
    metric_info.total_invalid.bytes uint64 - Total number of bytes. -
    metric_info.total_invalid.bundles uint64 - Total number of bundles. -
    metric_info.total_sent CounterInfo - Total number of bundles sent. -
    metric_info.total_sent.bytes uint64 - Total number of bytes. -
    metric_info.total_sent.bundles uint64 - Total number of bundles. -
    metric_info.total_received CounterInfo - Total number of bundles received. -
    metric_info.total_received.bytes uint64 - Total number of bytes. -
    metric_info.total_received.bundles uint64 - Total number of bundles. -
    metric_info.message_sent map<int32, CounterInfo> - Number of sent bundles categorized by message type. -
    metric_info.message_received map<int32, CounterInfo> - Number of received bundles categorized by message type. -
    metric_info.total_invalid CounterInfo + Total number of invalid bundles. +
    metric_info.total_invalid.bytes uint64 + Total number of bytes. +
    metric_info.total_invalid.bundles uint64 + Total number of bundles. +
    metric_info.total_sent CounterInfo + Total number of bundles sent. +
    metric_info.total_sent.bytes uint64 + Total number of bytes. +
    metric_info.total_sent.bundles uint64 + Total number of bundles. +
    metric_info.total_received CounterInfo + Total number of bundles received. +
    metric_info.total_received.bytes uint64 + Total number of bytes. +
    metric_info.total_received.bundles uint64 + Total number of bundles. +
    metric_info.message_sent map<int32, CounterInfo> + Number of sent bundles categorized by message type. +
    metric_info.message_received map<int32, CounterInfo> + Number of received bundles categorized by message type. +
    #### GetNodeInfo @@ -3082,9 +3023,9 @@ A value of zero means the transaction is unconfirmed and may still in the transa

    GetNodeInfo retrieves information about a specific node in the network.

    GetNodeInfoRequest Request

    +Request Message has no fields. -Message has no fields. -

    GetNodeInfoResponse Response

    +

    GetNodeInfoResponse Response

    @@ -3095,137 +3036,137 @@ Message has no fields. - + - + - + - + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - - - - - - - - - - - - - - - - + + + - - - - - - - - - - - - - - + + + - - + + + - +
    moniker string - Moniker or Human-readable name identifying this node in the network. + Moniker or Human-readable name identifying this node in the network.
    agent string - Version and agent details of the node. + Version and agent details of the node.
    peer_id string - Peer ID of the node. + Peer ID of the node.
    started_at uint64 - Unix timestamp when the node was started (UTC). + Unix timestamp when the node was started (UTC).
    reachability string - Reachability status of the node. + Reachability status of the node.
    services int32 - Bitfield representing the services provided by the node. + Bitfield representing the services provided by the node.
    services_names string - Names of services provided by the node. + Names of services provided by the node. +
    local_addrsrepeated string + List of addresses associated with the node. +
    protocolsrepeated string + List of protocols supported by the node. +
    clock_offset double + Offset between the node's clock and the network's clock (in seconds). +
    connection_info ConnectionInfo + Information about the node's connections. +
    connection_info.connections uint64 + Total number of connections.
    local_addrsrepeated string
    connection_info.inbound_connections uint64 - List of addresses associated with the node. + Number of inbound connections.
    protocolsrepeated string
    connection_info.outbound_connections uint64 - List of protocols supported by the node. + Number of outbound connections.
    clock_offset double
    zmq_publishersrepeated ZMQPublisherInfo - Offset between the node's clock and the network's clock (in seconds). + List of active ZeroMQ publishers.
    connection_info ConnectionInfo
    zmq_publishers[].topic string - Information about the node's connections. + The topic associated with the publisher.
    connection_info.connections uint64 - Total number of connections. -
    connection_info.inbound_connections uint64 - Number of inbound connections. -
    connection_info.outbound_connections uint64 - Number of outbound connections. -
    zmq_publishersrepeated ZMQPublisherInfo
    zmq_publishers[].address string - List of active ZeroMQ publishers. + The address of the publisher.
    zmq_publishers[].topic string - The topic associated with the publisher. -
    zmq_publishers[].address string - The address of the publisher. -
    zmq_publishers[].hwm int32 - The high-water mark (HWM) for the publisher, indicating the +
    zmq_publishers[].hwm int32 + The high-water mark (HWM) for the publisher, indicating the maximum number of messages to queue before dropping older ones. -
    current_time uint64 - Current Unix timestamp of the node (UTC). + Current Unix timestamp of the node (UTC).
    #### Ping @@ -3233,11 +3174,10 @@ maximum number of messages to queue before dropping older ones.

    Ping provides a simple connectivity test and latency measurement.

    PingRequest Request

    +Request Message has no fields. -Message has no fields. -

    PingResponse Response

    - - +

    PingResponse Response

    +Response Message has no fields. ### Utils Service @@ -3259,19 +3199,20 @@ signing, verification, and other cryptographic operations.

    private_key string - The private key to sign the message. + The private key to sign the message. message string - The message content to be signed. + The message content to be signed. -

    SignMessageWithPrivateKeyResponse Response

    + +

    SignMessageWithPrivateKeyResponse Response

    @@ -3282,10 +3223,10 @@ signing, verification, and other cryptographic operations.

    - +
    signature string - The resulting signature in hexadecimal format. + The resulting signature in hexadecimal format.
    #### VerifyMessage @@ -3303,26 +3244,27 @@ signing, verification, and other cryptographic operations.

    message string - The original message content that was signed. + The original message content that was signed. signature string - The signature to verify in hexadecimal format. + The signature to verify in hexadecimal format. public_key string - The public key of the signer. + The public key of the signer. -

    VerifyMessageResponse Response

    + +

    VerifyMessageResponse Response

    @@ -3333,10 +3275,10 @@ signing, verification, and other cryptographic operations.

    - +
    is_valid bool - Boolean indicating whether the signature is valid for the given message and public key. + Boolean indicating whether the signature is valid for the given message and public key.
    #### PublicKeyAggregation @@ -3354,12 +3296,13 @@ signing, verification, and other cryptographic operations.

    public_keys repeated string - List of BLS public keys to be aggregated. + List of BLS public keys to be aggregated. -

    PublicKeyAggregationResponse Response

    + +

    PublicKeyAggregationResponse Response

    @@ -3370,17 +3313,17 @@ signing, verification, and other cryptographic operations.

    - + - +
    public_key string - The aggregated BLS public key. + The aggregated BLS public key.
    address string - The blockchain address derived from the aggregated public key. + The blockchain address derived from the aggregated public key.
    #### SignatureAggregation @@ -3398,12 +3341,13 @@ signing, verification, and other cryptographic operations.

    signatures repeated string - List of BLS signatures to be aggregated. + List of BLS signatures to be aggregated. -

    SignatureAggregationResponse Response

    + +

    SignatureAggregationResponse Response

    @@ -3414,10 +3358,10 @@ signing, verification, and other cryptographic operations.

    - +
    signature string - The aggregated BLS signature in hexadecimal format. + The aggregated BLS signature in hexadecimal format.
    ### Wallet Service @@ -3439,19 +3383,20 @@ signing, verification, and other cryptographic operations.

    wallet_name string - The name for the new wallet. + The name for the new wallet. password string - Password to secure the new wallet. + Password to secure the new wallet. -

    CreateWalletResponse Response

    + +

    CreateWalletResponse Response

    @@ -3462,17 +3407,17 @@ signing, verification, and other cryptographic operations.

    - + - +
    wallet_name string - The name for the new wallet. + The name for the new wallet.
    mnemonic string - The mnemonic (seed phrase) for wallet recovery. + The mnemonic (seed phrase) for wallet recovery.
    #### RestoreWallet @@ -3490,26 +3435,27 @@ signing, verification, and other cryptographic operations.

    wallet_name string - The name for the restored wallet. + The name for the restored wallet. mnemonic string - The mnemonic (seed phrase) for wallet recovery. + The mnemonic (seed phrase) for wallet recovery. password string - Password to secure the restored wallet. + Password to secure the restored wallet. -

    RestoreWalletResponse Response

    + +

    RestoreWalletResponse Response

    @@ -3520,10 +3466,10 @@ signing, verification, and other cryptographic operations.

    - +
    wallet_name string - The name of the restored wallet. + The name of the restored wallet.
    #### LoadWallet @@ -3542,12 +3488,13 @@ deprecated: It will be removed in a future version.

    wallet_name string - The name of the wallet to load. + The name of the wallet to load. -

    LoadWalletResponse Response

    + +

    LoadWalletResponse Response

    @@ -3558,10 +3505,10 @@ deprecated: It will be removed in a future version.

    - +
    wallet_name string - The name of the loaded wallet. + The name of the loaded wallet.
    #### UnloadWallet @@ -3580,12 +3527,13 @@ deprecated: It will be removed in a future version.

    wallet_name string - The name of the wallet to unload. + The name of the wallet to unload. -

    UnloadWalletResponse Response

    + +

    UnloadWalletResponse Response

    @@ -3596,10 +3544,10 @@ deprecated: It will be removed in a future version.

    - +
    wallet_name string - The name of the unloaded wallet. + The name of the unloaded wallet.
    #### ListWallets @@ -3607,9 +3555,9 @@ deprecated: It will be removed in a future version.

    ListWallets returns a list of all available wallets.

    ListWalletsRequest Request

    +Request Message has no fields. -Message has no fields. -

    ListWalletsResponse Response

    +

    ListWalletsResponse Response

    @@ -3620,10 +3568,10 @@ Message has no fields. - +
    wallets repeated string - Array of wallet names. + Array of wallet names.
    #### GetWalletInfo @@ -3641,12 +3589,13 @@ Message has no fields. wallet_name string - The name of the wallet to query. + The name of the wallet to query. -

    GetWalletInfoResponse Response

    + +

    GetWalletInfoResponse Response

    @@ -3657,66 +3606,66 @@ Message has no fields. - + - + - + - + - + - + - + - + - +
    wallet_name string - The name of the wallet. + The name of the wallet.
    version int32 - The wallet format version. + The wallet format version.
    network string - The network the wallet is connected to (e.g., mainnet, testnet). + The network the wallet is connected to (e.g., mainnet, testnet).
    encrypted bool - Indicates if the wallet is encrypted. + Indicates if the wallet is encrypted.
    uuid string - A unique identifier of the wallet. + A unique identifier of the wallet.
    created_at int64 - Unix timestamp of wallet creation. + Unix timestamp of wallet creation.
    default_fee int64 - The default fee of the wallet. + The default fee of the wallet.
    driver string - The storage driver used by the wallet (e.g., SQLite, Legacy JSON ). + The storage driver used by the wallet (e.g., SQLite, Legacy JSON ).
    path string - Path to the wallet file or storage location. + Path to the wallet file or storage location.
    #### UpdatePassword @@ -3734,26 +3683,27 @@ Message has no fields. wallet_name string - The name of the wallet whose password will be updated. + The name of the wallet whose password will be updated. old_password string - The current wallet password. + The current wallet password. new_password string - The new wallet password. + The new wallet password. -

    UpdatePasswordResponse Response

    + +

    UpdatePasswordResponse Response

    @@ -3764,10 +3714,10 @@ Message has no fields. - +
    wallet_name string - The name of the wallet whose password was updated. + The name of the wallet whose password was updated.
    #### GetTotalBalance @@ -3785,12 +3735,13 @@ Message has no fields. wallet_name string - The name of the wallet to get the total balance. + The name of the wallet to get the total balance. -

    GetTotalBalanceResponse Response

    + +

    GetTotalBalanceResponse Response

    @@ -3801,17 +3752,17 @@ Message has no fields. - + - +
    wallet_name string - The name of the queried wallet. + The name of the queried wallet.
    total_balance int64 - The total balance of the wallet in NanoPAC. + The total balance of the wallet in NanoPAC.
    #### GetTotalStake @@ -3829,12 +3780,13 @@ Message has no fields. wallet_name string - The name of the wallet to get the total stake. + The name of the wallet to get the total stake. -

    GetTotalStakeResponse Response

    + +

    GetTotalStakeResponse Response

    @@ -3845,17 +3797,17 @@ Message has no fields. - + - +
    wallet_name string - The name of the queried wallet. + The name of the queried wallet.
    total_stake int64 - The total stake amount in NanoPAC. + The total stake amount in NanoPAC.
    #### GetValidatorAddress @@ -3874,12 +3826,13 @@ Deprecated: Will move into utils.

    public_key string - The public key of the validator. + The public key of the validator. -

    GetValidatorAddressResponse Response

    + +

    GetValidatorAddressResponse Response

    @@ -3890,10 +3843,10 @@ Deprecated: Will move into utils.

    - +
    address string - The validator address associated with the public key. + The validator address associated with the public key.
    #### GetAddressInfo @@ -3911,19 +3864,20 @@ Deprecated: Will move into utils.

    wallet_name string - The name of the wallet containing the address. + The name of the wallet containing the address. address string - The address to query. + The address to query. -

    GetAddressInfoResponse Response

    + +

    GetAddressInfoResponse Response

    @@ -3934,45 +3888,45 @@ Deprecated: Will move into utils.

    - + - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + +
    wallet_name string - The name of the wallet containing the address. + The name of the wallet containing the address.
    address_info AddressInfo - Detailed information about the address. + Detailed information about the address.
    address_info.address string - The address string. -
    address_info.public_key string - The public key associated with the address. -
    address_info.label string - A human-readable label associated with the address. -
    address_info.path string - The Hierarchical Deterministic (HD) path of the address within the wallet. -
    address_info.address string + The address string. +
    address_info.public_key string + The public key associated with the address. +
    address_info.label string + A human-readable label associated with the address. +
    address_info.path string + The Hierarchical Deterministic (HD) path of the address within the wallet. +
    #### SetAddressLabel @@ -3990,33 +3944,34 @@ Deprecated: Will move into utils.

    wallet_name string - The name of the wallet containing the address. + The name of the wallet containing the address. password string - Wallet password required for modification. + Wallet password required for modification. address string - The address to label. + The address to label. label string - The new label for the address. + The new label for the address. -

    SetAddressLabelResponse Response

    + +

    SetAddressLabelResponse Response

    @@ -4027,24 +3982,24 @@ Deprecated: Will move into utils.

    - + - + - +
    wallet_name string - The name of the wallet where the address label was updated. + The name of the wallet where the address label was updated.
    address string - The address where the label was updated. + The address where the label was updated.
    label string - The new label for the address. + The new label for the address.
    #### GetNewAddress @@ -4062,41 +4017,42 @@ Deprecated: Will move into utils.

    wallet_name string - The name of the wallet to generate a new address. + The name of the wallet to generate a new address. address_type AddressType - (Enum)The type of address to generate. -
    Available values: label string - A label for the new address. + A label for the new address. password string - Password for the new address. It's required when address_type is Ed25519 type. + Password for the new address. It's required when address_type is Ed25519 type. -

    GetNewAddressResponse Response

    + +

    GetNewAddressResponse Response

    @@ -4107,45 +4063,45 @@ Note: Generating a new Ed25519 address requires the wallet password.) - + - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + +
    wallet_name string - The name of the wallet where address was generated. + The name of the wallet where address was generated.
    address_info AddressInfo - Detailed information about the new address. + Detailed information about the new address.
    address_info.address string - The address string. -
    address_info.public_key string - The public key associated with the address. -
    address_info.label string - A human-readable label associated with the address. -
    address_info.path string - The Hierarchical Deterministic (HD) path of the address within the wallet. -
    address_info.address string + The address string. +
    address_info.public_key string + The public key associated with the address. +
    address_info.label string + A human-readable label associated with the address. +
    address_info.path string + The Hierarchical Deterministic (HD) path of the address within the wallet. +
    #### ListAddresses @@ -4163,27 +4119,28 @@ Note: Generating a new Ed25519 address requires the wallet password.) wallet_name string - The name of the queried wallet. + The name of the queried wallet. address_types repeated AddressType - (Enum)Filter addresses by their types. If empty, all address types are included. -
    Available values: -

    ListAddressesResponse Response

    + +

    ListAddressesResponse Response

    @@ -4194,45 +4151,45 @@ Note: Generating a new Ed25519 address requires the wallet password.) - + - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + +
    wallet_name string - The name of the queried wallet. + The name of the queried wallet.
    data repeated AddressInfo - List of all addresses in the wallet with their details. + List of all addresses in the wallet with their details.
    data[].address string - The address string. -
    data[].public_key string - The public key associated with the address. -
    data[].label string - A human-readable label associated with the address. -
    data[].path string - The Hierarchical Deterministic (HD) path of the address within the wallet. -
    data[].address string + The address string. +
    data[].public_key string + The public key associated with the address. +
    data[].label string + A human-readable label associated with the address. +
    data[].path string + The Hierarchical Deterministic (HD) path of the address within the wallet. +
    #### SignMessage @@ -4250,33 +4207,34 @@ Note: Generating a new Ed25519 address requires the wallet password.) wallet_name string - The name of the wallet to sign with. + The name of the wallet to sign with. password string - Wallet password required for signing. + Wallet password required for signing. address string - The address whose private key should be used for signing the message. + The address whose private key should be used for signing the message. message string - The arbitrary message to be signed. + The arbitrary message to be signed. -

    SignMessageResponse Response

    + +

    SignMessageResponse Response

    @@ -4287,10 +4245,10 @@ Note: Generating a new Ed25519 address requires the wallet password.) - +
    signature string - The signature in hexadecimal format. + The signature in hexadecimal format.
    #### SignRawTransaction @@ -4308,26 +4266,27 @@ Note: Generating a new Ed25519 address requires the wallet password.) wallet_name string - The name of the wallet used for signing. + The name of the wallet used for signing. raw_transaction string - The raw transaction data to be signed. + The raw transaction data to be signed. password string - Wallet password required for signing. + Wallet password required for signing. -

    SignRawTransactionResponse Response

    + +

    SignRawTransactionResponse Response

    @@ -4338,17 +4297,17 @@ Note: Generating a new Ed25519 address requires the wallet password.) - + - +
    transaction_id string - The ID of the signed transaction. + The ID of the signed transaction.
    signed_raw_transaction string - The signed raw transaction data. + The signed raw transaction data.
    #### ListTransactions @@ -4367,14 +4326,14 @@ optionally filtered by a specific address, with pagination support.

    wallet_name string - The name of the wallet to query transactions for. + The name of the wallet to query transactions for. address string - Optional: The address to filter transactions. + Optional: The address to filter transactions. If empty or set to "*", transactions for all addresses in the wallet are included. @@ -4382,20 +4341,20 @@ If empty or set to "*", transactions for all addresses in the wallet are include direction TxDirection - (Enum)Filter transactions by direction relative to the wallet. -Defaults to any direction if not set. -
    Available values: + (Enum)Filter transactions by direction relative to the wallet. +Defaults to any direction if not set.
    Available values: + count int32 - Optional: The maximum number of transactions to return. + Optional: The maximum number of transactions to return. Defaults to 10 if not set. @@ -4403,13 +4362,14 @@ Defaults to 10 if not set. skip int32 - Optional: The number of transactions to skip (for pagination). + Optional: The number of transactions to skip (for pagination). Defaults to 0 if not set. -

    ListTransactionsResponse Response

    + +

    ListTransactionsResponse Response

    @@ -4420,273 +4380,256 @@ Defaults to 0 if not set. - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - + + + + + + + + + + - - -
    wallet_name string - The name of the wallet queried. + The name of the wallet queried.
    txs repeated TransactionInfo - List of transactions for the wallet, filtered by the specified address if provided. + List of transactions for the wallet, filtered by the specified address if provided.
    txs[].id string - The unique ID of the transaction. -
    txs[].data string - The raw transaction data in hexadecimal format. -
    txs[].version int32 - The version of the transaction. -
    txs[].lock_time uint32 - The lock time for the transaction. -
    txs[].value int64 - The value of the transaction in NanoPAC. -
    txs[].fee int64 - The fee for the transaction in NanoPAC. -
    txs[].payload_type PayloadType - (Enum)The type of transaction payload. -
    Available values:
      -
    • PAYLOAD_TYPE_UNSPECIFIED = 0 (Unspecified payload type.)
      • -
    • PAYLOAD_TYPE_TRANSFER = 1 (Transfer payload type.)
      • -
    • PAYLOAD_TYPE_BOND = 2 (Bond payload type.)
      • -
    • PAYLOAD_TYPE_SORTITION = 3 (Sortition payload type.)
      • -
    • PAYLOAD_TYPE_UNBOND = 4 (Unbond payload type.)
      • -
    • PAYLOAD_TYPE_WITHDRAW = 5 (Withdraw payload type.)
      • -
    • PAYLOAD_TYPE_BATCH_TRANSFER = 6 (Batch transfer payload type.)
      • -
    -
    txs[].transfer PayloadTransfer - (OneOf)Transfer transaction payload. -
    txs[].transfer.sender string - The sender's address. -
    txs[].transfer.receiver string - The receiver's address. -
    txs[].transfer.amount int64 - The amount to be transferred in NanoPAC. -
    txs[].bond PayloadBond - (OneOf)Bond transaction payload. -
    txs[].bond.sender string - The sender's address. -
    txs[].bond.receiver string - The receiver's address. -
    txs[].bond.stake int64 - The stake amount in NanoPAC. -
    txs[].bond.public_key string - The public key of the validator. -
    txs[].sortition PayloadSortition - (OneOf)Sortition transaction payload. -
    txs[].sortition.address string - The validator address associated with the sortition proof. -
    txs[].sortition.proof string - The proof for the sortition. -
    txs[].unbond PayloadUnbond - (OneOf)Unbond transaction payload. -
    txs[].unbond.validator string - The address of the validator to unbond from. -
    txs[].withdraw PayloadWithdraw - (OneOf)Withdraw transaction payload. -
    txs[].withdraw.validator_address string - The address of the validator to withdraw from. -
    txs[].withdraw.account_address string - The address of the account to withdraw to. -
    txs[].withdraw.amount int64 - The withdrawal amount in NanoPAC. -
    txs[].batch_transfer PayloadBatchTransfer - (OneOf)Batch Transfer transaction payload. -
    txs[].batch_transfer.sender string - The sender's address. -
    txs[].batch_transfer.recipientsrepeated Recipient - The list of recipients with their amounts. -
    txs[].memo string - A memo string for the transaction. -
    txs[].public_key string - The public key associated with the transaction. -
    txs[].signature string - The signature for the transaction. -
    txs[].block_height uint32 - The block height containing the transaction. +
    txs[].id string + The unique ID of the transaction. +
    txs[].data string + The raw transaction data in hexadecimal format. +
    txs[].version int32 + The version of the transaction. +
    txs[].lock_time uint32 + The lock time for the transaction. +
    txs[].value int64 + The value of the transaction in NanoPAC. +
    txs[].fee int64 + The fee for the transaction in NanoPAC. +
    txs[].payload_type PayloadType + (Enum)The type of transaction payload. +
    Available values:
      +
    • PAYLOAD_TYPE_UNSPECIFIED = 0 (Unspecified payload type.)
      • +
    • PAYLOAD_TYPE_TRANSFER = 1 (Transfer payload type.)
      • +
    • PAYLOAD_TYPE_BOND = 2 (Bond payload type.)
      • +
    • PAYLOAD_TYPE_SORTITION = 3 (Sortition payload type.)
      • +
    • PAYLOAD_TYPE_UNBOND = 4 (Unbond payload type.)
      • +
    • PAYLOAD_TYPE_WITHDRAW = 5 (Withdraw payload type.)
      • +
    • PAYLOAD_TYPE_BATCH_TRANSFER = 6 (Batch transfer payload type.)
      • +
    +
    txs[].transfer PayloadTransfer + (OneOf)Transfer transaction payload. +
    txs[].transfer.sender string + The sender's address. +
    txs[].transfer.receiver string + The receiver's address. +
    txs[].transfer.amount int64 + The amount to be transferred in NanoPAC. +
    txs[].bond PayloadBond + (OneOf)Bond transaction payload. +
    txs[].bond.sender string + The sender's address. +
    txs[].bond.receiver string + The receiver's address. +
    txs[].bond.stake int64 + The stake amount in NanoPAC. +
    txs[].bond.public_key string + The public key of the validator. +
    txs[].sortition PayloadSortition + (OneOf)Sortition transaction payload. +
    txs[].sortition.address string + The validator address associated with the sortition proof. +
    txs[].sortition.proof string + The proof for the sortition. +
    txs[].unbond PayloadUnbond + (OneOf)Unbond transaction payload. +
    txs[].unbond.validator string + The address of the validator to unbond from. +
    txs[].withdraw PayloadWithdraw + (OneOf)Withdraw transaction payload. +
    txs[].withdraw.validator_address string + The address of the validator to withdraw from. +
    txs[].withdraw.account_address string + The address of the account to withdraw to. +
    txs[].withdraw.amount int64 + The withdrawal amount in NanoPAC. +
    txs[].batch_transfer PayloadBatchTransfer + (OneOf)Batch Transfer transaction payload. +
    txs[].batch_transfer.sender string + The sender's address. +
    txs[].batch_transfer.recipientsrepeated Recipient + The list of recipients with their amounts. +
    txs[].memo string + A memo string for the transaction. +
    txs[].public_key string + The public key associated with the transaction. +
    txs[].signature string + The signature for the transaction. +
    txs[].block_height uint32 + The block height containing the transaction. A value of zero means the transaction is unconfirmed and may still in the transaction pool. -
    txs[].confirmed bool - Indicates whether the transaction is confirmed. -
    txs[].confirmations int32 - The number of blocks that have been added to the chain after this transaction was included in a block. +
    txs[].confirmed bool + Indicates whether the transaction is confirmed. +
    txs[].confirmations int32 + The number of blocks that have been added to the chain after this transaction was included in a block. A value of zero means the transaction is unconfirmed and may still in the transaction pool. -
    - -## Scalar Value Types + + + +## Scalar Value Types - + @@ -4805,9 +4748,10 @@ A value of zero means the transaction is unconfirmed and may still in the transa - +
    .proto TypeGoC++RustJavaPythonC#
    .proto TypeGoC++RustJavaPython
    bytes []byte stringVecVec<u8> ByteString str
    +
    diff --git a/content/api/json-rpc.md b/content/api/json-rpc.md index 592c3e6..7f00d7f 100644 --- a/content/api/json-rpc.md +++ b/content/api/json-rpc.md @@ -75,203 +75,203 @@ curl --location 'http://localhost:8545/' \
  • Blockchain Service +
  • Network Service +
  • Utils Service +
  • Wallet Service +
    • - +
    @@ -295,300 +295,285 @@ curl --location 'http://localhost:8545/' \ id string - The unique ID of the transaction to retrieve. + The unique ID of the transaction to retrieve. verbosity numeric - (Enum)The verbosity level for transaction details. -
    Available values: + (Enum)The verbosity level for transaction details.
    Available values: + -

    Result

    + +

    Result

    - + - - + - + - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - + + + + + + + + + + - - + + +
    FieldTypeDescription
    FieldTypeDescription
    block_height numeric - The height of the block containing the transaction. + The height of the block containing the transaction.
    block_time numeric - The UNIX timestamp of the block containing the transaction. + The UNIX timestamp of the block containing the transaction.
    transaction object (TransactionInfo) - Detailed information about the transaction. -
    transaction.id string - The unique ID of the transaction. -
    transaction.data string - The raw transaction data in hexadecimal format. -
    transaction.version numeric - The version of the transaction. -
    transaction.lock_time numeric - The lock time for the transaction. -
    transaction.value numeric - The value of the transaction in NanoPAC. -
    transaction.fee numeric - The fee for the transaction in NanoPAC. -
    transaction.payload_type numeric - (Enum)The type of transaction payload. -
    Available values:
      -
    • PAYLOAD_TYPE_UNSPECIFIED = 0 (Unspecified payload type.)
      • -
    • PAYLOAD_TYPE_TRANSFER = 1 (Transfer payload type.)
      • -
    • PAYLOAD_TYPE_BOND = 2 (Bond payload type.)
      • -
    • PAYLOAD_TYPE_SORTITION = 3 (Sortition payload type.)
      • -
    • PAYLOAD_TYPE_UNBOND = 4 (Unbond payload type.)
      • -
    • PAYLOAD_TYPE_WITHDRAW = 5 (Withdraw payload type.)
      • -
    • PAYLOAD_TYPE_BATCH_TRANSFER = 6 (Batch transfer payload type.)
      • -
    -
    transaction.transfer object (PayloadTransfer) - (OneOf)Transfer transaction payload. -
    transaction.transfer.sender string - The sender's address. -
    transaction.transfer.receiver string - The receiver's address. -
    transaction.transfer.amount numeric - The amount to be transferred in NanoPAC. -
    transaction.bond object (PayloadBond) - (OneOf)Bond transaction payload. -
    transaction.bond.sender string - The sender's address. -
    transaction.bond.receiver string - The receiver's address. -
    transaction.bond.stake numeric - The stake amount in NanoPAC. -
    transaction.bond.public_key string - The public key of the validator. -
    transaction.sortition object (PayloadSortition) - (OneOf)Sortition transaction payload. -
    transaction.sortition.address string - The validator address associated with the sortition proof. -
    transaction.sortition.proof string - The proof for the sortition. -
    transaction.unbond object (PayloadUnbond) - (OneOf)Unbond transaction payload. -
    transaction.unbond.validator string - The address of the validator to unbond from. -
    transaction.withdraw object (PayloadWithdraw) - (OneOf)Withdraw transaction payload. -
    transaction.withdraw.validator_address string - The address of the validator to withdraw from. -
    transaction.withdraw.account_address string - The address of the account to withdraw to. -
    transaction.withdraw.amount numeric - The withdrawal amount in NanoPAC. -
    transaction.batch_transfer object (PayloadBatchTransfer) - (OneOf)Batch Transfer transaction payload. -
    transaction.batch_transfer.sender string - The sender's address. -
    transaction.batch_transfer.recipientsrepeated object (Recipient) - The list of recipients with their amounts. -
    transaction.memo string - A memo string for the transaction. -
    transaction.public_key string - The public key associated with the transaction. -
    transaction.signature string - The signature for the transaction. -
    transaction.block_height numeric - The block height containing the transaction. + Detailed information about the transaction. +
    transaction.id string + The unique ID of the transaction. +
    transaction.data string + The raw transaction data in hexadecimal format. +
    transaction.version numeric + The version of the transaction. +
    transaction.lock_time numeric + The lock time for the transaction. +
    transaction.value numeric + The value of the transaction in NanoPAC. +
    transaction.fee numeric + The fee for the transaction in NanoPAC. +
    transaction.payload_type numeric + (Enum)The type of transaction payload.
    Available values: +
      +
    • PAYLOAD_TYPE_UNSPECIFIED = 0 (Unspecified payload type.)
      • +
    • PAYLOAD_TYPE_TRANSFER = 1 (Transfer payload type.)
      • +
    • PAYLOAD_TYPE_BOND = 2 (Bond payload type.)
      • +
    • PAYLOAD_TYPE_SORTITION = 3 (Sortition payload type.)
      • +
    • PAYLOAD_TYPE_UNBOND = 4 (Unbond payload type.)
      • +
    • PAYLOAD_TYPE_WITHDRAW = 5 (Withdraw payload type.)
      • +
    • PAYLOAD_TYPE_BATCH_TRANSFER = 6 (Batch transfer payload type.)
      • +
    +
    transaction.transfer object (PayloadTransfer) + (OneOf)Transfer transaction payload. +
    transaction.transfer.sender string + The sender's address. +
    transaction.transfer.receiver string + The receiver's address. +
    transaction.transfer.amount numeric + The amount to be transferred in NanoPAC. +
    transaction.bond object (PayloadBond) + (OneOf)Bond transaction payload. +
    transaction.bond.sender string + The sender's address. +
    transaction.bond.receiver string + The receiver's address. +
    transaction.bond.stake numeric + The stake amount in NanoPAC. +
    transaction.bond.public_key string + The public key of the validator. +
    transaction.sortition object (PayloadSortition) + (OneOf)Sortition transaction payload. +
    transaction.sortition.address string + The validator address associated with the sortition proof. +
    transaction.sortition.proof string + The proof for the sortition. +
    transaction.unbond object (PayloadUnbond) + (OneOf)Unbond transaction payload. +
    transaction.unbond.validator string + The address of the validator to unbond from. +
    transaction.withdraw object (PayloadWithdraw) + (OneOf)Withdraw transaction payload. +
    transaction.withdraw.validator_address string + The address of the validator to withdraw from. +
    transaction.withdraw.account_address string + The address of the account to withdraw to. +
    transaction.withdraw.amount numeric + The withdrawal amount in NanoPAC. +
    transaction.batch_transfer object (PayloadBatchTransfer) + (OneOf)Batch Transfer transaction payload. +
    transaction.batch_transfer.sender string + The sender's address. +
    transaction.batch_transfer.recipientsrepeated object (Recipient) + The list of recipients with their amounts. +
    transaction.memo string + A memo string for the transaction. +
    transaction.public_key string + The public key associated with the transaction. +
    transaction.signature string + The signature for the transaction. +
    transaction.block_height numeric + The block height containing the transaction. A value of zero means the transaction is unconfirmed and may still in the transaction pool. -
    transaction.confirmed boolean - Indicates whether the transaction is confirmed. -
    transaction.confirmations numeric - The number of blocks that have been added to the chain after this transaction was included in a block. +
    transaction.confirmed boolean + Indicates whether the transaction is confirmed. +
    transaction.confirmations numeric + The number of blocks that have been added to the chain after this transaction was included in a block. A value of zero means the transaction is unconfirmed and may still in the transaction pool. -
    #### pactus.transaction.calculate_fee @@ -606,56 +591,56 @@ A value of zero means the transaction is unconfirmed and may still in the transa amount numeric - The amount involved in the transaction, specified in NanoPAC. + The amount involved in the transaction, specified in NanoPAC. payload_type numeric - (Enum)The type of transaction payload. -
    Available values: + (Enum)The type of transaction payload.
    Available values: + fixed_amount boolean - Indicates if the amount should be fixed and include the fee. + Indicates if the amount should be fixed and include the fee. -

    Result

    + +

    Result

    - + - - + - + - +
    FieldTypeDescription
    FieldTypeDescription
    amount numeric - The calculated amount in NanoPAC. + The calculated amount in NanoPAC.
    fee numeric - The calculated transaction fee in NanoPAC. + The calculated transaction fee in NanoPAC.
    #### pactus.transaction.broadcast_transaction @@ -673,26 +658,26 @@ A value of zero means the transaction is unconfirmed and may still in the transa signed_raw_transaction string - The signed raw transaction data to be broadcasted. + The signed raw transaction data to be broadcasted. -

    Result

    + +

    Result

    - + - - + - +
    FieldTypeDescription
    FieldTypeDescription
    id string - The unique ID of the broadcasted transaction. + The unique ID of the broadcasted transaction.
    #### pactus.transaction.get_raw_transfer_transaction @@ -710,68 +695,68 @@ A value of zero means the transaction is unconfirmed and may still in the transa lock_time numeric - The lock time for the transaction. If not set, defaults to the last block height. + The lock time for the transaction. If not set, defaults to the last block height. sender string - The sender's account address. + The sender's account address. receiver string - The receiver's account address. + The receiver's account address. amount numeric - The amount to be transferred, specified in NanoPAC. Must be greater than 0. + The amount to be transferred, specified in NanoPAC. Must be greater than 0. fee numeric - The transaction fee in NanoPAC. If not set, it is set to the estimated fee. + The transaction fee in NanoPAC. If not set, it is set to the estimated fee. memo string - A memo string for the transaction. + A memo string for the transaction. -

    Result

    + +

    Result

    - + - - + - + - +
    FieldTypeDescription
    FieldTypeDescription
    raw_transaction string - The raw transaction data in hexadecimal format. + The raw transaction data in hexadecimal format.
    id string - The unique ID of the transaction. + The unique ID of the transaction.
    #### pactus.transaction.get_raw_bond_transaction @@ -789,75 +774,75 @@ A value of zero means the transaction is unconfirmed and may still in the transa lock_time numeric - The lock time for the transaction. If not set, defaults to the last block height. + The lock time for the transaction. If not set, defaults to the last block height. sender string - The sender's account address. + The sender's account address. receiver string - The receiver's validator address. + The receiver's validator address. stake numeric - The stake amount in NanoPAC. Must be greater than 0. + The stake amount in NanoPAC. Must be greater than 0. public_key string - The public key of the validator. Optional, but required when registering a new validator. + The public key of the validator. Optional, but required when registering a new validator. fee numeric - The transaction fee in NanoPAC. If not set, it is set to the estimated fee. + The transaction fee in NanoPAC. If not set, it is set to the estimated fee. memo string - A memo string for the transaction. + A memo string for the transaction. -

    Result

    + +

    Result

    - + - - + - + - +
    FieldTypeDescription
    FieldTypeDescription
    raw_transaction string - The raw transaction data in hexadecimal format. + The raw transaction data in hexadecimal format.
    id string - The unique ID of the transaction. + The unique ID of the transaction.
    #### pactus.transaction.get_raw_unbond_transaction @@ -875,47 +860,47 @@ A value of zero means the transaction is unconfirmed and may still in the transa lock_time numeric - The lock time for the transaction. If not set, defaults to the last block height. + The lock time for the transaction. If not set, defaults to the last block height. validator_address string - The address of the validator to unbond from. + The address of the validator to unbond from. memo string - A memo string for the transaction. + A memo string for the transaction. -

    Result

    + +

    Result

    - + - - + - + - +
    FieldTypeDescription
    FieldTypeDescription
    raw_transaction string - The raw transaction data in hexadecimal format. + The raw transaction data in hexadecimal format.
    id string - The unique ID of the transaction. + The unique ID of the transaction.
    #### pactus.transaction.get_raw_withdraw_transaction @@ -933,68 +918,68 @@ A value of zero means the transaction is unconfirmed and may still in the transa lock_time numeric - The lock time for the transaction. If not set, defaults to the last block height. + The lock time for the transaction. If not set, defaults to the last block height. validator_address string - The address of the validator to withdraw from. + The address of the validator to withdraw from. account_address string - The address of the account to withdraw to. + The address of the account to withdraw to. amount numeric - The withdrawal amount in NanoPAC. Must be greater than 0. + The withdrawal amount in NanoPAC. Must be greater than 0. fee numeric - The transaction fee in NanoPAC. If not set, it is set to the estimated fee. + The transaction fee in NanoPAC. If not set, it is set to the estimated fee. memo string - A memo string for the transaction. + A memo string for the transaction. -

    Result

    + +

    Result

    - + - - + - + - +
    FieldTypeDescription
    FieldTypeDescription
    raw_transaction string - The raw transaction data in hexadecimal format. + The raw transaction data in hexadecimal format.
    id string - The unique ID of the transaction. + The unique ID of the transaction.
    #### pactus.transaction.get_raw_batch_transfer_transaction @@ -1012,61 +997,61 @@ A value of zero means the transaction is unconfirmed and may still in the transa lock_time numeric - The lock time for the transaction. If not set, defaults to the last block height. + The lock time for the transaction. If not set, defaults to the last block height. sender string - The sender's account address. + The sender's account address. recipients repeated object (Recipient) - The list of recipients with their amounts. Minimum 2 recipients required. + The list of recipients with their amounts. Minimum 2 recipients required. fee numeric - The transaction fee in NanoPAC. If not set, it is set to the estimated fee. + The transaction fee in NanoPAC. If not set, it is set to the estimated fee. memo string - A memo string for the transaction. + A memo string for the transaction. -

    Result

    + +

    Result

    - + - - + - + - +
    FieldTypeDescription
    FieldTypeDescription
    raw_transaction string - The raw transaction data in hexadecimal format. + The raw transaction data in hexadecimal format.
    id string - The unique ID of the transaction. + The unique ID of the transaction.
    #### pactus.transaction.decode_raw_transaction @@ -1084,731 +1069,701 @@ A value of zero means the transaction is unconfirmed and may still in the transa raw_transaction string - The raw transaction data in hexadecimal format. + The raw transaction data in hexadecimal format. -

    Result

    + +

    Result

    - + - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeDescription
    FieldTypeDescription
    transaction object (TransactionInfo) - The decoded transaction information. -
    transaction.id string - The unique ID of the transaction. -
    transaction.data string - The raw transaction data in hexadecimal format. -
    transaction.version numeric - The version of the transaction. -
    transaction.lock_time numeric - The lock time for the transaction. -
    transaction.value numeric - The value of the transaction in NanoPAC. -
    transaction.fee numeric - The fee for the transaction in NanoPAC. -
    transaction.payload_type numeric - (Enum)The type of transaction payload. -
    Available values:
      -
    • PAYLOAD_TYPE_UNSPECIFIED = 0 (Unspecified payload type.)
      • -
    • PAYLOAD_TYPE_TRANSFER = 1 (Transfer payload type.)
      • -
    • PAYLOAD_TYPE_BOND = 2 (Bond payload type.)
      • -
    • PAYLOAD_TYPE_SORTITION = 3 (Sortition payload type.)
      • -
    • PAYLOAD_TYPE_UNBOND = 4 (Unbond payload type.)
      • -
    • PAYLOAD_TYPE_WITHDRAW = 5 (Withdraw payload type.)
      • -
    • PAYLOAD_TYPE_BATCH_TRANSFER = 6 (Batch transfer payload type.)
      • -
    -
    transaction.transfer object (PayloadTransfer) - (OneOf)Transfer transaction payload. -
    transaction.transfer.sender string - The sender's address. -
    transaction.transfer.receiver string - The receiver's address. -
    transaction.transfer.amount numeric - The amount to be transferred in NanoPAC. -
    transaction.bond object (PayloadBond) - (OneOf)Bond transaction payload. -
    transaction.bond.sender string - The sender's address. -
    transaction.bond.receiver string - The receiver's address. -
    transaction.bond.stake numeric - The stake amount in NanoPAC. -
    transaction.bond.public_key string - The public key of the validator. -
    transaction.sortition object (PayloadSortition) - (OneOf)Sortition transaction payload. -
    transaction.sortition.address string - The validator address associated with the sortition proof. -
    transaction.sortition.proof string - The proof for the sortition. -
    transaction.unbond object (PayloadUnbond) - (OneOf)Unbond transaction payload. -
    transaction.unbond.validator string - The address of the validator to unbond from. -
    transaction.withdraw object (PayloadWithdraw) - (OneOf)Withdraw transaction payload. -
    transaction.withdraw.validator_address string - The address of the validator to withdraw from. -
    transaction.withdraw.account_address string - The address of the account to withdraw to. -
    transaction.withdraw.amount numeric - The withdrawal amount in NanoPAC. -
    transaction.batch_transfer object (PayloadBatchTransfer) - (OneOf)Batch Transfer transaction payload. -
    transaction.batch_transfer.sender string - The sender's address. -
    transaction.batch_transfer.recipientsrepeated object (Recipient) - The list of recipients with their amounts. -
    transaction.memo string - A memo string for the transaction. -
    transaction.public_key string - The public key associated with the transaction. -
    transaction.signature string - The signature for the transaction. -
    transaction.block_height numeric - The block height containing the transaction. -A value of zero means the transaction is unconfirmed and may still in the transaction pool. -
    transaction.confirmed boolean - Indicates whether the transaction is confirmed. -
    transaction.confirmations numeric - The number of blocks that have been added to the chain after this transaction was included in a block. -A value of zero means the transaction is unconfirmed and may still in the transaction pool. -
    - -### Blockchain Service - -

    Blockchain service defines RPC methods for interacting with the blockchain.

    - -#### pactus.blockchain.get_block - -

    GetBlock retrieves information about a block based on the provided request parameters.

    - -

    Parameters

    - - - - - - - - - + The decoded transaction information. + + + + + - - + + + + + + + - -
    FieldTypeDescription
    height numeric
    transaction.id string - The height of the block to retrieve. + The unique ID of the transaction.
    verbosity
    transaction.data string + The raw transaction data in hexadecimal format. +
    transaction.version numeric - (Enum)The verbosity level for block information. -
    Available values:
      -
    • BLOCK_VERBOSITY_DATA = 0 (Request only block data.)
      • -
    • BLOCK_VERBOSITY_INFO = 1 (Request block information and transaction IDs.)
      • -
    • BLOCK_VERBOSITY_TRANSACTIONS = 2 (Request block information and detailed transaction data.)
      • -
    + The version of the transaction.
    -

    Result

    - - - - - - - - + + - - - + + + - - - + + + - - + + - - - + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + (OneOf)Transfer transaction payload. + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + The sender's address. + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeDescription
    height
    transaction.lock_time numeric - The height of the block. + The lock time for the transaction.
    hash string
    transaction.value numeric - The hash of the block. + The value of the transaction in NanoPAC.
    data string
    transaction.fee numeric - Block data, available only if verbosity level is set to BLOCK_VERBOSITY_DATA. + The fee for the transaction in NanoPAC.
    block_time
    transaction.payload_type numeric - The timestamp of the block. + (Enum)The type of transaction payload.
    Available values: +
      +
    • PAYLOAD_TYPE_UNSPECIFIED = 0 (Unspecified payload type.)
      • +
    • PAYLOAD_TYPE_TRANSFER = 1 (Transfer payload type.)
      • +
    • PAYLOAD_TYPE_BOND = 2 (Bond payload type.)
      • +
    • PAYLOAD_TYPE_SORTITION = 3 (Sortition payload type.)
      • +
    • PAYLOAD_TYPE_UNBOND = 4 (Unbond payload type.)
      • +
    • PAYLOAD_TYPE_WITHDRAW = 5 (Withdraw payload type.)
      • +
    • PAYLOAD_TYPE_BATCH_TRANSFER = 6 (Batch transfer payload type.)
      • +
    header object (BlockHeaderInfo)
    transaction.transfer object (PayloadTransfer) - Header information of the block. -
    header.version numeric - The version of the block. -
    header.prev_block_hash string - The hash of the previous block. -
    header.state_root string - The state root hash of the blockchain. -
    header.sortition_seed string - The sortition seed of the block. -
    header.proposer_address string - The address of the proposer of the block. -
    prev_cert object (CertificateInfo)
    transaction.transfer.sender string - Certificate information of the previous block. -
    prev_cert.hash string - The hash of the certificate. -
    prev_cert.round numeric - The round of the certificate. -
    prev_cert.committersrepeated numeric - List of committers in the certificate. -
    prev_cert.absenteesrepeated numeric - List of absentees in the certificate. -
    prev_cert.signature string - The signature of the certificate. -
    txsrepeated object (TransactionInfo)
    transaction.transfer.receiver string - List of transactions in the block, available when verbosity level is set to -BLOCK_VERBOSITY_TRANSACTIONS. + The receiver's address.
    txs[].id string - The unique ID of the transaction. -
    txs[].data string - The raw transaction data in hexadecimal format. -
    txs[].version numeric - The version of the transaction. -
    txs[].lock_time numeric - The lock time for the transaction. -
    txs[].value numeric - The value of the transaction in NanoPAC. -
    txs[].fee numeric - The fee for the transaction in NanoPAC. -
    txs[].payload_type numeric - (Enum)The type of transaction payload. -
    Available values:
      -
    • PAYLOAD_TYPE_UNSPECIFIED = 0 (Unspecified payload type.)
      • -
    • PAYLOAD_TYPE_TRANSFER = 1 (Transfer payload type.)
      • -
    • PAYLOAD_TYPE_BOND = 2 (Bond payload type.)
      • -
    • PAYLOAD_TYPE_SORTITION = 3 (Sortition payload type.)
      • -
    • PAYLOAD_TYPE_UNBOND = 4 (Unbond payload type.)
      • -
    • PAYLOAD_TYPE_WITHDRAW = 5 (Withdraw payload type.)
      • -
    • PAYLOAD_TYPE_BATCH_TRANSFER = 6 (Batch transfer payload type.)
      • -
    -
    txs[].transfer object (PayloadTransfer) - (OneOf)Transfer transaction payload. -
    txs[].transfer.sender string - The sender's address. -
    txs[].transfer.receiver string - The receiver's address. -
    txs[].transfer.amount numeric - The amount to be transferred in NanoPAC. -
    txs[].bond object (PayloadBond) - (OneOf)Bond transaction payload. -
    txs[].bond.sender string - The sender's address. -
    txs[].bond.receiver string - The receiver's address. -
    txs[].bond.stake numeric - The stake amount in NanoPAC. -
    txs[].bond.public_key string - The public key of the validator. -
    txs[].sortition object (PayloadSortition) - (OneOf)Sortition transaction payload. -
    txs[].sortition.address string - The validator address associated with the sortition proof. -
    txs[].sortition.proof string - The proof for the sortition. -
    txs[].unbond object (PayloadUnbond) - (OneOf)Unbond transaction payload. -
    txs[].unbond.validator string - The address of the validator to unbond from. -
    txs[].withdraw object (PayloadWithdraw) - (OneOf)Withdraw transaction payload. -
    txs[].withdraw.validator_address string - The address of the validator to withdraw from. -
    txs[].withdraw.account_address string - The address of the account to withdraw to. -
    txs[].withdraw.amount numeric - The withdrawal amount in NanoPAC. -
    txs[].batch_transfer object (PayloadBatchTransfer) - (OneOf)Batch Transfer transaction payload. -
    txs[].batch_transfer.sender string - The sender's address. -
    txs[].batch_transfer.recipientsrepeated object (Recipient) - The list of recipients with their amounts. -
    txs[].memo string - A memo string for the transaction. -
    txs[].public_key string - The public key associated with the transaction. -
    txs[].signature string - The signature for the transaction. -
    txs[].block_height numeric - The block height containing the transaction. -A value of zero means the transaction is unconfirmed and may still in the transaction pool. -
    txs[].confirmed boolean - Indicates whether the transaction is confirmed. -
    txs[].confirmations numeric - The number of blocks that have been added to the chain after this transaction was included in a block. -A value of zero means the transaction is unconfirmed and may still in the transaction pool. -
    - -#### pactus.blockchain.get_block_hash - -

    GetBlockHash retrieves the hash of a block at the specified height.

    - -

    Parameters

    - - - - - - - - + + + + + + - -
    FieldTypeDescription
    height
    transaction.transfer.amount numeric - The height of the block to retrieve the hash for. + The amount to be transferred in NanoPAC. +
    transaction.bond object (PayloadBond) + (OneOf)Bond transaction payload.
    -

    Result

    - - - - - - - - + + - - -
    FieldTypeDescription
    hash
    transaction.bond.sender string - The hash of the block. + The sender's address.
    - -#### pactus.blockchain.get_block_height - + + transaction.bond.receiver + string + + The receiver's address. + + + transaction.bond.stake + numeric + + The stake amount in NanoPAC. + + + transaction.bond.public_key + string + + The public key of the validator. + + + transaction.sortition + object (PayloadSortition) + + (OneOf)Sortition transaction payload. + + + + transaction.sortition.address + string + + The validator address associated with the sortition proof. + + + transaction.sortition.proof + string + + The proof for the sortition. + + + transaction.unbond + object (PayloadUnbond) + + (OneOf)Unbond transaction payload. + + + + transaction.unbond.validator + string + + The address of the validator to unbond from. + + + transaction.withdraw + object (PayloadWithdraw) + + (OneOf)Withdraw transaction payload. + + + + transaction.withdraw.validator_address + string + + The address of the validator to withdraw from. + + + transaction.withdraw.account_address + string + + The address of the account to withdraw to. + + + transaction.withdraw.amount + numeric + + The withdrawal amount in NanoPAC. + + + transaction.batch_transfer + object (PayloadBatchTransfer) + + (OneOf)Batch Transfer transaction payload. + + + + transaction.batch_transfer.sender + string + + The sender's address. + + + transaction.batch_transfer.recipients + repeated object (Recipient) + + The list of recipients with their amounts. + + + transaction.memo + string + + A memo string for the transaction. + + + + transaction.public_key + string + + The public key associated with the transaction. + + + + transaction.signature + string + + The signature for the transaction. + + + + transaction.block_height + numeric + + The block height containing the transaction. +A value of zero means the transaction is unconfirmed and may still in the transaction pool. + + + + transaction.confirmed + boolean + + Indicates whether the transaction is confirmed. + + + + transaction.confirmations + numeric + + The number of blocks that have been added to the chain after this transaction was included in a block. +A value of zero means the transaction is unconfirmed and may still in the transaction pool. + + + + + +### Blockchain Service + +

    Blockchain service defines RPC methods for interacting with the blockchain.

    + +#### pactus.blockchain.get_block + +

    GetBlock retrieves information about a block based on the provided request parameters.

    + +

    Parameters

    + + + + + + + + + + + + + + + + + +
    FieldTypeDescription
    height numeric + The height of the block to retrieve. +
    verbosity numeric + (Enum)The verbosity level for block information.
    Available values: +
      +
    • BLOCK_VERBOSITY_DATA = 0 (Request only block data.)
      • +
    • BLOCK_VERBOSITY_INFO = 1 (Request block information and transaction IDs.)
      • +
    • BLOCK_VERBOSITY_TRANSACTIONS = 2 (Request block information and detailed transaction data.)
      • +
    +
    + +

    Result

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldTypeDescription
    height numeric + The height of the block. +
    hash string + The hash of the block. +
    data string + Block data, available only if verbosity level is set to BLOCK_VERBOSITY_DATA. +
    block_time numeric + The timestamp of the block. +
    header object (BlockHeaderInfo) + Header information of the block. +
    header.version numeric + The version of the block. +
    header.prev_block_hash string + The hash of the previous block. +
    header.state_root string + The state root hash of the blockchain. +
    header.sortition_seed string + The sortition seed of the block. +
    header.proposer_address string + The address of the proposer of the block. +
    prev_cert object (CertificateInfo) + Certificate information of the previous block. +
    prev_cert.hash string + The hash of the certificate. +
    prev_cert.round numeric + The round of the certificate. +
    prev_cert.committersrepeated numeric + List of committers in the certificate. +
    prev_cert.absenteesrepeated numeric + List of absentees in the certificate. +
    prev_cert.signature string + The signature of the certificate. +
    txsrepeated object (TransactionInfo) + List of transactions in the block, available when verbosity level is set to +BLOCK_VERBOSITY_TRANSACTIONS. +
    txs[].id string + The unique ID of the transaction. +
    txs[].data string + The raw transaction data in hexadecimal format. +
    txs[].version numeric + The version of the transaction. +
    txs[].lock_time numeric + The lock time for the transaction. +
    txs[].value numeric + The value of the transaction in NanoPAC. +
    txs[].fee numeric + The fee for the transaction in NanoPAC. +
    txs[].payload_type numeric + (Enum)The type of transaction payload.
    Available values: +
      +
    • PAYLOAD_TYPE_UNSPECIFIED = 0 (Unspecified payload type.)
      • +
    • PAYLOAD_TYPE_TRANSFER = 1 (Transfer payload type.)
      • +
    • PAYLOAD_TYPE_BOND = 2 (Bond payload type.)
      • +
    • PAYLOAD_TYPE_SORTITION = 3 (Sortition payload type.)
      • +
    • PAYLOAD_TYPE_UNBOND = 4 (Unbond payload type.)
      • +
    • PAYLOAD_TYPE_WITHDRAW = 5 (Withdraw payload type.)
      • +
    • PAYLOAD_TYPE_BATCH_TRANSFER = 6 (Batch transfer payload type.)
      • +
    +
    txs[].transfer object (PayloadTransfer) + (OneOf)Transfer transaction payload. +
    txs[].transfer.sender string + The sender's address. +
    txs[].transfer.receiver string + The receiver's address. +
    txs[].transfer.amount numeric + The amount to be transferred in NanoPAC. +
    txs[].bond object (PayloadBond) + (OneOf)Bond transaction payload. +
    txs[].bond.sender string + The sender's address. +
    txs[].bond.receiver string + The receiver's address. +
    txs[].bond.stake numeric + The stake amount in NanoPAC. +
    txs[].bond.public_key string + The public key of the validator. +
    txs[].sortition object (PayloadSortition) + (OneOf)Sortition transaction payload. +
    txs[].sortition.address string + The validator address associated with the sortition proof. +
    txs[].sortition.proof string + The proof for the sortition. +
    txs[].unbond object (PayloadUnbond) + (OneOf)Unbond transaction payload. +
    txs[].unbond.validator string + The address of the validator to unbond from. +
    txs[].withdraw object (PayloadWithdraw) + (OneOf)Withdraw transaction payload. +
    txs[].withdraw.validator_address string + The address of the validator to withdraw from. +
    txs[].withdraw.account_address string + The address of the account to withdraw to. +
    txs[].withdraw.amount numeric + The withdrawal amount in NanoPAC. +
    txs[].batch_transfer object (PayloadBatchTransfer) + (OneOf)Batch Transfer transaction payload. +
    txs[].batch_transfer.sender string + The sender's address. +
    txs[].batch_transfer.recipientsrepeated object (Recipient) + The list of recipients with their amounts. +
    txs[].memo string + A memo string for the transaction. +
    txs[].public_key string + The public key associated with the transaction. +
    txs[].signature string + The signature for the transaction. +
    txs[].block_height numeric + The block height containing the transaction. +A value of zero means the transaction is unconfirmed and may still in the transaction pool. +
    txs[].confirmed boolean + Indicates whether the transaction is confirmed. +
    txs[].confirmations numeric + The number of blocks that have been added to the chain after this transaction was included in a block. +A value of zero means the transaction is unconfirmed and may still in the transaction pool. +
    + +#### pactus.blockchain.get_block_hash + +

    GetBlockHash retrieves the hash of a block at the specified height.

    + +

    Parameters

    + + + + + + + + + + + + +
    FieldTypeDescription
    height numeric + The height of the block to retrieve the hash for. +
    + +

    Result

    + + + + + + + + + + + +
    FieldTypeDescription
    hash string + The hash of the block. +
    + +#### pactus.blockchain.get_block_height +

    GetBlockHeight retrieves the height of a block with the specified hash.

    Parameters

    @@ -1819,356 +1774,671 @@ A value of zero means the transaction is unconfirmed and may still in the transa - hash + hash + string + + The hash of the block to retrieve the height for. + + + + + +

    Result

    + + + + + + + + + + + +
    FieldTypeDescription
    height numeric + The height of the block. +
    + +#### pactus.blockchain.get_blockchain_info + +

    GetBlockchainInfo retrieves general information about the blockchain.

    + +

    Parameters

    +Parameters has no fields. + +

    Result

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldTypeDescription
    last_block_height numeric + The height of the last block in the blockchain. +
    last_block_hash string + The hash of the last block in the blockchain. +
    total_accounts numeric + The total number of accounts in the blockchain. +
    total_validators numeric + The total number of validators in the blockchain. +
    active_validators numeric + The number of active (not unbonded) validators in the blockchain. +
    total_power numeric + The total power of the blockchain. +
    committee_power numeric + The power of the committee. +
    committee_validatorsrepeated object (ValidatorInfo) + List of committee validators. +
    committee_validators[].hash string + The hash of the validator. +
    committee_validators[].data string + The serialized data of the validator. +
    committee_validators[].public_key string + The public key of the validator. +
    committee_validators[].number numeric + The unique number assigned to the validator. +
    committee_validators[].stake numeric + The stake of the validator in NanoPAC. +
    committee_validators[].last_bonding_height numeric + The height at which the validator last bonded. +
    committee_validators[].last_sortition_height numeric + The height at which the validator last participated in sortition. +
    committee_validators[].unbonding_height numeric + The height at which the validator will unbond. +
    committee_validators[].address string + The address of the validator. +
    committee_validators[].availability_score numeric + The availability score of the validator. +
    committee_validators[].protocol_version numeric + The protocol version of the validator. +
    is_pruned boolean + If the blocks are subject to pruning. +
    pruning_height numeric + Lowest-height block stored (only present if pruning is enabled) +
    last_block_time numeric + Timestamp of the last block in Unix format +
    committee_protocol_versions map<int32, double> + Map of protocol versions and their percentages in the committee. +
    + +#### pactus.blockchain.get_consensus_info + +

    GetConsensusInfo retrieves information about the consensus instances.

    + +

    Parameters

    +Parameters has no fields. + +

    Result

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldTypeDescription
    proposal object (ProposalInfo) + The proposal of the consensus info. +
    proposal.height numeric + The height of the proposal. +
    proposal.round numeric + The round of the proposal. +
    proposal.block_data string + The block data of the proposal. +
    proposal.signature string + The signature of the proposal, signed by the proposer. +
    instancesrepeated object (ConsensusInfo) + List of consensus instances. +
    instances[].address string + The address of the consensus instance. +
    instances[].active boolean + Indicates whether the consensus instance is active and part of the committee. +
    instances[].height numeric + The height of the consensus instance. +
    instances[].round numeric + The round of the consensus instance. +
    instances[].votesrepeated object (VoteInfo) + List of votes in the consensus instance. +
    instances[].votes[].type numeric + (Enum)The type of the vote.
    Available values: +
      +
    • VOTE_TYPE_UNSPECIFIED = 0 (Unspecified vote type.)
      • +
    • VOTE_TYPE_PREPARE = 1 (Prepare vote type.)
      • +
    • VOTE_TYPE_PRECOMMIT = 2 (Precommit vote type.)
      • +
    • VOTE_TYPE_CP_PRE_VOTE = 3 (Change-proposer:pre-vote vote type.)
      • +
    • VOTE_TYPE_CP_MAIN_VOTE = 4 (Change-proposer:main-vote vote type.)
      • +
    • VOTE_TYPE_CP_DECIDED = 5 (Change-proposer:decided vote type.)
      • +
    +
    instances[].votes[].voter string + The address of the voter. +
    instances[].votes[].block_hash string + The hash of the block being voted on. +
    instances[].votes[].round numeric + The consensus round of the vote. +
    instances[].votes[].cp_round numeric + The change-proposer round of the vote. +
    instances[].votes[].cp_value numeric + The change-proposer value of the vote. +
    + +#### pactus.blockchain.get_account + +

    GetAccount retrieves information about an account based on the provided address.

    + +

    Parameters

    + + + + + + + + + + + + +
    FieldTypeDescription
    address string + The address of the account to retrieve information for. +
    + +

    Result

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldTypeDescription
    account object (AccountInfo) + Detailed information about the account. +
    account.hash string + The hash of the account. +
    account.data string + The serialized data of the account. +
    account.number numeric + The unique number assigned to the account. +
    account.balance numeric + The balance of the account in NanoPAC. +
    account.address string + The address of the account. +
    + +#### pactus.blockchain.get_validator + +

    GetValidator retrieves information about a validator based on the provided address.

    + +

    Parameters

    + + + + + + + +
    FieldTypeDescription
    address string - The hash of the block to retrieve the height for. + The address of the validator to retrieve information for.
    -

    Result

    + +

    Result

    - + - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - +
    FieldTypeDescription
    FieldTypeDescription
    height
    validator object (ValidatorInfo) + Detailed information about the validator. +
    validator.hash string + The hash of the validator. +
    validator.data string + The serialized data of the validator. +
    validator.public_key string + The public key of the validator. +
    validator.number numeric + The unique number assigned to the validator. +
    validator.stake numeric + The stake of the validator in NanoPAC. +
    validator.last_bonding_height numeric + The height at which the validator last bonded. +
    validator.last_sortition_height numeric + The height at which the validator last participated in sortition. +
    validator.unbonding_height numeric + The height at which the validator will unbond. +
    validator.address string + The address of the validator. +
    validator.availability_score numeric + The availability score of the validator. +
    validator.protocol_version numeric - The height of the block. + The protocol version of the validator.
    -#### pactus.blockchain.get_blockchain_info +#### pactus.blockchain.get_validator_by_number -

    GetBlockchainInfo retrieves general information about the blockchain.

    +

    GetValidatorByNumber retrieves information about a validator based on the provided number.

    Parameters

    -Parameters has no fields. -

    Result

    - - + - - + +
    FieldTypeDescription
    last_block_heightnumber numeric - The height of the last block in the blockchain. + The unique number of the validator to retrieve information for.
    last_block_hash
    + +

    Result

    + + + + + + + + + + + + - - - + + + - - - + + + - - + + - - + + - - + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + - - + + - - + + + + + + + - - - + + + - +
    FieldTypeDescription
    validator object (ValidatorInfo) + Detailed information about the validator. +
    validator.hash string - The hash of the last block in the blockchain. + The hash of the validator.
    total_accounts numeric
    validator.data string - The total number of accounts in the blockchain. + The serialized data of the validator.
    total_validators numeric
    validator.public_key string - The total number of validators in the blockchain. + The public key of the validator.
    active_validators
    validator.number numeric - The number of active (not unbonded) validators in the blockchain. + The unique number assigned to the validator.
    total_power
    validator.stake numeric - The total power of the blockchain. + The stake of the validator in NanoPAC.
    committee_power
    validator.last_bonding_height numeric - The power of the committee. + The height at which the validator last bonded.
    committee_validatorsrepeated object (ValidatorInfo) - List of committee validators. -
    committee_validators[].hash string - The hash of the validator. -
    committee_validators[].data string - The serialized data of the validator. -
    committee_validators[].public_key string - The public key of the validator. -
    committee_validators[].number numeric - The unique number assigned to the validator. -
    committee_validators[].stake numeric - The stake of the validator in NanoPAC. -
    committee_validators[].last_bonding_height numeric - The height at which the validator last bonded. -
    committee_validators[].last_sortition_height numeric - The height at which the validator last participated in sortition. -
    committee_validators[].unbonding_height numeric - The height at which the validator will unbond. -
    committee_validators[].address string - The address of the validator. -
    committee_validators[].availability_score numeric - The availability score of the validator. -
    committee_validators[].protocol_version numeric - The protocol version of the validator. -
    is_pruned boolean
    validator.last_sortition_height numeric - If the blocks are subject to pruning. + The height at which the validator last participated in sortition.
    pruning_height
    validator.unbonding_height numeric - Lowest-height block stored (only present if pruning is enabled) + The height at which the validator will unbond.
    last_block_time
    validator.address string + The address of the validator. +
    validator.availability_score numeric - Timestamp of the last block in Unix format + The availability score of the validator.
    committee_protocol_versions map<int32, double>
    validator.protocol_version numeric - Map of protocol versions and their percentages in the committee. + The protocol version of the validator.
    -#### pactus.blockchain.get_consensus_info +#### pactus.blockchain.get_validator_addresses -

    GetConsensusInfo retrieves information about the consensus instances.

    +

    GetValidatorAddresses retrieves a list of all validator addresses.

    Parameters

    - Parameters has no fields. -

    Result

    + +

    Result

    - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + List of validator addresses. + + +
    FieldTypeDescription
    FieldTypeDescription
    proposal object (ProposalInfo) - The proposal of the consensus info. -
    proposal.height numeric - The height of the proposal. -
    proposal.round numeric - The round of the proposal. -
    proposal.block_data string - The block data of the proposal. -
    proposal.signature string - The signature of the proposal, signed by the proposer. -
    instancesrepeated object (ConsensusInfo)
    addressesrepeated string - List of consensus instances. -
    instances[].address string - The address of the consensus instance. -
    instances[].active boolean - Indicates whether the consensus instance is active and part of the committee. -
    instances[].height numeric - The height of the consensus instance. -
    instances[].round numeric - The round of the consensus instance. -
    instances[].votesrepeated object (VoteInfo) - List of votes in the consensus instance. -
    instances[].votes[].type numeric - (Enum)The type of the vote. -
    Available values:
      -
    • VOTE_TYPE_UNSPECIFIED = 0 (Unspecified vote type.)
      • -
    • VOTE_TYPE_PREPARE = 1 (Prepare vote type.)
      • -
    • VOTE_TYPE_PRECOMMIT = 2 (Precommit vote type.)
      • -
    • VOTE_TYPE_CP_PRE_VOTE = 3 (Change-proposer:pre-vote vote type.)
      • -
    • VOTE_TYPE_CP_MAIN_VOTE = 4 (Change-proposer:main-vote vote type.)
      • -
    • VOTE_TYPE_CP_DECIDED = 5 (Change-proposer:decided vote type.)
      • -
    -
    instances[].votes[].voter string - The address of the voter. -
    instances[].votes[].block_hash string - The hash of the block being voted on. -
    instances[].votes[].round numeric - The consensus round of the vote. -
    instances[].votes[].cp_round numeric - The change-proposer round of the vote. -
    instances[].votes[].cp_value numeric - The change-proposer value of the vote. -
    -#### pactus.blockchain.get_account +#### pactus.blockchain.get_public_key -

    GetAccount retrieves information about an account based on the provided address.

    +

    GetPublicKey retrieves the public key of an account based on the provided address.

    Parameters

    @@ -2181,66 +2451,31 @@ Parameters has no fields. address string - The address of the account to retrieve information for. + The address for which to retrieve the public key. -

    Result

    + +

    Result

    - + - - - - + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - + The public key associated with the provided address. + + +
    FieldTypeDescription
    FieldTypeDescription
    account object (AccountInfo)
    public_key string - Detailed information about the account. -
    account.hash string - The hash of the account. -
    account.data string - The serialized data of the account. -
    account.number numeric - The unique number assigned to the account. -
    account.balance numeric - The balance of the account in NanoPAC. -
    account.address string - The address of the account. -
    -#### pactus.blockchain.get_validator +#### pactus.blockchain.get_tx_pool_content -

    GetValidator retrieves information about a validator based on the provided address.

    +

    GetTxPoolContent retrieves current transactions in the transaction pool.

    Parameters

    @@ -2250,576 +2485,272 @@ Parameters has no fields. - address - string + payload_type + numeric - The address of the validator to retrieve information for. + (Enum)The type of transactions to retrieve from the transaction pool. 0 means all types.
    Available values: + -

    Result

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeDescription
    validator object (ValidatorInfo) - Detailed information about the validator. -
    validator.hash string - The hash of the validator. -
    validator.data string - The serialized data of the validator. -
    validator.public_key string - The public key of the validator. -
    validator.number numeric - The unique number assigned to the validator. -
    validator.stake numeric - The stake of the validator in NanoPAC. -
    validator.last_bonding_height numeric - The height at which the validator last bonded. -
    validator.last_sortition_height numeric - The height at which the validator last participated in sortition. -
    validator.unbonding_height numeric - The height at which the validator will unbond. -
    validator.address string - The address of the validator. -
    validator.availability_score numeric - The availability score of the validator. -
    validator.protocol_version numeric - The protocol version of the validator. -
    - -#### pactus.blockchain.get_validator_by_number -

    GetValidatorByNumber retrieves information about a validator based on the provided number.

    - -

    Parameters

    +

    Result

    - + - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - -
    FieldTypeDescription
    FieldTypeDescription
    number
    txsrepeated object (TransactionInfo) + List of transactions currently in the pool. +
    txs[].id string + The unique ID of the transaction. +
    txs[].data string + The raw transaction data in hexadecimal format. +
    txs[].version numeric + The version of the transaction. +
    txs[].lock_time numeric + The lock time for the transaction. +
    txs[].value numeric + The value of the transaction in NanoPAC. +
    txs[].fee numeric + The fee for the transaction in NanoPAC. +
    txs[].payload_type numeric - The unique number of the validator to retrieve information for. + (Enum)The type of transaction payload.
    Available values: +
      +
    • PAYLOAD_TYPE_UNSPECIFIED = 0 (Unspecified payload type.)
      • +
    • PAYLOAD_TYPE_TRANSFER = 1 (Transfer payload type.)
      • +
    • PAYLOAD_TYPE_BOND = 2 (Bond payload type.)
      • +
    • PAYLOAD_TYPE_SORTITION = 3 (Sortition payload type.)
      • +
    • PAYLOAD_TYPE_UNBOND = 4 (Unbond payload type.)
      • +
    • PAYLOAD_TYPE_WITHDRAW = 5 (Withdraw payload type.)
      • +
    • PAYLOAD_TYPE_BATCH_TRANSFER = 6 (Batch transfer payload type.)
      • +
    +
    txs[].transfer object (PayloadTransfer) + (OneOf)Transfer transaction payload. +
    txs[].transfer.sender string + The sender's address. +
    txs[].transfer.receiver string + The receiver's address. +
    txs[].transfer.amount numeric + The amount to be transferred in NanoPAC. +
    txs[].bond object (PayloadBond) + (OneOf)Bond transaction payload. +
    txs[].bond.sender string + The sender's address. +
    txs[].bond.receiver string + The receiver's address. +
    txs[].bond.stake numeric + The stake amount in NanoPAC. +
    txs[].bond.public_key string + The public key of the validator. +
    txs[].sortition object (PayloadSortition) + (OneOf)Sortition transaction payload. +
    txs[].sortition.address string + The validator address associated with the sortition proof. +
    txs[].sortition.proof string + The proof for the sortition. +
    txs[].unbond object (PayloadUnbond) + (OneOf)Unbond transaction payload. +
    txs[].unbond.validator string + The address of the validator to unbond from. +
    txs[].withdraw object (PayloadWithdraw) + (OneOf)Withdraw transaction payload. +
    txs[].withdraw.validator_address string + The address of the validator to withdraw from. +
    txs[].withdraw.account_address string + The address of the account to withdraw to. +
    txs[].withdraw.amount numeric + The withdrawal amount in NanoPAC. +
    txs[].batch_transfer object (PayloadBatchTransfer) + (OneOf)Batch Transfer transaction payload. +
    txs[].batch_transfer.sender string + The sender's address. +
    txs[].batch_transfer.recipientsrepeated object (Recipient) + The list of recipients with their amounts.
    -

    Result

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldTypeDescription
    validator object (ValidatorInfo) - Detailed information about the validator. -
    validator.hash string - The hash of the validator. -
    validator.data string - The serialized data of the validator. -
    validator.public_key string - The public key of the validator. -
    validator.number numeric - The unique number assigned to the validator. -
    validator.stake numeric - The stake of the validator in NanoPAC. -
    validator.last_bonding_height numeric - The height at which the validator last bonded. -
    validator.last_sortition_height numeric - The height at which the validator last participated in sortition. -
    validator.unbonding_height numeric - The height at which the validator will unbond. -
    validator.address string - The address of the validator. -
    validator.availability_score numeric - The availability score of the validator. -
    validator.protocol_version numeric - The protocol version of the validator. -
    - -#### pactus.blockchain.get_validator_addresses - -

    GetValidatorAddresses retrieves a list of all validator addresses.

    - -

    Parameters

    - -Parameters has no fields. -

    Result

    - - - - - - - - - + + + - -
    FieldTypeDescription
    addressesrepeated string
    txs[].memo string - List of validator addresses. + A memo string for the transaction.
    - -#### pactus.blockchain.get_public_key - -

    GetPublicKey retrieves the public key of an account based on the provided address.

    - -

    Parameters

    - - - - - - - - + + - -
    FieldTypeDescription
    address
    txs[].public_key string - The address for which to retrieve the public key. + The public key associated with the transaction.
    -

    Result

    - - - - - - - - + + - -
    FieldTypeDescription
    public_key
    txs[].signature string - The public key associated with the provided address. + The signature for the transaction.
    - -#### pactus.blockchain.get_tx_pool_content - -

    GetTxPoolContent retrieves current transactions in the transaction pool.

    - -

    Parameters

    - - - - - - - - + + - -
    FieldTypeDescription
    payload_type
    txs[].block_height numeric - (Enum)The type of transactions to retrieve from the transaction pool. 0 means all types. -
    Available values:
      -
    • PAYLOAD_TYPE_UNSPECIFIED = 0 (Unspecified payload type.)
      • -
    • PAYLOAD_TYPE_TRANSFER = 1 (Transfer payload type.)
      • -
    • PAYLOAD_TYPE_BOND = 2 (Bond payload type.)
      • -
    • PAYLOAD_TYPE_SORTITION = 3 (Sortition payload type.)
      • -
    • PAYLOAD_TYPE_UNBOND = 4 (Unbond payload type.)
      • -
    • PAYLOAD_TYPE_WITHDRAW = 5 (Withdraw payload type.)
      • -
    • PAYLOAD_TYPE_BATCH_TRANSFER = 6 (Batch transfer payload type.)
      • -
    + The block height containing the transaction. +A value of zero means the transaction is unconfirmed and may still in the transaction pool.
    -

    Result

    - - - - - - - - - + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + - - + + +
    FieldTypeDescription
    txsrepeated object (TransactionInfo)
    txs[].confirmed boolean - List of transactions currently in the pool. -
    txs[].id string - The unique ID of the transaction. -
    txs[].data string - The raw transaction data in hexadecimal format. -
    txs[].version numeric - The version of the transaction. -
    txs[].lock_time numeric - The lock time for the transaction. -
    txs[].value numeric - The value of the transaction in NanoPAC. -
    txs[].fee numeric - The fee for the transaction in NanoPAC. -
    txs[].payload_type numeric - (Enum)The type of transaction payload. -
    Available values:
      -
    • PAYLOAD_TYPE_UNSPECIFIED = 0 (Unspecified payload type.)
      • -
    • PAYLOAD_TYPE_TRANSFER = 1 (Transfer payload type.)
      • -
    • PAYLOAD_TYPE_BOND = 2 (Bond payload type.)
      • -
    • PAYLOAD_TYPE_SORTITION = 3 (Sortition payload type.)
      • -
    • PAYLOAD_TYPE_UNBOND = 4 (Unbond payload type.)
      • -
    • PAYLOAD_TYPE_WITHDRAW = 5 (Withdraw payload type.)
      • -
    • PAYLOAD_TYPE_BATCH_TRANSFER = 6 (Batch transfer payload type.)
      • -
    -
    txs[].transfer object (PayloadTransfer) - (OneOf)Transfer transaction payload. -
    txs[].transfer.sender string - The sender's address. -
    txs[].transfer.receiver string - The receiver's address. -
    txs[].transfer.amount numeric - The amount to be transferred in NanoPAC. -
    txs[].bond object (PayloadBond) - (OneOf)Bond transaction payload. -
    txs[].bond.sender string - The sender's address. -
    txs[].bond.receiver string - The receiver's address. -
    txs[].bond.stake numeric - The stake amount in NanoPAC. -
    txs[].bond.public_key string - The public key of the validator. -
    txs[].sortition object (PayloadSortition) - (OneOf)Sortition transaction payload. -
    txs[].sortition.address string - The validator address associated with the sortition proof. -
    txs[].sortition.proof string - The proof for the sortition. -
    txs[].unbond object (PayloadUnbond) - (OneOf)Unbond transaction payload. -
    txs[].unbond.validator string - The address of the validator to unbond from. -
    txs[].withdraw object (PayloadWithdraw) - (OneOf)Withdraw transaction payload. -
    txs[].withdraw.validator_address string - The address of the validator to withdraw from. -
    txs[].withdraw.account_address string - The address of the account to withdraw to. -
    txs[].withdraw.amount numeric - The withdrawal amount in NanoPAC. -
    txs[].batch_transfer object (PayloadBatchTransfer) - (OneOf)Batch Transfer transaction payload. -
    txs[].batch_transfer.sender string - The sender's address. -
    txs[].batch_transfer.recipientsrepeated object (Recipient) - The list of recipients with their amounts. -
    txs[].memo string - A memo string for the transaction. -
    txs[].public_key string - The public key associated with the transaction. -
    txs[].signature string - The signature for the transaction. -
    txs[].block_height numeric - The block height containing the transaction. -A value of zero means the transaction is unconfirmed and may still in the transaction pool. -
    txs[].confirmed boolean - Indicates whether the transaction is confirmed. -
    txs[].confirmations numeric - The number of blocks that have been added to the chain after this transaction was included in a block. + Indicates whether the transaction is confirmed. +
    txs[].confirmations numeric + The number of blocks that have been added to the chain after this transaction was included in a block. A value of zero means the transaction is unconfirmed and may still in the transaction pool. -
    ### Network Service @@ -2841,290 +2772,279 @@ A value of zero means the transaction is unconfirmed and may still in the transa only_connected boolean - If true, returns only peers that are currently connected. + If true, returns only peers that are currently connected. -

    Result

    + +

    Result

    - + - - + - + - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + List of connected peers. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + Metrics related to node activity. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldTypeDescription
    FieldTypeDescription
    network_name string - Name of the network. + Name of the network.
    connected_peers_count numeric - Number of connected peers. + Number of connected peers.
    connected_peers repeated object (PeerInfo) - List of connected peers. -
    connected_peers[].status numeric - Current status of the peer (e.g., connected, disconnected). -
    connected_peers[].moniker string - Moniker or Human-Readable name of the peer. -
    connected_peers[].agent string - Version and agent details of the peer. -
    connected_peers[].peer_id string - Peer ID of the peer in P2P network. -
    connected_peers[].consensus_keysrepeated string - List of consensus keys used by the peer. -
    connected_peers[].consensus_addressesrepeated string - List of consensus addresses used by the peer. -
    connected_peers[].services numeric - Bitfield representing the services provided by the peer. -
    connected_peers[].last_block_hash string - Hash of the last block the peer knows. -
    connected_peers[].height numeric - Blockchain height of the peer. -
    connected_peers[].last_sent numeric - Unix timestamp of the last bundle sent to the peer (UTC). -
    connected_peers[].last_received numeric - Unix timestamp of the last bundle received from the peer (UTC). -
    connected_peers[].address string - Network address of the peer. -
    connected_peers[].direction numeric - (Enum)Connection direction (e.g., inbound, outbound). -
    Available values:
      -
    • DIRECTION_UNKNOWN = 0 (Unknown direction (default value).)
      • -
    • DIRECTION_INBOUND = 1 (Inbound connection - peer connected to us.)
      • -
    • DIRECTION_OUTBOUND = 2 (Outbound connection - we connected to peer.)
      • -
    -
    connected_peers[].protocolsrepeated string - List of protocols supported by the peer. -
    connected_peers[].total_sessions numeric - Total download sessions with the peer. -
    connected_peers[].completed_sessions numeric - Completed download sessions with the peer. -
    connected_peers[].metric_info object (MetricInfo) - Metrics related to peer activity. -
    connected_peers[].metric_info.total_invalid object (CounterInfo) - Total number of invalid bundles. -
    connected_peers[].metric_info.total_sent object (CounterInfo) - Total number of bundles sent. -
    connected_peers[].metric_info.total_received object (CounterInfo) - Total number of bundles received. -
    connected_peers[].metric_info.message_sent map<int32, CounterInfo> - Number of sent bundles categorized by message type. -
    connected_peers[].metric_info.message_received map<int32, CounterInfo> - Number of received bundles categorized by message type. -
    connected_peers[].outbound_hello_sent boolean - Whether the hello message was sent from the outbound connection. -
    connected_peers[].status numeric + Current status of the peer (e.g., connected, disconnected). +
    connected_peers[].moniker string + Moniker or Human-Readable name of the peer. +
    connected_peers[].agent string + Version and agent details of the peer. +
    connected_peers[].peer_id string + Peer ID of the peer in P2P network. +
    connected_peers[].consensus_keysrepeated string + List of consensus keys used by the peer. +
    connected_peers[].consensus_addressesrepeated string + List of consensus addresses used by the peer. +
    connected_peers[].services numeric + Bitfield representing the services provided by the peer. +
    connected_peers[].last_block_hash string + Hash of the last block the peer knows. +
    connected_peers[].height numeric + Blockchain height of the peer. +
    connected_peers[].last_sent numeric + Unix timestamp of the last bundle sent to the peer (UTC). +
    connected_peers[].last_received numeric + Unix timestamp of the last bundle received from the peer (UTC). +
    connected_peers[].address string + Network address of the peer. +
    connected_peers[].direction numeric + (Enum)Connection direction (e.g., inbound, outbound).
    Available values: +
      +
    • DIRECTION_UNKNOWN = 0 (Unknown direction (default value).)
      • +
    • DIRECTION_INBOUND = 1 (Inbound connection - peer connected to us.)
      • +
    • DIRECTION_OUTBOUND = 2 (Outbound connection - we connected to peer.)
      • +
    +
    connected_peers[].protocolsrepeated string + List of protocols supported by the peer. +
    connected_peers[].total_sessions numeric + Total download sessions with the peer. +
    connected_peers[].completed_sessions numeric + Completed download sessions with the peer. +
    connected_peers[].metric_info object (MetricInfo) + Metrics related to peer activity. +
    connected_peers[].metric_info.total_invalid object (CounterInfo) + Total number of invalid bundles. +
    connected_peers[].metric_info.total_sent object (CounterInfo) + Total number of bundles sent. +
    connected_peers[].metric_info.total_received object (CounterInfo) + Total number of bundles received. +
    connected_peers[].metric_info.message_sent map<int32, CounterInfo> + Number of sent bundles categorized by message type. +
    connected_peers[].metric_info.message_received map<int32, CounterInfo> + Number of received bundles categorized by message type. +
    connected_peers[].outbound_hello_sent boolean + Whether the hello message was sent from the outbound connection. +
    metric_info object (MetricInfo) - Metrics related to node activity. -
    metric_info.total_invalid object (CounterInfo) - Total number of invalid bundles. -
    metric_info.total_invalid.bytes numeric - Total number of bytes. -
    metric_info.total_invalid.bundles numeric - Total number of bundles. -
    metric_info.total_sent object (CounterInfo) - Total number of bundles sent. -
    metric_info.total_sent.bytes numeric - Total number of bytes. -
    metric_info.total_sent.bundles numeric - Total number of bundles. -
    metric_info.total_received object (CounterInfo) - Total number of bundles received. -
    metric_info.total_received.bytes numeric - Total number of bytes. -
    metric_info.total_received.bundles numeric - Total number of bundles. -
    metric_info.message_sent map<int32, CounterInfo> - Number of sent bundles categorized by message type. -
    metric_info.message_received map<int32, CounterInfo> - Number of received bundles categorized by message type. -
    metric_info.total_invalid object (CounterInfo) + Total number of invalid bundles. +
    metric_info.total_invalid.bytes numeric + Total number of bytes. +
    metric_info.total_invalid.bundles numeric + Total number of bundles. +
    metric_info.total_sent object (CounterInfo) + Total number of bundles sent. +
    metric_info.total_sent.bytes numeric + Total number of bytes. +
    metric_info.total_sent.bundles numeric + Total number of bundles. +
    metric_info.total_received object (CounterInfo) + Total number of bundles received. +
    metric_info.total_received.bytes numeric + Total number of bytes. +
    metric_info.total_received.bundles numeric + Total number of bundles. +
    metric_info.message_sent map<int32, CounterInfo> + Number of sent bundles categorized by message type. +
    metric_info.message_received map<int32, CounterInfo> + Number of received bundles categorized by message type. +
    #### pactus.network.get_node_info @@ -3132,150 +3052,149 @@ A value of zero means the transaction is unconfirmed and may still in the transa

    GetNodeInfo retrieves information about a specific node in the network.

    Parameters

    - Parameters has no fields. -

    Result

    + +

    Result

    - + - - + - + - + - + - + - + - + - + - + - + - + - - - - - - - - - - - - - - - - - + Information about the node's connections. + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + - - + + + - +
    FieldTypeDescription
    FieldTypeDescription
    moniker string - Moniker or Human-readable name identifying this node in the network. + Moniker or Human-readable name identifying this node in the network.
    agent string - Version and agent details of the node. + Version and agent details of the node.
    peer_id string - Peer ID of the node. + Peer ID of the node.
    started_at numeric - Unix timestamp when the node was started (UTC). + Unix timestamp when the node was started (UTC).
    reachability string - Reachability status of the node. + Reachability status of the node.
    services numeric - Bitfield representing the services provided by the node. + Bitfield representing the services provided by the node.
    services_names string - Names of services provided by the node. + Names of services provided by the node.
    local_addrs repeated string - List of addresses associated with the node. + List of addresses associated with the node.
    protocols repeated string - List of protocols supported by the node. + List of protocols supported by the node.
    clock_offset numeric - Offset between the node's clock and the network's clock (in seconds). + Offset between the node's clock and the network's clock (in seconds).
    connection_info object (ConnectionInfo) - Information about the node's connections. -
    connection_info.connections numeric - Total number of connections. -
    connection_info.inbound_connections numeric - Number of inbound connections. -
    connection_info.outbound_connections numeric - Number of outbound connections. -
    connection_info.connections numeric + Total number of connections. +
    connection_info.inbound_connections numeric + Number of inbound connections. +
    connection_info.outbound_connections numeric + Number of outbound connections. +
    zmq_publishers repeated object (ZMQPublisherInfo) - List of active ZeroMQ publishers. -
    zmq_publishers[].topic string - The topic associated with the publisher. -
    zmq_publishers[].address string - The address of the publisher. -
    zmq_publishers[].hwm numeric - The high-water mark (HWM) for the publisher, indicating the + List of active ZeroMQ publishers. +
    zmq_publishers[].topic string + The topic associated with the publisher. +
    zmq_publishers[].address string + The address of the publisher. +
    zmq_publishers[].hwm numeric + The high-water mark (HWM) for the publisher, indicating the maximum number of messages to queue before dropping older ones. -
    current_time numeric - Current Unix timestamp of the node (UTC). + Current Unix timestamp of the node (UTC).
    #### pactus.network.ping @@ -3283,11 +3202,11 @@ maximum number of messages to queue before dropping older ones.

    Ping provides a simple connectivity test and latency measurement.

    Parameters

    - Parameters has no fields. -

    Result

    - +

    Result

    + +Result has no fields. ### Utils Service @@ -3309,33 +3228,33 @@ signing, verification, and other cryptographic operations.

    private_key string - The private key to sign the message. + The private key to sign the message. message string - The message content to be signed. + The message content to be signed. -

    Result

    + +

    Result

    - + - - + - +
    FieldTypeDescription
    FieldTypeDescription
    signature string - The resulting signature in hexadecimal format. + The resulting signature in hexadecimal format.
    #### pactus.utils.verify_message @@ -3353,40 +3272,40 @@ signing, verification, and other cryptographic operations.

    message string - The original message content that was signed. + The original message content that was signed. signature string - The signature to verify in hexadecimal format. + The signature to verify in hexadecimal format. public_key string - The public key of the signer. + The public key of the signer. -

    Result

    + +

    Result

    - + - - + - +
    FieldTypeDescription
    FieldTypeDescription
    is_valid boolean - Boolean indicating whether the signature is valid for the given message and public key. + Boolean indicating whether the signature is valid for the given message and public key.
    #### pactus.utils.public_key_aggregation @@ -3404,33 +3323,33 @@ signing, verification, and other cryptographic operations.

    public_keys repeated string - List of BLS public keys to be aggregated. + List of BLS public keys to be aggregated. -

    Result

    + +

    Result

    - + - - + - + - +
    FieldTypeDescription
    FieldTypeDescription
    public_key string - The aggregated BLS public key. + The aggregated BLS public key.
    address string - The blockchain address derived from the aggregated public key. + The blockchain address derived from the aggregated public key.
    #### pactus.utils.signature_aggregation @@ -3448,26 +3367,26 @@ signing, verification, and other cryptographic operations.

    signatures repeated string - List of BLS signatures to be aggregated. + List of BLS signatures to be aggregated. -

    Result

    + +

    Result

    - + - - + - +
    FieldTypeDescription
    FieldTypeDescription
    signature string - The aggregated BLS signature in hexadecimal format. + The aggregated BLS signature in hexadecimal format.
    ### Wallet Service @@ -3489,40 +3408,40 @@ signing, verification, and other cryptographic operations.

    wallet_name string - The name for the new wallet. + The name for the new wallet. password string - Password to secure the new wallet. + Password to secure the new wallet. -

    Result

    + +

    Result

    - + - - + - + - +
    FieldTypeDescription
    FieldTypeDescription
    wallet_name string - The name for the new wallet. + The name for the new wallet.
    mnemonic string - The mnemonic (seed phrase) for wallet recovery. + The mnemonic (seed phrase) for wallet recovery.
    #### pactus.wallet.restore_wallet @@ -3540,40 +3459,40 @@ signing, verification, and other cryptographic operations.

    wallet_name string - The name for the restored wallet. + The name for the restored wallet. mnemonic string - The mnemonic (seed phrase) for wallet recovery. + The mnemonic (seed phrase) for wallet recovery. password string - Password to secure the restored wallet. + Password to secure the restored wallet. -

    Result

    + +

    Result

    - + - - + - +
    FieldTypeDescription
    FieldTypeDescription
    wallet_name string - The name of the restored wallet. + The name of the restored wallet.
    #### pactus.wallet.load_wallet @@ -3592,26 +3511,26 @@ deprecated: It will be removed in a future version.

    wallet_name string - The name of the wallet to load. + The name of the wallet to load. -

    Result

    + +

    Result

    - + - - + - +
    FieldTypeDescription
    FieldTypeDescription
    wallet_name string - The name of the loaded wallet. + The name of the loaded wallet.
    #### pactus.wallet.unload_wallet @@ -3630,26 +3549,26 @@ deprecated: It will be removed in a future version.

    wallet_name string - The name of the wallet to unload. + The name of the wallet to unload. -

    Result

    + +

    Result

    - + - - + - +
    FieldTypeDescription
    FieldTypeDescription
    wallet_name string - The name of the unloaded wallet. + The name of the unloaded wallet.
    #### pactus.wallet.list_wallets @@ -3657,23 +3576,22 @@ deprecated: It will be removed in a future version.

    ListWallets returns a list of all available wallets.

    Parameters

    - Parameters has no fields. -

    Result

    + +

    Result

    - + - - + - +
    FieldTypeDescription
    FieldTypeDescription
    wallets repeated string - Array of wallet names. + Array of wallet names.
    #### pactus.wallet.get_wallet_info @@ -3691,82 +3609,82 @@ Parameters has no fields. wallet_name string - The name of the wallet to query. + The name of the wallet to query. -

    Result

    + +

    Result

    - + - - + - + - + - + - + - + - + - + - + - +
    FieldTypeDescription
    FieldTypeDescription
    wallet_name string - The name of the wallet. + The name of the wallet.
    version numeric - The wallet format version. + The wallet format version.
    network string - The network the wallet is connected to (e.g., mainnet, testnet). + The network the wallet is connected to (e.g., mainnet, testnet).
    encrypted boolean - Indicates if the wallet is encrypted. + Indicates if the wallet is encrypted.
    uuid string - A unique identifier of the wallet. + A unique identifier of the wallet.
    created_at numeric - Unix timestamp of wallet creation. + Unix timestamp of wallet creation.
    default_fee numeric - The default fee of the wallet. + The default fee of the wallet.
    driver string - The storage driver used by the wallet (e.g., SQLite, Legacy JSON ). + The storage driver used by the wallet (e.g., SQLite, Legacy JSON ).
    path string - Path to the wallet file or storage location. + Path to the wallet file or storage location.
    #### pactus.wallet.update_password @@ -3784,40 +3702,40 @@ Parameters has no fields. wallet_name string - The name of the wallet whose password will be updated. + The name of the wallet whose password will be updated. old_password string - The current wallet password. + The current wallet password. new_password string - The new wallet password. + The new wallet password. -

    Result

    + +

    Result

    - + - - + - +
    FieldTypeDescription
    FieldTypeDescription
    wallet_name string - The name of the wallet whose password was updated. + The name of the wallet whose password was updated.
    #### pactus.wallet.get_total_balance @@ -3835,33 +3753,33 @@ Parameters has no fields. wallet_name string - The name of the wallet to get the total balance. + The name of the wallet to get the total balance. -

    Result

    + +

    Result

    - + - - + - + - +
    FieldTypeDescription
    FieldTypeDescription
    wallet_name string - The name of the queried wallet. + The name of the queried wallet.
    total_balance numeric - The total balance of the wallet in NanoPAC. + The total balance of the wallet in NanoPAC.
    #### pactus.wallet.get_total_stake @@ -3879,33 +3797,33 @@ Parameters has no fields. wallet_name string - The name of the wallet to get the total stake. + The name of the wallet to get the total stake. -

    Result

    + +

    Result

    - + - - + - + - +
    FieldTypeDescription
    FieldTypeDescription
    wallet_name string - The name of the queried wallet. + The name of the queried wallet.
    total_stake numeric - The total stake amount in NanoPAC. + The total stake amount in NanoPAC.
    #### pactus.wallet.get_validator_address @@ -3924,26 +3842,26 @@ Deprecated: Will move into utils.

    public_key string - The public key of the validator. + The public key of the validator. -

    Result

    + +

    Result

    - + - - + - +
    FieldTypeDescription
    FieldTypeDescription
    address string - The validator address associated with the public key. + The validator address associated with the public key.
    #### pactus.wallet.get_address_info @@ -3961,68 +3879,68 @@ Deprecated: Will move into utils.

    wallet_name string - The name of the wallet containing the address. + The name of the wallet containing the address. address string - The address to query. + The address to query. -

    Result

    + +

    Result

    - + - - + - + - - - - - - - - - - - - - - - - - - - - - - + Detailed information about the address. + + + + + + + + + + + + + + + + + + + + + + +
    FieldTypeDescription
    FieldTypeDescription
    wallet_name string - The name of the wallet containing the address. + The name of the wallet containing the address.
    address_info object (AddressInfo) - Detailed information about the address. -
    address_info.address string - The address string. -
    address_info.public_key string - The public key associated with the address. -
    address_info.label string - A human-readable label associated with the address. -
    address_info.path string - The Hierarchical Deterministic (HD) path of the address within the wallet. -
    address_info.address string + The address string. +
    address_info.public_key string + The public key associated with the address. +
    address_info.label string + A human-readable label associated with the address. +
    address_info.path string + The Hierarchical Deterministic (HD) path of the address within the wallet. +
    #### pactus.wallet.set_address_label @@ -4040,61 +3958,61 @@ Deprecated: Will move into utils.

    wallet_name string - The name of the wallet containing the address. + The name of the wallet containing the address. password string - Wallet password required for modification. + Wallet password required for modification. address string - The address to label. + The address to label. label string - The new label for the address. + The new label for the address. -

    Result

    + +

    Result

    - + - - + - + - + - +
    FieldTypeDescription
    FieldTypeDescription
    wallet_name string - The name of the wallet where the address label was updated. + The name of the wallet where the address label was updated.
    address string - The address where the label was updated. + The address where the label was updated.
    label string - The new label for the address. + The new label for the address.
    #### pactus.wallet.get_new_address @@ -4112,90 +4030,90 @@ Deprecated: Will move into utils.

    wallet_name string - The name of the wallet to generate a new address. + The name of the wallet to generate a new address. address_type numeric - (Enum)The type of address to generate. -
    Available values: label string - A label for the new address. + A label for the new address. password string - Password for the new address. It's required when address_type is Ed25519 type. + Password for the new address. It's required when address_type is Ed25519 type. -

    Result

    + +

    Result

    - + - - + - + - - - - - - - - - - - - - - - - - - - - - - + Detailed information about the new address. + + + + + + + + + + + + + + + + + + + + + + +
    FieldTypeDescription
    FieldTypeDescription
    wallet_name string - The name of the wallet where address was generated. + The name of the wallet where address was generated.
    address_info object (AddressInfo) - Detailed information about the new address. -
    address_info.address string - The address string. -
    address_info.public_key string - The public key associated with the address. -
    address_info.label string - A human-readable label associated with the address. -
    address_info.path string - The Hierarchical Deterministic (HD) path of the address within the wallet. -
    address_info.address string + The address string. +
    address_info.public_key string + The public key associated with the address. +
    address_info.label string + A human-readable label associated with the address. +
    address_info.path string + The Hierarchical Deterministic (HD) path of the address within the wallet. +
    #### pactus.wallet.list_addresses @@ -4213,76 +4131,76 @@ Note: Generating a new Ed25519 address requires the wallet password.) wallet_name string - The name of the queried wallet. + The name of the queried wallet. address_types repeated numeric - (Enum)Filter addresses by their types. If empty, all address types are included. -
    Available values: -

    Result

    + +

    Result

    - + - - + - + - - - - - - - - - - - - - - - - - - - - - - + List of all addresses in the wallet with their details. + + + + + + + + + + + + + + + + + + + + + + +
    FieldTypeDescription
    FieldTypeDescription
    wallet_name string - The name of the queried wallet. + The name of the queried wallet.
    data repeated object (AddressInfo) - List of all addresses in the wallet with their details. -
    data[].address string - The address string. -
    data[].public_key string - The public key associated with the address. -
    data[].label string - A human-readable label associated with the address. -
    data[].path string - The Hierarchical Deterministic (HD) path of the address within the wallet. -
    data[].address string + The address string. +
    data[].public_key string + The public key associated with the address. +
    data[].label string + A human-readable label associated with the address. +
    data[].path string + The Hierarchical Deterministic (HD) path of the address within the wallet. +
    #### pactus.wallet.sign_message @@ -4300,47 +4218,47 @@ Note: Generating a new Ed25519 address requires the wallet password.) wallet_name string - The name of the wallet to sign with. + The name of the wallet to sign with. password string - Wallet password required for signing. + Wallet password required for signing. address string - The address whose private key should be used for signing the message. + The address whose private key should be used for signing the message. message string - The arbitrary message to be signed. + The arbitrary message to be signed. -

    Result

    + +

    Result

    - + - - + - +
    FieldTypeDescription
    FieldTypeDescription
    signature string - The signature in hexadecimal format. + The signature in hexadecimal format.
    #### pactus.wallet.sign_raw_transaction @@ -4358,47 +4276,47 @@ Note: Generating a new Ed25519 address requires the wallet password.) wallet_name string - The name of the wallet used for signing. + The name of the wallet used for signing. raw_transaction string - The raw transaction data to be signed. + The raw transaction data to be signed. password string - Wallet password required for signing. + Wallet password required for signing. -

    Result

    + +

    Result

    - + - - + - + - +
    FieldTypeDescription
    FieldTypeDescription
    transaction_id string - The ID of the signed transaction. + The ID of the signed transaction.
    signed_raw_transaction string - The signed raw transaction data. + The signed raw transaction data.
    #### pactus.wallet.list_transactions @@ -4417,14 +4335,14 @@ optionally filtered by a specific address, with pagination support.

    wallet_name string - The name of the wallet to query transactions for. + The name of the wallet to query transactions for. address string - Optional: The address to filter transactions. + Optional: The address to filter transactions. If empty or set to "*", transactions for all addresses in the wallet are included. @@ -4432,20 +4350,20 @@ If empty or set to "*", transactions for all addresses in the wallet are include direction numeric - (Enum)Filter transactions by direction relative to the wallet. -Defaults to any direction if not set. -
    Available values: + (Enum)Filter transactions by direction relative to the wallet. +Defaults to any direction if not set.
    Available values: + count numeric - Optional: The maximum number of transactions to return. + Optional: The maximum number of transactions to return. Defaults to 10 if not set. @@ -4453,281 +4371,266 @@ Defaults to 10 if not set. skip numeric - Optional: The number of transactions to skip (for pagination). + Optional: The number of transactions to skip (for pagination). Defaults to 0 if not set. -

    Result

    + +

    Result

    - + - - + - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - + + + + + + + + + + - - -
    FieldTypeDescription
    FieldTypeDescription
    wallet_name string - The name of the wallet queried. + The name of the wallet queried.
    txs repeated object (TransactionInfo) - List of transactions for the wallet, filtered by the specified address if provided. -
    txs[].id string - The unique ID of the transaction. -
    txs[].data string - The raw transaction data in hexadecimal format. -
    txs[].version numeric - The version of the transaction. -
    txs[].lock_time numeric - The lock time for the transaction. -
    txs[].value numeric - The value of the transaction in NanoPAC. -
    txs[].fee numeric - The fee for the transaction in NanoPAC. -
    txs[].payload_type numeric - (Enum)The type of transaction payload. -
    Available values:
      -
    • PAYLOAD_TYPE_UNSPECIFIED = 0 (Unspecified payload type.)
      • -
    • PAYLOAD_TYPE_TRANSFER = 1 (Transfer payload type.)
      • -
    • PAYLOAD_TYPE_BOND = 2 (Bond payload type.)
      • -
    • PAYLOAD_TYPE_SORTITION = 3 (Sortition payload type.)
      • -
    • PAYLOAD_TYPE_UNBOND = 4 (Unbond payload type.)
      • -
    • PAYLOAD_TYPE_WITHDRAW = 5 (Withdraw payload type.)
      • -
    • PAYLOAD_TYPE_BATCH_TRANSFER = 6 (Batch transfer payload type.)
      • -
    -
    txs[].transfer object (PayloadTransfer) - (OneOf)Transfer transaction payload. -
    txs[].transfer.sender string - The sender's address. -
    txs[].transfer.receiver string - The receiver's address. -
    txs[].transfer.amount numeric - The amount to be transferred in NanoPAC. -
    txs[].bond object (PayloadBond) - (OneOf)Bond transaction payload. -
    txs[].bond.sender string - The sender's address. -
    txs[].bond.receiver string - The receiver's address. -
    txs[].bond.stake numeric - The stake amount in NanoPAC. -
    txs[].bond.public_key string - The public key of the validator. -
    txs[].sortition object (PayloadSortition) - (OneOf)Sortition transaction payload. -
    txs[].sortition.address string - The validator address associated with the sortition proof. -
    txs[].sortition.proof string - The proof for the sortition. -
    txs[].unbond object (PayloadUnbond) - (OneOf)Unbond transaction payload. -
    txs[].unbond.validator string - The address of the validator to unbond from. -
    txs[].withdraw object (PayloadWithdraw) - (OneOf)Withdraw transaction payload. -
    txs[].withdraw.validator_address string - The address of the validator to withdraw from. -
    txs[].withdraw.account_address string - The address of the account to withdraw to. -
    txs[].withdraw.amount numeric - The withdrawal amount in NanoPAC. -
    txs[].batch_transfer object (PayloadBatchTransfer) - (OneOf)Batch Transfer transaction payload. -
    txs[].batch_transfer.sender string - The sender's address. -
    txs[].batch_transfer.recipientsrepeated object (Recipient) - The list of recipients with their amounts. -
    txs[].memo string - A memo string for the transaction. -
    txs[].public_key string - The public key associated with the transaction. -
    txs[].signature string - The signature for the transaction. -
    txs[].block_height numeric - The block height containing the transaction. + List of transactions for the wallet, filtered by the specified address if provided. +
    txs[].id string + The unique ID of the transaction. +
    txs[].data string + The raw transaction data in hexadecimal format. +
    txs[].version numeric + The version of the transaction. +
    txs[].lock_time numeric + The lock time for the transaction. +
    txs[].value numeric + The value of the transaction in NanoPAC. +
    txs[].fee numeric + The fee for the transaction in NanoPAC. +
    txs[].payload_type numeric + (Enum)The type of transaction payload.
    Available values: +
      +
    • PAYLOAD_TYPE_UNSPECIFIED = 0 (Unspecified payload type.)
      • +
    • PAYLOAD_TYPE_TRANSFER = 1 (Transfer payload type.)
      • +
    • PAYLOAD_TYPE_BOND = 2 (Bond payload type.)
      • +
    • PAYLOAD_TYPE_SORTITION = 3 (Sortition payload type.)
      • +
    • PAYLOAD_TYPE_UNBOND = 4 (Unbond payload type.)
      • +
    • PAYLOAD_TYPE_WITHDRAW = 5 (Withdraw payload type.)
      • +
    • PAYLOAD_TYPE_BATCH_TRANSFER = 6 (Batch transfer payload type.)
      • +
    +
    txs[].transfer object (PayloadTransfer) + (OneOf)Transfer transaction payload. +
    txs[].transfer.sender string + The sender's address. +
    txs[].transfer.receiver string + The receiver's address. +
    txs[].transfer.amount numeric + The amount to be transferred in NanoPAC. +
    txs[].bond object (PayloadBond) + (OneOf)Bond transaction payload. +
    txs[].bond.sender string + The sender's address. +
    txs[].bond.receiver string + The receiver's address. +
    txs[].bond.stake numeric + The stake amount in NanoPAC. +
    txs[].bond.public_key string + The public key of the validator. +
    txs[].sortition object (PayloadSortition) + (OneOf)Sortition transaction payload. +
    txs[].sortition.address string + The validator address associated with the sortition proof. +
    txs[].sortition.proof string + The proof for the sortition. +
    txs[].unbond object (PayloadUnbond) + (OneOf)Unbond transaction payload. +
    txs[].unbond.validator string + The address of the validator to unbond from. +
    txs[].withdraw object (PayloadWithdraw) + (OneOf)Withdraw transaction payload. +
    txs[].withdraw.validator_address string + The address of the validator to withdraw from. +
    txs[].withdraw.account_address string + The address of the account to withdraw to. +
    txs[].withdraw.amount numeric + The withdrawal amount in NanoPAC. +
    txs[].batch_transfer object (PayloadBatchTransfer) + (OneOf)Batch Transfer transaction payload. +
    txs[].batch_transfer.sender string + The sender's address. +
    txs[].batch_transfer.recipientsrepeated object (Recipient) + The list of recipients with their amounts. +
    txs[].memo string + A memo string for the transaction. +
    txs[].public_key string + The public key associated with the transaction. +
    txs[].signature string + The signature for the transaction. +
    txs[].block_height numeric + The block height containing the transaction. A value of zero means the transaction is unconfirmed and may still in the transaction pool. -
    txs[].confirmed boolean - Indicates whether the transaction is confirmed. -
    txs[].confirmations numeric - The number of blocks that have been added to the chain after this transaction was included in a block. +
    txs[].confirmed boolean + Indicates whether the transaction is confirmed. +
    txs[].confirmations numeric + The number of blocks that have been added to the chain after this transaction was included in a block. A value of zero means the transaction is unconfirmed and may still in the transaction pool. -
    + + + +