package walletrpc
Get desktop application:
View/edit binary Protocol Buffers messages
service VersionService
api.proto:5rpc Version (, )
api.proto:6message
api.proto:9(message has no fields)
message
api.proto:10string version_string = 1
uint32 major = 2
uint32 minor = 3
uint32 patch = 4
string prerelease = 5
string build_metadata = 6
service WalletLoaderService
api.proto:44rpc WalletExists (, )
api.proto:45message
api.proto:306(message has no fields)
message
api.proto:307bool exists = 1
rpc CreateWallet (, )
api.proto:46message
api.proto:291bytes public_passphrase = 1
bytes private_passphrase = 2
bytes seed = 3
message
api.proto:296(message has no fields)
rpc OpenWallet (, )
api.proto:47message
api.proto:298bytes public_passphrase = 1
message
api.proto:301(message has no fields)
rpc CloseWallet (, )
api.proto:48message
api.proto:303(message has no fields)
message
api.proto:304(message has no fields)
rpc StartConsensusRpc (, )
api.proto:49message
api.proto:311string network_address = 1
string username = 2
bytes password = 3
bytes certificate = 4
message
api.proto:317(message has no fields)
service WalletService
api.proto:19rpc Ping (, )
api.proto:21Queries
message
api.proto:83(message has no fields)
message
api.proto:84(message has no fields)
rpc Network (, )
api.proto:22message
api.proto:86(message has no fields)
message
api.proto:87uint32 active_network = 1
rpc AccountNumber (, )
api.proto:23message
api.proto:91string account_name = 1
message
api.proto:94uint32 account_number = 1
rpc Accounts (, )
api.proto:24message
api.proto:98(message has no fields)
message
api.proto:99repeated accounts = 1
bytes current_block_hash = 2
int32 current_block_height = 3
rpc Balance (, )
api.proto:25message
api.proto:148uint32 account_number = 1
int32 required_confirmations = 2
message
api.proto:152int64 total = 1
int64 spendable = 2
int64 immature_reward = 3
rpc GetTransactions (, )
api.proto:26message
api.proto:158bytes 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
api.proto:184repeated mined_transactions = 1
repeated unmined_transactions = 2
rpc TransactionNotifications (, stream )
api.proto:29Notifications
message
api.proto:243(message has no fields)
message
api.proto:244repeated 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 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. Additonally, 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.
rpc SpentnessNotifications (, stream )
api.proto:30message
api.proto:266uint32 account = 1
bool no_notify_unspent = 2
bool no_notify_spent = 3
message
api.proto:272bytes transaction_hash = 1
uint32 output_index = 2
optional spender = 3
rpc AccountNotifications (, stream )
api.proto:31message
api.proto:282(message has no fields)
message
api.proto:283uint32 account_number = 1
string account_name = 2
uint32 external_key_count = 3
uint32 internal_key_count = 4
uint32 imported_key_count = 5
rpc ChangePassphrase (, )
api.proto:34Control
message
api.proto:189ChangePassphraseRequest.Key key = 1
bytes old_passphrase = 2
bytes new_passphrase = 3
message
api.proto:198(message has no fields)
rpc RenameAccount (, )
api.proto:35message
api.proto:113uint32 account_number = 1
string new_name = 2
message
api.proto:117(message has no fields)
rpc NextAccount (, )
api.proto:36message
api.proto:119bytes passphrase = 1
string account_name = 2
message
api.proto:123uint32 account_number = 1
rpc NextAddress (, )
api.proto:37message
api.proto:127uint32 account = 1
NextAddressRequest.Kind kind = 2
message
api.proto:135string address = 1
rpc ImportPrivateKey (, )
api.proto:38message
api.proto:139bytes passphrase = 1
uint32 account = 2
string private_key_wif = 3
bool rescan = 4
message
api.proto:145(message has no fields)
rpc FundTransaction (, )
api.proto:39message
api.proto:200uint32 account = 1
int64 target_amount = 2
int32 required_confirmations = 3
bool include_immature_coinbases = 4
bool include_change_script = 5
message
api.proto:207repeated selected_outputs = 1
int64 total_amount = 2
bytes change_pk_script = 3
rpc SignTransaction (, )
api.proto:40message
api.proto:221bytes 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
api.proto:233bytes transaction = 1
repeated uint32 unsigned_input_indexes = 2
rpc PublishTransaction (, )
api.proto:41message
api.proto:238bytes signed_transaction = 1
message
api.proto:241(message has no fields)
message
api.proto:78uint32 account = 1
int64 total_balance = 2
message
api.proto:100Used in:
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
message
api.proto:71Used in: ,
bytes hash = 1
int32 height = 2
int64 timestamp = 3
repeated transactions = 4
Used in:
PRIVATE = 0
PUBLIC = 1
message
api.proto:208Used in:
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:
BIP0044_EXTERNAL = 0
BIP0044_INTERNAL = 1
message
api.proto:275Used in:
bytes transaction_hash = 1
uint32 input_index = 2
message
api.proto:52Used in: , ,
bytes hash = 1
bytes transaction = 2
repeated debits = 3
repeated credits = 4
int64 fee = 5
int64 timestamp = 6
May be earlier than a block timestamp, but never later.
message
api.proto:53Used in:
uint32 index = 1
uint32 previous_account = 2
int64 previous_amount = 3
message
api.proto:58Used in:
uint32 index = 1
uint32 account = 2
bool internal = 3