@@ -91,6 +88,10 @@ are encoded using the [base64](https://en.wikipedia.org/wiki/Base64) decoder.
Network Service
@@ -171,17 +172,17 @@ parameters.
id |
string |
- Transaction ID.
+ The unique ID of the transaction to retrieve.
|
verbosity |
string |
- (Enum) Verbosity level for transaction details.
+ (Enum) The verbosity level for transaction details.
Available values:
- TRANSACTION_DATA = Request transaction data only.
- - TRANSACTION_INFO = Request transaction details.
+ - TRANSACTION_INFO = Request detailed transaction information.
|
@@ -198,70 +199,70 @@ parameters.
block_height |
numeric |
- Height of the block containing the transaction.
+ The height of the block containing the transaction.
|
block_time |
numeric |
- Time of the block containing the transaction.
+ The UNIX timestamp of the block containing the transaction.
|
transaction |
object |
- Information about the transaction.
+ Detailed information about the transaction.
|
transaction.id |
string |
- Transaction ID.
+ The unique ID of the transaction.
|
transaction.data |
string |
- Transaction data.
+ The raw transaction data.
|
transaction.version |
numeric |
- Transaction version.
+ The version of the transaction.
|
transaction.lock_time |
numeric |
- Lock time for the transaction.
+ The lock time for the transaction.
|
transaction.value |
numeric |
- Transaction value in NanoPAC.
+ The value of the transaction in NanoPAC.
|
transaction.fee |
numeric |
- Transaction fee in NanoPAC.
+ The fee for the transaction in NanoPAC.
|
transaction.payload_type |
string |
- (Enum) Type of transaction payload.
+ (Enum) The type of transaction payload.
Available values: |
transaction.transfer.sender |
string |
- Sender's address.
+ The sender's address.
|
transaction.transfer.receiver |
string |
- Receiver's address.
+ The receiver's address.
|
transaction.transfer.amount |
numeric |
- Transaction amount in NanoPAC.
+ The amount to be transferred in NanoPAC.
|
transaction.bond |
object |
- (OneOf) Bond payload.
+ (OneOf) Bond transaction payload.
|
transaction.bond.sender |
string |
- Sender's address.
+ The sender's address.
|
transaction.bond.receiver |
string |
- Receiver's address.
+ The receiver's address.
|
transaction.bond.stake |
numeric |
- Stake amount in NanoPAC.
+ The stake amount in NanoPAC.
|
transaction.sortition |
object |
- (OneOf) Sortition payload.
+ (OneOf) Sortition transaction payload.
|
transaction.sortition.address |
string |
- Address associated with the sortition.
+ The validator address associated with the sortition proof.
|
transaction.sortition.proof |
string |
- Proof for the sortition.
+ The proof for the sortition.
|
transaction.unbond |
object |
- (OneOf) Unbond payload.
+ (OneOf) Unbond transaction payload.
|
transaction.unbond.validator |
string |
- Address of the validator to unbond from.
+ The address of the validator to unbond from.
|
transaction.withdraw |
object |
- (OneOf) Withdraw payload.
+ (OneOf) Withdraw transaction payload.
|
transaction.withdraw.from |
string |
- Address to withdraw from.
+ The address to withdraw from.
|
transaction.withdraw.to |
string |
- Address to withdraw to.
+ The address to withdraw to.
|
transaction.withdraw.amount |
numeric |
- Withdrawal amount in NanoPAC.
+ The withdrawal amount in NanoPAC.
|
transaction.memo |
string |
- Transaction memo.
+ A memo string for the transaction.
|
transaction.public_key |
string |
- Public key associated with the transaction.
+ The public key associated with the transaction.
|
transaction.signature |
string |
- Transaction signature.
+ The signature for the transaction.
|
@@ -431,14 +432,14 @@ and payload type.
amount |
numeric |
- Transaction amount in NanoPAC.
+ The amount involved in the transaction, specified in NanoPAC.
|
payload_type |
string |
- (Enum) Type of transaction payload.
+ (Enum) The type of transaction payload.
Available values:
- UNKNOWN = Unknown payload type.
- TRANSFER_PAYLOAD = Transfer payload type.
@@ -453,7 +454,7 @@ and payload type.
fixed_amount |
boolean |
- Indicates that amount should be fixed and includes the fee.
+ Indicates if the amount should be fixed and include the fee.
|
|
@@ -469,14 +470,14 @@ and payload type.
amount |
numeric |
- Calculated amount in NanoPAC.
+ The calculated amount in NanoPAC.
|
fee |
numeric |
- Calculated transaction fee in NanoPAC.
+ The calculated transaction fee in NanoPAC.
|
@@ -497,7 +498,7 @@ and payload type.
signed_raw_transaction |
string |
- Signed raw transaction data.
+ The signed raw transaction data to be broadcasted.
|
@@ -513,7 +514,7 @@ and payload type.
id |
string |
- Transaction ID.
+ The unique ID of the broadcasted transaction.
|
@@ -534,45 +535,43 @@ and payload type.
lock_time |
numeric |
- Lock time for the transaction.
-If not explicitly set, it sets to the last block height.
+ The lock time for the transaction. If not set, defaults to the last block
+height.
|
sender |
string |
- Sender's account address.
+ The sender's account address.
|
receiver |
string |
- Receiver's account address.
+ The receiver's account address.
|
amount |
numeric |
- Transfer amount in NanoPAC.
-It should be greater than 0.
+ The amount to be transferred, specified in NanoPAC. Must be greater than 0.
|
fee |
numeric |
- Transaction fee in NanoPAC.
-If not explicitly set, it is calculated based on the amount.
+ The transaction fee in NanoPAC. If not set, it is set to the estimated fee.
|
memo |
string |
- Transaction memo.
+ A memo string for the transaction.
|
@@ -588,7 +587,7 @@ If not explicitly set, it is calculated based on the amount.
raw_transaction |
string |
- Raw transaction data.
+ The raw transaction data.
|
@@ -609,52 +608,50 @@ If not explicitly set, it is calculated based on the amount.
lock_time |
numeric |
- Lock time for the transaction.
-If not explicitly set, it sets to the last block height.
+ The lock time for the transaction. If not set, defaults to the last block
+height.
|
sender |
string |
- Sender's account address.
+ The sender's account address.
|
receiver |
string |
- Receiver's validator address.
+ The receiver's validator address.
|
stake |
numeric |
- Stake amount in NanoPAC.
-It should be greater than 0.
+ The stake amount in NanoPAC. Must be greater than 0.
|
public_key |
string |
- Public key of the validator.
+ The public key of the validator.
|
fee |
numeric |
- Transaction fee in NanoPAC.
-If not explicitly set, it is calculated based on the stake.
+ The transaction fee in NanoPAC. If not set, it is set to the estimated fee.
|
memo |
string |
- Transaction memo.
+ A memo string for the transaction.
|
@@ -670,7 +667,7 @@ If not explicitly set, it is calculated based on the stake.
raw_transaction |
string |
- Raw transaction data.
+ The raw transaction data.
|
@@ -691,22 +688,22 @@ If not explicitly set, it is calculated based on the stake.
lock_time |
numeric |
- Lock time for the transaction.
-If not explicitly set, it sets to the last block height.
+ The lock time for the transaction. If not set, defaults to the last block
+height.
|
validator_address |
string |
- Address of the validator to unbond from.
+ The address of the validator to unbond from.
|
memo |
string |
- Transaction memo.
+ A memo string for the transaction.
|
@@ -722,7 +719,7 @@ If not explicitly set, it sets to the last block height.
raw_transaction |
string |
- Raw transaction data.
+ The raw transaction data.
|
@@ -743,45 +740,43 @@ If not explicitly set, it sets to the last block height.
lock_time |
numeric |
- Lock time for the transaction.
-If not explicitly set, it sets to the last block height.
+ The lock time for the transaction. If not set, defaults to the last block
+height.
|
validator_address |
string |
- Address of the validator to withdraw from.
+ The address of the validator to withdraw from.
|
account_address |
string |
- Address of the account to withdraw to.
+ The address of the account to withdraw to.
|
amount |
numeric |
- Withdrawal amount in NanoPAC.
-It should be greater than 0.
+ The withdrawal amount in NanoPAC. Must be greater than 0.
|
fee |
numeric |
- Transaction fee in NanoPAC.
-If not explicitly set, it is calculated based on the amount.
+ The transaction fee in NanoPAC. If not set, it is set to the estimated fee.
|
memo |
string |
- Transaction memo.
+ A memo string for the transaction.
|
@@ -797,7 +792,7 @@ If not explicitly set, it is calculated based on the amount.
raw_transaction |
string |
- Raw transaction data.
+ The raw transaction data.
|
@@ -823,18 +818,18 @@ parameters.
height |
numeric |
- Height of the block.
+ The height of the block to retrieve.
|
verbosity |
string |
- (Enum) Verbosity level for block information.
+ (Enum) The verbosity level for block information.
Available values:
- - BLOCK_DATA = Request block data only.
+ - BLOCK_DATA = Request only block data.
- BLOCK_INFO = Request block information and transaction IDs.
- - BLOCK_TRANSACTIONS = Request block information and transaction details.
+ - BLOCK_TRANSACTIONS = Request block information and detailed transaction data.
|
@@ -851,70 +846,70 @@ parameters.
height |
numeric |
- Height of the block.
+ The height of the block.
|
hash |
string |
- Hash of the block.
+ The hash of the block.
|
data |
string |
- Block data, only available if the verbosity level is set to BLOCK_DATA.
+ Block data, available only if verbosity level is set to BLOCK_DATA.
|
block_time |
numeric |
- Block timestamp.
+ The timestamp of the block.
|
header |
object |
- Block header information.
+ Header information of the block.
|
header.version |
numeric |
- Block version.
+ The version of the block.
|
header.prev_block_hash |
string |
- Hash of the previous block.
+ The hash of the previous block.
|
header.state_root |
string |
- State root of the block.
+ The state root hash of the blockchain.
|
header.sortition_seed |
string |
- Sortition seed of the block.
+ The sortition seed of the block.
|
header.proposer_address |
string |
- Address of the proposer of the block.
+ The address of the proposer of the block.
|
@@ -928,14 +923,14 @@ parameters.
prev_cert.hash |
string |
- Hash of the certificate.
+ The hash of the certificate.
|
prev_cert.round |
numeric |
- Round of the certificate.
+ The round of the certificate.
|
@@ -956,64 +951,64 @@ parameters.
prev_cert.signature |
string |
- Certificate signature.
+ The signature of the certificate.
|
txs |
repeated object |
- List of transactions in the block.
-Transaction information is available when the verbosity level is set to BLOCK_TRANSACTIONS.
+ List of transactions in the block, available when verbosity level is set to
+BLOCK_TRANSACTIONS.
|
txs[].id |
string |
- Transaction ID.
+ The unique ID of the transaction.
|
txs[].data |
string |
- Transaction data.
+ The raw transaction data.
|
txs[].version |
numeric |
- Transaction version.
+ The version of the transaction.
|
txs[].lock_time |
numeric |
- Lock time for the transaction.
+ The lock time for the transaction.
|
txs[].value |
numeric |
- Transaction value in NanoPAC.
+ The value of the transaction in NanoPAC.
|
txs[].fee |
numeric |
- Transaction fee in NanoPAC.
+ The fee for the transaction in NanoPAC.
|
txs[].payload_type |
string |
- (Enum) Type of transaction payload.
+ (Enum) The type of transaction payload.
Available values: |
txs[].transfer.sender |
string |
- Sender's address.
+ The sender's address.
|
txs[].transfer.receiver |
string |
- Receiver's address.
+ The receiver's address.
|
txs[].transfer.amount |
numeric |
- Transaction amount in NanoPAC.
+ The amount to be transferred in NanoPAC.
|
txs[].bond |
object |
- (OneOf) Bond payload.
+ (OneOf) Bond transaction payload.
|
txs[].bond.sender |
string |
- Sender's address.
+ The sender's address.
|
txs[].bond.receiver |
string |
- Receiver's address.
+ The receiver's address.
|
txs[].bond.stake |
numeric |
- Stake amount in NanoPAC.
+ The stake amount in NanoPAC.
|
txs[].sortition |
object |
- (OneOf) Sortition payload.
+ (OneOf) Sortition transaction payload.
|
txs[].sortition.address |
string |
- Address associated with the sortition.
+ The validator address associated with the sortition proof.
|
txs[].sortition.proof |
string |
- Proof for the sortition.
+ The proof for the sortition.
|
txs[].unbond |
object |
- (OneOf) Unbond payload.
+ (OneOf) Unbond transaction payload.
|
txs[].unbond.validator |
string |
- Address of the validator to unbond from.
+ The address of the validator to unbond from.
|
txs[].withdraw |
object |
- (OneOf) Withdraw payload.
+ (OneOf) Withdraw transaction payload.
|
txs[].withdraw.from |
string |
- Address to withdraw from.
+ The address to withdraw from.
|
txs[].withdraw.to |
string |
- Address to withdraw to.
+ The address to withdraw to.
|
txs[].withdraw.amount |
numeric |
- Withdrawal amount in NanoPAC.
+ The withdrawal amount in NanoPAC.
|
txs[].memo |
string |
- Transaction memo.
+ A memo string for the transaction.
|
txs[].public_key |
string |
- Public key associated with the transaction.
+ The public key associated with the transaction.
|
txs[].signature |
string |
- Transaction signature.
+ The signature for the transaction.
|
@@ -1182,7 +1177,7 @@ Transaction information is available when the verbosity level is set to BLOCK_TR
height |
numeric |
- Height of the block.
+ The height of the block to retrieve the hash for.
|
@@ -1198,7 +1193,7 @@ Transaction information is available when the verbosity level is set to BLOCK_TR
hash |
string |
- Hash of the block.
+ The hash of the block.
|
@@ -1219,7 +1214,7 @@ Transaction information is available when the verbosity level is set to BLOCK_TR
hash |
string |
- Hash of the block.
+ The hash of the block to retrieve the height for.
|
@@ -1235,7 +1230,7 @@ Transaction information is available when the verbosity level is set to BLOCK_TR
height |
numeric |
- Height of the block.
+ The height of the block.
|
@@ -1259,42 +1254,42 @@ Parameters has no fields.
last_block_height |
numeric |
- Height of the last block.
+ The height of the last block in the blockchain.
|
last_block_hash |
string |
- Hash of the last block.
+ The hash of the last block in the blockchain.
|
total_accounts |
numeric |
- Total number of accounts.
+ The total number of accounts in the blockchain.
|
total_validators |
numeric |
- Total number of validators.
+ The total number of validators in the blockchain.
|
total_power |
numeric |
- Total power in the blockchain.
+ The total power of the blockchain.
|
committee_power |
numeric |
- Power of the committee.
+ The power of the committee.
|
@@ -1308,70 +1303,70 @@ Parameters has no fields.
committee_validators[].hash |
string |
- Hash of the validator.
+ The hash of the validator.
|
committee_validators[].data |
string |
- Validator data.
+ The serialized data of the validator.
|
committee_validators[].public_key |
string |
- Public key of the validator.
+ The public key of the validator.
|
committee_validators[].number |
numeric |
- Validator number.
+ The unique number assigned to the validator.
|
committee_validators[].stake |
numeric |
- Validator stake in NanoPAC.
+ The stake of the validator in NanoPAC.
|
committee_validators[].last_bonding_height |
numeric |
- Last bonding height.
+ The height at which the validator last bonded.
|
committee_validators[].last_sortition_height |
numeric |
- Last sortition height.
+ The height at which the validator last participated in sortition.
|
committee_validators[].unbonding_height |
numeric |
- Unbonding height.
+ The height at which the validator will unbond.
|
committee_validators[].address |
string |
- Address of the validator.
+ The address of the validator.
|
committee_validators[].availability_score |
numeric |
- Availability score of the validator.
+ The availability score of the validator.
|
@@ -1402,28 +1397,29 @@ Parameters has no fields.
instances[].address |
string |
- Address of the consensus instance.
+ The address of the consensus instance.
|
- instances[].Active |
+ instances[].active |
boolean |
- Whether the consensus instance is active.
+ Indicates whether the consensus instance is active and part of the
+committee.
|
instances[].height |
numeric |
- Height of the consensus instance.
+ The height of the consensus instance.
|
instances[].round |
numeric |
- Round of the consensus instance.
+ The round of the consensus instance.
|
@@ -1437,7 +1433,7 @@ Parameters has no fields.
instances[].votes[].type |
string |
- (Enum) Type of the vote.
+ (Enum) The type of the vote.
Available values:
- VOTE_UNKNOWN = Unknown vote type.
- VOTE_PREPARE = Prepare vote type.
@@ -1450,35 +1446,35 @@ Parameters has no fields.
instances[].votes[].voter |
string |
- Voter's address.
+ The address of the voter.
|
|
instances[].votes[].block_hash |
string |
- Hash of the block being voted on.
+ The hash of the block being voted on.
|
instances[].votes[].round |
numeric |
- Round of the vote.
+ The consensus round of the vote.
|
instances[].votes[].cp_round |
numeric |
- Consensus round of the vote.
+ The change-proposer round of the vote.
|
instances[].votes[].cp_value |
numeric |
- Consensus value of the vote.
+ The change-proposer value of the vote.
|
@@ -1500,7 +1496,7 @@ address.
address |
string |
- Address of the account.
+ The address of the account to retrieve information for.
|
@@ -1516,42 +1512,42 @@ address.
account |
object |
- Account information.
+ Detailed information about the account.
|
account.hash |
string |
- Hash of the account.
+ The hash of the account.
|
account.data |
string |
- Account data.
+ The serialized data of the account.
|
account.number |
numeric |
- Account number.
+ The unique number assigned to the account.
|
account.balance |
numeric |
- Account balance in NanoPAC.
+ The balance of the account in NanoPAC.
|
account.address |
string |
- Address of the account.
+ The address of the account.
|
@@ -1573,7 +1569,7 @@ address.
address |
string |
- Address of the validator.
+ The address of the validator to retrieve information for.
|
@@ -1589,77 +1585,77 @@ address.
validator |
object |
- Validator information.
+ Detailed information about the validator.
|
validator.hash |
string |
- Hash of the validator.
+ The hash of the validator.
|
validator.data |
string |
- Validator data.
+ The serialized data of the validator.
|
validator.public_key |
string |
- Public key of the validator.
+ The public key of the validator.
|
validator.number |
numeric |
- Validator number.
+ The unique number assigned to the validator.
|
validator.stake |
numeric |
- Validator stake in NanoPAC.
+ The stake of the validator in NanoPAC.
|
validator.last_bonding_height |
numeric |
- Last bonding height.
+ The height at which the validator last bonded.
|
validator.last_sortition_height |
numeric |
- Last sortition height.
+ The height at which the validator last participated in sortition.
|
validator.unbonding_height |
numeric |
- Unbonding height.
+ The height at which the validator will unbond.
|
validator.address |
string |
- Address of the validator.
+ The address of the validator.
|
validator.availability_score |
numeric |
- Availability score of the validator.
+ The availability score of the validator.
|
@@ -1681,7 +1677,7 @@ provided number.
number |
numeric |
- Validator number.
+ The unique number of the validator to retrieve information for.
|
@@ -1697,77 +1693,77 @@ provided number.
validator |
object |
- Validator information.
+ Detailed information about the validator.
|
validator.hash |
string |
- Hash of the validator.
+ The hash of the validator.
|
validator.data |
string |
- Validator data.
+ The serialized data of the validator.
|
validator.public_key |
string |
- Public key of the validator.
+ The public key of the validator.
|
validator.number |
numeric |
- Validator number.
+ The unique number assigned to the validator.
|
validator.stake |
numeric |
- Validator stake in NanoPAC.
+ The stake of the validator in NanoPAC.
|
validator.last_bonding_height |
numeric |
- Last bonding height.
+ The height at which the validator last bonded.
|
validator.last_sortition_height |
numeric |
- Last sortition height.
+ The height at which the validator last participated in sortition.
|
validator.unbonding_height |
numeric |
- Unbonding height.
+ The height at which the validator will unbond.
|
validator.address |
string |
- Address of the validator.
+ The address of the validator.
|
validator.availability_score |
numeric |
- Availability score of the validator.
+ The availability score of the validator.
|
@@ -1813,7 +1809,7 @@ address.
address |
string |
- Address for which public key is requested.
+ The address for which to retrieve the public key.
|
@@ -1829,12 +1825,255 @@ address.
public_key |
string |
- Public key of the account.
+ The public key associated with the provided address.
|
+### pactus.blockchain.get_tx_pool_content
+
+GetTxPoolContent retrieves current transactions in the transaction pool.
+
+Parameters
+
+
+
+ Field | Type | Description |
+
+
+
+ payload_type |
+ string |
+
+ (Enum) The type of transactions to retrieve from the transaction pool. 0 means all
+types.
+ Available values:
+ - UNKNOWN = Unknown payload type.
+ - TRANSFER_PAYLOAD = Transfer payload type.
+ - BOND_PAYLOAD = Bond payload type.
+ - SORTITION_PAYLOAD = Sortition payload type.
+ - UNBOND_PAYLOAD = Unbond payload type.
+ - WITHDRAW_PAYLOAD = Withdraw payload type.
+
+ |
+
+
+
+ Result
+
+
+
+ Field | Type | Description |
+
+
+
+ txs |
+ repeated object |
+
+ List of transactions currently in the pool.
+ |
+
+
+ txs[].id |
+ string |
+
+ The unique ID of the transaction.
+ |
+
+
+ txs[].data |
+ string |
+
+ The raw transaction data.
+ |
+
+
+ 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 |
+ string |
+
+ (Enum) The type of transaction payload.
+ Available values:
+ - UNKNOWN = Unknown payload type.
+ - TRANSFER_PAYLOAD = Transfer payload type.
+ - BOND_PAYLOAD = Bond payload type.
+ - SORTITION_PAYLOAD = Sortition payload type.
+ - UNBOND_PAYLOAD = Unbond payload type.
+ - WITHDRAW_PAYLOAD = Withdraw payload type.
+
+ |
+
+
+ txs[].transfer |
+ object |
+
+ (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 |
+
+ (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[].sortition |
+ object |
+
+ (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 |
+
+ (OneOf) Unbond transaction payload.
+ |
+
+
+ txs[].unbond.validator |
+ string |
+
+ The address of the validator to unbond from.
+ |
+
+
+ txs[].withdraw |
+ object |
+
+ (OneOf) Withdraw transaction payload.
+ |
+
+
+ txs[].withdraw.from |
+ string |
+
+ The address to withdraw from.
+ |
+
+
+ txs[].withdraw.to |
+ string |
+
+ The address to withdraw to.
+ |
+
+
+ txs[].withdraw.amount |
+ numeric |
+
+ The withdrawal amount in NanoPAC.
+ |
+
+
+ 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.
+ |
+
+
+
+
## Network Service
Network service provides RPCs for retrieving information about the network.
@@ -1854,7 +2093,7 @@ address.
only_connected |
boolean |
- Only returns the peers with connected status
+ If true, only returns peers with connected status.
|
@@ -1937,10 +2176,10 @@ address.
- connected_peers[].consensus_address |
+ connected_peers[].consensus_addresses |
repeated string |
- Consensus address of the peer.
+ Consensus addresses of the peer.
|
@@ -1961,21 +2200,21 @@ address.
connected_peers[].height |
numeric |
- Height of the peer in the blockchain.
+ Blockchain height of the peer.
|
connected_peers[].received_bundles |
numeric |
- Count of received bundles.
+ Number of received bundles.
|
connected_peers[].invalid_bundles |
numeric |
- Count of invalid bundles received.
+ Number of invalid bundles received.
|
@@ -2031,14 +2270,14 @@ address.
connected_peers[].total_sessions |
numeric |
- Total sessions with the peer.
+ Total download sessions with the peer.
|
connected_peers[].completed_sessions |
numeric |
- Completed sessions with the peer.
+ Completed download sessions with the peer.
|
@@ -2139,21 +2378,21 @@ Parameters has no fields.
clock_offset |
numeric |
- Clock offset
+ Clock offset of the node.
|
connection_info |
object |
- Connection information
+ Information about the node's connections.
|
connection_info.connections |
numeric |
- Total number of the connection.
+ Total number of connections.
|
@@ -2192,14 +2431,14 @@ Parameters has no fields.
wallet_name |
string |
- Name of the new wallet.
+ The name of the new wallet.
|
password |
string |
- Password for securing the wallet.
+ The password for securing the wallet.
|
@@ -2215,7 +2454,7 @@ Parameters has no fields.
mnemonic |
string |
- Menomic for wallet recovery.
+ The mnemonic for wallet recovery.
|
@@ -2236,21 +2475,21 @@ Parameters has no fields.
wallet_name |
string |
- Name of the wallet to restore.
+ The name of the wallet to restore.
|
mnemonic |
string |
- Menomic for wallet recovery.
+ The mnemonic for wallet recovery.
|
password |
string |
- Password for securing the wallet.
+ The password for securing the wallet.
|
@@ -2266,7 +2505,7 @@ Parameters has no fields.
wallet_name |
string |
- Name of the restored wallet.
+ The name of the restored wallet.
|
@@ -2287,7 +2526,7 @@ Parameters has no fields.
wallet_name |
string |
- Name of the wallet to load.
+ The name of the wallet to load.
|
@@ -2303,7 +2542,7 @@ Parameters has no fields.
wallet_name |
string |
- Name of the loaded wallet.
+ The name of the loaded wallet.
|
@@ -2324,7 +2563,7 @@ Parameters has no fields.
wallet_name |
string |
- Name of the wallet to unload.
+ The name of the wallet to unload.
|
@@ -2340,7 +2579,7 @@ Parameters has no fields.
wallet_name |
string |
- Name of the unloaded wallet.
+ The name of the unloaded wallet.
|
@@ -2361,7 +2600,7 @@ Parameters has no fields.
wallet_name |
string |
- Name of the wallet.
+ The name of the wallet to get the total balance.
|
@@ -2377,7 +2616,7 @@ Parameters has no fields.
wallet_name |
string |
- Name of the wallet.
+ The name of the wallet.
|
@@ -2405,21 +2644,21 @@ Parameters has no fields.
wallet_name |
string |
- Name of the wallet used for signing.
+ The name of the wallet used for signing.
|
raw_transaction |
string |
- Raw transaction data to be signed.
+ The raw transaction data to be signed.
|
password |
string |
- Password for unlocking the wallet for signing.
+ The password for unlocking the wallet for signing.
|
@@ -2435,14 +2674,14 @@ Parameters has no fields.
transaction_id |
string |
- ID of the signed transaction.
+ The ID of the signed transaction.
|
signed_raw_transaction |
string |
- Signed raw transaction data.
+ The signed raw transaction data.
|
@@ -2464,7 +2703,7 @@ public key.
public_key |
string |
- Public key for which the validator address is requested.
+ The public key for which the validator address is requested.
|
@@ -2480,7 +2719,7 @@ public key.
address |
string |
- Validator address associated with the public key.
+ The validator address associated with the public key.
|
@@ -2501,14 +2740,14 @@ public key.
wallet_name |
string |
- The name of the wallet for which the new address is requested.
+ The name of the wallet to generate a new address.
|
address_type |
string |
- (Enum) The type of the new address.
+ (Enum) The type of address to generate.
Available values: |
@@ -2536,35 +2775,35 @@ public key.
wallet_name |
string |
- The name of the wallet from which the address is created.
+ The name of the wallet from which the address is generated.
|
address_info |
object |
- Information about the new address.
+ Information about the newly generated address.
|
address_info.address |
string |
- The string representing the address.
+ The address string.
|
address_info.public_key |
string |
- The public key that the address is derived from.
+ The public key associated with the address.
|
address_info.label |
string |
- The label that is associated with the address.
+ A label associated with the address.
|
@@ -2579,7 +2818,7 @@ public key.
### pactus.wallet.get_address_history
-GetAddressHistory retrieve transaction history of an address.
+GetAddressHistory retrieves the transaction history of an address.
Parameters
@@ -2592,14 +2831,14 @@ public key.
wallet_name |
string |
- Name of the wallet.
+ The name of the wallet.
|
address |
string |
- Address to get the transaction history of it.
+ The address to retrieve the transaction history for.
|
@@ -2615,42 +2854,42 @@ public key.
history_info |
repeated object |
- Array of address history and activities.
+ Array of history information for the address.
|
history_info[].transaction_id |
string |
- Hash of transaction.
+ The transaction ID hash.
|
history_info[].time |
numeric |
- Transaction timestamp.
+ The timestamp of the transaction.
|
history_info[].payload_type |
string |
- Type of transaction payload.
+ The payload type of the transaction.
|
history_info[].description |
string |
- Description of transaction.
+ A description of the transaction.
|
history_info[].amount |
numeric |
- Amount of transaction.
+ The amount involved in the transaction.
|
diff --git a/static/swagger-ui/pactus.swagger.json b/static/swagger-ui/pactus.swagger.json
index 9302a46..623c87b 100644
--- a/static/swagger-ui/pactus.swagger.json
+++ b/static/swagger-ui/pactus.swagger.json
@@ -3,11 +3,10 @@
"info": {
"title": "Pactus APIs",
"description": "Each node in the Pactus network can be configured to use the [gRPC](https://grpc.io/) protocol for communication.\nHere you can find the list of all gRPC methods and messages.\n\nAll the amounts and values in gRPC endpoints are in NanoPAC units, which are atomic and the smallest unit in the Pactus blockchain.\nEach PAC is equivalent to 1,000,000,000 or 10\u003csup\u003e9\u003c/sup\u003e NanoPACs.\n",
- "version": "1.1",
+ "version": "1.2",
"contact": {
"name": "Pactus Blockchain",
- "url": "https://pactus.org",
- "email": "info@pactus.org"
+ "url": "https://pactus.org"
},
"license": {
"name": "MIT License",
@@ -61,7 +60,7 @@
"parameters": [
{
"name": "address",
- "description": "Address of the account.",
+ "description": "The address of the account to retrieve information for.",
"in": "query",
"required": false,
"type": "string"
@@ -93,7 +92,7 @@
"parameters": [
{
"name": "height",
- "description": "Height of the block.",
+ "description": "The height of the block to retrieve.",
"in": "query",
"required": false,
"type": "integer",
@@ -101,7 +100,7 @@
},
{
"name": "verbosity",
- "description": "Verbosity level for block information.\n\n - BLOCK_DATA: Request block data only.\n - BLOCK_INFO: Request block information and transaction IDs.\n - BLOCK_TRANSACTIONS: Request block information and transaction details.",
+ "description": "The verbosity level for block information.\n\n - BLOCK_DATA: Request only block data.\n - BLOCK_INFO: Request block information and transaction IDs.\n - BLOCK_TRANSACTIONS: Request block information and detailed transaction data.",
"in": "query",
"required": false,
"type": "string",
@@ -139,7 +138,7 @@
"parameters": [
{
"name": "height",
- "description": "Height of the block.",
+ "description": "The height of the block to retrieve the hash for.",
"in": "query",
"required": false,
"type": "integer",
@@ -172,11 +171,10 @@
"parameters": [
{
"name": "hash",
- "description": "Hash of the block.",
+ "description": "The hash of the block to retrieve the height for.",
"in": "query",
"required": false,
- "type": "string",
- "format": "byte"
+ "type": "string"
}
],
"tags": [
@@ -251,7 +249,7 @@
"parameters": [
{
"name": "address",
- "description": "Address for which public key is requested.",
+ "description": "The address for which to retrieve the public key.",
"in": "query",
"required": false,
"type": "string"
@@ -262,6 +260,47 @@
]
}
},
+ "/pactus/blockchain/get_txpool_content": {
+ "get": {
+ "summary": "GetTxPoolContent retrieves current transactions in the transaction pool.",
+ "operationId": "Blockchain_GetTxPoolContent",
+ "responses": {
+ "200": {
+ "description": "A successful response.",
+ "schema": {
+ "$ref": "#/definitions/pactusGetTxPoolContentResponse"
+ }
+ },
+ "default": {
+ "description": "An unexpected error response.",
+ "schema": {
+ "$ref": "#/definitions/rpcStatus"
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "payloadType",
+ "description": "The type of transactions to retrieve from the transaction pool. 0 means all\ntypes.\n\n - UNKNOWN: Unknown payload type.\n - TRANSFER_PAYLOAD: Transfer payload type.\n - BOND_PAYLOAD: Bond payload type.\n - SORTITION_PAYLOAD: Sortition payload type.\n - UNBOND_PAYLOAD: Unbond payload type.\n - WITHDRAW_PAYLOAD: Withdraw payload type.",
+ "in": "query",
+ "required": false,
+ "type": "string",
+ "enum": [
+ "UNKNOWN",
+ "TRANSFER_PAYLOAD",
+ "BOND_PAYLOAD",
+ "SORTITION_PAYLOAD",
+ "UNBOND_PAYLOAD",
+ "WITHDRAW_PAYLOAD"
+ ],
+ "default": "UNKNOWN"
+ }
+ ],
+ "tags": [
+ "Blockchain"
+ ]
+ }
+ },
"/pactus/blockchain/get_validator": {
"get": {
"summary": "GetValidator retrieves information about a validator based on the provided\naddress.",
@@ -283,7 +322,7 @@
"parameters": [
{
"name": "address",
- "description": "Address of the validator.",
+ "description": "The address of the validator to retrieve information for.",
"in": "query",
"required": false,
"type": "string"
@@ -315,7 +354,7 @@
"parameters": [
{
"name": "number",
- "description": "Validator number.",
+ "description": "The unique number of the validator to retrieve information for.",
"in": "query",
"required": false,
"type": "integer",
@@ -348,7 +387,7 @@
"parameters": [
{
"name": "onlyConnected",
- "description": "Only returns the peers with connected status",
+ "description": "If true, only returns peers with connected status.",
"in": "query",
"required": false,
"type": "boolean"
@@ -403,11 +442,10 @@
"parameters": [
{
"name": "signedRawTransaction",
- "description": "Signed raw transaction data.",
+ "description": "The signed raw transaction data to be broadcasted.",
"in": "query",
"required": false,
- "type": "string",
- "format": "byte"
+ "type": "string"
}
],
"tags": [
@@ -436,7 +474,7 @@
"parameters": [
{
"name": "amount",
- "description": "Transaction amount in NanoPAC.",
+ "description": "The amount involved in the transaction, specified in NanoPAC.",
"in": "query",
"required": false,
"type": "string",
@@ -444,7 +482,7 @@
},
{
"name": "payloadType",
- "description": "Type of transaction payload.\n\n - UNKNOWN: Unknown payload type.\n - TRANSFER_PAYLOAD: Transfer payload type.\n - BOND_PAYLOAD: Bond payload type.\n - SORTITION_PAYLOAD: Sortition payload type.\n - UNBOND_PAYLOAD: Unbond payload type.\n - WITHDRAW_PAYLOAD: Withdraw payload type.",
+ "description": "The type of transaction payload.\n\n - UNKNOWN: Unknown payload type.\n - TRANSFER_PAYLOAD: Transfer payload type.\n - BOND_PAYLOAD: Bond payload type.\n - SORTITION_PAYLOAD: Sortition payload type.\n - UNBOND_PAYLOAD: Unbond payload type.\n - WITHDRAW_PAYLOAD: Withdraw payload type.",
"in": "query",
"required": false,
"type": "string",
@@ -460,7 +498,7 @@
},
{
"name": "fixedAmount",
- "description": "Indicates that amount should be fixed and includes the fee.",
+ "description": "Indicates if the amount should be fixed and include the fee.",
"in": "query",
"required": false,
"type": "boolean"
@@ -492,7 +530,7 @@
"parameters": [
{
"name": "lockTime",
- "description": "Lock time for the transaction.\nIf not explicitly set, it sets to the last block height.",
+ "description": "The lock time for the transaction. If not set, defaults to the last block\nheight.",
"in": "query",
"required": false,
"type": "integer",
@@ -500,21 +538,21 @@
},
{
"name": "sender",
- "description": "Sender's account address.",
+ "description": "The sender's account address.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "receiver",
- "description": "Receiver's validator address.",
+ "description": "The receiver's validator address.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "stake",
- "description": "Stake amount in NanoPAC.\nIt should be greater than 0.",
+ "description": "The stake amount in NanoPAC. Must be greater than 0.",
"in": "query",
"required": false,
"type": "string",
@@ -522,14 +560,14 @@
},
{
"name": "publicKey",
- "description": "Public key of the validator.",
+ "description": "The public key of the validator.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "fee",
- "description": "Transaction fee in NanoPAC.\nIf not explicitly set, it is calculated based on the stake.",
+ "description": "The transaction fee in NanoPAC. If not set, it is set to the estimated fee.",
"in": "query",
"required": false,
"type": "string",
@@ -537,7 +575,7 @@
},
{
"name": "memo",
- "description": "Transaction memo.",
+ "description": "A memo string for the transaction.",
"in": "query",
"required": false,
"type": "string"
@@ -569,7 +607,7 @@
"parameters": [
{
"name": "lockTime",
- "description": "Lock time for the transaction.\nIf not explicitly set, it sets to the last block height.",
+ "description": "The lock time for the transaction. If not set, defaults to the last block\nheight.",
"in": "query",
"required": false,
"type": "integer",
@@ -577,21 +615,21 @@
},
{
"name": "sender",
- "description": "Sender's account address.",
+ "description": "The sender's account address.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "receiver",
- "description": "Receiver's account address.",
+ "description": "The receiver's account address.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "amount",
- "description": "Transfer amount in NanoPAC.\nIt should be greater than 0.",
+ "description": "The amount to be transferred, specified in NanoPAC. Must be greater than 0.",
"in": "query",
"required": false,
"type": "string",
@@ -599,7 +637,7 @@
},
{
"name": "fee",
- "description": "Transaction fee in NanoPAC.\nIf not explicitly set, it is calculated based on the amount.",
+ "description": "The transaction fee in NanoPAC. If not set, it is set to the estimated fee.",
"in": "query",
"required": false,
"type": "string",
@@ -607,7 +645,7 @@
},
{
"name": "memo",
- "description": "Transaction memo.",
+ "description": "A memo string for the transaction.",
"in": "query",
"required": false,
"type": "string"
@@ -639,7 +677,7 @@
"parameters": [
{
"name": "lockTime",
- "description": "Lock time for the transaction.\nIf not explicitly set, it sets to the last block height.",
+ "description": "The lock time for the transaction. If not set, defaults to the last block\nheight.",
"in": "query",
"required": false,
"type": "integer",
@@ -647,14 +685,14 @@
},
{
"name": "validatorAddress",
- "description": "Address of the validator to unbond from.",
+ "description": "The address of the validator to unbond from.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "memo",
- "description": "Transaction memo.",
+ "description": "A memo string for the transaction.",
"in": "query",
"required": false,
"type": "string"
@@ -686,7 +724,7 @@
"parameters": [
{
"name": "lockTime",
- "description": "Lock time for the transaction.\nIf not explicitly set, it sets to the last block height.",
+ "description": "The lock time for the transaction. If not set, defaults to the last block\nheight.",
"in": "query",
"required": false,
"type": "integer",
@@ -694,21 +732,21 @@
},
{
"name": "validatorAddress",
- "description": "Address of the validator to withdraw from.",
+ "description": "The address of the validator to withdraw from.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "accountAddress",
- "description": "Address of the account to withdraw to.",
+ "description": "The address of the account to withdraw to.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "amount",
- "description": "Withdrawal amount in NanoPAC.\nIt should be greater than 0.",
+ "description": "The withdrawal amount in NanoPAC. Must be greater than 0.",
"in": "query",
"required": false,
"type": "string",
@@ -716,7 +754,7 @@
},
{
"name": "fee",
- "description": "Transaction fee in NanoPAC.\nIf not explicitly set, it is calculated based on the amount.",
+ "description": "The transaction fee in NanoPAC. If not set, it is set to the estimated fee.",
"in": "query",
"required": false,
"type": "string",
@@ -724,7 +762,7 @@
},
{
"name": "memo",
- "description": "Transaction memo.",
+ "description": "A memo string for the transaction.",
"in": "query",
"required": false,
"type": "string"
@@ -756,15 +794,14 @@
"parameters": [
{
"name": "id",
- "description": "Transaction ID.",
+ "description": "The unique ID of the transaction to retrieve.",
"in": "query",
"required": false,
- "type": "string",
- "format": "byte"
+ "type": "string"
},
{
"name": "verbosity",
- "description": "Verbosity level for transaction details.\n\n - TRANSACTION_DATA: Request transaction data only.\n - TRANSACTION_INFO: Request transaction details.",
+ "description": "The verbosity level for transaction details.\n\n - TRANSACTION_DATA: Request transaction data only.\n - TRANSACTION_INFO: Request detailed transaction information.",
"in": "query",
"required": false,
"type": "string",
@@ -801,14 +838,14 @@
"parameters": [
{
"name": "walletName",
- "description": "Name of the new wallet.",
+ "description": "The name of the new wallet.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "password",
- "description": "Password for securing the wallet.",
+ "description": "The password for securing the wallet.",
"in": "query",
"required": false,
"type": "string"
@@ -840,14 +877,14 @@
"parameters": [
{
"name": "walletName",
- "description": "The name of the wallet for which the new address is requested.",
+ "description": "The name of the wallet to generate a new address.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "addressType",
- "description": "The type of the new address.",
+ "description": "The type of address to generate.",
"in": "query",
"required": false,
"type": "string",
@@ -860,7 +897,7 @@
},
{
"name": "label",
- "description": "The label for the new address.",
+ "description": "A label for the new address.",
"in": "query",
"required": false,
"type": "string"
@@ -892,7 +929,7 @@
"parameters": [
{
"name": "walletName",
- "description": "Name of the wallet.",
+ "description": "The name of the wallet to get the total balance.",
"in": "query",
"required": false,
"type": "string"
@@ -924,7 +961,7 @@
"parameters": [
{
"name": "publicKey",
- "description": "Public key for which the validator address is requested.",
+ "description": "The public key for which the validator address is requested.",
"in": "query",
"required": false,
"type": "string"
@@ -956,7 +993,7 @@
"parameters": [
{
"name": "walletName",
- "description": "Name of the wallet to load.",
+ "description": "The name of the wallet to load.",
"in": "query",
"required": false,
"type": "string"
@@ -988,21 +1025,21 @@
"parameters": [
{
"name": "walletName",
- "description": "Name of the wallet to restore.",
+ "description": "The name of the wallet to restore.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "mnemonic",
- "description": "Menomic for wallet recovery.",
+ "description": "The mnemonic for wallet recovery.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "password",
- "description": "Password for securing the wallet.",
+ "description": "The password for securing the wallet.",
"in": "query",
"required": false,
"type": "string"
@@ -1034,22 +1071,21 @@
"parameters": [
{
"name": "walletName",
- "description": "Name of the wallet used for signing.",
+ "description": "The name of the wallet used for signing.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "rawTransaction",
- "description": "Raw transaction data to be signed.",
+ "description": "The raw transaction data to be signed.",
"in": "query",
"required": false,
- "type": "string",
- "format": "byte"
+ "type": "string"
},
{
"name": "password",
- "description": "Password for unlocking the wallet for signing.",
+ "description": "The password for unlocking the wallet for signing.",
"in": "query",
"required": false,
"type": "string"
@@ -1081,7 +1117,7 @@
"parameters": [
{
"name": "walletName",
- "description": "Name of the wallet to unload.",
+ "description": "The name of the wallet to unload.",
"in": "query",
"required": false,
"type": "string"
@@ -1099,27 +1135,25 @@
"properties": {
"hash": {
"type": "string",
- "format": "byte",
- "description": "Hash of the account."
+ "description": "The hash of the account."
},
"data": {
"type": "string",
- "format": "byte",
- "description": "Account data."
+ "description": "The serialized data of the account."
},
"number": {
"type": "integer",
"format": "int32",
- "description": "Account number."
+ "description": "The unique number assigned to the account."
},
"balance": {
"type": "string",
"format": "int64",
- "description": "Account balance in NanoPAC."
+ "description": "The balance of the account in NanoPAC."
},
"address": {
"type": "string",
- "description": "Address of the account."
+ "description": "The address of the account."
}
},
"description": "Message containing information about an account."
@@ -1129,22 +1163,22 @@
"properties": {
"address": {
"type": "string",
- "description": "The string representing the address."
+ "description": "The address string."
},
"publicKey": {
"type": "string",
- "description": "The public key that the address is derived from."
+ "description": "The public key associated with the address."
},
"label": {
"type": "string",
- "description": "The label that is associated with the address."
+ "description": "A label associated with the address."
},
"path": {
"type": "string",
"description": "The Hierarchical Deterministic path of the address within the wallet."
}
},
- "description": "Message of address information."
+ "description": "Message containing address information."
},
"pactusAddressType": {
"type": "string",
@@ -1162,26 +1196,23 @@
"version": {
"type": "integer",
"format": "int32",
- "description": "Block version."
+ "description": "The version of the block."
},
"prevBlockHash": {
"type": "string",
- "format": "byte",
- "description": "Hash of the previous block."
+ "description": "The hash of the previous block."
},
"stateRoot": {
"type": "string",
- "format": "byte",
- "description": "State root of the block."
+ "description": "The state root hash of the blockchain."
},
"sortitionSeed": {
"type": "string",
- "format": "byte",
- "description": "Sortition seed of the block."
+ "description": "The sortition seed of the block."
},
"proposerAddress": {
"type": "string",
- "description": "Address of the proposer of the block."
+ "description": "The address of the proposer of the block."
}
},
"description": "Message containing information about the header of a block."
@@ -1194,15 +1225,14 @@
"BLOCK_TRANSACTIONS"
],
"default": "BLOCK_DATA",
- "description": "Enumeration for verbosity level when requesting block information.\n\n - BLOCK_DATA: Request block data only.\n - BLOCK_INFO: Request block information and transaction IDs.\n - BLOCK_TRANSACTIONS: Request block information and transaction details."
+ "description": "Enumeration for verbosity levels when requesting block information.\n\n - BLOCK_DATA: Request only block data.\n - BLOCK_INFO: Request block information and transaction IDs.\n - BLOCK_TRANSACTIONS: Request block information and detailed transaction data."
},
"pactusBroadcastTransactionResponse": {
"type": "object",
"properties": {
"id": {
"type": "string",
- "format": "byte",
- "description": "Transaction ID."
+ "description": "The unique ID of the broadcasted transaction."
}
},
"description": "Response message containing the ID of the broadcasted transaction."
@@ -1213,12 +1243,12 @@
"amount": {
"type": "string",
"format": "int64",
- "description": "Calculated amount in NanoPAC."
+ "description": "The calculated amount in NanoPAC."
},
"fee": {
"type": "string",
"format": "int64",
- "description": "Calculated transaction fee in NanoPAC."
+ "description": "The calculated transaction fee in NanoPAC."
}
},
"description": "Response message containing the calculated transaction fee."
@@ -1228,13 +1258,12 @@
"properties": {
"hash": {
"type": "string",
- "format": "byte",
- "description": "Hash of the certificate."
+ "description": "The hash of the certificate."
},
"round": {
"type": "integer",
"format": "int32",
- "description": "Round of the certificate."
+ "description": "The round of the certificate."
},
"committers": {
"type": "array",
@@ -1254,8 +1283,7 @@
},
"signature": {
"type": "string",
- "format": "byte",
- "description": "Certificate signature."
+ "description": "The signature of the certificate."
}
},
"description": "Message containing information about a certificate."
@@ -1266,7 +1294,7 @@
"connections": {
"type": "string",
"format": "uint64",
- "description": "Total number of the connection."
+ "description": "Total number of connections."
},
"inboundConnections": {
"type": "string",
@@ -1279,28 +1307,28 @@
"description": "Number of outbound connections."
}
},
- "description": "Response message containing information about the overall network."
+ "description": "Response message containing information about the node's connections."
},
"pactusConsensusInfo": {
"type": "object",
"properties": {
"address": {
"type": "string",
- "description": "Address of the consensus instance."
+ "description": "The address of the consensus instance."
},
- "Active": {
+ "active": {
"type": "boolean",
- "description": "Whether the consensus instance is active."
+ "description": "Indicates whether the consensus instance is active and part of the\ncommittee."
},
"height": {
"type": "integer",
"format": "int64",
- "description": "Height of the consensus instance."
+ "description": "The height of the consensus instance."
},
"round": {
"type": "integer",
"format": "int32",
- "description": "Round of the consensus instance."
+ "description": "The round of the consensus instance."
},
"votes": {
"type": "array",
@@ -1311,24 +1339,24 @@
"description": "List of votes in the consensus instance."
}
},
- "description": "Message containing information about consensus."
+ "description": "Message containing information about a consensus instance."
},
"pactusCreateWalletResponse": {
"type": "object",
"properties": {
"mnemonic": {
"type": "string",
- "description": "Menomic for wallet recovery."
+ "description": "The mnemonic for wallet recovery."
}
},
- "description": "Response message containing the name of the created wallet."
+ "description": "Response message containing the mnemonic for wallet recovery."
},
"pactusGetAccountResponse": {
"type": "object",
"properties": {
"account": {
"$ref": "#/definitions/pactusAccountInfo",
- "description": "Account information."
+ "description": "Detailed information about the account."
}
},
"description": "Message containing the response with account information."
@@ -1342,18 +1370,17 @@
"type": "object",
"$ref": "#/definitions/pactusHistoryInfo"
},
- "description": "Array of address history and activities."
+ "description": "Array of history information for the address."
}
},
- "description": "Response message to get an address transaction history."
+ "description": "Response message containing the address transaction history."
},
"pactusGetBlockHashResponse": {
"type": "object",
"properties": {
"hash": {
"type": "string",
- "format": "byte",
- "description": "Hash of the block."
+ "description": "The hash of the block."
}
},
"description": "Message containing the response with the block hash."
@@ -1364,7 +1391,7 @@
"height": {
"type": "integer",
"format": "int64",
- "description": "Height of the block."
+ "description": "The height of the block."
}
},
"description": "Message containing the response with the block height."
@@ -1375,26 +1402,24 @@
"height": {
"type": "integer",
"format": "int64",
- "description": "Height of the block."
+ "description": "The height of the block."
},
"hash": {
"type": "string",
- "format": "byte",
- "description": "Hash of the block."
+ "description": "The hash of the block."
},
"data": {
"type": "string",
- "format": "byte",
- "description": "Block data, only available if the verbosity level is set to BLOCK_DATA."
+ "description": "Block data, available only if verbosity level is set to BLOCK_DATA."
},
"blockTime": {
"type": "integer",
"format": "int64",
- "description": "Block timestamp."
+ "description": "The timestamp of the block."
},
"header": {
"$ref": "#/definitions/pactusBlockHeaderInfo",
- "description": "Block header information."
+ "description": "Header information of the block."
},
"prevCert": {
"$ref": "#/definitions/pactusCertificateInfo",
@@ -1406,7 +1431,7 @@
"type": "object",
"$ref": "#/definitions/pactusTransactionInfo"
},
- "description": "List of transactions in the block.\nTransaction information is available when the verbosity level is set to BLOCK_TRANSACTIONS."
+ "description": "List of transactions in the block, available when verbosity level is set to\nBLOCK_TRANSACTIONS."
}
},
"description": "Message containing the response with block information."
@@ -1417,32 +1442,31 @@
"lastBlockHeight": {
"type": "integer",
"format": "int64",
- "description": "Height of the last block."
+ "description": "The height of the last block in the blockchain."
},
"lastBlockHash": {
"type": "string",
- "format": "byte",
- "description": "Hash of the last block."
+ "description": "The hash of the last block in the blockchain."
},
"totalAccounts": {
"type": "integer",
"format": "int32",
- "description": "Total number of accounts."
+ "description": "The total number of accounts in the blockchain."
},
"totalValidators": {
"type": "integer",
"format": "int32",
- "description": "Total number of validators."
+ "description": "The total number of validators in the blockchain."
},
"totalPower": {
"type": "string",
"format": "int64",
- "description": "Total power in the blockchain."
+ "description": "The total power of the blockchain."
},
"committeePower": {
"type": "string",
"format": "int64",
- "description": "Power of the committee."
+ "description": "The power of the committee."
},
"committeeValidators": {
"type": "array",
@@ -1523,14 +1547,14 @@
"properties": {
"walletName": {
"type": "string",
- "description": "The name of the wallet from which the address is created."
+ "description": "The name of the wallet from which the address is generated."
},
"addressInfo": {
"$ref": "#/definitions/pactusAddressInfo",
- "description": "Information about the new address."
+ "description": "Information about the newly generated address."
}
},
- "description": "Response message containing the new address."
+ "description": "Response message containing the newly generated address."
},
"pactusGetNodeInfoResponse": {
"type": "object",
@@ -1545,7 +1569,6 @@
},
"peerId": {
"type": "string",
- "format": "byte",
"description": "Peer ID of the node."
},
"startedAt": {
@@ -1589,11 +1612,11 @@
"clockOffset": {
"type": "number",
"format": "double",
- "title": "Clock offset"
+ "description": "Clock offset of the node."
},
"connectionInfo": {
"$ref": "#/definitions/pactusConnectionInfo",
- "title": "Connection information"
+ "description": "Information about the node's connections."
}
},
"description": "Response message containing information about a specific node in the network."
@@ -1603,7 +1626,7 @@
"properties": {
"publicKey": {
"type": "string",
- "description": "Public key of the account."
+ "description": "The public key associated with the provided address."
}
},
"description": "Message containing the response with the public key."
@@ -1613,8 +1636,7 @@
"properties": {
"rawTransaction": {
"type": "string",
- "format": "byte",
- "description": "Raw transaction data."
+ "description": "The raw transaction data."
}
},
"description": "Response message containing raw transaction data."
@@ -1624,7 +1646,7 @@
"properties": {
"walletName": {
"type": "string",
- "description": "Name of the wallet."
+ "description": "The name of the wallet."
},
"totalBalance": {
"type": "string",
@@ -1640,26 +1662,40 @@
"blockHeight": {
"type": "integer",
"format": "int64",
- "description": "Height of the block containing the transaction."
+ "description": "The height of the block containing the transaction."
},
"blockTime": {
"type": "integer",
"format": "int64",
- "description": "Time of the block containing the transaction."
+ "description": "The UNIX timestamp of the block containing the transaction."
},
"transaction": {
"$ref": "#/definitions/pactusTransactionInfo",
- "description": "Information about the transaction."
+ "description": "Detailed information about the transaction."
}
},
"description": "Response message containing details of a transaction."
},
+ "pactusGetTxPoolContentResponse": {
+ "type": "object",
+ "properties": {
+ "txs": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "$ref": "#/definitions/pactusTransactionInfo"
+ },
+ "description": "List of transactions currently in the pool."
+ }
+ },
+ "description": "Response message containing transactions in the transaction pool."
+ },
"pactusGetValidatorAddressResponse": {
"type": "object",
"properties": {
"address": {
"type": "string",
- "description": "Validator address associated with the public key."
+ "description": "The validator address associated with the public key."
}
},
"description": "Response message containing the validator address corresponding to a public\nkey."
@@ -1682,7 +1718,7 @@
"properties": {
"validator": {
"$ref": "#/definitions/pactusValidatorInfo",
- "description": "Validator information."
+ "description": "Detailed information about the validator."
}
},
"description": "Message containing the response with validator information."
@@ -1692,35 +1728,35 @@
"properties": {
"transactionId": {
"type": "string",
- "description": "Hash of transaction."
+ "description": "The transaction ID hash."
},
"time": {
"type": "integer",
"format": "int64",
- "description": "Transaction timestamp."
+ "description": "The timestamp of the transaction."
},
"payloadType": {
"type": "string",
- "description": "Type of transaction payload."
+ "description": "The payload type of the transaction."
},
"description": {
"type": "string",
- "description": "Description of transaction."
+ "description": "A description of the transaction."
},
"amount": {
"type": "string",
"format": "int64",
- "description": "Amount of transaction."
+ "description": "The amount involved in the transaction."
}
},
- "description": "Message of address history information."
+ "description": "Message containing transaction history information for an address."
},
"pactusLoadWalletResponse": {
"type": "object",
"properties": {
"walletName": {
"type": "string",
- "description": "Name of the loaded wallet."
+ "description": "The name of the loaded wallet."
}
},
"description": "Response message containing the name of the loaded wallet."
@@ -1730,16 +1766,16 @@
"properties": {
"sender": {
"type": "string",
- "description": "Sender's address."
+ "description": "The sender's address."
},
"receiver": {
"type": "string",
- "description": "Receiver's address."
+ "description": "The receiver's address."
},
"stake": {
"type": "string",
"format": "int64",
- "description": "Stake amount in NanoPAC."
+ "description": "The stake amount in NanoPAC."
}
},
"description": "Payload for a bond transaction."
@@ -1749,12 +1785,11 @@
"properties": {
"address": {
"type": "string",
- "description": "Address associated with the sortition."
+ "description": "The validator address associated with the sortition proof."
},
"proof": {
"type": "string",
- "format": "byte",
- "description": "Proof for the sortition."
+ "description": "The proof for the sortition."
}
},
"description": "Payload for a sortition transaction."
@@ -1764,16 +1799,16 @@
"properties": {
"sender": {
"type": "string",
- "description": "Sender's address."
+ "description": "The sender's address."
},
"receiver": {
"type": "string",
- "description": "Receiver's address."
+ "description": "The receiver's address."
},
"amount": {
"type": "string",
"format": "int64",
- "description": "Transaction amount in NanoPAC."
+ "description": "The amount to be transferred in NanoPAC."
}
},
"description": "Payload for a transfer transaction."
@@ -1789,14 +1824,14 @@
"WITHDRAW_PAYLOAD"
],
"default": "UNKNOWN",
- "description": "Enumeration for different types of transaction payload.\n\n - UNKNOWN: Unknown payload type.\n - TRANSFER_PAYLOAD: Transfer payload type.\n - BOND_PAYLOAD: Bond payload type.\n - SORTITION_PAYLOAD: Sortition payload type.\n - UNBOND_PAYLOAD: Unbond payload type.\n - WITHDRAW_PAYLOAD: Withdraw payload type."
+ "description": "Enumeration for different types of transaction payloads.\n\n - UNKNOWN: Unknown payload type.\n - TRANSFER_PAYLOAD: Transfer payload type.\n - BOND_PAYLOAD: Bond payload type.\n - SORTITION_PAYLOAD: Sortition payload type.\n - UNBOND_PAYLOAD: Unbond payload type.\n - WITHDRAW_PAYLOAD: Withdraw payload type."
},
"pactusPayloadUnbond": {
"type": "object",
"properties": {
"validator": {
"type": "string",
- "description": "Address of the validator to unbond from."
+ "description": "The address of the validator to unbond from."
}
},
"description": "Payload for an unbond transaction."
@@ -1806,16 +1841,16 @@
"properties": {
"from": {
"type": "string",
- "description": "Address to withdraw from."
+ "description": "The address to withdraw from."
},
"to": {
"type": "string",
- "description": "Address to withdraw to."
+ "description": "The address to withdraw to."
},
"amount": {
"type": "string",
"format": "int64",
- "description": "Withdrawal amount in NanoPAC."
+ "description": "The withdrawal amount in NanoPAC."
}
},
"description": "Payload for a withdraw transaction."
@@ -1838,7 +1873,6 @@
},
"peerId": {
"type": "string",
- "format": "byte",
"description": "Peer ID of the peer."
},
"consensusKeys": {
@@ -1848,12 +1882,12 @@
},
"description": "Consensus keys used by the peer."
},
- "consensusAddress": {
+ "consensusAddresses": {
"type": "array",
"items": {
"type": "string"
},
- "description": "Consensus address of the peer."
+ "description": "Consensus addresses of the peer."
},
"services": {
"type": "integer",
@@ -1862,23 +1896,22 @@
},
"lastBlockHash": {
"type": "string",
- "format": "byte",
"description": "Hash of the last block the peer knows."
},
"height": {
"type": "integer",
"format": "int64",
- "description": "Height of the peer in the blockchain."
+ "description": "Blockchain height of the peer."
},
"receivedBundles": {
"type": "integer",
"format": "int32",
- "description": "Count of received bundles."
+ "description": "Number of received bundles."
},
"invalidBundles": {
"type": "integer",
"format": "int32",
- "description": "Count of invalid bundles received."
+ "description": "Number of invalid bundles received."
},
"lastSent": {
"type": "string",
@@ -1924,12 +1957,12 @@
"totalSessions": {
"type": "integer",
"format": "int32",
- "description": "Total sessions with the peer."
+ "description": "Total download sessions with the peer."
},
"completedSessions": {
"type": "integer",
"format": "int32",
- "description": "Completed sessions with the peer."
+ "description": "Completed download sessions with the peer."
}
},
"description": "Information about a peer in the network."
@@ -1939,7 +1972,7 @@
"properties": {
"walletName": {
"type": "string",
- "description": "Name of the restored wallet."
+ "description": "The name of the restored wallet."
}
},
"description": "Response message containing the name of the restored wallet."
@@ -1949,13 +1982,11 @@
"properties": {
"transactionId": {
"type": "string",
- "format": "byte",
- "description": "ID of the signed transaction."
+ "description": "The ID of the signed transaction."
},
"signedRawTransaction": {
"type": "string",
- "format": "byte",
- "description": "Signed raw transaction data."
+ "description": "The signed raw transaction data."
}
},
"description": "Response message containing the transaction ID and signed raw transaction."
@@ -1965,70 +1996,67 @@
"properties": {
"id": {
"type": "string",
- "format": "byte",
- "description": "Transaction ID."
+ "description": "The unique ID of the transaction."
},
"data": {
"type": "string",
- "format": "byte",
- "description": "Transaction data."
+ "description": "The raw transaction data."
},
"version": {
"type": "integer",
"format": "int32",
- "description": "Transaction version."
+ "description": "The version of the transaction."
},
"lockTime": {
"type": "integer",
"format": "int64",
- "description": "Lock time for the transaction."
+ "description": "The lock time for the transaction."
},
"value": {
"type": "string",
"format": "int64",
- "description": "Transaction value in NanoPAC."
+ "description": "The value of the transaction in NanoPAC."
},
"fee": {
"type": "string",
"format": "int64",
- "description": "Transaction fee in NanoPAC."
+ "description": "The fee for the transaction in NanoPAC."
},
"payloadType": {
"$ref": "#/definitions/pactusPayloadType",
- "description": "Type of transaction payload."
+ "description": "The type of transaction payload."
},
"transfer": {
"$ref": "#/definitions/pactusPayloadTransfer",
- "description": "Transfer payload."
+ "description": "Transfer transaction payload."
},
"bond": {
"$ref": "#/definitions/pactusPayloadBond",
- "description": "Bond payload."
+ "description": "Bond transaction payload."
},
"sortition": {
"$ref": "#/definitions/pactusPayloadSortition",
- "description": "Sortition payload."
+ "description": "Sortition transaction payload."
},
"unbond": {
"$ref": "#/definitions/pactusPayloadUnbond",
- "description": "Unbond payload."
+ "description": "Unbond transaction payload."
},
"withdraw": {
"$ref": "#/definitions/pactusPayloadWithdraw",
- "description": "Withdraw payload."
+ "description": "Withdraw transaction payload."
},
"memo": {
"type": "string",
- "description": "Transaction memo."
+ "description": "A memo string for the transaction."
},
"publicKey": {
"type": "string",
- "description": "Public key associated with the transaction."
+ "description": "The public key associated with the transaction."
},
"signature": {
"type": "string",
- "format": "byte",
- "description": "Transaction signature."
+ "description": "The signature for the transaction."
}
},
"description": "Information about a transaction."
@@ -2040,14 +2068,14 @@
"TRANSACTION_INFO"
],
"default": "TRANSACTION_DATA",
- "description": "Enumeration for verbosity level when requesting transaction details.\n\n - TRANSACTION_DATA: Request transaction data only.\n - TRANSACTION_INFO: Request transaction details."
+ "description": "Enumeration for verbosity levels when requesting transaction details.\n\n - TRANSACTION_DATA: Request transaction data only.\n - TRANSACTION_INFO: Request detailed transaction information."
},
"pactusUnloadWalletResponse": {
"type": "object",
"properties": {
"walletName": {
"type": "string",
- "description": "Name of the unloaded wallet."
+ "description": "The name of the unloaded wallet."
}
},
"description": "Response message containing the name of the unloaded wallet."
@@ -2057,51 +2085,49 @@
"properties": {
"hash": {
"type": "string",
- "format": "byte",
- "description": "Hash of the validator."
+ "description": "The hash of the validator."
},
"data": {
"type": "string",
- "format": "byte",
- "description": "Validator data."
+ "description": "The serialized data of the validator."
},
"publicKey": {
"type": "string",
- "description": "Public key of the validator."
+ "description": "The public key of the validator."
},
"number": {
"type": "integer",
"format": "int32",
- "description": "Validator number."
+ "description": "The unique number assigned to the validator."
},
"stake": {
"type": "string",
"format": "int64",
- "description": "Validator stake in NanoPAC."
+ "description": "The stake of the validator in NanoPAC."
},
"lastBondingHeight": {
"type": "integer",
"format": "int64",
- "description": "Last bonding height."
+ "description": "The height at which the validator last bonded."
},
"lastSortitionHeight": {
"type": "integer",
"format": "int64",
- "description": "Last sortition height."
+ "description": "The height at which the validator last participated in sortition."
},
"unbondingHeight": {
"type": "integer",
"format": "int64",
- "description": "Unbonding height."
+ "description": "The height at which the validator will unbond."
},
"address": {
"type": "string",
- "description": "Address of the validator."
+ "description": "The address of the validator."
},
"availabilityScore": {
"type": "number",
"format": "double",
- "description": "Availability score of the validator."
+ "description": "The availability score of the validator."
}
},
"description": "Message containing information about a validator."
@@ -2111,31 +2137,30 @@
"properties": {
"type": {
"$ref": "#/definitions/pactusVoteType",
- "description": "Type of the vote."
+ "description": "The type of the vote."
},
"voter": {
"type": "string",
- "description": "Voter's address."
+ "description": "The address of the voter."
},
"blockHash": {
"type": "string",
- "format": "byte",
- "description": "Hash of the block being voted on."
+ "description": "The hash of the block being voted on."
},
"round": {
"type": "integer",
"format": "int32",
- "description": "Round of the vote."
+ "description": "The consensus round of the vote."
},
"cpRound": {
"type": "integer",
"format": "int32",
- "description": "Consensus round of the vote."
+ "description": "The change-proposer round of the vote."
},
"cpValue": {
"type": "integer",
"format": "int32",
- "description": "Consensus value of the vote."
+ "description": "The change-proposer value of the vote."
}
},
"description": "Message containing information about a vote."