diff --git a/content/api/grpc.md b/content/api/grpc.md
index 67b54bf..d0950b1 100644
--- a/content/api/grpc.md
+++ b/content/api/grpc.md
@@ -235,7 +235,6 @@ For seamless integration with Pactus, you can use these client libraries:
GetTransaction retrieves transaction details based on the provided request parameters.
GetTransactionRequest Request
-
| Field | Type | Description |
@@ -252,18 +251,17 @@ For seamless integration with Pactus, you can use these client libraries:
verbosity |
TransactionVerbosity |
- (Enum)The verbosity level for transaction details. Available values:
-
- - TRANSACTION_VERBOSITY_DATA = 0 (Request transaction data only.)
- - TRANSACTION_VERBOSITY_INFO = 1 (Request detailed transaction information.)
-
+ (Enum)The verbosity level for transaction details.
+ Available values:
+ - TRANSACTION_VERBOSITY_DATA = 0 (Request transaction data only.)
+ - TRANSACTION_VERBOSITY_INFO = 1 (Request detailed transaction information.)
+
|
GetTransactionResponse Response
-
| Field | Type | Description |
@@ -532,7 +530,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
CalculateFee calculates the transaction fee based on the specified amount and payload type.
CalculateFeeRequest Request
-
| Field | Type | Description |
@@ -549,16 +546,16 @@ A value of zero means the transaction is unconfirmed and may still in the transa
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.)
-
+ (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.)
+
|
@@ -572,7 +569,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
CalculateFeeResponse Response
-
| Field | Type | Description |
@@ -600,7 +596,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
BroadcastTransaction broadcasts a signed transaction to the network.
BroadcastTransactionRequest Request
-
| Field | Type | Description |
@@ -617,7 +612,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
BroadcastTransactionResponse Response
-
| Field | Type | Description |
@@ -638,7 +632,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
GetRawTransferTransaction retrieves raw details of a transfer transaction.
GetRawTransferTransactionRequest Request
-
| Field | Type | Description |
@@ -690,7 +683,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
GetRawTransactionResponse Response
-
| Field | Type | Description |
@@ -718,7 +710,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
GetRawBondTransaction retrieves raw details of a bond transaction.
GetRawBondTransactionRequest Request
-
| Field | Type | Description |
@@ -777,7 +768,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
GetRawTransactionResponse Response
-
| Field | Type | Description |
@@ -805,7 +795,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
GetRawUnbondTransaction retrieves raw details of an unbond transaction.
GetRawUnbondTransactionRequest Request
-
| Field | Type | Description |
@@ -836,7 +825,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
GetRawTransactionResponse Response
-
| Field | Type | Description |
@@ -864,7 +852,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
GetRawWithdrawTransaction retrieves raw details of a withdraw transaction.
GetRawWithdrawTransactionRequest Request
-
| Field | Type | Description |
@@ -916,7 +903,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
GetRawTransactionResponse Response
-
| Field | Type | Description |
@@ -944,7 +930,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
GetRawBatchTransferTransaction retrieves raw details of batch transfer transaction.
GetRawBatchTransferTransactionRequest Request
-
| Field | Type | Description |
@@ -989,7 +974,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
GetRawTransactionResponse Response
-
| Field | Type | Description |
@@ -1017,7 +1001,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
DecodeRawTransaction accepts raw transaction and returns decoded transaction.
DecodeRawTransactionRequest Request
-
| Field | Type | Description |
@@ -1034,7 +1017,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
DecodeRawTransactionResponse Response
-
| Field | Type | Description |
@@ -1293,7 +1275,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
GetBlock retrieves information about a block based on the provided request parameters.
GetBlockRequest Request
-
| Field | Type | Description |
@@ -1310,19 +1291,18 @@ A value of zero means the transaction is unconfirmed and may still in the transa
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.)
-
+ (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
-
| Field | Type | Description |
@@ -1690,7 +1670,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
GetBlockHash retrieves the hash of a block at the specified height.
GetBlockHashRequest Request
-
| Field | Type | Description |
@@ -1707,7 +1686,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
GetBlockHashResponse Response
-
| Field | Type | Description |
@@ -1728,7 +1706,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
GetBlockHeight retrieves the height of a block with the specified hash.
GetBlockHeightRequest Request
-
| Field | Type | Description |
@@ -1745,7 +1722,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
GetBlockHeightResponse Response
-
| Field | Type | Description |
@@ -1769,7 +1745,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
Request Message has no fields.
GetBlockchainInfoResponse Response
-
| Field | Type | Description |
@@ -1947,7 +1922,6 @@ Request Message has no fields.
Request Message has no fields.
GetConsensusInfoResponse Response
-
| Field | Type | Description |
@@ -2082,7 +2056,6 @@ Request Message has no fields.
GetAccount retrieves information about an account based on the provided address.
GetAccountRequest Request
-
| Field | Type | Description |
@@ -2099,7 +2072,6 @@ Request Message has no fields.
GetAccountResponse Response
-
| Field | Type | Description |
@@ -2155,7 +2127,6 @@ Request Message has no fields.
GetValidator retrieves information about a validator based on the provided address.
GetValidatorRequest Request
-
| Field | Type | Description |
@@ -2172,7 +2143,6 @@ Request Message has no fields.
GetValidatorResponse Response
-
| Field | Type | Description |
@@ -2270,7 +2240,6 @@ Request Message has no fields.
GetValidatorByNumber retrieves information about a validator based on the provided number.
GetValidatorByNumberRequest Request
-
| Field | Type | Description |
@@ -2287,7 +2256,6 @@ Request Message has no fields.
GetValidatorResponse Response
-
| Field | Type | Description |
@@ -2388,7 +2356,6 @@ Request Message has no fields.
Request Message has no fields.
GetValidatorAddressesResponse Response
-
| Field | Type | Description |
@@ -2409,7 +2376,6 @@ Request Message has no fields.
GetPublicKey retrieves the public key of an account based on the provided address.
GetPublicKeyRequest Request
-
| Field | Type | Description |
@@ -2426,7 +2392,6 @@ Request Message has no fields.
GetPublicKeyResponse Response
-
| Field | Type | Description |
@@ -2447,7 +2412,6 @@ Request Message has no fields.
GetTxPoolContent retrieves current transactions in the transaction pool.
GetTxPoolContentRequest Request
-
| Field | Type | Description |
@@ -2457,23 +2421,22 @@ Request Message has no fields.
payload_type |
PayloadType |
- (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.)
-
+ (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.)
+
|
GetTxPoolContentResponse Response
-
| Field | Type | Description |
@@ -2732,7 +2695,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
GetNetworkInfo retrieves information about the overall network.
GetNetworkInfoRequest Request
-
| Field | Type | Description |
@@ -2749,7 +2711,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
GetNetworkInfoResponse Response
-
| Field | Type | Description |
@@ -3026,7 +2987,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
Request Message has no fields.
GetNodeInfoResponse Response
-
| Field | Type | Description |
@@ -3189,7 +3149,6 @@ signing, verification, and other cryptographic operations.
SignMessageWithPrivateKey signs a message with the provided private key.
SignMessageWithPrivateKeyRequest Request
-
| Field | Type | Description |
@@ -3213,7 +3172,6 @@ signing, verification, and other cryptographic operations.
SignMessageWithPrivateKeyResponse Response
-
| Field | Type | Description |
@@ -3234,7 +3192,6 @@ signing, verification, and other cryptographic operations.
VerifyMessage verifies a signature against the public key and message.
VerifyMessageRequest Request
-
| Field | Type | Description |
@@ -3265,7 +3222,6 @@ signing, verification, and other cryptographic operations.
VerifyMessageResponse Response
-
| Field | Type | Description |
@@ -3286,7 +3242,6 @@ signing, verification, and other cryptographic operations.
PublicKeyAggregation aggregates multiple BLS public keys into a single key.
PublicKeyAggregationRequest Request
-
| Field | Type | Description |
@@ -3303,7 +3258,6 @@ signing, verification, and other cryptographic operations.
PublicKeyAggregationResponse Response
-
| Field | Type | Description |
@@ -3331,7 +3285,6 @@ signing, verification, and other cryptographic operations.
SignatureAggregation aggregates multiple BLS signatures into a single signature.
SignatureAggregationRequest Request
-
| Field | Type | Description |
@@ -3348,7 +3301,6 @@ signing, verification, and other cryptographic operations.
SignatureAggregationResponse Response
-
| Field | Type | Description |
@@ -3373,7 +3325,6 @@ signing, verification, and other cryptographic operations.
CreateWallet creates a new wallet with the specified parameters.
CreateWalletRequest Request
-
| Field | Type | Description |
@@ -3397,7 +3348,6 @@ signing, verification, and other cryptographic operations.
CreateWalletResponse Response
-
| Field | Type | Description |
@@ -3425,7 +3375,6 @@ signing, verification, and other cryptographic operations.
RestoreWallet restores an existing wallet with the given mnemonic.
RestoreWalletRequest Request
-
| Field | Type | Description |
@@ -3456,7 +3405,6 @@ signing, verification, and other cryptographic operations.
RestoreWalletResponse Response
-
| Field | Type | Description |
@@ -3478,7 +3426,6 @@ signing, verification, and other cryptographic operations.
deprecated: It will be removed in a future version.
LoadWalletRequest Request
-
| Field | Type | Description |
@@ -3495,7 +3442,6 @@ deprecated: It will be removed in a future version.
LoadWalletResponse Response
-
| Field | Type | Description |
@@ -3517,7 +3463,6 @@ deprecated: It will be removed in a future version.
deprecated: It will be removed in a future version.
UnloadWalletRequest Request
-
| Field | Type | Description |
@@ -3534,7 +3479,6 @@ deprecated: It will be removed in a future version.
UnloadWalletResponse Response
-
| Field | Type | Description |
@@ -3558,7 +3502,6 @@ deprecated: It will be removed in a future version.
Request Message has no fields.
ListWalletsResponse Response
-
| Field | Type | Description |
@@ -3579,7 +3522,6 @@ Request Message has no fields.
GetWalletInfo returns detailed information about a specific wallet.
GetWalletInfoRequest Request
-
| Field | Type | Description |
@@ -3596,7 +3538,6 @@ Request Message has no fields.
GetWalletInfoResponse Response
-
| Field | Type | Description |
@@ -3673,7 +3614,6 @@ Request Message has no fields.
UpdatePassword updates the password of an existing wallet.
UpdatePasswordRequest Request
-
| Field | Type | Description |
@@ -3704,7 +3644,6 @@ Request Message has no fields.
UpdatePasswordResponse Response
-
| Field | Type | Description |
@@ -3725,7 +3664,6 @@ Request Message has no fields.
GetTotalBalance returns the total available balance of the wallet.
GetTotalBalanceRequest Request
-
| Field | Type | Description |
@@ -3742,7 +3680,6 @@ Request Message has no fields.
GetTotalBalanceResponse Response
-
| Field | Type | Description |
@@ -3770,7 +3707,6 @@ Request Message has no fields.
GetTotalStake returns the total stake amount in the wallet.
GetTotalStakeRequest Request
-
| Field | Type | Description |
@@ -3787,7 +3723,6 @@ Request Message has no fields.
GetTotalStakeResponse Response
-
| Field | Type | Description |
@@ -3816,7 +3751,6 @@ Request Message has no fields.
Deprecated: Will move into utils.
GetValidatorAddressRequest Request
-
| Field | Type | Description |
@@ -3833,7 +3767,6 @@ Deprecated: Will move into utils.
GetValidatorAddressResponse Response
-
| Field | Type | Description |
@@ -3854,7 +3787,6 @@ Deprecated: Will move into utils.
GetAddressInfo returns detailed information about a specific address.
GetAddressInfoRequest Request
-
| Field | Type | Description |
@@ -3878,7 +3810,6 @@ Deprecated: Will move into utils.
GetAddressInfoResponse Response
-
| Field | Type | Description |
@@ -3934,7 +3865,6 @@ Deprecated: Will move into utils.
SetAddressLabel sets or updates the label for a given address.
SetAddressLabelRequest Request
-
| Field | Type | Description |
@@ -3972,7 +3902,6 @@ Deprecated: Will move into utils.
SetAddressLabelResponse Response
-
| Field | Type | Description |
@@ -4007,7 +3936,6 @@ Deprecated: Will move into utils.
GetNewAddress generates a new address for the specified wallet.
GetNewAddressRequest Request
-
| Field | Type | Description |
@@ -4024,15 +3952,15 @@ Deprecated: Will move into utils.
address_type |
AddressType |
- (Enum)The type of address to generate. Available values:
-
- - ADDRESS_TYPE_TREASURY = 0 (Treasury address type.
+ (Enum)The type of address to generate.
+
Available values:
+ - ADDRESS_TYPE_TREASURY = 0 (Treasury address type.
Should not be used to generate new addresses.)
- - ADDRESS_TYPE_VALIDATOR = 1 (Validator address type used for validator nodes.)
- - ADDRESS_TYPE_BLS_ACCOUNT = 2 (Account address type with BLS signature scheme.)
- - ADDRESS_TYPE_ED25519_ACCOUNT = 3 (Account address type with Ed25519 signature scheme.
+
- ADDRESS_TYPE_VALIDATOR = 1 (Validator address type used for validator nodes.)
+ - ADDRESS_TYPE_BLS_ACCOUNT = 2 (Account address type with BLS signature scheme.)
+ - ADDRESS_TYPE_ED25519_ACCOUNT = 3 (Account address type with Ed25519 signature scheme.
Note: Generating a new Ed25519 address requires the wallet password.)
-
+
|
@@ -4053,7 +3981,6 @@ Note: Generating a new Ed25519 address requires the wallet password.)
GetNewAddressResponse Response
-
| Field | Type | Description |
@@ -4109,7 +4036,6 @@ Note: Generating a new Ed25519 address requires the wallet password.)
ListAddresses returns all addresses in the specified wallet.
ListAddressesRequest Request
-
| Field | Type | Description |
@@ -4126,22 +4052,21 @@ Note: Generating a new Ed25519 address requires the wallet password.)
address_types |
repeated AddressType |
- (Enum)Filter addresses by their types. If empty, all address types are included. Available values:
-
- - ADDRESS_TYPE_TREASURY = 0 (Treasury address type.
+ (Enum)Filter addresses by their types. If empty, all address types are included.
+
Available values:
+ - ADDRESS_TYPE_TREASURY = 0 (Treasury address type.
Should not be used to generate new addresses.)
- - ADDRESS_TYPE_VALIDATOR = 1 (Validator address type used for validator nodes.)
- - ADDRESS_TYPE_BLS_ACCOUNT = 2 (Account address type with BLS signature scheme.)
- - ADDRESS_TYPE_ED25519_ACCOUNT = 3 (Account address type with Ed25519 signature scheme.
+
- ADDRESS_TYPE_VALIDATOR = 1 (Validator address type used for validator nodes.)
+ - ADDRESS_TYPE_BLS_ACCOUNT = 2 (Account address type with BLS signature scheme.)
+ - ADDRESS_TYPE_ED25519_ACCOUNT = 3 (Account address type with Ed25519 signature scheme.
Note: Generating a new Ed25519 address requires the wallet password.)
-
+
|
ListAddressesResponse Response
-
| Field | Type | Description |
@@ -4197,7 +4122,6 @@ Note: Generating a new Ed25519 address requires the wallet password.)
SignMessage signs an arbitrary message using a wallet's private key.
SignMessageRequest Request
-
| Field | Type | Description |
@@ -4235,7 +4159,6 @@ Note: Generating a new Ed25519 address requires the wallet password.)
SignMessageResponse Response
-
| Field | Type | Description |
@@ -4256,7 +4179,6 @@ Note: Generating a new Ed25519 address requires the wallet password.)
SignRawTransaction signs a raw transaction for a specified wallet.
SignRawTransactionRequest Request
-
| Field | Type | Description |
@@ -4287,7 +4209,6 @@ Note: Generating a new Ed25519 address requires the wallet password.)
SignRawTransactionResponse Response
-
| Field | Type | Description |
@@ -4316,7 +4237,6 @@ Note: Generating a new Ed25519 address requires the wallet password.)
optionally filtered by a specific address, with pagination support.
ListTransactionsRequest Request
-
| Field | Type | Description |
@@ -4334,7 +4254,7 @@ optionally filtered by a specific address, with pagination support.
string |
Optional: The address to filter transactions.
-If empty or set to "*", transactions for all addresses in the wallet are included.
+If empty or set to '*', transactions for all addresses in the wallet are included.
|
@@ -4342,12 +4262,12 @@ If empty or set to "*", transactions for all addresses in the wallet are include
| TxDirection |
(Enum)Filter transactions by direction relative to the wallet.
-Defaults to any direction if not set. Available values:
-
- - TX_DIRECTION_ANY = 0 (include both incoming and outgoing transactions.)
- - TX_DIRECTION_INCOMING = 1 (Include only incoming transactions where the wallet receives funds.)
- - TX_DIRECTION_OUTGOING = 2 (Include only outgoing transactions where the wallet sends funds.)
-
+Defaults to any direction if not set.
+ Available values:
+ - TX_DIRECTION_ANY = 0 (include both incoming and outgoing transactions.)
+ - TX_DIRECTION_INCOMING = 1 (Include only incoming transactions where the wallet receives funds.)
+ - TX_DIRECTION_OUTGOING = 2 (Include only outgoing transactions where the wallet sends funds.)
+
|
@@ -4370,7 +4290,6 @@ Defaults to 0 if not set.
ListTransactionsResponse Response
-
| Field | Type | Description |
diff --git a/content/api/json-rpc.md b/content/api/json-rpc.md
index 7f00d7f..d976369 100644
--- a/content/api/json-rpc.md
+++ b/content/api/json-rpc.md
@@ -285,7 +285,6 @@ curl --location 'http://localhost:8545/' \
GetTransaction retrieves transaction details based on the provided request parameters.
Parameters
-
| Field | Type | Description |
@@ -302,18 +301,17 @@ curl --location 'http://localhost:8545/' \
verbosity |
numeric |
- (Enum)The verbosity level for transaction details. Available values:
-
- - TRANSACTION_VERBOSITY_DATA = 0 (Request transaction data only.)
- - TRANSACTION_VERBOSITY_INFO = 1 (Request detailed transaction information.)
-
+ (Enum)The verbosity level for transaction details.
+ Available values:
+ - TRANSACTION_VERBOSITY_DATA = 0 (Request transaction data only.)
+ - TRANSACTION_VERBOSITY_INFO = 1 (Request detailed transaction information.)
+
|
Result
-
| Field | Type | Description |
@@ -385,16 +383,16 @@ curl --location 'http://localhost:8545/' \
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.)
-
+ (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.)
+
|
@@ -581,7 +579,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
CalculateFee calculates the transaction fee based on the specified amount and payload type.
Parameters
-
| Field | Type | Description |
@@ -598,16 +595,16 @@ A value of zero means the transaction is unconfirmed and may still in the transa
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.)
-
+ (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.)
+
|
@@ -621,7 +618,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
Result
-
| Field | Type | Description |
@@ -648,7 +644,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
BroadcastTransaction broadcasts a signed transaction to the network.
Parameters
-
| Field | Type | Description |
@@ -665,7 +660,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
Result
-
| Field | Type | Description |
@@ -685,7 +679,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
GetRawTransferTransaction retrieves raw details of a transfer transaction.
Parameters
-
| Field | Type | Description |
@@ -737,7 +730,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
Result
-
| Field | Type | Description |
@@ -764,7 +756,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
GetRawBondTransaction retrieves raw details of a bond transaction.
Parameters
-
| Field | Type | Description |
@@ -823,7 +814,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
Result
-
| Field | Type | Description |
@@ -850,7 +840,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
GetRawUnbondTransaction retrieves raw details of an unbond transaction.
Parameters
-
| Field | Type | Description |
@@ -881,7 +870,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
Result
-
| Field | Type | Description |
@@ -908,7 +896,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
GetRawWithdrawTransaction retrieves raw details of a withdraw transaction.
Parameters
-
| Field | Type | Description |
@@ -960,7 +947,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
Result
-
| Field | Type | Description |
@@ -987,7 +973,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
GetRawBatchTransferTransaction retrieves raw details of batch transfer transaction.
Parameters
-
| Field | Type | Description |
@@ -1032,7 +1017,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
Result
-
| Field | Type | Description |
@@ -1059,7 +1043,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
DecodeRawTransaction accepts raw transaction and returns decoded transaction.
Parameters
-
| Field | Type | Description |
@@ -1076,7 +1059,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
Result
-
| Field | Type | Description |
@@ -1134,16 +1116,16 @@ A value of zero means the transaction is unconfirmed and may still in the transa
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.)
-
+ (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.)
+
|
@@ -1334,7 +1316,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
GetBlock retrieves information about a block based on the provided request parameters.
Parameters
-
| Field | Type | Description |
@@ -1351,19 +1332,18 @@ A value of zero means the transaction is unconfirmed and may still in the transa
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.)
-
+ (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
-
| Field | Type | Description |
@@ -1534,16 +1514,16 @@ BLOCK_VERBOSITY_TRANSACTIONS.
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.)
-
+ (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.)
+
|
@@ -1730,7 +1710,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
GetBlockHash retrieves the hash of a block at the specified height.
Parameters
-
| Field | Type | Description |
@@ -1747,7 +1726,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
Result
-
| Field | Type | Description |
@@ -1767,7 +1745,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
GetBlockHeight retrieves the height of a block with the specified hash.
Parameters
-
| Field | Type | Description |
@@ -1784,7 +1761,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
Result
-
| Field | Type | Description |
@@ -1807,7 +1783,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
Parameters has no fields.
Result
-
| Field | Type | Description |
@@ -1984,7 +1959,6 @@ Parameters has no fields.
Parameters has no fields.
Result
-
| Field | Type | Description |
@@ -2070,15 +2044,15 @@ Parameters has no fields.
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.)
-
+ (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 |
@@ -2118,7 +2092,6 @@ Parameters has no fields.
GetAccount retrieves information about an account based on the provided address.
Parameters
-
| Field | Type | Description |
@@ -2135,7 +2108,6 @@ Parameters has no fields.
Result
-
| Field | Type | Description |
@@ -2190,7 +2162,6 @@ Parameters has no fields.
GetValidator retrieves information about a validator based on the provided address.
Parameters
-
| Field | Type | Description |
@@ -2207,7 +2178,6 @@ Parameters has no fields.
Result
-
| Field | Type | Description |
@@ -2304,7 +2274,6 @@ Parameters has no fields.
GetValidatorByNumber retrieves information about a validator based on the provided number.
Parameters
-
| Field | Type | Description |
@@ -2321,7 +2290,6 @@ Parameters has no fields.
Result
-
| Field | Type | Description |
@@ -2421,7 +2389,6 @@ Parameters has no fields.
Parameters has no fields.
Result
-
| Field | Type | Description |
@@ -2441,7 +2408,6 @@ Parameters has no fields.
GetPublicKey retrieves the public key of an account based on the provided address.
Parameters
-
| Field | Type | Description |
@@ -2458,7 +2424,6 @@ Parameters has no fields.
Result
-
| Field | Type | Description |
@@ -2478,7 +2443,6 @@ Parameters has no fields.
GetTxPoolContent retrieves current transactions in the transaction pool.
Parameters
-
| Field | Type | Description |
@@ -2488,23 +2452,22 @@ Parameters has no fields.
payload_type |
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.)
-
+ (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.)
+
|
Result
-
| Field | Type | Description |
@@ -2562,16 +2525,16 @@ Parameters has no fields.
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.)
-
+ (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.)
+
|
@@ -2762,7 +2725,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
GetNetworkInfo retrieves information about the overall network.
Parameters
-
| Field | Type | Description |
@@ -2779,7 +2741,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
Result
-
| Field | Type | Description |
@@ -2893,12 +2854,12 @@ A value of zero means the transaction is unconfirmed and may still in the transa
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.)
-
+ (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.)
+
|
@@ -3055,7 +3016,6 @@ A value of zero means the transaction is unconfirmed and may still in the transa
Parameters has no fields.
Result
-
| Field | Type | Description |
@@ -3205,7 +3165,6 @@ maximum number of messages to queue before dropping older ones.
Parameters has no fields.
Result
-
Result has no fields.
### Utils Service
@@ -3218,7 +3177,6 @@ signing, verification, and other cryptographic operations.
SignMessageWithPrivateKey signs a message with the provided private key.
Parameters
-
| Field | Type | Description |
@@ -3242,7 +3200,6 @@ signing, verification, and other cryptographic operations.
Result
-
| Field | Type | Description |
@@ -3262,7 +3219,6 @@ signing, verification, and other cryptographic operations.
VerifyMessage verifies a signature against the public key and message.
Parameters
-
| Field | Type | Description |
@@ -3293,7 +3249,6 @@ signing, verification, and other cryptographic operations.
Result
-
| Field | Type | Description |
@@ -3313,7 +3268,6 @@ signing, verification, and other cryptographic operations.
PublicKeyAggregation aggregates multiple BLS public keys into a single key.
Parameters
-
| Field | Type | Description |
@@ -3330,7 +3284,6 @@ signing, verification, and other cryptographic operations.
Result
-
| Field | Type | Description |
@@ -3357,7 +3310,6 @@ signing, verification, and other cryptographic operations.
SignatureAggregation aggregates multiple BLS signatures into a single signature.
Parameters
-
| Field | Type | Description |
@@ -3374,7 +3326,6 @@ signing, verification, and other cryptographic operations.
Result
-
| Field | Type | Description |
@@ -3398,7 +3349,6 @@ signing, verification, and other cryptographic operations.
CreateWallet creates a new wallet with the specified parameters.
Parameters
-
| Field | Type | Description |
@@ -3422,7 +3372,6 @@ signing, verification, and other cryptographic operations.
Result
-
| Field | Type | Description |
@@ -3449,7 +3398,6 @@ signing, verification, and other cryptographic operations.
RestoreWallet restores an existing wallet with the given mnemonic.
Parameters
-
| Field | Type | Description |
@@ -3480,7 +3428,6 @@ signing, verification, and other cryptographic operations.
Result
-
| Field | Type | Description |
@@ -3501,7 +3448,6 @@ signing, verification, and other cryptographic operations.
deprecated: It will be removed in a future version.
Parameters
-
| Field | Type | Description |
@@ -3518,7 +3464,6 @@ deprecated: It will be removed in a future version.
Result
-
| Field | Type | Description |
@@ -3539,7 +3484,6 @@ deprecated: It will be removed in a future version.
deprecated: It will be removed in a future version.
Parameters
-
| Field | Type | Description |
@@ -3556,7 +3500,6 @@ deprecated: It will be removed in a future version.
Result
-
| Field | Type | Description |
@@ -3579,7 +3522,6 @@ deprecated: It will be removed in a future version.
Parameters has no fields.
Result
-
| Field | Type | Description |
@@ -3599,7 +3541,6 @@ Parameters has no fields.
GetWalletInfo returns detailed information about a specific wallet.
Parameters
-
| Field | Type | Description |
@@ -3616,7 +3557,6 @@ Parameters has no fields.
Result
-
| Field | Type | Description |
@@ -3692,7 +3632,6 @@ Parameters has no fields.
UpdatePassword updates the password of an existing wallet.
Parameters
-
| Field | Type | Description |
@@ -3723,7 +3662,6 @@ Parameters has no fields.
Result
-
| Field | Type | Description |
@@ -3743,7 +3681,6 @@ Parameters has no fields.
GetTotalBalance returns the total available balance of the wallet.
Parameters
-
| Field | Type | Description |
@@ -3760,7 +3697,6 @@ Parameters has no fields.
Result
-
| Field | Type | Description |
@@ -3787,7 +3723,6 @@ Parameters has no fields.
GetTotalStake returns the total stake amount in the wallet.
Parameters
-
| Field | Type | Description |
@@ -3804,7 +3739,6 @@ Parameters has no fields.
Result
-
| Field | Type | Description |
@@ -3832,7 +3766,6 @@ Parameters has no fields.
Deprecated: Will move into utils.
Parameters
-
| Field | Type | Description |
@@ -3849,7 +3782,6 @@ Deprecated: Will move into utils.
Result
-
| Field | Type | Description |
@@ -3869,7 +3801,6 @@ Deprecated: Will move into utils.
GetAddressInfo returns detailed information about a specific address.
Parameters
-
| Field | Type | Description |
@@ -3893,7 +3824,6 @@ Deprecated: Will move into utils.
Result
-
| Field | Type | Description |
@@ -3948,7 +3878,6 @@ Deprecated: Will move into utils.
SetAddressLabel sets or updates the label for a given address.
Parameters
-
| Field | Type | Description |
@@ -3986,7 +3915,6 @@ Deprecated: Will move into utils.
Result
-
| Field | Type | Description |
@@ -4020,7 +3948,6 @@ Deprecated: Will move into utils.
GetNewAddress generates a new address for the specified wallet.
Parameters
-
| Field | Type | Description |
@@ -4037,15 +3964,15 @@ Deprecated: Will move into utils.
address_type |
numeric |
- (Enum)The type of address to generate. Available values:
-
- - ADDRESS_TYPE_TREASURY = 0 (Treasury address type.
+ (Enum)The type of address to generate.
+
Available values:
+ - ADDRESS_TYPE_TREASURY = 0 (Treasury address type.
Should not be used to generate new addresses.)
- - ADDRESS_TYPE_VALIDATOR = 1 (Validator address type used for validator nodes.)
- - ADDRESS_TYPE_BLS_ACCOUNT = 2 (Account address type with BLS signature scheme.)
- - ADDRESS_TYPE_ED25519_ACCOUNT = 3 (Account address type with Ed25519 signature scheme.
+
- ADDRESS_TYPE_VALIDATOR = 1 (Validator address type used for validator nodes.)
+ - ADDRESS_TYPE_BLS_ACCOUNT = 2 (Account address type with BLS signature scheme.)
+ - ADDRESS_TYPE_ED25519_ACCOUNT = 3 (Account address type with Ed25519 signature scheme.
Note: Generating a new Ed25519 address requires the wallet password.)
-
+
|
@@ -4066,7 +3993,6 @@ Note: Generating a new Ed25519 address requires the wallet password.)
Result
-
| Field | Type | Description |
@@ -4121,7 +4047,6 @@ Note: Generating a new Ed25519 address requires the wallet password.)
ListAddresses returns all addresses in the specified wallet.
Parameters
-
| Field | Type | Description |
@@ -4138,22 +4063,21 @@ Note: Generating a new Ed25519 address requires the wallet password.)
address_types |
repeated numeric |
- (Enum)Filter addresses by their types. If empty, all address types are included. Available values:
-
- - ADDRESS_TYPE_TREASURY = 0 (Treasury address type.
+ (Enum)Filter addresses by their types. If empty, all address types are included.
+
Available values:
+ - ADDRESS_TYPE_TREASURY = 0 (Treasury address type.
Should not be used to generate new addresses.)
- - ADDRESS_TYPE_VALIDATOR = 1 (Validator address type used for validator nodes.)
- - ADDRESS_TYPE_BLS_ACCOUNT = 2 (Account address type with BLS signature scheme.)
- - ADDRESS_TYPE_ED25519_ACCOUNT = 3 (Account address type with Ed25519 signature scheme.
+
- ADDRESS_TYPE_VALIDATOR = 1 (Validator address type used for validator nodes.)
+ - ADDRESS_TYPE_BLS_ACCOUNT = 2 (Account address type with BLS signature scheme.)
+ - ADDRESS_TYPE_ED25519_ACCOUNT = 3 (Account address type with Ed25519 signature scheme.
Note: Generating a new Ed25519 address requires the wallet password.)
-
+
|
Result
-
| Field | Type | Description |
@@ -4208,7 +4132,6 @@ Note: Generating a new Ed25519 address requires the wallet password.)
SignMessage signs an arbitrary message using a wallet's private key.
Parameters
-
| Field | Type | Description |
@@ -4246,7 +4169,6 @@ Note: Generating a new Ed25519 address requires the wallet password.)
Result
-
| Field | Type | Description |
@@ -4266,7 +4188,6 @@ Note: Generating a new Ed25519 address requires the wallet password.)
SignRawTransaction signs a raw transaction for a specified wallet.
Parameters
-
| Field | Type | Description |
@@ -4297,7 +4218,6 @@ Note: Generating a new Ed25519 address requires the wallet password.)
Result
-
| Field | Type | Description |
@@ -4325,7 +4245,6 @@ Note: Generating a new Ed25519 address requires the wallet password.)
optionally filtered by a specific address, with pagination support.
Parameters
-
| Field | Type | Description |
@@ -4343,7 +4262,7 @@ optionally filtered by a specific address, with pagination support.
string |
Optional: The address to filter transactions.
-If empty or set to "*", transactions for all addresses in the wallet are included.
+If empty or set to '*', transactions for all addresses in the wallet are included.
|
@@ -4351,12 +4270,12 @@ If empty or set to "*", transactions for all addresses in the wallet are include
| numeric |
(Enum)Filter transactions by direction relative to the wallet.
-Defaults to any direction if not set. Available values:
-
- - TX_DIRECTION_ANY = 0 (include both incoming and outgoing transactions.)
- - TX_DIRECTION_INCOMING = 1 (Include only incoming transactions where the wallet receives funds.)
- - TX_DIRECTION_OUTGOING = 2 (Include only outgoing transactions where the wallet sends funds.)
-
+Defaults to any direction if not set.
+ Available values:
+ - TX_DIRECTION_ANY = 0 (include both incoming and outgoing transactions.)
+ - TX_DIRECTION_INCOMING = 1 (Include only incoming transactions where the wallet receives funds.)
+ - TX_DIRECTION_OUTGOING = 2 (Include only outgoing transactions where the wallet sends funds.)
+
|
@@ -4379,7 +4298,6 @@ Defaults to 0 if not set.
Result
-
| Field | Type | Description |
@@ -4444,16 +4362,16 @@ Defaults to 0 if not set.
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.)
-
+ (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.)
+
|
@@ -4633,4 +4551,5 @@ A value of zero means the transaction is unconfirmed and may still in the transa
-
+
+
diff --git a/static/swagger-ui/pactus.swagger.json b/static/swagger-ui/pactus.swagger.json
index f684f0e..7e127c5 100644
--- a/static/swagger-ui/pactus.swagger.json
+++ b/static/swagger-ui/pactus.swagger.json
@@ -474,6 +474,29 @@
]
}
},
+ "/pactus/blockchain/get_validator_addresses": {
+ "get": {
+ "summary": "GetValidatorAddresses retrieves a list of all validator addresses.",
+ "operationId": "Blockchain_GetValidatorAddresses",
+ "responses": {
+ "200": {
+ "description": "A successful response.",
+ "schema": {
+ "$ref": "#/definitions/pactusGetValidatorAddressesResponse"
+ }
+ },
+ "default": {
+ "description": "An unexpected error response.",
+ "schema": {
+ "$ref": "#/definitions/rpcStatus"
+ }
+ }
+ },
+ "tags": [
+ "Blockchain"
+ ]
+ }
+ },
"/pactus/blockchain/get_validator_by_number": {
"get": {
"summary": "GetValidatorByNumber retrieves information about a validator based on the provided number.",
@@ -902,7 +925,7 @@
}
},
"/pactus/wallet/create_wallet": {
- "get": {
+ "post": {
"summary": "CreateWallet creates a new wallet with the specified parameters.",
"operationId": "Wallet_CreateWallet",
"responses": {
@@ -921,18 +944,13 @@
},
"parameters": [
{
- "name": "walletName",
- "description": "The name for the new wallet.",
- "in": "query",
- "required": false,
- "type": "string"
- },
- {
- "name": "password",
- "description": "Password to secure the new wallet.",
- "in": "query",
- "required": false,
- "type": "string"
+ "name": "body",
+ "description": "Request message for creating a new wallet.",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/pactusCreateWalletRequest"
+ }
}
],
"tags": [
@@ -980,7 +998,7 @@
}
},
"/pactus/wallet/get_new_address": {
- "get": {
+ "post": {
"summary": "GetNewAddress generates a new address for the specified wallet.",
"operationId": "Wallet_GetNewAddress",
"responses": {
@@ -999,39 +1017,13 @@
},
"parameters": [
{
- "name": "walletName",
- "description": "The name of the wallet to generate a new address.",
- "in": "query",
- "required": false,
- "type": "string"
- },
- {
- "name": "addressType",
- "description": "The type of address to generate.\n\n - ADDRESS_TYPE_TREASURY: Treasury address type.\nShould not be used to generate new addresses.\n - ADDRESS_TYPE_VALIDATOR: Validator address type used for validator nodes.\n - ADDRESS_TYPE_BLS_ACCOUNT: Account address type with BLS signature scheme.\n - ADDRESS_TYPE_ED25519_ACCOUNT: Account address type with Ed25519 signature scheme.\nNote: Generating a new Ed25519 address requires the wallet password.",
- "in": "query",
- "required": false,
- "type": "string",
- "enum": [
- "ADDRESS_TYPE_TREASURY",
- "ADDRESS_TYPE_VALIDATOR",
- "ADDRESS_TYPE_BLS_ACCOUNT",
- "ADDRESS_TYPE_ED25519_ACCOUNT"
- ],
- "default": "ADDRESS_TYPE_TREASURY"
- },
- {
- "name": "label",
- "description": "A label for the new address.",
- "in": "query",
- "required": false,
- "type": "string"
- },
- {
- "name": "password",
- "description": "Password for the new address. It's required when address_type is Ed25519 type.",
- "in": "query",
- "required": false,
- "type": "string"
+ "name": "body",
+ "description": "Request message for generating a new wallet address.",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/pactusGetNewAddressRequest"
+ }
}
],
"tags": [
@@ -1167,38 +1159,6 @@
]
}
},
- "/pactus/wallet/is_wallet_loaded": {
- "get": {
- "summary": "IsWalletLoaded checks whether the specified wallet is currently loaded.",
- "operationId": "Wallet_IsWalletLoaded",
- "responses": {
- "200": {
- "description": "A successful response.",
- "schema": {
- "$ref": "#/definitions/pactusIsWalletLoadedResponse"
- }
- },
- "default": {
- "description": "An unexpected error response.",
- "schema": {
- "$ref": "#/definitions/rpcStatus"
- }
- }
- },
- "parameters": [
- {
- "name": "walletName",
- "description": "Name of the wallet to check.",
- "in": "query",
- "required": false,
- "type": "string"
- }
- ],
- "tags": [
- "Wallet"
- ]
- }
- },
"/pactus/wallet/list_addresses": {
"get": {
"summary": "ListAddresses returns all addresses in the specified wallet.",
@@ -1276,7 +1236,7 @@
},
{
"name": "address",
- "description": "Optional: The address to filter transactions.\nIf empty or set to \"*\", transactions for all addresses in the wallet are included.",
+ "description": "Optional: The address to filter transactions.\nIf empty or set to '*', transactions for all addresses in the wallet are included.",
"in": "query",
"required": false,
"type": "string"
@@ -1318,7 +1278,7 @@
},
"/pactus/wallet/list_wallets": {
"get": {
- "summary": "ListWallets returns a list of all available wallets.\nIf `include_unloaded` is set, it returns both loaded and unloaded wallets.",
+ "summary": "ListWallets returns a list of all available wallets.",
"operationId": "Wallet_ListWallets",
"responses": {
"200": {
@@ -1334,23 +1294,14 @@
}
}
},
- "parameters": [
- {
- "name": "includeUnloaded",
- "description": "Whether to include wallets that exist on disk but are not currently loaded.",
- "in": "query",
- "required": false,
- "type": "boolean"
- }
- ],
"tags": [
"Wallet"
]
}
},
"/pactus/wallet/load_wallet": {
- "get": {
- "summary": "LoadWallet loads an existing wallet with the given name.",
+ "post": {
+ "summary": "LoadWallet loads an existing wallet with the given name.\ndeprecated: It will be removed in a future version.",
"operationId": "Wallet_LoadWallet",
"responses": {
"200": {
@@ -1368,11 +1319,13 @@
},
"parameters": [
{
- "name": "walletName",
- "description": "The name of the wallet to load.",
- "in": "query",
- "required": false,
- "type": "string"
+ "name": "body",
+ "description": "Request message for loading an existing wallet.\nDeprecated: It will be removed in a future version.",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/pactusLoadWalletRequest"
+ }
}
],
"tags": [
@@ -1381,7 +1334,7 @@
}
},
"/pactus/wallet/restore_wallet": {
- "get": {
+ "post": {
"summary": "RestoreWallet restores an existing wallet with the given mnemonic.",
"operationId": "Wallet_RestoreWallet",
"responses": {
@@ -1400,25 +1353,13 @@
},
"parameters": [
{
- "name": "walletName",
- "description": "The name for the restored wallet.",
- "in": "query",
- "required": false,
- "type": "string"
- },
- {
- "name": "mnemonic",
- "description": "The mnemonic (seed phrase) for wallet recovery.",
- "in": "query",
- "required": false,
- "type": "string"
- },
- {
- "name": "password",
- "description": "Password to secure the restored wallet.",
- "in": "query",
- "required": false,
- "type": "string"
+ "name": "body",
+ "description": "Request message for restoring a wallet from mnemonic (seed phrase).",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/pactusRestoreWalletRequest"
+ }
}
],
"tags": [
@@ -1480,7 +1421,7 @@
}
},
"/pactus/wallet/sign_message": {
- "get": {
+ "post": {
"summary": "SignMessage signs an arbitrary message using a wallet's private key.",
"operationId": "Wallet_SignMessage",
"responses": {
@@ -1499,32 +1440,13 @@
},
"parameters": [
{
- "name": "walletName",
- "description": "The name of the wallet to sign with.",
- "in": "query",
- "required": false,
- "type": "string"
- },
- {
- "name": "password",
- "description": "Wallet password required for signing.",
- "in": "query",
- "required": false,
- "type": "string"
- },
- {
- "name": "address",
- "description": "The address whose private key should be used for signing the message.",
- "in": "query",
- "required": false,
- "type": "string"
- },
- {
- "name": "message",
- "description": "The arbitrary message to be signed.",
- "in": "query",
- "required": false,
- "type": "string"
+ "name": "body",
+ "description": "Request message to sign an arbitrary message.",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/pactusSignMessageRequest"
+ }
}
],
"tags": [
@@ -1533,7 +1455,7 @@
}
},
"/pactus/wallet/sign_raw_transaction": {
- "get": {
+ "post": {
"summary": "SignRawTransaction signs a raw transaction for a specified wallet.",
"operationId": "Wallet_SignRawTransaction",
"responses": {
@@ -1552,25 +1474,13 @@
},
"parameters": [
{
- "name": "walletName",
- "description": "The name of the wallet used for signing.",
- "in": "query",
- "required": false,
- "type": "string"
- },
- {
- "name": "rawTransaction",
- "description": "The raw transaction data to be signed.",
- "in": "query",
- "required": false,
- "type": "string"
- },
- {
- "name": "password",
- "description": "Wallet password required for signing.",
- "in": "query",
- "required": false,
- "type": "string"
+ "name": "body",
+ "description": "Request message for signing a raw transaction.",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/pactusSignRawTransactionRequest"
+ }
}
],
"tags": [
@@ -1579,8 +1489,8 @@
}
},
"/pactus/wallet/unload_wallet": {
- "get": {
- "summary": "UnloadWallet unloads a currently loaded wallet with the specified name.",
+ "post": {
+ "summary": "UnloadWallet unloads a currently loaded wallet with the specified name.\ndeprecated: It will be removed in a future version.",
"operationId": "Wallet_UnloadWallet",
"responses": {
"200": {
@@ -1598,11 +1508,13 @@
},
"parameters": [
{
- "name": "walletName",
- "description": "The name of the wallet to unload.",
- "in": "query",
- "required": false,
- "type": "string"
+ "name": "body",
+ "description": "Request message for unloading a wallet.\nDeprecated: It will be removed in a future version.",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/pactusUnloadWalletRequest"
+ }
}
],
"tags": [
@@ -1611,7 +1523,7 @@
}
},
"/pactus/wallet/update_password": {
- "get": {
+ "post": {
"summary": "UpdatePassword updates the password of an existing wallet.",
"operationId": "Wallet_UpdatePassword",
"responses": {
@@ -1630,25 +1542,13 @@
},
"parameters": [
{
- "name": "walletName",
- "description": "The name of the wallet whose password will be updated.",
- "in": "query",
- "required": false,
- "type": "string"
- },
- {
- "name": "oldPassword",
- "description": "The current wallet password.",
- "in": "query",
- "required": false,
- "type": "string"
- },
- {
- "name": "newPassword",
- "description": "The new wallet password.",
- "in": "query",
- "required": false,
- "type": "string"
+ "name": "body",
+ "description": "Request message for updating wallet password.",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/pactusUpdatePasswordRequest"
+ }
}
],
"tags": [
@@ -1915,6 +1815,20 @@
},
"description": "CounterInfo holds counter data regarding byte and bundle counts."
},
+ "pactusCreateWalletRequest": {
+ "type": "object",
+ "properties": {
+ "walletName": {
+ "type": "string",
+ "description": "The name for the new wallet."
+ },
+ "password": {
+ "type": "string",
+ "description": "Password to secure the new wallet."
+ }
+ },
+ "description": "Request message for creating a new wallet."
+ },
"pactusCreateWalletResponse": {
"type": "object",
"properties": {
@@ -2159,6 +2073,28 @@
},
"description": "Response message contains information about the overall network."
},
+ "pactusGetNewAddressRequest": {
+ "type": "object",
+ "properties": {
+ "walletName": {
+ "type": "string",
+ "description": "The name of the wallet to generate a new address."
+ },
+ "addressType": {
+ "$ref": "#/definitions/pactusAddressType",
+ "description": "The type of address to generate."
+ },
+ "label": {
+ "type": "string",
+ "description": "A label for the new address."
+ },
+ "password": {
+ "type": "string",
+ "description": "Password for the new address. It's required when address_type is Ed25519 type."
+ }
+ },
+ "description": "Request message for generating a new wallet address."
+ },
"pactusGetNewAddressResponse": {
"type": "object",
"properties": {
@@ -2565,20 +2501,6 @@
},
"description": "Response message contains wallet details."
},
- "pactusIsWalletLoadedResponse": {
- "type": "object",
- "properties": {
- "walletName": {
- "type": "string",
- "description": "Name of the wallet."
- },
- "loaded": {
- "type": "boolean",
- "description": "True if the wallet is currently loaded."
- }
- },
- "description": "Response message indicating wallet load status."
- },
"pactusListAddressesResponse": {
"type": "object",
"properties": {
@@ -2628,6 +2550,16 @@
},
"description": "Response message contains wallet names."
},
+ "pactusLoadWalletRequest": {
+ "type": "object",
+ "properties": {
+ "walletName": {
+ "type": "string",
+ "description": "The name of the wallet to load."
+ }
+ },
+ "description": "Request message for loading an existing wallet.\nDeprecated: It will be removed in a future version."
+ },
"pactusLoadWalletResponse": {
"type": "object",
"properties": {
@@ -2636,7 +2568,7 @@
"description": "The name of the loaded wallet."
}
},
- "description": "Response message confirming wallet loaded."
+ "description": "Response message confirming wallet loaded.\nDeprecated: It will be removed in a future version."
},
"pactusMetricInfo": {
"type": "object",
@@ -2951,6 +2883,24 @@
},
"description": "Recipient is receiver with amount."
},
+ "pactusRestoreWalletRequest": {
+ "type": "object",
+ "properties": {
+ "walletName": {
+ "type": "string",
+ "description": "The name for the restored wallet."
+ },
+ "mnemonic": {
+ "type": "string",
+ "description": "The mnemonic (seed phrase) for wallet recovery."
+ },
+ "password": {
+ "type": "string",
+ "description": "Password to secure the restored wallet."
+ }
+ },
+ "description": "Request message for restoring a wallet from mnemonic (seed phrase)."
+ },
"pactusRestoreWalletResponse": {
"type": "object",
"properties": {
@@ -2979,6 +2929,28 @@
},
"description": "Response message for updated address label."
},
+ "pactusSignMessageRequest": {
+ "type": "object",
+ "properties": {
+ "walletName": {
+ "type": "string",
+ "description": "The name of the wallet to sign with."
+ },
+ "password": {
+ "type": "string",
+ "description": "Wallet password required for signing."
+ },
+ "address": {
+ "type": "string",
+ "description": "The address whose private key should be used for signing the message."
+ },
+ "message": {
+ "type": "string",
+ "description": "The arbitrary message to be signed."
+ }
+ },
+ "description": "Request message to sign an arbitrary message."
+ },
"pactusSignMessageResponse": {
"type": "object",
"properties": {
@@ -3013,6 +2985,24 @@
},
"description": "Response message contains the signature generated from the message."
},
+ "pactusSignRawTransactionRequest": {
+ "type": "object",
+ "properties": {
+ "walletName": {
+ "type": "string",
+ "description": "The name of the wallet used for signing."
+ },
+ "rawTransaction": {
+ "type": "string",
+ "description": "The raw transaction data to be signed."
+ },
+ "password": {
+ "type": "string",
+ "description": "Wallet password required for signing."
+ }
+ },
+ "description": "Request message for signing a raw transaction."
+ },
"pactusSignRawTransactionResponse": {
"type": "object",
"properties": {
@@ -3157,6 +3147,16 @@
"default": "TX_DIRECTION_ANY",
"description": "TxDirection indicates the direction of a transaction relative to the wallet.\n\n - TX_DIRECTION_ANY: include both incoming and outgoing transactions.\n - TX_DIRECTION_INCOMING: Include only incoming transactions where the wallet receives funds.\n - TX_DIRECTION_OUTGOING: Include only outgoing transactions where the wallet sends funds."
},
+ "pactusUnloadWalletRequest": {
+ "type": "object",
+ "properties": {
+ "walletName": {
+ "type": "string",
+ "description": "The name of the wallet to unload."
+ }
+ },
+ "description": "Request message for unloading a wallet.\nDeprecated: It will be removed in a future version."
+ },
"pactusUnloadWalletResponse": {
"type": "object",
"properties": {
@@ -3165,7 +3165,25 @@
"description": "The name of the unloaded wallet."
}
},
- "description": "Response message confirming wallet unloading."
+ "description": "Response message confirming wallet unloading.\nDeprecated: It will be removed in a future version."
+ },
+ "pactusUpdatePasswordRequest": {
+ "type": "object",
+ "properties": {
+ "walletName": {
+ "type": "string",
+ "description": "The name of the wallet whose password will be updated."
+ },
+ "oldPassword": {
+ "type": "string",
+ "description": "The current wallet password."
+ },
+ "newPassword": {
+ "type": "string",
+ "description": "The new wallet password."
+ }
+ },
+ "description": "Request message for updating wallet password."
},
"pactusUpdatePasswordResponse": {
"type": "object",