Welcome to PyStratis’s documentation!

Raises

APIError – Error thrown by node API. See message for details.

estimate_offline_setup_tx_fee(cold_wallet_address: Union[Address, str], hot_wallet_address: Union[Address, str], wallet_name: str, wallet_account: str, amount: Union[Money, int, float, decimal.Decimal], fees: Union[Money, int, float, decimal.Decimal], subtract_fee_from_amount: bool = True, split_count: int = 1, segwit_change_address: bool = False, **kwargs) → Money

Estimate the cold staking offline setup tx fee.

Parameters

cold_wallet_address (Address, str) – The cold wallet address.
hot_wallet_address (Address, str) – The hot wallet address.
wallet_name (str) – The wallet name.
wallet_account (str) – The wallet account.
amount (Money, int, float, Decimal) – The amount to send to the old wallet.
fees (Money, int, float, Decimal) – The transaction fee.
subtract_fee_from_amount (bool, optional) – If fee should be subtracted from amount. Default=True.
split_count (int, optional) – Number of transactions to split over. Default=1.
segwit_change_address (bool, optional) – If change address is a segwit address. Default=False.
**kwargs – Extra keyword arguments.

Returns

The offline cold staking fee estimate.

Return type

Raises

APIError – Error thrown by node API. See message for details.

withdrawal(receiving_address: Union[Address, str], wallet_name: str, wallet_password: str, amount: Union[Money, int, float, decimal.Decimal], fees: Union[Money, int, float, decimal.Decimal], subtract_fee_from_amount: bool = True, **kwargs) → WithdrawalModel

Spends funds from the cold staking wallet account back to a normal wallet account.

Parameters

receiving_address (Address, str) – The receiving address.
wallet_password (str) – The wallet password.
wallet_name (str) – The wallet name.
amount (Money, int, float, Decimal) – The amount to withdraw to the receiving address.
fees (Money, int, float, Decimal, optional) – The amount paid in fees.
subtract_fee_from_amount (bool, optional) – If fee should be subtracted from amount. Default=True.
**kwargs – Extra keyword arguments.

Returns

The withdrawal transaction model.

Return type

WithdrawalModel

Raises

APIError – Error thrown by node API. See message for details.

offline_withdrawal(receiving_address: Union[Address, str], wallet_name: str, account_name: str, amount: Union[Money, int, float, decimal.Decimal], fees: Union[Money, int, float, decimal.Decimal], subtract_fee_from_amount: bool = True, **kwargs) → BuildOfflineSignModel

Builds a request to spend funds from a cold staking wallet account back to a normal wallet account.

Parameters

receiving_address (Address, str) – The receiving address.
wallet_name (str) – The wallet name.
account_name (str) – The account name.
amount (Money, int, float, Decimal) – The amount to withdraw to the receiving address.
fees (Money, int, float, Decimal) – The amount paid in fees.
subtract_fee_from_amount (bool, optional) – If fee should be subtracted from amount. Default=True.
**kwargs – Extra keyword arguments.

Returns

The built withdrawal transaction model for offline signing.

Return type

BuildOfflineSignModel

Raises

APIError – Error thrown by node API. See message for details.

estimate_offline_withdrawal_tx_fee(wallet_name: str, account_name: str, receiving_address: Union[Address, str], amount: Union[Money, int, float, decimal.Decimal], subtract_fee_from_amount: bool = True, **kwargs) → Money

Estimate the fee for an offline cold staking withdrawal transaction.

Parameters

wallet_name (str) – The wallet name.
account_name (str) – The account name.
receiving_address (Address, str) – The receiving address.
amount (Money, int, float, Decimal) – The amount to withdraw to the receiving address.
subtract_fee_from_amount (bool, optional) – If fee should be subtracted from amount. Default=True.
**kwargs – Extra keyword arguments.

Returns

The estimate for offline withdrawal transaction fee.

Return type

Raises

APIError – Error thrown by node API. See message for details.

estimate_withdrawal_tx_fee(receiving_address: Union[Address, str], wallet_name: str, wallet_password: str, amount: Union[Money, int, float, decimal.Decimal], fees: Union[Money, int, float, decimal.Decimal], subtract_fee_from_amount: bool = True, **kwargs) → Money

Estimate the fee for a cold staking withdrawal transaction.

Parameters

receiving_address (Address, str) – The receiving address.
wallet_password (str) – The wallet password.
wallet_name (str) – The wallet name.
amount (Money, int, float, Decimal) – The amount to withdraw to the receiving address.
fees (Money, int, float, Decimal, optional) – The amount paid in fees.
subtract_fee_from_amount (bool, optional) – If fee should be subtracted from amount. Default=True.
**kwargs – Extra keyword arguments.

Returns

The estimate for the withdrawal transaction fee.

Return type

JoinFederationResponseModel

Raises

APIError – Error thrown by node API. See message for details.

retrieve_filtered_utxos(wallet_name: str, wallet_password: str, wallet_account: str, trx_hex: hexstr, broadcast: bool = False, **kwargs) → List[hexstr]

Estimate the fee for a cold staking withdrawal transaction.

Parameters

wallet_name (str) – The wallet name.
wallet_password (str) – The wallet password.
wallet_account (str) – The wallet account.
trx_hex (hexstr) – The transaction id hex.
broadcast (bool) – If true, broadcast the transaction to the network after being built. Default=False.
**kwargs – Extra keyword arguments.

Returns

A list of hex encoded coldstaking transactions.

Return type

List[hexstr]

Raises

APIError – Error thrown by node API. See message for details.

AccountModel

class AccountModel(*, accountName: str)

A pydantic model for a cold staking account.

account_name: str: The cold staking account name.

AddressModel

class AddressModel(*, address: Address)

A pydantic model for a cold staking address.

address: Address: The cold staking address.

BuildOfflineSignModel

class BuildOfflineSignModel(*, walletName: str, walletAccount: str, unsignedTransaction: hexstr, fee: Money, utxos: List[UtxoDescriptor], addresses: List[AddressDescriptor])

A pydantic model for a built offline sign request.

wallet_name: str: The wallet name.

wallet_account: str: The wallet account.

unsigned_transaction: hexstr: The unsigned transaction hex.

fee: Money: The transaction fee.

utxos: List[UtxoDescriptor]: The utxos included in the transaction.

addresses: List[AddressDescriptor]: The addresses and amounts receiving outputs.

InfoModel

class InfoModel(*, coldWalletAccountExists: bool, hotWalletAccountExists: bool)

A pydantic model for cold wallet information.

cold_wallet_account_exists: bool: True if cold wallet account exists.

hot_wallet_account_exists: bool: True if hot wallet account exists.

SetupModel

class SetupModel(*, transactionHex: hexstr)

A pydantic model for a cold staking wallet setup transaction.

transaction_hex: hexstr: The hex serialized cold staking wallet setup transaction.

WithdrawalModel

class WithdrawalModel(*, transactionHex: hexstr)

A pydantic model for a cold staking withdrawal transaction.

transaction_hex: hexstr: A hex serialized cold staking wallet withdrawal transaction.

Collateral

class Collateral(**kwargs)

Implements the collateral api endpoints.

join_federation(collateral_address: Union[Address, str], collateral_wallet_name: str, collateral_wallet_password: str, wallet_password: str, wallet_name: str, wallet_account: str = 'account 0', **kwargs) → JoinFederationResponseModel

Called by a miner wanting to join the federation.

Parameters

collateral_address (Address, str) – The collateral address.
collateral_wallet_name (str) – The collateral wallet name.
collateral_wallet_password (SecretStr) – The collateral wallet password.
wallet_password (SecretStr) – The wallet password.
wallet_name (str) – The wallet name.
wallet_account (str, optional) – The wallet account. Default=’account 0’.
**kwargs – Extra keyword arguments.

Returns

The response to the join-federation API request.

Return type

Raises

APIError – Error thrown by node API. See message for details.

JoinFederationResponseModel

class JoinFederationResponseModel(*, MinerPublicKey: PubKey)

A pydantic model for the join federation response.

miner_public_key: PubKey: The miner public key for a new federation member, if successful.

CollateralVoting

class CollateralVoting(**kwargs)

Implements the collateralvoting api endpoints.

schedulevote_kickfedmember(pubkey_hex: Union[str, hexstr, PubKey], collateral_amount_satoshis: int, collateral_mainchain_address: Union[Address, str], **kwargs) → None

Schedule a vote to kick an existing federation member.

Parameters

pubkey_hex (PubKey) – The fedmember pubkey hex value.
collateral_amount_satoshis (int) – The collateral amount in satoshis.
collateral_mainchain_address (Address, str) – The mainchain address holding the collateral.
**kwargs – Extra keyword arguments.

Returns

None

Raises

APIError – Error thrown by node API. See message for details.

ConnectionManager

class ConnectionManager(**kwargs)

Implements the connectionmanager api endpoints.

addnode(ipaddr: str, command: str, **kwargs) → bool

Interface for the addnode command. Can continuously try to addnode, remove node, or onetry a node connection.

Parameters

ipaddr (str) – The endpoint.
command (str) – Allowed commands [add, remove, onetry]
**kwargs – Extra keyword arguments.

Returns

If command was successful.

Return type

bool

Raises

APIError – Error thrown by node API. See message for details.

getpeerinfo(**kwargs) → List[PeerInfoModel]

Gets the peer info.

Parameters: **kwargs – Extra keyword arguments.
Returns: A list of connected peers.
Return type: List[PeerInfoModel]
Raises: APIError – Error thrown by node API. See message for details.

PeerInfoModel

class PeerInfoModel(*, id: int, addr: str, addrlocal: str, services: str, relaytxes: bool, lastsend: int, lastrecv: int, bytessent: int, bytesrecv: int, conntime: int, timeoffset: int, pingtime: int, minping: int, pingwait: int, version: int, subver: str, inbound: bool, addnode: bool, startingheight: int, banscore: int, synced_headers: int, synced_blocks: int, whitelisted: bool, inflight: bool = None, bytessent_per_msg: int = None, bytesrecv_per_msg: int = None)

A pydantic model with power information..

peer_id: int: The peer id.

addr: str: The peer address.

addrlocal: str: The local peer address.

services: str: Peer services.

relaytxes: bool: Relay transactions.

lastsend: int: Last send.

lastrecv: int: Last received.

bytessent: int: Bytes sent.

bytesrecv: int: Bytes received.

conntime: int: Connection time in seconds.

timeoffset: int: The peer time offset in seconds.

pingtime: int: The ping time in ms.

minping: int: The minimum ping time.

pingwait: int: The point wait time.

version: int: The peer version

subver: str: The peer subversion.

inbound: bool: Inbound connected peer.

addnode: bool: If true, peer was connected by addnode.

starting_height: int: Connection starting height.

banscore: int: The peer’s ban score.

synced_headers: int: The number of synced headers.

synced_blocks: int: The number of synced blocks.

whitelisted: bool: If true, peer is whitelisted.

inflight: Optional[bool]: Inflight peer.

bytessent_per_msg: Optional[int]: Bytes sent per message.

bytesrecv_per_msg: Optional[int]: Bytes received per message.

Consensus

class Consensus(**kwargs)

Implements the consensus api endpoints.

deployment_flags(**kwargs) → List[DeploymentFlagsModel]

Get the active deployment flags.

Parameters: **kwargs – Extra keyword arguments.
Returns: A list of active deployment flags..
Return type: List[DeploymentFlagsModel]
Raises: APIError – Error thrown by node API. See message for details.

get_best_blockhash(**kwargs) → uint256

Gets the best block hash.

Parameters: **kwargs – Extra keyword arguments.
Returns: The block hash.
Return type: uint256
Raises: APIError – Error thrown by node API. See message for details.

get_blockhash(height: int, **kwargs) → uint256

Gets the block hash at the specified block

Parameters

height (int) – The requested height for block hash retrieval.
**kwargs – Extra keyword arguments.

Returns

The block hash.

Return type

CrossChainTransferModel

Raises

APIError – Error thrown by node API. See message for details.

DeploymentFlagsModel

class DeploymentFlagsModel(*, deploymentName: str, deploymentIndex: int, stateValue: int, thresholdState: str, height: int, sinceHeight: int, confirmationPeriod: int, periodStartHeight: int, periodEndHeight: int, votes: int, blocks: int, versions: dict, threshold: int, timeStart: str, timeTimeOut: str)

A pydantic model representing deployment flags.

deployment_name: str: The deployment flag name.

deployment_index: int: The deployment index.

state_value: int: The deployment flag state value.

threshold_state: str: The deployment flag threshold state.

height: int: The block height.

since_height: int: The flag’s activation height.

confirmation_period: int: The confirmation period size.

period_start_height: int: The activation period start height.

period_end_height: int: The activation period ending height.

votes: int: The number of votes.

blocks: int: Blocks.

versions: dict: Versions.

threshold: int: The threshold.

time_start: str: The start time.

time_time_out: str: The timeout time.

Dashboard

class Dashboard(**kwargs)

Implements the dashboard api endpoints.

stats(**kwargs) → str

Gets the dashboard of node stats.

Parameters: **kwargs – Extra keyword arguments.
Returns: The dashboard text.
Return type: str
Raises: APIError – Error thrown by node API. See message for details.

asyncloops_stats(**kwargs) → str

Gets the dashboard of asyncloop stats.

Parameters: **kwargs – Extra keyword arguments.
Returns: The async loop stats.
Return type: str
Raises: APIError – Error thrown by node API. See message for details.

Diagnostic

class Diagnostic(**kwargs)

Implements the diagnostic api endpoints.

get_connectedpeers_info(**kwargs) → GetConnectedPeersInfoModel

Get connected peers info.

Parameters: **kwargs – Extra keyword arguments.
Returns: Information on connected peers.
Return type: GetConnectedPeersInfoModel
Raises: APIError – Error thrown by node API. See message for details.

get_status(**kwargs) → GetStatusModel

Get the diagnostic feature status.

Parameters: **kwargs – Extra keyword arguments.
Returns: The feature status.
Return type: GetStatusModel
Raises: APIError – Error thrown by node API. See message for details.

get_peer_statistics(connected_only: bool, **kwargs) → List[PeerStatisticsModel]

Gets statistics for connected peers.

Parameters

connected_only (bool) – To show data for only connected nodes.
**kwargs – Extra keyword arguments.

Returns

A list of statistics on the connected peers.

Return type

List[PeerStatisticsModel]

Raises

APIError – Error thrown by node API. See message for details.

start_collecting_peerstatistics(**kwargs) → str

Start collecting peer statistics.

Parameters: **kwargs – Extra keyword arguments.
Returns: The status of the feature.
Return type: str
Raises: APIError – Error thrown by node API. See message for details.

stop_collecting_peerstatistics(**kwargs) → str

Stop collecting peer statistics.

Parameters: **kwargs – Extra keyword arguments.
Returns: The status of the feature.
Return type: str
Raises: APIError – Error thrown by node API. See message for details.

ConnectedPeerInfoModel

class ConnectedPeerInfoModel(*, isConnected: bool, disconnectReason: str = None, state: int, endPoint: str)

A pydantic model representing connected peer information.

is_connected: bool: True if the peer is connected

disconnect_reason: Optional[str]: The reason for disconnection.

state: int: The connection state.

endpoint: str: The peer’s endpoint.

GetConnectedPeersInfoModel

class GetConnectedPeersInfoModel(*, peersByPeerId: List[ConnectedPeerInfoModel], connectedPeers: List[ConnectedPeerInfoModel], connectedPeersNotInPeersByPeerId: List[ConnectedPeerInfoModel])

A pydantic model for connected peer information.

peers_by_peer_id: List[ConnectedPeerInfoModel]: A list of peers by id.

connected_peers: List[ConnectedPeerInfoModel]: A list of connected peers.

connected_peers_not_in_peers_by_peer_id: List[ConnectedPeerInfoModel]: A list of known peer ls not connected to.

GetStatusModel

class GetStatusModel(*, peerStatistics: str)

A pydantic model for status of diagnostics collection service.

peer_statistics: str: The status of the service.

PeerStatisticsModel

class PeerStatisticsModel(*, peerEndPoint: str, connected: bool, inbound: bool, bytesSent: int, bytesReceived: int, receivedMessages: int, sentMessages: int, latestEvents: List[str])

A pydantic model for peer statistics.

peer_endpoint: str: The peer endpoint.

connected: bool: If true, peer is connected.

inbound: bool: If true, peer is inbound connection.

bytes_sent: int: Bytes sent to peer.

bytes_received: int: Bytes received from peer.

received_messages: int: The number of received messages from peer.

send_messages: int: The number of sent messages to peer.

latest_events: List[str]: A list of peer events.

Federation

class Federation(**kwargs)

Implements the federation api endpoints.

reconstruct(**kwargs) → str

Signals the node to rebuild the federation. Will need to restart node when complete.

Parameters: **kwargs – Extra keyword arguments.
Returns: The node response ot the request.
Return type: str
Raises: APIError – Error thrown by node API. See message for details.

members_current(**kwargs) → FederationMemberDetailedModel

Retrieves the information for the current federation member’s voting status and mining estimates.

Parameters: **kwargs – Extra keyword arguments.
Returns: Information on the current member.
Return type: FederationMemberDetailedModel
Raises: APIError – Error thrown by node API. See message for details.

members(**kwargs) → List[FederationMemberModel]

Retrieves a list of active federation members and last active times.

Parameters: **kwargs – Extra keyword arguments.
Returns: Information on each of federation members.
Return type: List[FederationMemberModel]
Raises: APIError – Error thrown by node API. See message for details.

miner_at_height(block_height: int, **kwargs) → PubKey

Gets the federation pubkey that mined the block at the specified height.

Parameters

block_height – The height to query
**kwargs –

Returns

The pubkey that produced the block at the specified height.

Return type

PubKey

Raises

APIError – Error thrown by node API. See message for details.

federation_at_height(block_height: int, **kwargs) → List[PubKey]

Gets the federation membership at the specified height.

Parameters

block_height – The height to query
**kwargs –

Returns

The pubkeys of federation members at the specified height.

Return type

List[PubKey]

Raises

APIError – Error thrown by node API. See message for details.

FederationMemberDetailedModel

class FederationMemberDetailedModel(*, pubkey: PubKey, collateralAmount: Money, lastActiveTime: str, periodOfInactivity: str, pollStartBlockHeight: int = None, pollNumberOfVotesAcquired: int = None, pollFinishedBlockHeight: int = None, pollWillFinishInBlocks: int = None, pollExecutedBlockHeight: int = None, memberWillStartMiningAtBlockHeight: int = None, memberWillStartEarningRewardsEstimateHeight: int = None, pollType: str = None, rewardEstimatePerBlock: Money = None, federationSize: int, miningStats: pystratis.api.federation.responsemodels.miningstats.MiningStats)

A pydantic model for details on federation members.

poll_start_block_height: Optional[int]: The poll start block height.

poll_number_of_votes_acquired: Optional[int]: The number of poll votes acquired.

poll_finished_block_height: Optional[int]: The poll finished block height.

poll_will_finish_in_blocks: Optional[int]: The number of blocks until the poll finishes.

poll_executed_block_height: Optional[int]: The block heigh where poll was executed, if it has occurred.

member_will_start_mining_at_block_height: Optional[int]: Height when the member will start mining.

pubkey: PubKey: The federation member’s pubkey.

collateral_amount: Money: The federation member’s collateral amount.

last_active_time: str: The federation member’s last active time.

period_of_inactivity: str: The federation member’s period of inactivity.

member_will_start_earning_rewards_estimate_height: Optional[int]: Height when member will start earning rewards.

poll_type: Optional[str]: The poll type.

reward_estimate_per_block: Optional[Money]: The reward estimate per block.

federation_size: int: The size of the federation.

mining_stats: pystratis.api.federation.responsemodels.miningstats.MiningStats: The mining stats for the federation member.

FederationMemberModel

class FederationMemberModel(*, pubkey: PubKey, collateralAmount: Money, lastActiveTime: str, periodOfInactivity: str)

A pydantic model for a federation member.

pubkey: PubKey: The federation member’s pubkey.

collateral_amount: Money: The federation member’s collateral amount.

last_active_time: str: The federation member’s last active time.

period_of_inactivity: str: The federation member’s period of inactivity.

FederationGateway

class FederationGateway(**kwargs)

Implements the federationgateway api endpoints.

deposits(block_height: int, **kwargs) → List[MaturedBlockDepositsModel]

Retrieves block deposits

Parameters

block_height (int) – The block height at which to obtain deposits.
**kwargs – Extra keyword arguments.

Returns

A list of matured block deposits.

Return type

List[MaturedBlockDepositsModel]

Raises

APIError – Error thrown by node API. See message for details.

pending_transfer(deposit_id: Union[str, uint256], transaction_id: Union[str, uint256], **kwargs) → List[CrossChainTransferModel]

Gets pending transfers.

Parameters

deposit_id (uint256, str) – The deposit id hash.
transaction_id (uint256, str) – The transaction id hash.
**kwargs – Extra keyword arguments.

Returns

A list of cross chain transfers.

Return type

List[CrossChainTransferModel]

Raises

APIError – Error thrown by node API. See message for details.

fullysigned_transfer(deposit_id: Union[str, uint256], transaction_id: Union[str, uint256], **kwargs) → List[CrossChainTransferModel]

Get fully signed transfers.

Parameters

deposit_id (uint256, str) – The deposit id hash.
transaction_id (uint256, str) – The transaction id hash.
**kwargs – Extra keyword arguments.

Returns

A list of cross chain transfers.

Return type

List[CrossChainTransferModel]

Raises

APIError – Error thrown by node API. See message for details.

member_info(**kwargs) → FederationMemberInfoModel

Gets info on the state of a multisig member.

Parameters: **kwargs – Extra keyword arguments.
Returns: Information on the current multisig member.
Return type: FederationMemberInfoModel
Raises: APIError – Error thrown by node API. See message for details.

info(**kwargs) → FederationGatewayInfoModel

Gets info on the state of the federation.

Parameters: **kwargs – Extra keyword arguments.
Returns: Information on the federation gateway.
Return type: FederationGatewayInfoModel
Raises: APIError – Error thrown by node API. See message for details.

ip_add(ipaddr: str, **kwargs) → str

Add a federation member’s IP address to the federation IP list

Parameters

ipaddr (str) – The endpoint.
**kwargs – Extra keyword arguments.

Returns

Response to ip add request.

Return type

str

Raises

APIError – Error thrown by node API. See message for details.

ip_remove(ipaddr: str, **kwargs) → str

Remove a federation member’s IP address to the federation IP list

Parameters

ipaddr (str) – The endpoint.
**kwargs – Extra keyword arguments.

Returns

response to ip remove request.

Return type

str

Raises

APIError – Error thrown by node API. See message for details.

ip_replace(ipaddrtouse: str, ipaddr: str, **kwargs) → str

Replace a federation member’s IP from the federation IP list with another.

Parameters

ipaddrtouse (str) – The new endpoint.
ipaddr (str) – The endpoint being replaced.
**kwargs – Extra keyword arguments.

Returns

Response to ip replace request.

Return type

str

Raises

APIError – Error thrown by node API. See message for details.

verify_transfer(deposit_id_transaction_id: Union[str, uint256], **kwargs) → Union[str, ValidateTransactionResultModel]

Validate a transfer transaction.

Parameters

deposit_id_transaction_id (uint256, str) – The transaction id containing the deposit with the deposit id.
**kwargs – Extra keyword arguments.

Returns

A model describing the validity of the transfer.

Return type

Union[str, ValidateTransactionResultModel]

Raises

APIError – Error thrown by node API. See message for details.

transfers_delete_suspended(**kwargs) → str

Delete a suspended transfer transaction.

Parameters: **kwargs – Extra keyword arguments.
Returns: A message about the deletion request.
Return type: str
Raises: APIError – Error thrown by node API. See message for details.

transfer(deposit_id: Union[str, uint256], **kwargs) → CrossChainTransferModel

Gets pending transfers.

Parameters

deposit_id (uint256, str) – The deposit id hash.
**kwargs – Extra keyword arguments.

Returns

A cross chain transfer.

Return type

Raises

APIError – Error thrown by node API. See message for details.

CrosschainTransferModel

class CrossChainTransferModel(*, depositAmount: Money, depositId: uint256, depositHeight: int, transferStatus: CrossChainTransferStatus, tx: TransactionModel)

A pydantic model of a cross chain transfer.

deposit_amount: Money: The amount deposited.

deposit_id: uint256: The hash of the deposit transaction.

deposit_height: int: The height of the deposit transaction.

transfer_status: CrossChainTransferStatus: The transfer status.

tx: TransactionModel: The transaction model of the cross chain transaction.

FederationGatewayInfoModel

class FederationGatewayInfoModel(*, active: bool, mainchain: bool, endpoints: List[str], multisigPubKey: PubKey, federationMultisigPubKeys: List[PubKey], miningPubKey: PubKey = '', federationMiningPubKeys: List[PubKey] = [], multisigAddress: Address, multisigRedeemScript: str = None, multisigRedeemScriptPaymentScript: str = None, minconfsmalldeposits: int, minconfnormaldeposits: int, minconflargedeposits: int, minconfdistributiondeposits: int)

A pydantic model representing information on the federation gateway.

active: bool: True if federation gateway is active.

mainchain: bool: True if called on mainchain node.

multisig_pubkey: PubKey: The multisig pubkey.

federation_multisig_pubkeys: List[PubKey]: A list of federation multisig pubkeys.

mining_pubkey: PubKey: The mining pubkey.

federation_mining_pubkeys: Optional[List[PubKey]]: The federation mining pubkeys. Only active if federation mining is active.

multisig_address: Address: The multisig address.

multisig_redeem_script: Optional[str]: The multisig redeem script.

multisig_redeem_script_payment_script: Optional[str]: The multisig redeem script payment script.

min_conf_small_deposits: int: The minimum confirmations for small deposits.

min_conf_normal_deposits: int: The minimum confirmations for normal deposits.

min_conf_large_deposits: int: The minimum confirmations for large deposits.

min_conf_distribution_deposits: int: The minimum confirmations for distribution deposits.

FederationMemberConnectionInfoModel

class FederationMemberConnectionInfoModel(*, federationMemberIp: str, isConnected: bool, isBanned: bool)

A pydantic model for federation member connections.

federation_member_ip: str: The federation member ip.

is_connected: bool: If true, federation member is connected.

is_banned: bool: If true, federation member is banned.

FederationMemberInfoModel

class FederationMemberInfoModel(*, asyncLoopState: str, consensusHeight: int, cctsHeight: int, cctsNextDepositHeight: int, cctsPartials: int, cctsSuspended: int, federationWalletActive: bool, federationWalletHeight: int, nodeVersion: str, pubKey: PubKey = None, federationConnectionState: str, federationMemberConnections: List[FederationMemberConnectionInfoModel])

A pydantic model representing information about the current federation member.

async_loop_state: str: The async loop state.

consensus_height: int: The current consensus height.

ccts_height: int: The node’s CCTS height.

ccts_next_deposit_height: int: The next CCTS deposit height.

ccts_partials: int: The number of partial CCTS transactions.

ccts_suspended: int: The number of suspended CCTS transactions.

federation_wallet_active: bool: If true, the federation wallet is active.

federation_wallet_height: int: The local federation wallet height.

node_version: str: The node version.

pubkey: Optional[PubKey]: The member’s pubkey. Could be None.

federation_connection_state: str: The federation connection state.

federation_member_connections: List[FederationMemberConnectionInfoModel]: A list of connected federation members.

MaturedBlockDepositsModel

class MaturedBlockDepositsModel(*, deposits: List[Deposit], blockInfo: MaturedBlockInfoModel)

A pydantic model for matured block deposits.

deposits: List[Deposit]: A list of deposits.

block_info: MaturedBlockInfoModel: Matured block information model.

SerializableResult

class SerializableResult(*, value: Any = None, message: str = '')

A pydantic model for a serializable result.

value: Optional[Any]

message: Optional[str]

ValidateTransactionResultModel

class ValidateTransactionResultModel(*, isValid: bool, errors: List[str] = None)

A pydantic model for a validate transaction result.

is_valid: bool: If true, transaction is valid.

errors: Optional[List[str]]: Transaction validation errors.

FederationWallet

class FederationWallet(**kwargs)

Implements the federationwallet api endpoints.

general_info(**kwargs) → WalletGeneralInfoModel

Retrieves general information about the wallet.

Parameters: **kwargs – Extra keyword arguments.
Returns: General information about the federation wallet.
Return type: WalletGeneralInfoModel
Raises: APIError – Error thrown by node API. See message for details.

balance(**kwargs) → WalletBalanceModel

Retrieves wallet balances.

Parameters: **kwargs – Extra keyword arguments.
Returns: Federation wallet balance information.
Return type: WalletBalanceModel
Raises: APIError – Error thrown by node API. See message for details.

history(max_entries_to_return: int, **kwargs) → List[WithdrawalModel]

Retrieves a withdrawal history for the wallet.

Parameters

max_entries_to_return (int) – The maximum number of history entries to return.
**kwargs – Extra keyword arguments.

Returns

The federation wallet history.

Return type

List[WithdrawalModel]

Raises

APIError – Error thrown by node API. See message for details.

sync(block_hash: Union[str, uint256], **kwargs) → None

Starts sending block to wallet for synchronisation. Demo/testing use only.

Parameters

block_hash (uint256, str) – The block hash at which to start sync.
**kwargs – Extra keyword arguments.

Returns

None

Raises

APIError – Error thrown by node API. See message for details.

enable_federation(mnemonic: str, password: str, passphrase: Optional[str] = None, timeout_seconds: int = 60, **kwargs) → Union[None, str]

Enables the federation so that it can sign transactions.

Parameters

mnemonic (str) – The mnemonic.
password (str) – The password.
passphrase (str, optional) – The passphrase.
timeout_seconds (int, optional) – Seconds to timeout. Default=60.
**kwargs – Extra keyword arguments.

Returns

None if successful, str if error.

Return type

(str, None)

Raises

APIError –

remove_transactions(resync: bool = True, **kwargs) → List[RemovedTransactionModel]

Remove all transactions from the wallet.

Parameters

resync (bool, optional) – A flag to resync the wallet after transactions are removed. Default=True.
**kwargs – Extra keyword arguments.

Returns

A list of removed transactions from the federation wallet.

Return type

List[RemovedTransactionModel]

Raises

APIError – Error thrown by node API. See message for details.

RemovedTransactionModel

class RemovedTransactionModel(*, transactionId: uint256, creationTime: datetime.datetime)

A pydantic model for a removed transaction.

transaction_id: uint256: The removed transaction hash.

creation_time: datetime.datetime: The creation time of the removed transaction.

WalletBalanceModel

class WalletBalanceModel(*, balances: List[AccountBalanceModel])

A pydantic model for a wallet balance.

balances: List[AccountBalanceModel]: A list of account balances.

WalletGeneralInfoModel

class WalletGeneralInfoModel(*, walletName: str = None, network: str, creationTime: datetime.datetime, isDecrypted: bool, lastBlockSyncedHeight: int, chainTip: int, isChainSynced: bool, connectedNodes: int)

A model representing general wallet info.

wallet_name: Optional[str]: The name of the wallet. Will be None for multisig.

network: str: The name of the network the wallet is operating on.

creation_time: datetime.datetime: The datetime of wallet creation

is_decrypted: bool: If true, wallet is decrypted.

last_block_synced_height: int: The height of last block synced by wallet.

chain_tip: int: The height off the chain tip.

is_chain_synced: bool: If true, chain is synced.

connected_nodes: int: The number of connected nodes.

WithdrawalModel

class WithdrawalModel(*, id: uint256, depositId: uint256, amount: Money, payingTo: Union[str, Address], blockHeight: int, blockHash: uint256, signatureCount: int, spendingOutputDetails: str, transferStatus: CrossChainTransferStatus)

A pydantic model for a withdrawal processed by the multisig federation.

trx_id: uint256: The transaction hash.

deposit_id: uint256: The deposit transaction hash.

amount: Money: The amount of the withdrawal.

paying_to: Union[str, Address]: The address receiving the withdrawal.

block_height: int: The block height of the withdrawal.

block_hash: uint256: The hash of the block containing the withdrawal.

signature_count: int: The number of signatures on the withdrawal.

spending_output_details: str: Spending output details.

transfer_status: CrossChainTransferStatus: The cross chain transfer status.

Interop

class Interop(**kwargs)

Implements the interop api endpoints.

status_burns(**kwargs) → List[ConversionRequestModel]

Gets the current interop status of burns.

Parameters: **kwargs – Extra keyword arguments.
Returns: A list of burn conversion requests.
Return type: List[ConversionRequestModel]
Raises: APIError – Error thrown by node API. See message for details.

status_mints(**kwargs) → List[ConversionRequestModel]

Gets the current interop status of mints.

Parameters: **kwargs – Extra keyword arguments.
Returns: A list of mint conversion requests.
Return type: List[ConversionRequestModel]
Raises: APIError – Error thrown by node API. See message for details.

status_votes(**kwargs) → dict

Gets the current interop status of votes.

Parameters: **kwargs – Extra keyword arguments.
Returns: A dictionary of votes with {request_id: [pubkeys_that_voted]}
Return type: dict
Raises: APIError – Error thrown by node API. See message for details.

owners(destination_chain: int, **kwargs) → List[str]

Retrieves the list of current owners for the multisig wallet contract.

Parameters

destination_chain (int) – The destination chain.
**kwargs – Extra keyword arguments.

Returns

A list of owners of the multisig contract.

Return type

List[str]

Raises

APIError – Error thrown by node API. See message for details.

add_owner(destination_chain: int, new_owner_address: Union[str, Address], gas_price: int, **kwargs) → uint256

Creates and broadcasts an addOwner contract call on the multisig wallet contract. This can only be done by one of the current owners of the contract, and needs to be confirmed by a sufficient number of the other owners.

Parameters

destination_chain (int) – The destination chain.
new_owner_address (str, Address) – The address to add to multisig ownership.
gas_price (int) – The gas price.
**kwargs – Extra keyword arguments.

Returns

The transactionId of the multisig wallet contract transaction, which is then used to confirm the transaction.

Return type

Raises

APIError – Error thrown by node API. See message for details.

remove_owner(destination_chain: int, existing_owner_address: Union[str, Address], gas_price: int, **kwargs) → uint256

Creates and broadcasts a removeOwner contract call on the multisig wallet contract. This can only be done by one of the current owners of the contract, and needs to be confirmed by a sufficient number of the other owners.

Parameters

destination_chain (int) – The destination chain.
existing_owner_address (str, Address) – The address to add to multisig ownership.
gas_price (int) – The gas price.
**kwargs – Extra keyword arguments.

Returns

The transactionId of the multisig wallet contract transaction, which is then used to confirm the transaction.

Return type

Raises

APIError – Error thrown by node API. See message for details.

confirm_transaction(destination_chain: int, transaction_id: int, gas_price: int, **kwargs) → uint256

Explicitly confirms a given multisig wallet contract transactionId by submitting a contract call transaction to the network.

This can only be called once per multisig owner. Additional calls by the same owner account will simply fail and waste gas.

Parameters

destination_chain (int) – The destination chain.
transaction_id (int) – The multisig wallet transactionId (int, not transaction hash).
gas_price (int) – The gas price.
**kwargs – Extra keyword arguments.

Returns

The on-chain transaction hash of the contract call transaction.

Return type

Raises

APIError – Error thrown by node API. See message for details.

change_requirement(destination_chain: int, requirement: int, gas_price: int, **kwargs) → uint256

Creates and broadcasts a ‘changeRequirement()’ contract call on the multisig wallet contract. This can only be done by one of the current owners of the contract, and needs to be confirmed by a sufficient number of the other owners.

This should only be done once all owner modifications are complete to save gas and orchestrating confirmations.

Parameters

destination_chain (int) – The destination chain.
requirement (int) – The new threshold for confirmations on the multisig wallet contract. Can usually be numOwners / 2 rounded up.
gas_price (int) – The gas price.
**kwargs – Extra keyword arguments.

Returns

The multisig wallet transactionId of the changerequirement call.

Return type

Raises

APIError – Error thrown by node API. See message for details.

multisig_transaction(destination_chain: int, transaction_id: int, raw: bool, **kwargs) → Union[hexstr, TransactionResponseModel]

Retrieves a multisig wallet transaction.

Parameters

destination_chain (int) – The destination chain.
transaction_id (int) – The multisig wallet transactionId (int, not transaction hash).
raw (bool) – Indicates whether to partially decode the transaction or leave it in raw hex format.
**kwargs – Extra keyword arguments.

Returns

The multisig wallet transaction data.

Return type

Union[hexstr, TransactionResponseModel]

Raises

APIError – Error thrown by node API. See message for details.

multisig_confirmations(destination_chain: int, transaction_id: int, **kwargs) → List[str]

Returns the list of contract owners that confirmed a particular multisig transaction.

Parameters

destination_chain (int) – The destination chain.
transaction_id (int) – The multisig wallet transactionId (int, not transaction hash).
**kwargs – Extra keyword arguments.

Returns

A list of owner addresses that confirmed the transaction.

Return type

List[str]

Raises

APIError – Error thrown by node API. See message for details.

balance(destination_chain: int, account: str, **kwargs) → Money

Retrieves the wSTRAX balance of a given account.

Parameters

destination_chain (int) – The chain the wSTRAX ERC20 contract is deployed to.
account (str) – The account to retrieve the balance for.
**kwargs – Extra keyword arguments.

Returns

The wSTRAX account balance.

Return type

Raises

APIError – Error thrown by node API. See message for details.

requests_delete(**kwargs) → Money

Deletes conversion requests.

Parameters: **kwargs – Extra keyword arguments.
Returns: A message about the status of the request.
Return type: str
Raises: APIError – Error thrown by node API. See message for details.

requests_setoriginator(request_id: int, **kwargs) → str

Endpoint that allows the multisig operator to set itself as the originator (submittor) for a given request id.

Parameters

request_id (int) – The requestId in question.
**kwargs – Extra keyword arguments.

Returns

A message about the status of the request.

Return type

str

Raises

APIError – Error thrown by node API. See message for details.

requests_setnotoriginator(request_id: int, **kwargs) → str

Endpoint that allows the multisig operator to reset the request as NotOriginator.

Parameters

request_id (int) – The requestId in question.
**kwargs – Extra keyword arguments.

Returns

A message about the status of the request.

Return type

str

Raises

APIError – Error thrown by node API. See message for details.

requests_reprocess_burn(request_id: int, height: int, **kwargs) → str

Endpoint that allows the multisig operator to reprocess a burn.

Parameters

request_id (int) – The requestId to reprocess burn.
height (int) – The height at which to reprocess the burn.
**kwargs – Extra keyword arguments.

Returns

A message about the status of the request.

Return type

str

Raises

APIError – Error thrown by node API. See message for details.

requests_pushvote(request_id: int, vote_id: int, **kwargs) → str

Endpoint that allows the multisig operator to manually add a vote if they are originator of the request.

Parameters

request_id (int) – The request id.
vote_id (int) – The vote id.
**kwargs – Extra keyword arguments.

Returns

A message about the status of the request.

Return type

str

Raises

APIError – Error thrown by node API. See message for details.

ConversionRequestModel

class ConversionRequestModel(*, requestId: uint256, requestType: ConversionRequestType, requestStatus: int, blockHeight: int, destinationAddress: Address, destinationChain: DestinationChain, amount: Money, processed: bool)

A pydantic model of a conversion request.

request_id: uint256: The hash of the conversion request.

request_type: ConversionRequestType: The conversion request type.

request_status: int: The conversion request status.

block_height: int: The block height of the transaction.

destination_address: Address: The destination address.

destination_chain: DestinationChain: The destination chain.

amount: Money: The amount converted.

processed: bool: True if the conversion has been processed.

TransactionResponseModel

class TransactionResponseModel(*, data: hexstr, destination: DestinationChain, value: Money, executed: bool)

A pydantic model of a multisig transaction response.

data: hexstr: The transaction hexstr.

destination: DestinationChain: The destination chain.

value: Money: The amount converted.

executed: bool: True if the transaction has been processed.

Mempool

class Mempool(**kwargs)

Implements the mempool api endpoints.

get_raw_mempool(**kwargs) → List[uint256]

Gets a list of transaction hashes in the mempool.

Parameters: **kwargs – Extra keyword arguments.
Returns: A list of transactions in the mempool.
Return type: List[uint256]
Raises: APIError – Error thrown by node API. See message for details.

Mining

class Mining(**kwargs)

Implements the mining api endpoints.

generate(block_count: int, **kwargs) → GenerateBlocksModel

Generate blocks by mining.

Parameters

block_count (int) – The number of blocks to mine.
**kwargs – Extra keyword arguments.

Returns

A list of generated blocks.

Return type

GenerateBlocksModel

Raises

APIError – Error thrown by node API. See message for details.

stop_mining(**kwargs) → None

Stop mining.

Parameters: **kwargs – Extra keyword arguments.
Returns: None
Raises: APIError – Error thrown by node API. See message for details.

GenerateBlocksModel

class GenerateBlocksModel(*, blocks: List[uint256])

A pydantic model for generated blocks.

blocks: List[uint256]: A list of hashes of generated blocks.

Multisig

class Multisig(**kwargs)

Implements the multisig api endpoints.

build_transaction(recipients: List[Recipient], secrets: List[MultisigSecret], **kwargs) → BuildTransactionModel

Builds a transaction.

Parameters

recipients (List[Recipient]) – A list of recipient objects.
secrets (List[MultisigSecret]) – A list of corresponding multisig secrets.
**kwargs – Extra keyword arguments.

Returns

A built multisig transaction.

Return type

Raises

APIError – Error thrown by node API. See message for details.

BuildTransactionModel

class BuildTransactionModel(*, fee: Money = 0, hex: hexstr, transactionId: uint256)

A pydantic model for a built transaction.

fee: Money: The transaction fee.

hex: hexstr: The transaction hex.

transaction_id: uint256: The transaction hash.

Network

class Network(**kwargs)

Implements the network api endpoints.

disconnect(peer_address: str, **kwargs) → None

Disconnect from a node.

Parameters

peer_address (str) – The peer endpoint.
**kwargs – Extra keyword arguments.

Returns

None

Raises

APIError – Error thrown by node API. See message for details.

set_ban(ban_command: str, ban_duration_seconds: int, peer_address: str, **kwargs) → None

Set a banned node.

Parameters

ban_command (str) – Allowed commands [add, remove].
ban_duration_seconds (int) – The ban duration in seconds.
peer_address (str) – The peer address to ban/unban.
**kwargs – Extra keyword arguments.

Returns

None

Raises

APIError – Error thrown by node API. See message for details.

get_bans(**kwargs) → List[BannedPeerModel]

Get a list of banned peers.

Parameters: **kwargs – Extra keyword arguments.
Returns: A list of banned peers with information on duration and reason for ban.
Return type: List[BannedPeerModel]
Raises: APIError – Error thrown by node API. See message for details.

clear_banned(**kwargs) → None

Clear banned node list.

Parameters: **kwargs – Extra keyword arguments.
Returns: None
Raises: APIError – Error thrown by node API. See message for details.

BannedPeerModel

class BannedPeerModel(*, endPoint: str, banUntil: str, banReason: str)

A pydantic model describing a banned peer.

endpoint: str: The banned peer endpoint.

ban_until: str: The time when ban end.

ban_reason: str: The reason for the ban.

Node

class Node(**kwargs)

Implements the node api endpoints.

status(publish: bool = False, **kwargs) → StatusModel

Gets the node status.

Parameters

publish (bool) – If true, publish a full node event with the status.
**kwargs – Extra keyword arguments.

Returns

Information about the node status.

Return type

StatusModel

Raises

APIError – Error thrown by node API. See message for details.

get_blockheader(block_hash: Union[str, uint256], is_json_format: bool = True, **kwargs) → BlockHeaderModel

Gets the specified block header.

Parameters

block_hash (str, uint256) – The specified block hash.
is_json_format (bool, optional) – If block header should be returned as json. Default=True.
**kwargs – Extra keyword arguments.

Returns

The block headers.

Return type

BlockHeaderModel

Raises

APIError – Error thrown by node API. See message for details.

get_raw_transaction(trxid: Union[uint256, str], verbose: bool = False, **kwargs) → Union[hexstr, TransactionModel]

Gets a raw transaction from a transaction id.

Requires txindex=1 in node configuration.

Parameters

trxid (uint256, str) – The transaction hash.
verbose (bool, optional) – If output should include verbose transaction data. Default=False.
**kwargs – Extra keyword arguments.

Returns

A raw transaction.

Return type

Union[hexstr, TransactionModel]

Raises

APIError – Error thrown by node API. See message for details.

decode_raw_transaction(raw_hex: Union[str, hexstr], **kwargs) → TransactionModel

Decodes raw transaction hex into a transaction model.

Parameters

raw_hex (hexstr, str) – The transaction hexstring.
**kwargs – Extra keyword arguments.

Returns

A transaction model.

Return type

TransactionModel

Raises

APIError – Error thrown by node API. See message for details.

validate_address(address: str, **kwargs) → ValidateAddressModel

Validate an address

Parameters

address (str) – The address to validate.
**kwargs – Extra keyword arguments.

Returns

Information on the validity of the provided address, and if valid, if it is a witness or script address.

Return type

ValidateAddressModel

Raises

APIError – Error thrown by node API. See message for details.

get_txout(trxid: Union[uint256, str], vout: int, include_mempool: bool = True, **kwargs) → GetTxOutModel

Gets a specified txout from a given transaction.

Parameters

trxid (uint256, str) – The trxid to check.
vout (int) – The vout.
include_mempool (bool, optional) – Include mempool in check. Default=True.
**kwargs – Extra keyword arguments.

Returns

The specified txout.

Return type

GetTxOutModel

Raises

APIError – Error thrown by node API. See message for details.

get_txout_proof(txids: List[Union[str, uint256]], block_hash: Union[uint256, str], **kwargs) → hexstr

The merkle proof that the specified transaction exist in a given block.

Should have txindex enabled if not specifying blockhash.

Parameters

txids (List[uint256]) – A list of transaction hashes.
block_hash (uint256, optional) – The block hash to check.
**kwargs – Extra keyword arguments.

Returns

The merkle proof.

Return type

hexstr

Raises

APIError – Error thrown by node API. See message for details.

shutdown(**kwargs) → None

Triggers node shutdown.

Parameters: **kwargs – Extra keyword arguments.
Returns: None
Raises: APIError – Error thrown by node API. See message for details.

stop(**kwargs) → None

Triggers node shutdown.

Parameters: **kwargs – Extra keyword arguments.
Returns: None
Raises: APIError – Error thrown by node API. See message for details.

log_levels(log_rules: List[LogRule], **kwargs) → None

Changes log level for the specified loggers.

Parameters

log_rules (List[LogRule]) – A list of log rules to change.
**kwargs – Extra keyword arguments.

Returns

None

Raises

APIError – Error thrown by node API. See message for details.

log_rules(**kwargs) → List[LogRule]

Returns the enabled log rules.

Parameters: **kwargs – Extra keyword arguments.
Returns: A list of active log rules.
Return type: List[LogRule]
Raises: APIError – Error thrown by node API. See message for details.

async_loops(**kwargs) → List[AsyncLoopsModel]

Gets the currently running async loops.

Parameters: **kwargs – Extra keyword arguments.
Returns: A list of active asynchronous loops.
Return type: List[AsyncLoopsModel]
Raises: APIError – Error thrown by node API. See message for details.

delete_datafolder_chain(**kwargs) → None

Schedules data folder storing chain state in the datafolder for deletion on the next graceful shutdown.

Parameters: **kwargs – Extra keyword arguments.
Returns: None
Raises: APIError – Error thrown by node API. See message for details.

rewind(height: int, **kwargs) → str

Signals the node to rewind to the specified height. This will be done via writing a flag to the .conf file so that on startup it be executed.

Parameters

height (int) – The specified height to rewind to on restart.
**kwargs – Extra keyword arguments.

Returns

str

Raises

APIError – Error thrown by node API. See message for details.

AsyncLoopsModel

class AsyncLoopsModel(*, loopName: str, status: str)

A pydantic model for async loops.

loop_name: str: The loop name.

status: str: The loop status.

BlockHeaderModel

class BlockHeaderModel(*, version: int, merkleroot: hexstr, nonce: int, bits: str, previousblockhash: uint256 = None, time: datetime.datetime)

A pydantic model representing the block header.

version: int: The version of the block.

merkleroot: hexstr: The merkle root of the block.

nonce: int: The nonce.

bits: str: The block’s bits.

previous_blockhash: Optional[uint256]: The previous blockhash.

time: datetime.datetime: The time of the block.

ConnectedPeerModel

class ConnectedPeerModel(*, version: str, remoteSocketEndpoint: str, tipHeight: int)

A pydantic model representing a connected peer.

version: str: The connectedpeer’s version.

remote_socket_endpoint: str: The connected peer’s remote socket endpoint.

tip_height: int: The connected peer’s tip height.

FeaturesDataModel

class FeaturesDataModel(*, namespace: str, state: FeatureInitializationState)

A pydantic model for features data.

namespace: str: The feature namespace.

state: FeatureInitializationState: The feature initialization state.

GetTxOutModel

class GetTxOutModel(*, bestblock: uint256, confirmations: int, value: Money, scriptPubKey: ScriptPubKey, coinbase: bool)

A pydantic model for get tx out response.

best_block: uint256: The highest block where utxo was present.

confirmations: int: The numberof confirmations.

value: Money: The value of the utxo.

script_pubkey: ScriptPubKey: The utxo scriptpubkey.

coinbase: bool: If true, the utxo originated as a coinbase transaction.

StatusModel

class StatusModel(*, agent: str, version: str, externalAddress: str, network: str, coinTicker: str, processId: str, consensusHeight: int = None, blockStoreHeight: int, bestPeerHeight: int = None, inboundPeers: List[ConnectedPeerModel], outboundPeers: List[ConnectedPeerModel], featuresData: List[FeaturesDataModel], dataDirectoryPath: str, runningTime: str, difficulty: float = None, protocolVersion: int, testnet: bool, relayFee: Money, state: FullNodeState, inIbd: bool, headerHeight: int)

A pydantic model for node status information.

agent: str: The node’s agent string.

version: str: The node version.

external_address: str: The node external address.

network: str: The network.

coin_ticker: str: The ticker string of the current network’s coin.

process_id: str: The process id of the node.

consensus_height: Optional[int]: The current consensus height.

blockstore_height: int: The current blockstore height.

best_peer_height: Optional[int]: The highest block height among connected peers.

inbound_peers: List[ConnectedPeerModel]: A list of inbound connected peers.

outbound_peers: List[ConnectedPeerModel]: A list of outbound connected peers.

features_data: List[FeaturesDataModel]: A list of features active on the node.

data_directory_path: str: The path to the node’s data directory.

running_time: str: The node’s current running time.

difficulty: Optional[float]: The current difficulty, if applicable.

protocol_version: int: The current protocol version.

testnet: bool: If true, node is on testnet.

relay_fee: Money: The network transaction relay fee.

state: FullNodeState: The node state model.

in_ibd: bool: If true, the node is in IBD state.

header_height: int: The header height.

TransactionModel

class TransactionModel(*, hex: hexstr, txid: uint256, hash: uint256, version: int, size: int, vsize: int, weight: int, locktime: int, vin: List[VIn], vout: List[VOut], blockhash: uint256 = None, confirmations: int = None, time: datetime.datetime = None, blocktime: datetime.datetime = None)

A pydantic model for a transaction.

hex: hexstr: The transaction hex.

txid: uint256: The transaction hash.

hash: uint256: The transaction hash.

version: int: The transaction version.

size: int: The transaction size.

vsize: int: The transaction vsize.

weight: int: The transaction weight.

locktime: int: The transaction locktime.

vin: List[VIn]: A list of VIn.

vout: List[VOut]: A list of VOut.

blockhash: Optional[uint256]: The hash of the block containing the transaction.

confirmations: Optional[int]: The number of confirmations of the transaction.

time: Optional[datetime.datetime]: The transaction time.

blocktime: Optional[datetime.datetime]: The blocktime.

ValidateAddressModel

class ValidateAddressModel(*, isvalid: bool, address: Address, scriptPubKey: str, isscript: bool, iswitness: bool)

A pydantic model for address validation.

isvalid: bool: True if the address is valid.

address: Address: The address.

scriptPubKey: str: The scriptPubKey.

isscript: bool: True if is a script address.

iswitness: bool: True if is a witness address.

Notifications

class Notifications(**kwargs)

Implements the notifications api endpoints.

sync(sync_from: Union[uint256, str], **kwargs) → None

Begin synchronizing the chain from the provided block height or block hash.

Parameters

sync_from (uint256, str) – The block hash to start syncing at.
**kwargs – Extra keyword arguments.

Returns

None

Raises

APIError – Error thrown by node API. See message for details.

RPC

class RPC(**kwargs)

Implements the rpc api endpoints.

call_by_name(command: str, **kwargs) → RPCCommandResponseModel

Calls the specified RPC command.

Parameters

command (str) – The complete RPC command.
**kwargs – Extra keyword arguments.

Returns

The command output.

Return type

The RPCCommandResponse

Raises

APIError – Error thrown by node API. See message for details.

list_methods(**kwargs) → List[RPCCommandListModel]

List available RPC call methods on this node.

Parameters: **kwargs – Extra keyword arguments.
Returns: A list of valid RPC commands.
Return type: List[RPCCommandListModel]
Raises: APIError – Error thrown by node API. See message for details.

RPCCommandListModel

class RPCCommandListModel(*, command: str, description: str)

A pydantic model for a RPC command.

command: str: The RPC command.

description: str: The command description.

RPCCommandResponseModel

class RPCCommandResponseModel(*, value: dict)

A pydantic model for a RPC response.

value: dict: The response.

SignalR

class SignalR(**kwargs)

Implements the signalr api endpoints.

get_connection_info(**kwargs) → GetConnectionInfoModel

Returns the signalr connection info.

Parameters: **kwargs – Extra keyword arguments.
Returns: Information on the SignalR service.
Return type: GetConnectionInfoModel
Raises: APIError – Error thrown by node API. See message for details.

GetConnectionInfoModel

class GetConnectionInfoModel(*, signalRUri: str, signalRPort: int)

A pydantic model for SignalR connection information.

signalr_uri: str: The SignalR uri.

signalr_port: int: The SignalR port.

SmartContracts

class SmartContracts(**kwargs)

Implements the smartcontracts api endpoints.

code(address: Union[Address, str], **kwargs) → GetCodeModel

Gets the bytecode for a smart contract as a hexadecimal string.

Parameters

address (Address, str) – The smart contract address containing the contract bytecode.
**kwargs – Extra keyword arguments.

Returns

The smart contract code.

Return type

GetCodeModel

Raises

APIError – Error thrown by node API. See message for details.

balance(address: Union[Address, str], **kwargs) → Money

Gets the balance of a smart contract in strax or sidechain coin.

Parameters

address (Address, str) – The smart contract address.
**kwargs – Extra keyword arguments.

Returns

The smart contract balance.

Return type

BuildCreateContractTransactionModel

Raises

APIError – Error thrown by node API. See message for details.

storage(contract_address: Union[Address, str], storage_key: str, data_type: int, **kwargs) → Union[bool, bytes, str, uint32, uint64, int32, int64, Address, bytearray, uint128, uint256]

Gets a single piece of smart contract data. Returns a serialized string, if exists.

Parameters

contract_address (Address, str) – The smart contract address being called.
storage_key (str) – The key in the key-value store.
data_type – The data type. Allowed values: [1,12]
**kwargs – Extra keyword arguments.

Returns

The smart contract information retrieved from storage.

Return type

Union[bool, bytes, str, uint32, uint64, int32, int64, Address, bytearray, uint128, uint256]

Raises

APIError – Error thrown by node API. See message for details.
RuntimeError –

receipt(tx_hash: Union[uint256, str], **kwargs) → ReceiptModel

Gets a smart contract transaction receipt.

Parameters

tx_hash (uint256, str) – The transaction hash of the smart contract receipt.
**kwargs – Extra keyword arguments.

Returns

The smart contract transaction receipt.

Return type

ReceiptModel

Raises

APIError – Error thrown by node API. See message for details.

receipt_search(contract_address: Union[Address, str], topics: Optional[List[str]] = None, event_name: Optional[str] = None, from_block: int = 0, to_block: Optional[int] = None, **kwargs) → List[ReceiptModel]

Searches a smart contract’s receipts for those which match a specific event.

Parameters

contract_address (Address, str) – The address for the smart contract.
event_name (str, optional) – The event to search for.
topics (List[str], optional) – A list of topics to search for.
from_block (int) – Block to start search from.
to_block (int, optional) – Block to search up to.
**kwargs – Extra keyword arguments.

Returns

A list of receipts.

Return type

List[ReceiptModel]

Raises

APIError – Error thrown by node API. See message for details.

build_create(wallet_name: str, fee_amount: Union[Money, int, float, decimal.Decimal], password: str, contract_code: Union[hexstr, str], gas_price: int, gas_limit: int, sender: Union[Address, str], amount: Union[Money, int, float, decimal.Decimal], outpoints: Optional[List[Outpoint]] = None, account_name: str = 'account 0', parameters: Optional[List[Union[str, SmartContractParameter]]] = None, **kwargs) → BuildCreateContractTransactionModel

Builds a transaction to create a smart contract.

Parameters

wallet_name (str) – The wallet name.
account_name (str, optional) – The wallet name. Default=’account 0’
outpoints (List[Outpoint], optional) – A list of the outpoints used to construct the transactation.
amount (Money, int, float, Decimal, optional) – The amount being sent.
fee_amount (Money, int, float, Decimal) – The fee amount.
password (SecretStr) – The password.
contract_code (hexstr, str) – The smart contract code hexstring.
gas_price (int) – The amount of gas being used in satoshis.
gas_limit (int) – The maximum amount of gas that can be used in satoshis.
sender (Address, str) – The address of the sending address.
parameters (List[Union[SmartContractParameter, str], optional) – A list of parameters for the smart contract.
**kwargs – Extra keyword arguments.

Returns

A built create smart contract transaction.

Return type

Raises

APIError – Error thrown by node API. See message for details.

build_call(wallet_name: str, fee_amount: Union[Money, int, float, decimal.Decimal], password: str, contract_address: Union[Address, str], method_name: str, gas_price: int, gas_limit: int, sender: Union[Address, str], amount: Optional[Union[Money, int, float, decimal.Decimal]] = None, outpoints: Optional[List[Outpoint]] = None, account_name: str = 'account 0', parameters: Optional[List[Union[str, SmartContractParameter]]] = None, **kwargs) → BuildContractTransactionModel

Builds a transaction to call a smart contract method.

Parameters

wallet_name (str) – The wallet name.
account_name (str, optional) – The wallet name. Default=’account 0’
outpoints (List[Outpoint], optional) – A list of the outpoints used to construct the transactation.
contract_address (Address, str) – The smart contract address being called.
method_name (str) – The method name being called.
amount (Money, int, float, Decimal, optional) – The amount being sent.
fee_amount (Money, int, float, Decimal) – The fee amount.
password (SecretStr) – The password.
gas_price (int) – The amount of gas being used in satoshis.
gas_limit (int) – The maximum amount of gas that can be used in satoshis.
sender (Address, str) – The address of the sending address.
parameters (List[Union[SmartContractParameter, str]], optional) – A list of parameters for the smart contract.
**kwargs – Extra keyword arguments.

Returns

A built smart contract transaction.

Return type

Raises

APIError – Error thrown by node API. See message for details.

build_transaction(sender: Union[Address, str], password: str, wallet_name: str, recipients: List[Recipient], op_return_data: Optional[str] = None, outpoints: Optional[List[Outpoint]] = None, op_return_amount: Optional[Union[Money, int, float, decimal.Decimal]] = None, fee_type: Optional[str] = None, allow_unconfirmed: bool = False, shuffle_outputs: bool = False, change_address: Optional[Union[Address, str]] = None, account_name: str = 'account 0', segwit_change_address: bool = False, fee_amount: Optional[Union[Money, int, float, decimal.Decimal]] = None, **kwargs) → BuildContractTransactionModel

Build a transaction to transfer funds on a smart contract network.

Parameters

sender (Address) – The sender address.
fee_amount (Money, int, float, Decimal, optional) – The fee amount.
password (SecretStr) – The password.
segwit_change_address (bool, optional) – If the change address is a segwit address. Default=False.
wallet_name (str) – The wallet name.
account_name (str, optional) – The account name. Default=’account 0’.
outpoints (List[Outpoint]) – A list of the outpoints used to construct the transactation.
recipients (List[Recipient]) – A list of the recipients, including amounts, for the transaction.
op_return_data (str, optional) – OP_RETURN data to include with the transaction.
op_return_amount (Money, int, float, Decimal, optional) – Amount to burn in the OP_RETURN transaction.
fee_type (str, optional) – low, medium, or high.
allow_unconfirmed (bool, optional) – If True, allow unconfirmed transactions in the estimation. Default=False
shuffle_outputs (bool, optional) – If True, shuffles outputs. Default=False.
change_address (Address, optional) – Sends output sum less amount sent to recipients to this designated change address, if provided.
**kwargs – Extra keyword arguments.

Returns

A built smart contract transaction.

Return type

Raises

APIError – Error thrown by node API. See message for details.

estimate_fee(sender: Union[Address, str], wallet_name: str, recipients: List[Recipient], fee_type: str, outpoints: Optional[List[Outpoint]] = None, allow_unconfirmed: bool = False, shuffle_outputs: bool = False, op_return_data: Optional[str] = None, op_return_amount: Optional[Union[Money, int, float, decimal.Decimal]] = None, account_name: str = 'account 0', change_address: Optional[Union[Address, str]] = None, **kwargs) → Money

Gets a fee estimate for a specific smart contract account-based transfer transaction.

Parameters

sender (Address, str) – The sender address.
wallet_name (str) – The wallet name.
account_name (str, optional) – The account name. Default=’account 0’.
outpoints (List[Outpoint], optional) – A list of the outpoints used to construct the transactation.
recipients (List[Recipient]) – A list of the recipients, including amounts, for the transaction.
op_return_data (str, optional) – OP_RETURN data to include with the transaction.
op_return_amount (Money, int, float, Decimal, optional) – Amount to burn in the OP_RETURN transaction.
fee_type (str, optional) – low, medium, or high.
allow_unconfirmed (bool, optional) – If True, allow unconfirmed transactions in the estimation. Default=False
shuffle_outputs (bool, optional) – If True, shuffles outputs. Default=False.
change_address (Address, str, optional) – Sends output sum less amount sent to recipients to this designated change address, if provided.
**kwargs – Extra keyword arguments.

Returns

The fee estimate.

Return type

BuildCreateContractTransactionModel

Raises

APIError – Error thrown by node API. See message for details.

build_and_send_create(wallet_name: str, fee_amount: Union[Money, int, float, decimal.Decimal], password: str, contract_code: Union[hexstr, str], gas_price: int, gas_limit: int, sender: Union[Address, str], amount: Optional[Union[Money, int, float, decimal.Decimal]] = None, outpoints: Optional[List[Outpoint]] = None, account_name: str = 'account 0', parameters: Optional[List[Union[str, SmartContractParameter]]] = None, **kwargs) → BuildCreateContractTransactionModel

Builds a transaction to create a smart contract and then broadcasts.

Parameters

wallet_name (str) – The wallet name.
account_name (str, optional) – The wallet name. Default=’account 0’
outpoints (List[Outpoint], optional) – A list of the outpoints used to construct the transactation.
amount (Money, int, float, Decimal, optional) – The amount being sent.
fee_amount (Money, int, float, Decimal) – The fee amount.
password (SecretStr) – The password.
contract_code (hexstr, str) – The smart contract code hexstring.
gas_price (int) – The amount of gas being used in satoshis.
gas_limit (int) – The maximum amount of gas that can be used in satoshis.
sender (Address, str) – The address of the sending address.
parameters (List[Union[SmartContractParameter, str]], optional) – A list of parameters for the smart contract.
**kwargs – Extra keyword arguments.

Returns

A built create smart contract transaction.

Return type

Raises

APIError – Error thrown by node API. See message for details.

build_and_send_call(wallet_name: str, fee_amount: Union[Money, int, float, decimal.Decimal], password: str, contract_address: Union[Address, str], method_name: str, gas_price: int, gas_limit: int, sender: Union[Address, str], amount: Optional[Union[Money, int, float, decimal.Decimal]] = None, outpoints: Optional[List[Outpoint]] = None, account_name: str = 'account 0', parameters: Optional[List[Union[str, SmartContractParameter]]] = None, **kwargs) → BuildContractTransactionModel

Builds a transaction to call a smart contract method and then broadcasts.

Parameters

wallet_name (str) – The wallet name.
account_name (str, optional) – The wallet name. Default=’account 0’
outpoints (List[Outpoint], optional) – A list of the outpoints used to construct the transactation.
contract_address (Address, str) – The smart contract address being called.
method_name (str) – The method name being called.
amount (Money, int, float, Decimal, optional) – The amount being sent.
fee_amount (Money, int, float, Decimal) – The fee amount.
password (SecretStr) – The password.
gas_price (int) – The amount of gas being used in satoshis.
gas_limit (int) – The maximum amount of gas that can be used in satoshis.
sender (Address, str) – The address of the sending address.
parameters (List[Union[SmartContractParameter, str]], optional) – A list of parameters for the smart contract.
**kwargs – Extra keyword arguments.

Returns

A built smart contract transaction.

Return type

LocalExecutionResultModel

Raises

APIError – Error thrown by node API. See message for details.

local_call(contract_address: Union[Address, str], method_name: str, amount: Union[Money, int, float, decimal.Decimal], gas_price: int, gas_limit: int, sender: Union[Address, str], block_height: Optional[int] = None, parameters: Optional[List[Union[str, SmartContractParameter]]] = None, **kwargs) → LocalExecutionResultModel

Makes a local call to a method on a smart contract that has been successfully deployed. The purpose is to query and test methods.

Parameters

contract_address (Address, str) – The smart contract address being called.
method_name (str) – The smart contract method being called.
amount (Money, int, float, Decimal) – The amount being sent.
gas_price (int) – The amount of gas being used in satoshis.
gas_limit (int) – The maximum amount of gas that can be used in satoshis.
sender (Address, str) – The address of the sending address.
block_height (int, optional) – The height at which to query the contract’s state. If unset, will default to the current chain tip.
parameters (List[Union[SmartContractParameter, str]], optional) – A list of parameters for the smart contract.
**kwargs – Extra keyword arguments.

Returns

The results of a local contract execution.

Return type

Raises

APIError – Error thrown by node API. See message for details.

address_balances(wallet_name: str, **kwargs) → List[AddressBalanceModel]

Gets all addresses owned by a wallet which have a balance associated with them.

Parameters

wallet_name (str) – The wallet name.
**kwargs – Extra keyword arguments.

Returns

A list of addresses with balance information.

Return type

List[AddressBalanceModel]

Raises

APIError – Error thrown by node API. See message for details.

AddressBalanceModel

class AddressBalanceModel(*, address: Address, sum: Money)

A pydantic model for an address balance.

address: Address: The address.

sum: Money: The amount present at the address.

BuildContractTransactionModel

class BuildContractTransactionModel(*, fee: Money, hex: hexstr, message: str = None, success: bool = None, transactionId: uint256 = None)

A pydantic model for building a smart contact transaction.

fee: Money: The transaction fee.

hex: hexstr: The hex serialized transaction.

message: Optional[str]: The build transaction message.

success: Optional[bool]: True if build was successful.

transaction_id: Optional[uint256]: The transaction hash, if build successful.

BuildCreateContractTransactionModel

class BuildCreateContractTransactionModel(*, fee: Money, hex: hexstr, message: str = None, success: bool = None, transactionId: uint256 = None, newContractAddress: Address)

A pydantic model for a create smart contact transaction.

new_contract_address: Address: The new address associated with the smart contract.

fee: Money: The transaction fee.

hex: hexstr: The hex serialized transaction.

message: Optional[str]: The build transaction message.

success: Optional[bool]: True if build was successful.

transaction_id: Optional[uint256]: The transaction hash, if build successful.

GetCodeModel

class GetCodeModel(*, type: str, bytecode: str, csharp: str, message: str = None)

A pydantic model for the smart contact code request.

type: str: The code type.

bytecode: str: The contract bytecode.

csharp: str: The csharp code.

message: Optional[str]: A message from response.

LocalExecutionResultModel

class LocalExecutionResultModel(*, internalTransfers: List[pystratis.api.smartcontracts.responsemodels.transferinfomodel.TransferInfoModel] = None, gasConsumed: int, revert: bool = None, errorMessage: str = None, return: Any = None, logs: List[pystratis.api.smartcontracts.responsemodels.logmodel.LogModel] = None)

A pydantic model representing the result of a local smart contact execution call.

internal_transfers: Optional[List[TransferInfoModel]]: A list of internal transfers.

gas_consumed: int: The amount of gas consumed by the call.

revert: Optional[bool]: If true, call was not successful.

error_message: Optional[str]: An error message, if thrown.

return_obj: Optional[Any]: An optional return object.

logs: Optional[List[LogModel]]: An optional list of logs returned.

LogModel

class LogModel(*, address: Address = None, topics: List[str] = None, data: str = None, log: dict = None)

A pydantic model of a smart contact log.

address: Optional[Address]: The smart contact address.

topics: Optional[List[str]]: A list of topics.

data: Optional[str]: Log data.

log: Optional[dict]: Log dict object response.

ReceiptModel

class ReceiptModel(*, transactionHash: pystratis.core.types.uint256.uint256, blockHash: pystratis.core.types.uint256.uint256, postState: pystratis.core.types.uint256.uint256 = None, gasUsed: int = None, from: pystratis.core.types.address.Address = None, to: pystratis.core.types.address.Address = None, newContractAddress: pystratis.core.types.address.Address = None, success: bool, returnValue: str = None, bloom: pystratis.core.types.hexstr.hexstr = None, error: str = None, logs: List[pystratis.api.smartcontracts.responsemodels.logmodel.LogModel] = None, blockNumber: int)

A pydantic model of a smart contact receipt.

transaction_hash: uint256: The transaction hash.

block_hash: uint256: The hash of the block containing the transaction.

post_state: Optional[uint256]: The smart contact state after execution.

gas_used: Optional[int]: The amount of gas used.

from_address: Optional[Address]: Sending address, if applicable.

to_address: Optional[Address]: Receiving address, if applicable.

new_contract_address: Optional[Address]: A new contract address, if creation transaction.

success: bool: True if transaction successful.

return_value: Optional[str]: Transaction return value, if applicable.

bloom: Optional[hexstr]: The bloom filter.

error: Optional[str]: Error message, if present.

logs: Optional[List[LogModel]]: Smart contact log model data, if present.

block_number: int: The block number.

TransferInfoModel

class TransferInfoModel(*, from: pystratis.core.types.address.Address, to: pystratis.core.types.address.Address, value: pystratis.core.types.money.Money)

A pydantic model of a smart contact transfer.

from_address: Address: The sending address.

to_address: Address: The receiving address.

value: Money: The amount sent.

SmartContractWallet

class SmartContractWallet(**kwargs)

Implements the smartcontractwallet api endpoints.

account_addresses(wallet_name: str, **kwargs) → List[Address]

Gets a smart contract account address.

Parameters

wallet_name (str) – The wallet name.
**kwargs – Extra keyword arguments.

Returns

A list of smart contract addresses.

Return type

List[Address]

Raises

APIError – Error thrown by node API. See message for details.

address_balance(address: Union[Address, str], **kwargs) → Money

Gets the balance at a specific wallet address in STRAX (or the sidechain coin).

Parameters

address (Address, str) – The smart contract address being queried.
**kwargs – Extra keyword arguments.

Returns

The smart contract address balance.

Return type

Raises

APIError – Error thrown by node API. See message for details.

history(wallet_name: str, address: Union[Address, str], skip: int = 0, take: Optional[int] = None, **kwargs) → List[ContractTransactionItemModel]

Gets the history of a specific smart contract wallet address.

Parameters

wallet_name (str) – The wallet name.
address (Address, str) – The address to query the history.
skip (int, optional) – Skip this many items. Default=0.
take (int, optional) – Take this many items.
**kwargs – Extra keyword arguments.

Returns

A history of a smart contract wallet address.

Return type

List[ContractTransactionItemModel]

Raises

APIError – Error thrown by node API. See message for details.

create(wallet_name: str, fee_amount: Union[Money, int, float, decimal.Decimal], password: str, contract_code: Union[hexstr, str], gas_price: int, gas_limit: int, sender: Union[Address, str], amount: Optional[Union[Money, int, float, decimal.Decimal]] = None, outpoints: Optional[List[Outpoint]] = None, account_name: str = 'account 0', parameters: Optional[List[str]] = None, **kwargs) → uint256

Builds a transaction to create a smart contract and then broadcasts the transaction to the network.

Parameters

wallet_name (str) – The wallet name.
account_name (str, optional) – The wallet name. Default=’account 0’
outpoints (List[Outpoint], optional) – A list of the outpoints used to construct the transactation.
amount (Money, int, float, Decimal, optional) – The amount being sent.
fee_amount (Money, int, float, Decimal) – The fee amount.
password (SecretStr) – The password.
contract_code (hexstr, str) – The smart contract code hexstring.
gas_price (int) – The amount of gas being used in satoshis.
gas_limit (int) – The maximum amount of gas that can be used in satoshis.
sender (Address, str) – The address of the sending address.
parameters (List[Union[SmartContractParameter, str], optional) – A list of parameters for the smart contract.
**kwargs – Extra keyword arguments.

Returns

The transaction hash.

Return type

Raises

APIError – Error thrown by node API. See message for details.

call(wallet_name: str, fee_amount: Union[Money, int, float, decimal.Decimal], password: str, contract_address: Union[Address, str], method_name: str, gas_price: int, gas_limit: int, sender: Union[Address, str], amount: Union[Money, int, float, decimal.Decimal], outpoints: Optional[List[Outpoint]] = None, account_name: str = 'account 0', parameters: Optional[List[str]] = None, **kwargs) → BuildContractTransactionModel

Builds a transaction to call a smart contract method and then broadcasts the transaction to the network.

Parameters

wallet_name (str) – The wallet name.
account_name (str, optional) – The wallet name. Default=’account 0’
outpoints (List[Outpoint], optional) – A list of the outpoints used to construct the transactation.
contract_address (Address, str) – The smart contract address being called.
method_name (str) – The method name being called.
amount (Money, int, float, Decimal, optional) – The amount being sent.
fee_amount (Money, int, float, Decimal) – The fee amount.
password (SecretStr) – The password.
gas_price (int) – The amount of gas being used in satoshis.
gas_limit (int) – The maximum amount of gas that can be used in satoshis.
sender (Address, str) – The address of the sending address.
parameters (List[Union[SmartContractParameter, str]], optional) – A list of parameters for the smart contract.
**kwargs – Extra keyword arguments.

Returns

A built smart contract transaction.

Return type

WalletSendTransactionModel

Raises

APIError – Error thrown by node API. See message for details.

send_transaction(transaction_hex: Union[hexstr, str], **kwargs) → WalletSendTransactionModel

Broadcasts a transaction, which either creates a smart contract or calls a method on a smart contract.

Parameters

transaction_hex (hexstr, str) – The transaction hex string.
**kwargs – Extra keyword arguments.

Returns

Information about the sent transaction.

Return type

Raises

APIError – Error thrown by node API. See message for details.

BuildContractTransactionModel

class BuildContractTransactionModel(*, fee: Money, hex: hexstr, message: str = None, success: bool = None, transactionId: uint256 = None)

A pydantic model for building a smart contact transaction.

fee: Money: The transaction fee.

hex: hexstr: The hex serialized transaction.

message: Optional[str]: The build transaction message.

success: Optional[bool]: True if build was successful.

transaction_id: Optional[uint256]: The transaction hash, if build successful.

ContractTransactionItemModel

class ContractTransactionItemModel(*, blockHeight: int, type: ContractTransactionItemType, hash: uint256, to: Address, amount: Money, transactionFee: Money, gasFee: Money)

A pydantic model representing a contract transaction.

block_height: int: The block height of block containing the transaction.

item_type: ContractTransactionItemType: The contract transaction item type.

hash: uint256: The transaction hash.

to_address: Address: The to address of the contact.

amount: Money: The transaction amount.

transaction_fee: Money: The transaction fee.

gas_fee: Money: The transaction’s gas fee.

TransactionOutputModel

class TransactionOutputModel(*, address: Optional[Union[int, Address]] = None, amount: Money, opReturnData: str = None)

A pydantic model of a transaction output.

address: Optional[Union[int, Address]]: The address receiving the output.

amount: Money: The output amount.

op_return_data: Optional[str]: The OP_RETURN data, if present.

WalletSendTransactionModel

class WalletSendTransactionModel(*, transactionId: uint256, outputs: List[TransactionOutputModel])

A pydantic model for a send transaction response.

transaction_id: uint256: The transaction hash.

outputs: List[TransactionOutputModel]: A list of transaction outputs.

Staking

class Staking(**kwargs)

Implements the staking api endpoints.

get_staking_info(**kwargs) → GetStakingInfoModel

Gets current staking information.

Parameters: **kwargs – Extra keyword arguments.
Returns: Information about current staking status.
Return type: GetStakingInfoModel
Raises: APIError – Error thrown by node API. See message for details.

start_staking(name: str, password: str, **kwargs) → None

Start staking

Parameters

name (str) – The wallet name.
password (str) – The wallet password.
**kwargs – Extra keyword arguments.

Returns

None

Raises

APIError – Error thrown by node API. See message for details.

start_multistaking(wallet_credentials: List[WalletSecret], **kwargs) → None

Start staking for multiple wallets simultaneously

Parameters

wallet_credentials (List[WalletSecret]) – A list of wallet credentials to launch staking of multiple wallets with one command.
**kwargs – Extra keyword arguments.

Returns

None

Raises

APIError – Error thrown by node API. See message for details.

stop_staking(**kwargs) → None

Stop staking.

Parameters: **kwargs – Extra keyword arguments.
Returns: None
Raises: APIError – Error thrown by node API. See message for details.

GetStakingInfoModel

class GetStakingInfoModel(*, enabled: bool, staking: bool, errors: str = None, currentBlockSize: int, currentBlockTx: int, pooledTx: int, difficulty: float, searchInterval: int, weight: int, netStakeWeight: int = None, immature: int, expectedTime: int)

A pydantic model for staking information.

enabled: bool: If true, staking is enabled.

staking: bool: If true, is currently staking.

errors: Optional[str]: Error messages, if present.

current_blocksize: int: The current block size.

current_block_tx: int: The current number of block transactions.

pooled_tx: int: The number of pooled transactions.

difficulty: float: The current difficulty.

search_interval: int: The search interval.

weight: int: The current staking weight.

net_stake_weight: Optional[int]: The network staking weight.

immature: int: The number of immature coins that can’t stake.

expected_time: int: The expected number of seconds between stakes.

Voting

class Voting(**kwargs)

Implements the voting api endpoints.

pending_polls(vote_type: int, pubkey_of_member_being_voted_on: Union[hexstr, str], **kwargs) → List[PollViewModel]

Gets a list of pending polls.

Parameters

vote_type (VoteKey, optional) – The type of vote to query.
pubkey_of_member_being_voted_on (PubKey, optional) – The pubkey to query.
**kwargs – Extra keyword arguments.

Returns

A list of pending polls.

Return type

List[PollViewModel]

Raises

APIError – Error thrown by node API. See message for details.

finished_polls(vote_type: int, pubkey_of_member_being_voted_on: Union[hexstr, str], **kwargs) → List[PollViewModel]

Gets a list of finished polls.

Parameters

vote_type (VoteKey, optional) – The type of vote to query.
pubkey_of_member_being_voted_on (PubKey, optional) – The pubkey to query.
**kwargs – Extra keyword arguments.

Returns

A list of finished polls.

Return type

List[PollViewModel]

Raises

APIError – Error thrown by node API. See message for details.

executed_polls(vote_type: int, pubkey_of_member_being_voted_on: Union[hexstr, str], **kwargs) → List[PollViewModel]

Gets a list of executed polls.

Parameters

vote_type (VoteKey, optional) – The type of vote to query.
pubkey_of_member_being_voted_on (hexstr, str, optional) – The pubkey to query.
**kwargs – Extra keyword arguments.

Returns

A list of executed polls.

Return type

List[PollViewModel]

Raises

APIError – Error thrown by node API. See message for details.

whitelisted_hashes(**kwargs) → List[WhitelistedHashesModel]

Gets a list of whitelisted hashes.

Parameters: **kwargs – Extra keyword arguments.
Returns: A list of whitelisted hashes.
Return type: List[WhitelistedhashesModel]
Raises: APIError – Error thrown by node API. See message for details.

schedulevote_whitelisthash(hash_id: Union[uint256, str], **kwargs) → None

Vote to add a hash from whitelist.

Parameters

hash_id (uint256, str) – The hash to whitelist.
**kwargs – Extra keyword arguments.

Returns

None

Raises

APIError – Error thrown by node API. See message for details.

schedulevote_removehash(hash_id: Union[uint256, str], **kwargs) → None

Vote to remove a hash from whitelist.

Parameters

hash_id (uint256, str) – The hash to remove.
**kwargs – Extra keyword arguments.

Returns

None

Raises

APIError – Error thrown by node API. See message for details.

schedulevote_kickmember(pubkey: Union[hexstr, str], **kwargs) → None

Vote to remove a hash from whitelist.

Parameters

pubkey (hexstr, str) – The pubkey to vote on kicking.
**kwargs – Extra keyword arguments.

Returns

None

Raises

APIError – Error thrown by node API. See message for details.

scheduled_votes(**kwargs) → List[VotingDataModel]

Gets the scheduled voting data.

Parameters: **kwargs – Extra keyword arguments.
Returns: A list of voting data.
Return type: List[VotingDataModel]
Raises: APIError – Error thrown by node API. See message for details.

polls_tip(**kwargs) → int

Gets the tip of the polls repository.

Parameters: **kwargs – Extra keyword arguments.
Returns: The pols repository tip.
Return type: int
Raises: APIError – Error thrown by node API. See message for details.

PollViewModel

class PollViewModel(*, IsPending: bool, IsExecuted: bool, Id: int, PollVotedInFavorBlockDataHash: uint256 = None, PollVotedInFavorBlockDataHeight: int = None, PollStartFavorBlockDataHash: uint256 = None, PollStartFavorBlockDataHeight: int = None, PollExecutedBlockDataHash: uint256 = None, PollExecutedBlockDataHeight: int = None, PubKeysHexVotedInFavor: List[PubKey], VotingDataString: str)

A pydantic model for polling data.

is_pending: bool: If true, poll is pending.

is_executed: bool: If true, poll has been executed.

poll_id: int: The poll id.

poll_voted_in_favor_blockdata_hash: Optional[uint256]: If voted in favor, the block of the vote.

poll_voted_in_favor_blockdata_height: Optional[int]: If voted in favor, the height of the block.

poll_start_favor_blockdata_hash: Optional[uint256]: The block hash when polling started.

poll_start_favor_blockdata_height: Optional[int]: The block height when polling started.

poll_executed_blockdata_hash: Optional[uint256]: The block hash when poll was executed, if executed.

poll_executed_blockdata_height: Optional[int]: The block height when poll was executed, if executed.

pubkeys_hex_voted_in_favor: List[PubKey]: A list of pubkeys voting in favor of poll.

voting_data_string: str: Voting data.

VotingDataModel

class VotingDataModel(*, key: PubKey, hash: uint256)

A pydantic model representing voting data.

key: PubKey: The pubkey.

hash: uint256: The hash voted upon.

WhitelistedHashesModel

class WhitelistedHashesModel(*, hash: uint256)

A pydantic model for a whitelisted hash.

hash: uint256: A whitelisted hash.

Wallet

class Wallet(**kwargs)

Implements the wallet api endpoints.

mnemonic(language: str = 'English', word_count: int = 12, **kwargs) → List[str]

Generates a mnemonic to use for an HD wallet. For more information about mnemonics, see BIP39.

Parameters

language (str) – The language used to generate mnemonic.
word_count (int) – Count of words needs to be generated.
**kwargs – Extra keyword arguments.

Returns

The generated mnemonic.

Return type

List[str]

Raises

APIError – Error thrown by node API. See message for details.

create(name: str, password: str, passphrase: str, mnemonic: Optional[str] = None, **kwargs) → List[str]

Creates a new wallet on this full node.

Parameters

mnemonic (str, optional) – The mnemonic used to create a HD wallet. If not specified, it will be randomly generated underhood.
password (str) – The password for a wallet to be created.
passphrase (str) – The passphrase used in master key generation.
name – (str): The name for a wallet to be created.
**kwargs – Extra keyword arguments.

Returns

The mnemonic used to generate this HD wallet.

Return type

List[str]

Raises

APIError – Error thrown by node API. See message for details.

sign_message(wallet_name: str, password: str, external_address: Union[Address, str], message: str, **kwargs) → str

Signs a message and returns the signature.

Parameters

wallet_name (str) – The name of the wallet to sign message with.
password (str) – The password of the wallet to sign message with.
external_address (Address, str) – The external address of a private key used to sign message.
message (str) – The message to be signed.
**kwargs – Extra keyword arguments.

Returns

The signature of the message.

Return type

str

Raises

APIError – Error thrown by node API. See message for details.

pubkey(wallet_name: str, external_address: Union[Address, str], **kwargs) → PubKey

Gets the public key for an address.

Parameters

wallet_name (str) – The name of the wallet to search for pubkey in.
external_address (Address, str) – The external address of a wanted pubkey.
**kwargs – Extra keyword arguments.

Returns

The requested public key.

Return type

PubKey

Raises

APIError – Error thrown by node API. See message for details.

verify_message(signature: str, external_address: Union[Address, str], message: str, **kwargs) → bool

Verifies the signature of a message.

Parameters

signature (str) – The signature to be verified.
external_address (Address, str) – The address of the signer.
message (str) – The message that was signed.
**kwargs – Extra keyword arguments.

Returns

True if signature is verified, False otherwise.

Return type

bool

Raises

APIError – Error thrown by node API. See message for details.

load(name: str, password: str, **kwargs) → None

Loads a previously created wallet.

Parameters

name (str) – The wallet name to load.
password (str) – The wallet password.
**kwargs – Extra keyword arguments.

Returns

None

Raises

APIError – Error thrown by node API. See message for details.

recover(mnemonic: str, password: str, passphrase: str, name: str, creation_date: Optional[str] = None, **kwargs) → None

Recovers an existing wallet.

Parameters

mnemonic (str) – A mnemonic for initializing a wallet.
password (str) – The password for the wallet.
passphrase (str) – The passphrase for the wallet.
name (str) – The name for the wallet.
creation_date (str, datetime, optional) – An estimate of the wallet creation date.
**kwargs – Extra keyword arguments.

Returns

None

Raises

APIError – Error thrown by node API. See message for details.

recover_via_extpubkey(extpubkey: Union[ExtPubKey, str, hexstr], account_index: int, name: str, creation_date: str, **kwargs) → None

Recovers a wallet using its extended public key.

Parameters

extpubkey (ExtPubKey, str, hexstr) – The extpubkey for the recovered wallet.
account_index (int) – The account index.
name (str) – The wallet name.
creation_date (str, datetime, optional) – An estimate of the wallet creation date.
**kwargs – Extra keyword arguments.

Returns

None

Raises

APIError – Error thrown by node API. See message for details.

general_info(name: str, **kwargs) → WalletGeneralInfoModel

Gets some general information about a wallet.

Parameters

name (str) – The wallet name.
**kwargs – Extra keyword arguments.

Returns

General information about the wallet.

Return type

WalletGeneralInfoModel

Raises

APIError – Error thrown by node API. See message for details.

transaction_count(wallet_name: str, account_name: str = 'account 0', **kwargs) → int

Get the transaction count for the specified Wallet and Account.

Parameters

wallet_name (str) – The wallet name.
account_name (str, optional) – The account name. Default=’account 0’.
**kwargs – Extra keyword arguments.

Returns

The number of transactions.

Return type

int

Raises

APIError – Error thrown by node API. See message for details.

history(wallet_name: str, account_name: str = 'account 0', address: Optional[Union[Address, str]] = None, skip: int = 0, take: Optional[int] = None, prev_output_tx_time: Optional[int] = None, prev_output_index: Optional[int] = None, search_query: Optional[str] = None, **kwargs) → WalletHistoryModel

Gets the history of a wallet.

Parameters

wallet_name (str) – The wallet name.
account_name (str, optional) – The account name. Default=’account 0’.
address (Address, str, optional) – The address to query the history.
skip (conint(ge=0), optional) – The number of history items to skip.
take (conint(ge=0), optional) – The number of history items to take.
prev_output_tx_time (conint(ge=0), optional) – The previous output transaction time.
prev_output_index (conint(ge=0), optional) – The previous output transaction index.
search_query (str, optional) – A search query.
**kwargs – Extra keyword arguments.

Returns

The wallet history.

Return type

WalletHistoryModel

Raises

APIError – Error thrown by node API. See message for details.

balance(wallet_name: str, account_name: str = 'account 0', include_balance_by_address: bool = False, **kwargs) → WalletBalanceModel

Gets the balance of a wallet in STRAX (or sidechain coin). Both the confirmed and unconfirmed balance are returned.

Parameters

wallet_name (str) – The wallet name.
account_name (str, optional) – The account name. Default=’account 0’.
include_balance_by_address (bool, optional) – If true, includes detailed information about balances by address. Default=False.
**kwargs – Extra keyword arguments.

Returns

The wallet balance.

Return type

WalletBalanceModel

Raises

APIError – Error thrown by node API. See message for details.

received_by_address(address: Union[Address, str], **kwargs) → AddressBalanceModel

Retrieves transactions received by the specified address.

Parameters

address (Address) – The address to query.
**kwargs – Extra keyword arguments.

Returns

The transactions associated with the address.

Return type

AddressBalanceModel

Raises

APIError – Error thrown by node API. See message for details.

max_balance(wallet_name: str, fee_type: str, account_name: str = 'account 0', allow_unconfirmed: bool = False, **kwargs) → MaxSpendableAmountModel

Gets the maximum spendable balance for an account along with the fee required to spend it.

Parameters

wallet_name (str) – The wallet name.
account_name (str, optional) – The account name. Default=’account 0’.
fee_type (str) – The fee type. Allowed [low, medium, high]
allow_unconfirmed (bool, optional) – If True, allow unconfirmed utxo in request. Default=False.
**kwargs – Extra keyword arguments.

Returns

Information about the maximum spendable amount and fee to send.

Return type

MaxSpendableAmountModel

Raises

APIError – Error thrown by node API. See message for details.

spendable_transactions(wallet_name: str, account_name: str = 'account 0', min_confirmations: int = 0, **kwargs) → SpendableTransactionsModel

Gets the spendable transactions for an account with the option to specify how many confirmations a transaction needs to be included.

Parameters

wallet_name (str) – The wallet name.
account_name (str, optional) – The account name. Default=’account 0’.
min_confirmations (int, optional) – Get spendable transactions less this value from chain tip. Default=0.
**kwargs – Extra keyword arguments.

Returns

Spendable transactions.

Return type

SpendableTransactionsModel

Raises

APIError – Error thrown by node API. See message for details.

estimate_txfee(wallet_name: str, outpoints: List[Outpoint], recipients: List[Recipient], op_return_data: Optional[str] = None, op_return_amount: Optional[Money] = None, fee_type: Optional[str] = None, allow_unconfirmed: bool = False, shuffle_outputs: bool = False, change_address: Optional[Address] = None, account_name: str = 'account 0', **kwargs) → Money

Gets a fee estimate for a specific transaction.

Parameters

wallet_name (str) – The wallet name.
account_name (str, optional) – The account name. Default=’account 0’.
outpoints (List[Outpoint]) – A list of outpoints to include in the transaction.
recipients (List[Recipient]) – A list of recipients with amounts.
op_return_data (str, optional) – The OP_RETURN data.
op_return_amount (Money, int, float, Decimal, optional) – The amount to burn in OP_RETURN.
fee_type (str, optional) – The fee type. Allowed [low, medium, high]
allow_unconfirmed (bool, optional) – If True, includes unconfirmed outputs. Default=False.
shuffle_outputs (bool, optional) – If True, shuffle outputs. Default=False.
change_address (Address, str, optional) – Specify a change address. If not set, a new change address is used.
**kwargs – Extra keyword arguments.

Returns

An estimate of the transaction fee.

Return type

Raises

APIError – Error thrown by node API. See message for details.

build_transaction(wallet_name: str, password: str, outpoints: List[Outpoint], recipients: List[Recipient], fee_amount: Optional[Union[Money, int, float, decimal.Decimal]] = None, segwit_change_address: bool = False, op_return_data: Optional[str] = None, op_return_amount: Optional[Union[Money, int, float, decimal.Decimal]] = None, fee_type: Optional[str] = None, allow_unconfirmed: bool = False, shuffle_outputs: bool = False, account_name: str = 'account 0', change_address: Optional[Union[Address, str]] = None, **kwargs) → BuildTransactionModel

Builds a transaction and returns the hex to use when executing the transaction.

Parameters

fee_amount (Money, int, float, Decimal, optional) – The fee amount. Cannot be set with fee_type.
password (str) – The password.
segwit_change_address (bool, optional) – If True, the change address is a segwit address. Default=False.
wallet_name (str) – The wallet name.
account_name (str, optional) – The account name. Default=’account 0’.
outpoints (List[Outpoint]) – A list of outpoints to include in the transaction.
recipients (List[Recipient]) – A list of recipients with amounts.
op_return_data (str, optional) – The OP_RETURN data.
op_return_amount (Money, int, float, Decimal, optional) – The amount to burn in OP_RETURN.
fee_type (str, optional) – The fee type. Allowed [low, medium, high]
allow_unconfirmed (bool, optional) – If True, includes unconfirmed outputs. Default=False.
shuffle_outputs (bool, optional) – If True, shuffle outputs. Default=False.
change_address (Address, str, optional) – Specify a change address. If not set, a new change address is used.
**kwargs – Extra keyword arguments.

Returns

A built transaction.

Return type

Raises

APIError – Error thrown by node API. See message for details.

build_interflux_transaction(wallet_name: str, password: str, destination_chain: int, destination_address: Union[Address, str], outpoints: List[Outpoint], recipients: List[Recipient], fee_amount: Optional[Union[Money, int, float, decimal.Decimal]] = None, segwit_change_address: bool = False, op_return_data: Optional[str] = None, op_return_amount: Optional[Union[Money, int, float, decimal.Decimal]] = None, fee_type: Optional[str] = None, allow_unconfirmed: bool = False, shuffle_outputs: bool = False, account_name: str = 'account 0', change_address: Optional[Union[Address, str]] = None, **kwargs) → BuildTransactionModel

Builds a transaction and returns the hex to use when executing the transaction.

Parameters

destination_chain (int) – Enumeration representing the destination chain.
destination_address (Address, str) – The destination address.
fee_amount (Money, int, float, Decimal, optional) – The fee amount. Cannot be set with fee_type.
password (str) – The password.
segwit_change_address (bool, optional) – If True, the change address is a segwit address.
wallet_name (str) – The wallet name.
account_name (str, optional) – The account name. Default=’account 0’.
outpoints (List[Outpoint]) – A list of outpoints to include in the transaction.
recipients (List[Recipient]) – A list of recipients with amounts.
op_return_data (str, optional) – The OP_RETURN data.
op_return_amount (Money, int, float, Decimal, optional) – The amount to burn in OP_RETURN.
fee_type (str, optional) – The fee type. Allowed [low, medium, high]
allow_unconfirmed (bool, optional) – If True, includes unconfirmed outputs. Default=False.
shuffle_outputs (bool, optional) – If True, shuffle outputs. Default=False.
change_address (Address, str, optional) – Specify a change address. If not set, a new change address is used.
**kwargs – Extra keyword arguments.

Returns

A built interflux transaction.

Return type

WalletSendTransactionModel

Raises

APIError – Error thrown by node API. See message for details.

send_transaction(transaction_hex: Union[str, hexstr], **kwargs) → WalletSendTransactionModel

Sends a transaction that has already been built.

Parameters

transaction_hex (hexstr, str) – The hexified transaction.
**kwargs – Extra keyword arguments.

Returns

Information about a sent transaction.

Return type

Raises

APIError – Error thrown by node API. See message for details.

list_wallets(**kwargs) → dict

Lists all the files found in the database

Parameters: **kwargs – Extra keyword arguments.
Returns: A list of wallets.
Return type: dict
Raises: APIError – Error thrown by node API. See message for details.

account(wallet_name: str, password: str, **kwargs) → str

Creates a new account for a wallet.

Parameters

password (str) – The wallet password.
wallet_name (str) – The wallet name.
**kwargs – Extra keyword arguments.

Returns

The newly created account name.

Return type

str

Raises

APIError – Error thrown by node API. See message for details.

accounts(wallet_name: str, **kwargs) → List[str]

Gets a list of accounts for the specified wallet.

Parameters

wallet_name (str) – The wallet name.
**kwargs – Extra keyword arguments.

Returns

A list of accounts.

Return type

List[str]

Raises

APIError – Error thrown by node API. See message for details.

unused_address(wallet_name: str, account_name: str = 'account 0', segwit: bool = False, **kwargs) → Address

Gets an unused address (in the Base58 format) for a wallet account.

Parameters

wallet_name (str) – The wallet name.
account_name (str, optional) – The account name. Default=’account 0’.
segwit (bool, optional) – If True, get a segwit address. Default=False.
**kwargs – Extra keyword arguments.

Returns

An unused address.

Return type

Address

Raises

APIError – Error thrown by node API. See message for details.

unused_addresses(wallet_name: str, count: int, account_name: str = 'account 0', segwit: bool = False, **kwargs) → List[Address]

Gets a specified number of unused addresses (in the Base58 format) for a wallet account.

Parameters

wallet_name (str) – The wallet name.
account_name (str, optional) – The account name. Default=’account 0’.
count (int) – The number of addresses to get.
segwit (bool, optional) – If True, get a segwit address. Default=False.
**kwargs – Extra keyword arguments.

Returns

A list of unused addresses.

Return type

List[Address]

Raises

APIError – Error thrown by node API. See message for details.

new_addresses(wallet_name: str, count: int, account_name: str = 'account 0', segwit: bool = False, **kwargs) → List[Address]

Gets a specified number of new addresses (in the Base58 format) for a wallet account.

Parameters

wallet_name (str) – The wallet name.
account_name (str, optional) – The account name. Default=’account 0’.
count (conint(ge=1)) – The number of addresses to get.
segwit (bool, optional) – If True, get a segwit address. Default=False.
**kwargs – Extra keyword arguments.

Returns

A new address.

Return type

List[Address]

Raises

APIError – Error thrown by node API. See message for details.

addresses(wallet_name: str, account_name: str = 'account 0', segwit: bool = False, **kwargs) → AddressesModel

Gets all addresses for a wallet account.

Parameters

wallet_name (str) – The wallet name.
account_name (str, optional) – The account name. Default=’account 0’.
segwit (bool, optional) – If True, gets a segwit address. Default=False.
**kwargs – Extra keyword arguments.

Returns

All addresses associated with the account given.

Return type

AddressesModel

Raises

APIError – Error thrown by node API. See message for details.

remove_transactions(wallet_name: str, ids: Optional[List[Union[str, uint256]]] = None, from_date: Optional[str] = None, remove_all: bool = False, resync: bool = True, **kwargs) → List[RemovedTransactionModel]

Removes transactions from the wallet.

Parameters

wallet_name (str) – The wallet name.
ids (List[uint256, str], optional) – A list of transaction ids to remove.
from_date (str, optional) – An option to remove transactions after given date.
remove_all (bool, optional) – An option to remove all transactions. Default=False.
resync (bool, optional) – If True, resyncs wallet after items removed. Default=True.
**kwargs – Extra keyword arguments.

Returns

A list of removed transactions.

Return type

List[RemovedTransactionModel]

Raises

APIError – Error thrown by node API. See message for details.

remove_wallet(wallet_name: str, **kwargs) → None

Remove a wallet

Parameters

wallet_name (str) – The wallet name.
**kwargs – Extra keyword arguments.

Returns

None

Raises

APIError – Error thrown by node API. See message for details.

extpubkey(wallet_name: str, account_name: str = 'account 0', **kwargs) → ExtPubKey

Gets the extended public key of a specified wallet account.

Parameters

wallet_name (str) – The wallet name.
account_name (str, optional) – The account name. Default=’account 0’.
**kwargs – Extra keyword arguments.

Returns

ExtPubKey

Raises

APIError – Error thrown by node API. See message for details.

private_key(password: str, wallet_name: str, address: Union[Address, str], **kwargs) → Key

Gets the private key of a specified wallet address.

Parameters

password (str) – The wallet password.
wallet_name (str) – The wallet name.
address (Address, str) – The address to request a private key for.
**kwargs – Extra keyword arguments.

Returns

The private key.

Return type

Key

Raises

APIError – Error thrown by node API. See message for details.

sync(block_hash: Union[uint256, str], **kwargs) → None

Requests the node resyncs from a block specified by its block hash.

Parameters

block_hash (uint256, str) – The hash to start syncing from.
**kwargs – Extra keyword arguments.

Returns

None

Raises

APIError – Error thrown by node API. See message for details.

sync_from_date(wallet_name: str, date: str, all_transactions: bool = True, **kwargs) → None

Request the node resyncs starting from a given date and time.

Parameters

date (str) – The date to sync from in YYYY-MM-DDTHH:MM:SS format.
all_transactions (bool, optional) – If True, sync all transactions. Default=True.
wallet_name (str) – The wallet name.
**kwargs – Extra keyword arguments.

Returns

None

Raises

APIError – Error thrown by node API. See message for details.

wallet_stats(wallet_name: str, account_name: str = 'account 0', min_confirmations: int = 0, verbose: bool = True, **kwargs) → WalletStatsModel

Retrieves information about the wallet.

Parameters

wallet_name (str) – The wallet name.
account_name (str, optional) – The account name. Default=’account 0’.
min_confirmations (int, optional) – Include transaction less this amount from the chain tip. Default=0.
verbose (bool, optional) – If True, give verbose response. Default=True.
**kwargs – Extra keyword arguments.

Returns

Wallet statistical information.

Return type

WalletStatsModel

Raises

APIError – Error thrown by node API. See message for details.

split_coins(wallet_name: str, wallet_password: str, total_amount_to_split: Union[Money, int, float, decimal.Decimal], utxos_count: int, account_name: str = 'account 0', **kwargs) → WalletSendTransactionModel

Creates requested amount of UTXOs each of equal value and sends the transaction.

Parameters

wallet_name (str) – The wallet name.
account_name (str, optional) – The account name. Default=’account 0’.
wallet_password (str) – The wallet password.
total_amount_to_split (Money, int, float, Decimal) – The total amount to split.
utxos_count (int) – The number of utxos to create. (Must be greater than 2).
**kwargs – Extra keyword arguments.

Returns

Information about the sent transaction.

Return type

WalletSendTransactionModel

Raises

APIError – Error thrown by node API. See message for details.

distribute_utxos(wallet_name: str, wallet_password: str, utxos_count: int, utxo_per_transaction: int, outpoints: List[Outpoint], account_name: str = 'account 0', use_unique_address_per_utxo: bool = True, reuse_addresses: bool = True, use_change_addresses: bool = False, timestamp_difference_between_transactions: int = 0, min_confirmations: int = 0, dry_run: bool = True, **kwargs) → DistributeUtxoModel

Splits and distributes UTXOs across wallet addresses

Parameters

wallet_name (str) – The wallet name.
account_name (str, optional) – The account name. Default=’account 0’.
wallet_password (str) – The wallet password.
use_unique_address_per_utxo (bool, optional) – If True, uses a unique address for each utxo. Default=True.
reuse_addresses (bool, optional) – If True, reuses addresses. Default=True.
use_change_addresses (bool, optional) – If True, use change addresses. Default=False.
utxos_count (int) – The number of utxos to create.
utxo_per_transaction (int) – The number of utxos per transaction.
timestamp_difference_between_transactions (int, optional) – The number of seconds between transactions. Default=0.
min_confirmations (int, optional) – The minimum number of confirmations to include in transaction. Default=0.
outpoints (List[Outpoint]) – A list of outpoints to include in the transaction.
dry_run (bool, optional) – If True, simulate transaction. Default=True.
**kwargs – Extra keyword arguments.

Returns

Information about the distribute utxo transaction.

Return type

DistributeUtxoModel

Raises

APIError – Error thrown by node API. See message for details.

sweep(private_keys: List[Union[Key, str]], destination_address: Union[Address, str], broadcast: bool = False, **kwargs) → List[uint256]

Sweeps a wallet to specified address.

Parameters

private_keys (List[Key, str]) – A list of private keys to sweep.
destination_address (Address, str) – The address to sweep the coins to.
broadcast (bool, optional) – Broadcast transaction after creation. Default=False.
**kwargs – Extra keyword arguments.

Returns

A list of transactions for the sweep.

Return type

List[uint256]

Raises

APIError – Error thrown by node API. See message for details.

build_offline_sign_request(wallet_name: str, outpoints: List[Outpoint], recipients: List[Recipient], fee_amount: Optional[Union[Money, int, float, decimal.Decimal]] = None, op_return_data: Optional[str] = None, op_return_amount: Optional[Union[Money, int, float, decimal.Decimal]] = None, fee_type: Optional[str] = None, allow_unconfirmed: bool = False, shuffle_outputs: bool = False, account_name: str = 'account 0', change_address: Optional[Union[Address, str]] = None, **kwargs) → BuildOfflineSignModel

Builds an offline sign request for a transaction.

Parameters

fee_amount (Money, int, float, Decimal) – The fee amount. Cannot be set with fee_type.
wallet_name (str) – The wallet name.
account_name (str, optional) – The account name. Default=’account 0’.
outpoints (List[Outpoint]) – A list of outputs to use for the transaction.
recipients (List[Recipient]) – A list of recipients, including amounts.
op_return_data (str, optional) – The OP_RETURN data.
op_return_amount (Money, optional) – The amount to burn in OP_RETURN.
fee_type (str, optional) – The fee type. Allowed [low, medium, high]
allow_unconfirmed (bool, optional) – If True, includes unconfirmed outputs. Default=False.
shuffle_outputs (bool, optional) – If True, shuffle outputs. Default=False.
change_address (Address, optional) – Specify a change address. If not set, a new change address is used.
**kwargs – Extra keyword arguments.

Returns

A built transaction that can be signed offline.

Return type

BuildOfflineSignModel

Raises

APIError – Error thrown by node API. See message for details.

offline_sign_request(wallet_password: str, wallet_name: str, unsigned_transaction: Union[str, hexstr], fee: Union[Money, int, float, decimal.Decimal], utxos: List[UtxoDescriptor], addresses: List[AddressDescriptor], wallet_account: str = 'account 0', **kwargs) → BuildTransactionModel

Build an offline sign request for a transaction. The resulting transaction hex can be broadcast.

Parameters

wallet_password (str) – The wallet password.
wallet_name (str) – The wallet name.
wallet_account (str, optional) – The account name. Default=’account 0’.
unsigned_transaction (hexstr, str) – The unsigned transaction hexstr.
fee (Money, int, float, Decimal) – The fee.
utxos (List[UtxoDescriptor]) – A list of utxodescriptors.
addresses (List[AddressDescriptor]) – A list of addresses to send transactions.
**kwargs – Extra keyword arguments.

Returns

A signed transaction that can be broadcast.

Return type