lbcwallet/rpc/documentation
Josh Rickmar 61e96a69e4 Cleanup TransactionDetails RPC messages.
Remove the addresses field from TransactionDetails.Output.  It is
assumed that the caller is able to deserialize the transaction and
encode the output scripts to addresses, so this is unnecessary server
overhead and conflicts with the current API philosophy of not
duplicating data already included in another field.

Since there is no additional data included for outputs not controlled
by the wallet, remove the `mine` specifier from the Output message and
replace it with an output index.  Only include messages for controlled
outputs, rather than creating messages for both controlled and
uncontrolled outputs.  Rename the repeated field from `outputs` to
`credits` to be consistent with the `debits` field.

Bump major API version as this is a breaking change.

Closes #408.
2018-05-23 19:38:56 -07:00
..
api.md Cleanup TransactionDetails RPC messages. 2018-05-23 19:38:56 -07:00
clientusage.md Fix example node.js client after breaking API change. 2016-04-28 09:36:58 -04:00
README.md Fix spelling in legacy test and docs using aspell 2016-03-09 20:39:03 +01:00
serverchanges.md Fix spelling in legacy test and docs using aspell 2016-03-09 20:39:03 +01:00

RPC Documentation

This project provides a gRPC server for Remote Procedure Call (RPC) access from other processes. This is intended to be the primary means by which users, through other client programs, interact with the wallet.

These documents cover the documentation for both consumers of the server and developers who must make changes or additions to the API and server implementation:

A legacy RPC server based on the JSON-RPC API of Bitcoin Core's wallet is also available, but documenting its usage is out of scope for these documents.