package walletrpc

Get desktop application:
View/edit binary Protocol Buffers messages

VersionService provides version information for the wallet.

• rpc Version (VersionRequest, VersionResponse)

  api.proto:10

  Version returns the version of the wallet.

  message VersionRequest

  api.proto:13

  (message has no fields)

  message VersionResponse

  api.proto:15

  • string version_string = 1

  • uint32 major = 2

  • uint32 minor = 3

  • uint32 patch = 4

  • string prerelease = 5

  • string build_metadata = 6

WalletLoaderService provides wallet loading and management operations.

• rpc CloseWallet (CloseWalletRequest, CloseWalletResponse)

  api.proto:86

  CloseWallet closes the currently open wallet.

  message CloseWalletRequest

  api.proto:358

  (message has no fields)

  message CloseWalletResponse

  api.proto:360

  (message has no fields)

• rpc CreateWallet (CreateWalletRequest, CreateWalletResponse)

  api.proto:82

  CreateWallet creates a new wallet.

  message CreateWalletRequest

  api.proto:344

  • bytes public_passphrase = 1

  • bytes private_passphrase = 2

  • bytes seed = 3

  message CreateWalletResponse

  api.proto:349

  (message has no fields)

• rpc OpenWallet (OpenWalletRequest, OpenWalletResponse)

  api.proto:84

  OpenWallet opens an existing wallet.

  message OpenWalletRequest

  api.proto:352

  • bytes public_passphrase = 1

  message OpenWalletResponse

  api.proto:355

  (message has no fields)

• rpc StartConsensusRpc (StartConsensusRpcRequest, StartConsensusRpcResponse)

  api.proto:88

  StartConsensusRpc starts the consensus RPC connection.

  message StartConsensusRpcRequest

  api.proto:369

  • string network_address = 1

  • string username = 2

  • bytes password = 3

  • bytes certificate = 4

  message StartConsensusRpcResponse

  api.proto:375

  (message has no fields)

• rpc WalletExists (WalletExistsRequest, WalletExistsResponse)

  api.proto:80

  WalletExists checks if a wallet exists.

  message WalletExistsRequest

  api.proto:363

  (message has no fields)

  message WalletExistsResponse

  api.proto:365

  • bool exists = 1

WalletService provides wallet functionality including queries, notifications, and control operations.

• rpc AccountNotifications (AccountNotificationsRequest, stream AccountNotificationsResponse)

  api.proto:50

  AccountNotifications streams notifications about account changes.

  message AccountNotificationsRequest

  api.proto:334

  (message has no fields)

  message AccountNotificationsResponse

  api.proto:336

  • uint32 account_number = 1

  • string account_name = 2

  • uint32 external_key_count = 3

  • uint32 internal_key_count = 4

  • uint32 imported_key_count = 5

• rpc AccountNumber (AccountNumberRequest, AccountNumberResponse)

  api.proto:33

  AccountNumber returns the account number for a given account name.

  message AccountNumberRequest

  api.proto:135

  • string account_name = 1

  message AccountNumberResponse

  api.proto:138

  • uint32 account_number = 1

• rpc Accounts (AccountsRequest, AccountsResponse)

  api.proto:35

  Accounts returns information about all accounts in the wallet.

  message AccountsRequest

  api.proto:142

  (message has no fields)

  message AccountsResponse

  api.proto:144

  • repeated AccountsResponse.Account accounts = 1

  • bytes current_block_hash = 2

  • int32 current_block_height = 3

• rpc Balance (BalanceRequest, BalanceResponse)

  api.proto:37

  Balance returns the balance for a specific account.

  message BalanceRequest

  api.proto:194

  • uint32 account_number = 1

  • int32 required_confirmations = 2

  message BalanceResponse

  api.proto:198

  • int64 total = 1

  • int64 spendable = 2

  • int64 immature_reward = 3

• rpc ChangePassphrase (ChangePassphraseRequest, ChangePassphraseResponse)

  api.proto:55

  Control ChangePassphrase changes the wallet's private or public passphrase.

  message ChangePassphraseRequest

  api.proto:237

  • ChangePassphraseRequest.Key key = 1

  • bytes old_passphrase = 2

  • bytes new_passphrase = 3

  message ChangePassphraseResponse

  api.proto:246

  (message has no fields)

• rpc FundTransaction (FundTransactionRequest, FundTransactionResponse)

  api.proto:67

  FundTransaction selects inputs to fund a transaction.

  message FundTransactionRequest

  api.proto:249

  • uint32 account = 1

  • int64 target_amount = 2

  • int32 required_confirmations = 3

  • bool include_immature_coinbases = 4

  • bool include_change_script = 5

  message FundTransactionResponse

  api.proto:256

  • repeated FundTransactionResponse.PreviousOutput selected_outputs = 1

  • int64 total_amount = 2

  • bytes change_pk_script = 3

• rpc GetTransactions (GetTransactionsRequest, GetTransactionsResponse)

  api.proto:39

  GetTransactions returns transaction history for the wallet.

  message GetTransactionsRequest

  api.proto:204

  • bytes starting_block_hash = 1

    Optionally specify the starting block from which to begin including all transactions. Either the starting block hash or height may be specified, but not both. If a block height is specified and is negative, the absolute value becomes the number of last blocks to include. That is, given a current chain height of 1000 and a starting block height of -3, transaction notifications will be created for blocks 998, 999, and 1000. If both options are excluded, transaction results are created for transactions since the genesis block.

  • sint32 starting_block_height = 2

  • bytes ending_block_hash = 3

    Optionally specify the last block that transaction results may appear in. Either the ending block hash or height may be specified, but not both. If both are excluded, transaction results are created for all transactions through the best block, and include all unmined transactions.

  • int32 ending_block_height = 4

  • int32 minimum_recent_transactions = 5

    Include at least this many of the newest transactions if they exist. Cannot be used when the ending block hash is specified. TODO: remove until spec adds it back in some way.

  message GetTransactionsResponse

  api.proto:232

  • repeated BlockDetails mined_transactions = 1

  • repeated TransactionDetails unmined_transactions = 2

• rpc ImportPrivateKey (ImportPrivateKeyRequest, ImportPrivateKeyResponse)

  api.proto:64

  ImportPrivateKey imports a private key into the wallet.

  message ImportPrivateKeyRequest

  api.proto:185

  • bytes passphrase = 1

  • uint32 account = 2

  • string private_key_wif = 3

  • bool rescan = 4

  message ImportPrivateKeyResponse

  api.proto:191

  (message has no fields)

• rpc Network (NetworkRequest, NetworkResponse)

  api.proto:31

  Network returns the active network the wallet is connected to.

  message NetworkRequest

  api.proto:129

  (message has no fields)

  message NetworkResponse

  api.proto:131

  • uint32 active_network = 1

• rpc NextAccount (NextAccountRequest, NextAccountResponse)

  api.proto:60

  NextAccount creates a new account.

  message NextAccountRequest

  api.proto:165

  • bytes passphrase = 1

  • string account_name = 2

  message NextAccountResponse

  api.proto:169

  • uint32 account_number = 1

• rpc NextAddress (NextAddressRequest, NextAddressResponse)

  api.proto:62

  NextAddress generates a new address for an account.

  message NextAddressRequest

  api.proto:173

  • uint32 account = 1

  • NextAddressRequest.Kind kind = 2

  message NextAddressResponse

  api.proto:181

  • string address = 1

• rpc Ping (PingRequest, PingResponse)

  api.proto:29

  Queries Ping tests connectivity to the wallet service.

  message PingRequest

  api.proto:124

  (message has no fields)

  message PingResponse

  api.proto:126

  (message has no fields)

• rpc PublishTransaction (PublishTransactionRequest, PublishTransactionResponse)

  api.proto:73

  PublishTransaction publishes a signed transaction to the network.

  message PublishTransactionRequest

  api.proto:287

  • bytes signed_transaction = 1

  message PublishTransactionResponse

  api.proto:290

  (message has no fields)

• rpc RenameAccount (RenameAccountRequest, RenameAccountResponse)

  api.proto:58

  RenameAccount renames an existing account.

  message RenameAccountRequest

  api.proto:158

  • uint32 account_number = 1

  • string new_name = 2

  message RenameAccountResponse

  api.proto:162

  (message has no fields)

• rpc SignTransaction (SignTransactionRequest, SignTransactionResponse)

  api.proto:70

  SignTransaction signs a transaction.

  message SignTransactionRequest

  api.proto:270

  • bytes passphrase = 1

  • bytes serialized_transaction = 2

  • repeated uint32 input_indexes = 3

    If no indexes are specified, signatures scripts will be added for every input. If any input indexes are specified, only those inputs will be signed. Rather than returning an incompletely signed transaction if any of the inputs to be signed can not be, the RPC immediately errors.

  message SignTransactionResponse

  api.proto:282

  • bytes transaction = 1

  • repeated uint32 unsigned_input_indexes = 2

• rpc SpentnessNotifications (SpentnessNotificationsRequest, stream SpentnessNotificationsResponse)

  api.proto:47

  SpentnessNotifications streams notifications about output spentness.

  message SpentnessNotificationsRequest

  api.proto:318

  • uint32 account = 1

  • bool no_notify_unspent = 2

  • bool no_notify_spent = 3

  message SpentnessNotificationsResponse

  api.proto:324

  • bytes transaction_hash = 1

  • uint32 output_index = 2

  • optional SpentnessNotificationsResponse.Spender spender = 3

• rpc TransactionNotifications (TransactionNotificationsRequest, stream TransactionNotificationsResponse)

  api.proto:44

  Notifications TransactionNotifications streams transaction notifications.

  message TransactionNotificationsRequest

  api.proto:293

  (message has no fields)

  message TransactionNotificationsResponse

  api.proto:295

  • repeated BlockDetails attached_blocks = 1

    Sorted by increasing height. This is a repeated field so many new blocks in a new best chain can be notified at once during a reorganize.

  • repeated bytes detached_blocks = 2

    If there was a chain reorganize, there may have been blocks with wallet transactions that are no longer in the best chain. These are those block's hashes.

  • repeated TransactionDetails unmined_transactions = 3

    Any new unmined transactions are included here. These unmined transactions refer to the current best chain, so transactions from detached blocks may be moved to mempool and included here if they are not mined or double spent in the new chain. Additionally, if no new blocks were attached but a relevant unmined transaction is seen by the wallet, it will be reported here.

  • repeated bytes unmined_transaction_hashes = 4

    Instead of notifying all of the removed unmined transactions, just send all of the current hashes.

• uint32 account = 1

• int64 total_balance = 2

Used in: AccountsResponse

• uint32 account_number = 1

• string account_name = 2

• int64 total_balance = 3

• uint32 external_key_count = 4

• uint32 internal_key_count = 5

• uint32 imported_key_count = 6

Used in: GetTransactionsResponse, TransactionNotificationsResponse

• bytes hash = 1

• int32 height = 2

• int64 timestamp = 3

• repeated TransactionDetails transactions = 4

Used in: ChangePassphraseRequest

• PRIVATE = 0

• PUBLIC = 1

Used in: FundTransactionResponse

• bytes transaction_hash = 1

• uint32 output_index = 2

• int64 amount = 3

• bytes pk_script = 4

• int64 receive_time = 5

• bool from_coinbase = 6

Used in: NextAddressRequest

• BIP0044_EXTERNAL = 0

• BIP0044_INTERNAL = 1

Used in: SpentnessNotificationsResponse

• bytes transaction_hash = 1

• uint32 input_index = 2

Used in: BlockDetails, GetTransactionsResponse, TransactionNotificationsResponse

• bytes hash = 1

• bytes transaction = 2

• repeated TransactionDetails.Input debits = 3

• repeated TransactionDetails.Output credits = 4

• int64 fee = 5

• int64 timestamp = 6

  May be earlier than a block timestamp, but never later.

Used in: TransactionDetails

• uint32 index = 1

• uint32 previous_account = 2

• int64 previous_amount = 3

Used in: TransactionDetails

• uint32 index = 1

• uint32 account = 2

• bool internal = 3