Bitcoin Wiki - User contributions [en]

Wallet protocol

2011-04-14T19:40:55Z

M0Ray: /* Binary or plaintext */

This is a project to define a new wallet protocol addressing problems with the current JSON-RPC implementation in bitcoind.
Please feel free to make edits. If you disagree with something, turn it into a "debate".

== Explanation ==
This protocol aims to be a standard for communication between Wallets and User Interfaces.
It can be used to access a Wallet remotely, or even locally, even if the Wallet and User Interface are produced by different or competing vendors. For example, you could use an Android User Interface from Google to control a QBitcoin Wallet.

Please see the [[Infrastructure]] page for an overview of where this protocol fits into the big picture.

== Requirements ==

* Never use human-formatted data (for example, use base bitcoin units, not Decimal BitCoins nor Tonal BitCoins, which should only be used in formatting for humans)
* Don't require polling (for example, broadcast events for new transactions, or changes to current "work")
* Cooperative mining (see below)
* Allow calculating expected minimum fee for transactions, with either (wallet's choice) locking on the used inputs, or prebuilding the tx and error if it becomes invalid before sending
* Easy to use in a RPC-like manner, for simple applications

=== Debates ===
==== Binary or plaintext ====
* Binary is more efficient to parse and create
* Plaintext is easier for humans to debug, and avoids forming a dependency on a specific number of bits, endianness, or precision
* Binary can include custom transactions as-is for transmission
* Protobuf (binary) seems efficient and easy to use from all major languages
* JSON implementations tend to be buggy
* YAML (plaintext) is both human readable and efficient for parser (available for most PLs)

=== Cooperative mining ===
The protocol should support submitting completed blocks, such that it can get (just) addresses from an upstream pool to generate to, and send all completed blocks to that pool for verification and counting (and possibly submission to the network). This can reduce the pool's load.

=== UI bundling ===
For more secure use by ordinary end users, UIs and Wallets should support stream-based communication over standard I/O (stdio). This allows the UI to simply execute a dedicated Wallet, without requiring the user to setup Wallet-side authentication. This also permits full compatibility with a hardware-based wallet located on a secured device (for example, a cryptographic hardware module, or a wallet device connected via RS232 or USB). (Suggestion, if UI's could talk to any stream, including a child process's stdio, as well as a pipe or a device, the flexibility would be valuable)

= DRAFT 0 =
Everything beyond this point is strictly DRAFT, should NOT be implemented, and is subject to being completely rewritten or modified!

== Conformance requirements ==

All diagrams, examples, and notes in this specification are non-normative, as are all sections explicitly marked non-normative. Everything else in this specification is normative.

The key words "MUST", "MUST NOT", "REQUIRED", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in the normative parts of this document are to be interpreted as described in RFC2119<ref name="RFC2119"/>. For readability, these words do not appear in all uppercase letters in this specification.

Requirements phrased in the imperative as part of algorithms (such as "strip any leading space characters" or "return false and abort these steps") are to be interpreted with the meaning of the key word ("must", "should", "may", etc) used in introducing the algorithm.

== Transport/Session Layer ==
Must support at least reliable in-order stream data.

Such as:
* stdio (required for self-contained UI bundling)
* serial
* TCP

== Presentation Layer ==
=== Encryption ===
* TLS (recommended)
* SSH

=== Packetization ===
Reliable, in-order packetization is required.
Packets should be request-oriented, while supporting:
* Fixed-length responses (MIME<ref name="RFC2045"/>-encoded)
* Persistent response streams (eg, HTTP chunked encoding)
* Optional: Full-duplex (two-way) communication (eg, WebSockets<ref name="WebSocket"/>)

This supports:
* HTTP<ref name="RFC2616"/> with SSE<ref name="SSE"/> (and WebSockets<ref name="WebSocket"/>)
* SPDY<ref name="SPDY"/>
* 0MQ<ref name="0MQ-RFC2"/>, protobuf<ref name="protobuf"/>, and specialized .proto files

Request types:
* Optional: CONNECT for establishing a full-duplex stream
* GET for read-only access, always returning a fixed-length response
* POST for method calls
* PUT for uploads
* HEAD for metadata

Note: Some protocols (eg, HTTP) do not allow complex structures in GET requests. An implementation using these protocols should allow silently upgrading GET to a POST with the same semantics.

Note: A logical CONNECT request may not map directly to the HTTP method by the same name. The current WebSocket specification uses a HTTP GET request.

=== MIME Formats ===
These content types may be specified in the Content-Type header, and Accept header.
* application/x-www-form-urlencoded (required)
* application/x-ripemd-160 (required)
* application/x-sha (required)
* multipart/mixed (required)
* text/event-stream<ref name="SSE"/> (required for events over HTTP<ref name="RFC2616"/>)
* application/x-bitcoin (required wallet-side)
* application/json<ref name="RFC4627"/> (recommended)
* application/xml<ref name="XML"/>

== Application Layer ==
=== Authentication / security ===
Wallets may micro-manage security as they like, but the following are RECOMMENDED security levels:
{| class="wikitable"
| "Miner" || Can generate new addresses, get work, and report found blocks
|-
| Merchant || Can create a transaction (only with 'proposal' flag), but not send it
|-
| Read-only || Can view accounts, addresses, and any public data, and combinations thereof (eg, balances)
|-
| Financial || Can create new transactions using the wallet's keys
|-
| Full/Admin || Can administrate (download, destroy, etc) wallet keys
|}

Wallets MAY grant full access to username 'admin' with a null password, to requests over stdio.

Wallets SHOULD grant Merchant access to username 'merchant' will a null password, to requests made over direct (ie, physically local, like Bluetooth) connections.
User interfaces SHOULD monitor for new, unsigned transactions with the 'proposal' flag set, and prompt the user to sign or delete them.

=== Object/Query Schema ===
May be provided in multipart/mixed, JSON, XML, etc...

{| class="wikitable sortable"
! Field Name !! Blk !! Tx !! Accting !! Coin !! Key !! Acct !! Queryable !! Description
|-
| id
| {{Table Value Yes}} || {{Table Value Yes}} || {{Table Value Yes}}
| {{Table Value Yes}} || {{Table Value Yes}} || {{Table Value Yes}}
| {{Table Value Yes}}
| Unique data identifier; only guaranteed to remain the same for a single session
|-
| type
| {{Table Value Yes}} || {{Table Value Yes}} || {{Table Value Yes}}
| {{Table Value Yes}} || {{Table Value Yes}} || {{Table Value Yes}}
| {{Table Value Yes}}
| Type of data: 'key', 'tx', 'coin', 'block', 'account', 'accounting'
|-
| hash
| {{Table Value Yes}} || {{Table Value Yes}} || {{Table Value No}}
| {{Table Value No}} || {{Table Value Yes}} || {{Table Value No}}
| {{Table Value Yes}}
|-
| size
| {{Table Value Yes}} || {{Table Value Yes}} || {{Table Value Unknown}}
| {{Table Value No}} || {{Table Value Yes}} || {{Table Value Unknown}}
| {{Table Value Yes}}
|-
| time
| {{Table Value Yes}} || {{Table Value Yes}} || {{Table Value Yes}}
| {{Table Value No}} || {{Table Value No}} || {{Table Value No}}
| {{Table Value Yes}}
|-
| difficulty
| {{Table Value Yes}} || {{Table Value No}} || {{Table Value No}}
| {{Table Value No}} || {{Table Value No}} || {{Table Value No}}
| {{Table Value Yes}}
|-
| difficultyNext
| {{Table Value Yes}} || {{Table Value No}} || {{Table Value No}}
| {{Table Value No}} || {{Table Value No}} || {{Table Value No}}
| {{Table Value Yes}}
|-
| height
| {{Table Value Yes}} || {{Table Value No}} || {{Table Value No}}
| {{Table Value No}} || {{Table Value No}} || {{Table Value No}}
| {{Table Value Yes}}
|-
| confirmations
| {{Table Value Yes}} || {{Table Value Yes}} || {{Table Value Unknown}}
| {{Table Value Yes}} || {{Table Value No}} || {{Table Value No}}
| {{Table Value Yes}}
| -2 for rejected, -1 for unsent, 0 for broadcast, 1+ for number of confirms
|-
| accepted
| {{Table Value Unknown}} || {{Table Value Yes}} || {{Table Value Unknown}}
| {{Table Value Yes}} || {{Table Value No}} || {{Table Value No}}
| {{Table Value Yes}}
| An unconfirmed, accepted tx, is part of the current mining merkle tree
|-
| related
| {{Table Value Yes}} || {{Table Value Yes}} || {{Table Value Unknown}}
| {{Table Value Unknown}} || {{Table Value Unknown}} || {{Table Value Unknown}}
| {{Table Value Yes}}
| Can have multiple entries (in JSON, an array value)
|-
| coinbase
| {{Table Value No}} || {{Table Value Yes}} || {{Table Value No}}
| {{Table Value Yes}} || {{Table Value No}} || {{Table Value No}}
| {{Table Value Yes}}
|-
| inputs
| {{Table Value No}} || {{Table Value Yes}} || {{Table Value Unknown}}
| {{Table Value No}} || {{Table Value No}} || {{Table Value No}}
| {{Table Value Yes}}
|-
| outputs
| {{Table Value No}} || {{Table Value Yes}} || {{Table Value Unknown}}
| {{Table Value No}} || {{Table Value No}} || {{Table Value No}}
| {{Table Value Yes}}
|-
| mine
| {{Table Value Yes}} || {{Table Value Yes}} || {{Table Value Unknown}}
| {{Table Value Yes}} || {{Table Value Yes}} || {{Table Value Unknown}}
| {{Table Value Yes}}
|-
| network
| {{Table Value Yes}} || {{Table Value Yes}} || {{Table Value Unknown}}
| {{Table Value Yes}} || {{Table Value Yes}} || {{Table Value Unknown}}
| {{Table Value Yes}}
| 0xF9BEB4D9 for the main network; 0xFABFB5DA for testnet
|-
| proposal
| {{Table Value No}} || {{Table Value Yes}} || {{Table Value No}}
| {{Table Value No}} || {{Table Value No}} || {{Table Value No}}
| {{Table Value No}}
|}

=== Data ===
* Arbitrary data can be accessed with the path /data/<id>
* GET to fetch
* To get only block header, use /data/<id>/header
* To get only actual content (eg, no calculated values), use /data/<id>/raw
* Optional: PUT to upload

=== Information ===
* GET /state/<network>/connections
* Mining info: (required for mining support)
** GET /state/<network>/hashesPerSec (optional)
** GET /state/<network>/merkle
* GET /info/protocols
** Returns a list of supported protocols/versions and their URIs

=== Requests ===
==== Address validation ====
* GET /validate/address?network=<id>&address=<hash>

==== Calculate balance ====
* GET /balance?<query-object>
Match transactions to be included in the balance.
To ignore spends, use matching.

==== Data search ====
* GET /dataSearch?<query-object>
* POST /dataSearch allowed for more complex queries

NOTE: To get the id rather than the data itself, use a HEAD request and check the Location header.

==== Generate new address ====
* POST /newAddress
** Optional parameter: recycle (bool) -- allows wallet to reuse a spent change address; if not supported, wallet should silently ignore
** Optional parameter: generate (bool) -- if true, make a new address on the spot, never use a preexisting one; if not supported, throw an error
** Optional parameter: account -- associate new address funds with this account id

==== Monitor events ====
* Always POST

===== New data available =====
* Query

==== Move between accounts ====
* POST /accounting/move
** dest=<accountId>
** query=<query-object> OR amount=<amount>
** Optional: comment=<string>

==== Transaction creation ====
* POST /tx/new
** send (bool) -- If true, sign and broadcast the transaction immediately
** fee (amount or range) -- If range, the wallet will try to calculate the minimum it expects the network to accept; if omitted, automatic fee range is unlimited unless bound by other factors (eg, input+strict)
** Optional: fromAccount (account id)
** Optional: input (multiple allowed of: coin id, OR coin id=>scriptSig)
** output (multiple allowed of: address=>amount pairs, OR script=>amount)
** strict (bool) -- If set, error rather than vary any parameters
** Optional: comment=<string>

==== Transaction broadcast ====
* POST /tx/send?id=<existing-tx-internal-id>

==== Shutdown wallet ====
* POST /shutdown

=== Events ===
==== New Data Available ====

=== p2p protocol encapsulation ===
Optional: Establish a full-duplex connection to /p2p to speak direct p2p protocol

== Appendix A. Useful algorithms ==
=== Counting confirmations ===
Because numerous (most) transactions change confirmation at the same event, the only way to do this efficiently, is to monitor for new block events. When a block arrives, increment the confirmation count of all transactions with at least 1 confirmation already. Then check the new block's introduced transactions (incrementing them from 0 to 1), and delete/invalidate any revoked transactions (eg, from a competing chain).

== Appendix B. JSON-RPC equivalents ==
=== backupwallet ===
=== getaccount / getlabel ===
=== getaddressesbyaccount / getaccountaddress / getaddressesbylabel ===
=== getbalance ===
=== getblockcount / getblocknumber ===
=== getconnectioncount ===
=== getdifficulty ===
=== getgenerate ===
=== gethashespersec ===
=== getinfo ===
=== getnewaddress ===
=== getreceivedbyaccount / getreceivedbylabel ===
=== getreceivedbyaddress / getamountreceived ===
=== gettransaction ===
=== getwork ===
=== help ===
=== listaccounts ===
=== listreceivedbyaccount / listreceivedbylabel ===
=== listreceivedbyaddress / getallreceived ===
=== listtransactions ===
=== move ===
=== sendfrom ===
=== sendtoaddress ===
=== setaccount / setlabel ===
=== setgenerate ===
=== settxfee ===
=== stop ===
=== validateaddress ===

== References ==
<references>
<ref name="0MQ-RFC2">[http://rfc.zeromq.org/spec:2 The Size-Prefixed Blob Format], iMatix Corporation.</ref>
<ref name="protobuf">[http://code.google.com/apis/protocolbuffers/docs/encoding.html Protocol Buffers Encoding], Google.</ref>
<ref name="RFC2045">[http://tools.ietf.org/html/rfc2045 Multipurpose Internet Mail Extensions (MIME)], Freed & Borenstein, First Virtual.</ref>
<ref name="RFC2119">[http://tools.ietf.org/html/rfc2119 Key words for use in RFCs to Indicate Requirement Levels], S. Bradner. IETF.</ref>
<ref name="RFC2616">[http://tools.ietf.org/html/rfc2616 Hypertext Transfer Protocol -- HTTP/1.1], Fielding, et al, W3C.</ref>
<ref name="RFC4627">[http://tools.ietf.org/html/rfc4627 The application/json Media Type for JavaScript Object Notation (JSON)], D. Crockford. JSON.org.</ref>
<ref name="SSE">[http://dev.w3.org/html5/eventsource/ Server-Sent Events], Ian Hickson, Google, Inc.</ref>
<ref name="SPDY">[http://www.chromium.org/spdy/spdy-protocol/spdy-protocol-draft2 SPDY Protocol], various. Google, Inc.</ref>
<ref name="WebSocket">[http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-06 The WebSocket protocol], Ian Hickson, Google, Inc.</ref>
<ref name="XML">[http://www.w3.org/TR/REC-xml Extensible Markup Language (XML) 1.0 (Second Edition)], Tim Bray, Jean Paoli, C. M. Sperberg-McQueen and Eve Maler, W3C.</ref>
</references>

Wallet protocol

2011-04-14T19:40:29Z

M0Ray: /* Binary or plaintext */

This is a project to define a new wallet protocol addressing problems with the current JSON-RPC implementation in bitcoind.
Please feel free to make edits. If you disagree with something, turn it into a "debate".

== Explanation ==
This protocol aims to be a standard for communication between Wallets and User Interfaces.
It can be used to access a Wallet remotely, or even locally, even if the Wallet and User Interface are produced by different or competing vendors. For example, you could use an Android User Interface from Google to control a QBitcoin Wallet.

Please see the [[Infrastructure]] page for an overview of where this protocol fits into the big picture.

== Requirements ==

* Never use human-formatted data (for example, use base bitcoin units, not Decimal BitCoins nor Tonal BitCoins, which should only be used in formatting for humans)
* Don't require polling (for example, broadcast events for new transactions, or changes to current "work")
* Cooperative mining (see below)
* Allow calculating expected minimum fee for transactions, with either (wallet's choice) locking on the used inputs, or prebuilding the tx and error if it becomes invalid before sending
* Easy to use in a RPC-like manner, for simple applications

=== Debates ===
==== Binary or plaintext ====
* Binary is more efficient to parse and create
* Plaintext is easier for humans to debug, and avoids forming a dependency on a specific number of bits, endianness, or precision
* Binary can include custom transactions as-is for transmission
* Protobuf (binary) seems efficient and easy to use from all major languages
* JSON implementations tend to be buggy
* YAML representation is both human readable and efficient for parser (available for most PLs)

=== Cooperative mining ===
The protocol should support submitting completed blocks, such that it can get (just) addresses from an upstream pool to generate to, and send all completed blocks to that pool for verification and counting (and possibly submission to the network). This can reduce the pool's load.

=== UI bundling ===
For more secure use by ordinary end users, UIs and Wallets should support stream-based communication over standard I/O (stdio). This allows the UI to simply execute a dedicated Wallet, without requiring the user to setup Wallet-side authentication. This also permits full compatibility with a hardware-based wallet located on a secured device (for example, a cryptographic hardware module, or a wallet device connected via RS232 or USB). (Suggestion, if UI's could talk to any stream, including a child process's stdio, as well as a pipe or a device, the flexibility would be valuable)

= DRAFT 0 =
Everything beyond this point is strictly DRAFT, should NOT be implemented, and is subject to being completely rewritten or modified!

== Conformance requirements ==

All diagrams, examples, and notes in this specification are non-normative, as are all sections explicitly marked non-normative. Everything else in this specification is normative.

The key words "MUST", "MUST NOT", "REQUIRED", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in the normative parts of this document are to be interpreted as described in RFC2119<ref name="RFC2119"/>. For readability, these words do not appear in all uppercase letters in this specification.

Requirements phrased in the imperative as part of algorithms (such as "strip any leading space characters" or "return false and abort these steps") are to be interpreted with the meaning of the key word ("must", "should", "may", etc) used in introducing the algorithm.

== Transport/Session Layer ==
Must support at least reliable in-order stream data.

Such as:
* stdio (required for self-contained UI bundling)
* serial
* TCP

== Presentation Layer ==
=== Encryption ===
* TLS (recommended)
* SSH

=== Packetization ===
Reliable, in-order packetization is required.
Packets should be request-oriented, while supporting:
* Fixed-length responses (MIME<ref name="RFC2045"/>-encoded)
* Persistent response streams (eg, HTTP chunked encoding)
* Optional: Full-duplex (two-way) communication (eg, WebSockets<ref name="WebSocket"/>)

This supports:
* HTTP<ref name="RFC2616"/> with SSE<ref name="SSE"/> (and WebSockets<ref name="WebSocket"/>)
* SPDY<ref name="SPDY"/>
* 0MQ<ref name="0MQ-RFC2"/>, protobuf<ref name="protobuf"/>, and specialized .proto files

Request types:
* Optional: CONNECT for establishing a full-duplex stream
* GET for read-only access, always returning a fixed-length response
* POST for method calls
* PUT for uploads
* HEAD for metadata

Note: Some protocols (eg, HTTP) do not allow complex structures in GET requests. An implementation using these protocols should allow silently upgrading GET to a POST with the same semantics.

Note: A logical CONNECT request may not map directly to the HTTP method by the same name. The current WebSocket specification uses a HTTP GET request.

=== MIME Formats ===
These content types may be specified in the Content-Type header, and Accept header.
* application/x-www-form-urlencoded (required)
* application/x-ripemd-160 (required)
* application/x-sha (required)
* multipart/mixed (required)
* text/event-stream<ref name="SSE"/> (required for events over HTTP<ref name="RFC2616"/>)
* application/x-bitcoin (required wallet-side)
* application/json<ref name="RFC4627"/> (recommended)
* application/xml<ref name="XML"/>

== Application Layer ==
=== Authentication / security ===
Wallets may micro-manage security as they like, but the following are RECOMMENDED security levels:
{| class="wikitable"
| "Miner" || Can generate new addresses, get work, and report found blocks
|-
| Merchant || Can create a transaction (only with 'proposal' flag), but not send it
|-
| Read-only || Can view accounts, addresses, and any public data, and combinations thereof (eg, balances)
|-
| Financial || Can create new transactions using the wallet's keys
|-
| Full/Admin || Can administrate (download, destroy, etc) wallet keys
|}

Wallets MAY grant full access to username 'admin' with a null password, to requests over stdio.

Wallets SHOULD grant Merchant access to username 'merchant' will a null password, to requests made over direct (ie, physically local, like Bluetooth) connections.
User interfaces SHOULD monitor for new, unsigned transactions with the 'proposal' flag set, and prompt the user to sign or delete them.

=== Object/Query Schema ===
May be provided in multipart/mixed, JSON, XML, etc...

{| class="wikitable sortable"
! Field Name !! Blk !! Tx !! Accting !! Coin !! Key !! Acct !! Queryable !! Description
|-
| id
| {{Table Value Yes}} || {{Table Value Yes}} || {{Table Value Yes}}
| {{Table Value Yes}} || {{Table Value Yes}} || {{Table Value Yes}}
| {{Table Value Yes}}
| Unique data identifier; only guaranteed to remain the same for a single session
|-
| type
| {{Table Value Yes}} || {{Table Value Yes}} || {{Table Value Yes}}
| {{Table Value Yes}} || {{Table Value Yes}} || {{Table Value Yes}}
| {{Table Value Yes}}
| Type of data: 'key', 'tx', 'coin', 'block', 'account', 'accounting'
|-
| hash
| {{Table Value Yes}} || {{Table Value Yes}} || {{Table Value No}}
| {{Table Value No}} || {{Table Value Yes}} || {{Table Value No}}
| {{Table Value Yes}}
|-
| size
| {{Table Value Yes}} || {{Table Value Yes}} || {{Table Value Unknown}}
| {{Table Value No}} || {{Table Value Yes}} || {{Table Value Unknown}}
| {{Table Value Yes}}
|-
| time
| {{Table Value Yes}} || {{Table Value Yes}} || {{Table Value Yes}}
| {{Table Value No}} || {{Table Value No}} || {{Table Value No}}
| {{Table Value Yes}}
|-
| difficulty
| {{Table Value Yes}} || {{Table Value No}} || {{Table Value No}}
| {{Table Value No}} || {{Table Value No}} || {{Table Value No}}
| {{Table Value Yes}}
|-
| difficultyNext
| {{Table Value Yes}} || {{Table Value No}} || {{Table Value No}}
| {{Table Value No}} || {{Table Value No}} || {{Table Value No}}
| {{Table Value Yes}}
|-
| height
| {{Table Value Yes}} || {{Table Value No}} || {{Table Value No}}
| {{Table Value No}} || {{Table Value No}} || {{Table Value No}}
| {{Table Value Yes}}
|-
| confirmations
| {{Table Value Yes}} || {{Table Value Yes}} || {{Table Value Unknown}}
| {{Table Value Yes}} || {{Table Value No}} || {{Table Value No}}
| {{Table Value Yes}}
| -2 for rejected, -1 for unsent, 0 for broadcast, 1+ for number of confirms
|-
| accepted
| {{Table Value Unknown}} || {{Table Value Yes}} || {{Table Value Unknown}}
| {{Table Value Yes}} || {{Table Value No}} || {{Table Value No}}
| {{Table Value Yes}}
| An unconfirmed, accepted tx, is part of the current mining merkle tree
|-
| related
| {{Table Value Yes}} || {{Table Value Yes}} || {{Table Value Unknown}}
| {{Table Value Unknown}} || {{Table Value Unknown}} || {{Table Value Unknown}}
| {{Table Value Yes}}
| Can have multiple entries (in JSON, an array value)
|-
| coinbase
| {{Table Value No}} || {{Table Value Yes}} || {{Table Value No}}
| {{Table Value Yes}} || {{Table Value No}} || {{Table Value No}}
| {{Table Value Yes}}
|-
| inputs
| {{Table Value No}} || {{Table Value Yes}} || {{Table Value Unknown}}
| {{Table Value No}} || {{Table Value No}} || {{Table Value No}}
| {{Table Value Yes}}
|-
| outputs
| {{Table Value No}} || {{Table Value Yes}} || {{Table Value Unknown}}
| {{Table Value No}} || {{Table Value No}} || {{Table Value No}}
| {{Table Value Yes}}
|-
| mine
| {{Table Value Yes}} || {{Table Value Yes}} || {{Table Value Unknown}}
| {{Table Value Yes}} || {{Table Value Yes}} || {{Table Value Unknown}}
| {{Table Value Yes}}
|-
| network
| {{Table Value Yes}} || {{Table Value Yes}} || {{Table Value Unknown}}
| {{Table Value Yes}} || {{Table Value Yes}} || {{Table Value Unknown}}
| {{Table Value Yes}}
| 0xF9BEB4D9 for the main network; 0xFABFB5DA for testnet
|-
| proposal
| {{Table Value No}} || {{Table Value Yes}} || {{Table Value No}}
| {{Table Value No}} || {{Table Value No}} || {{Table Value No}}
| {{Table Value No}}
|}

=== Data ===
* Arbitrary data can be accessed with the path /data/<id>
* GET to fetch
* To get only block header, use /data/<id>/header
* To get only actual content (eg, no calculated values), use /data/<id>/raw
* Optional: PUT to upload

=== Information ===
* GET /state/<network>/connections
* Mining info: (required for mining support)
** GET /state/<network>/hashesPerSec (optional)
** GET /state/<network>/merkle
* GET /info/protocols
** Returns a list of supported protocols/versions and their URIs

=== Requests ===
==== Address validation ====
* GET /validate/address?network=<id>&address=<hash>

==== Calculate balance ====
* GET /balance?<query-object>
Match transactions to be included in the balance.
To ignore spends, use matching.

==== Data search ====
* GET /dataSearch?<query-object>
* POST /dataSearch allowed for more complex queries

NOTE: To get the id rather than the data itself, use a HEAD request and check the Location header.

==== Generate new address ====
* POST /newAddress
** Optional parameter: recycle (bool) -- allows wallet to reuse a spent change address; if not supported, wallet should silently ignore
** Optional parameter: generate (bool) -- if true, make a new address on the spot, never use a preexisting one; if not supported, throw an error
** Optional parameter: account -- associate new address funds with this account id

==== Monitor events ====
* Always POST

===== New data available =====
* Query

==== Move between accounts ====
* POST /accounting/move
** dest=<accountId>
** query=<query-object> OR amount=<amount>
** Optional: comment=<string>

==== Transaction creation ====
* POST /tx/new
** send (bool) -- If true, sign and broadcast the transaction immediately
** fee (amount or range) -- If range, the wallet will try to calculate the minimum it expects the network to accept; if omitted, automatic fee range is unlimited unless bound by other factors (eg, input+strict)
** Optional: fromAccount (account id)
** Optional: input (multiple allowed of: coin id, OR coin id=>scriptSig)
** output (multiple allowed of: address=>amount pairs, OR script=>amount)
** strict (bool) -- If set, error rather than vary any parameters
** Optional: comment=<string>

==== Transaction broadcast ====
* POST /tx/send?id=<existing-tx-internal-id>

==== Shutdown wallet ====
* POST /shutdown

=== Events ===
==== New Data Available ====

=== p2p protocol encapsulation ===
Optional: Establish a full-duplex connection to /p2p to speak direct p2p protocol

== Appendix A. Useful algorithms ==
=== Counting confirmations ===
Because numerous (most) transactions change confirmation at the same event, the only way to do this efficiently, is to monitor for new block events. When a block arrives, increment the confirmation count of all transactions with at least 1 confirmation already. Then check the new block's introduced transactions (incrementing them from 0 to 1), and delete/invalidate any revoked transactions (eg, from a competing chain).

== Appendix B. JSON-RPC equivalents ==
=== backupwallet ===
=== getaccount / getlabel ===
=== getaddressesbyaccount / getaccountaddress / getaddressesbylabel ===
=== getbalance ===
=== getblockcount / getblocknumber ===
=== getconnectioncount ===
=== getdifficulty ===
=== getgenerate ===
=== gethashespersec ===
=== getinfo ===
=== getnewaddress ===
=== getreceivedbyaccount / getreceivedbylabel ===
=== getreceivedbyaddress / getamountreceived ===
=== gettransaction ===
=== getwork ===
=== help ===
=== listaccounts ===
=== listreceivedbyaccount / listreceivedbylabel ===
=== listreceivedbyaddress / getallreceived ===
=== listtransactions ===
=== move ===
=== sendfrom ===
=== sendtoaddress ===
=== setaccount / setlabel ===
=== setgenerate ===
=== settxfee ===
=== stop ===
=== validateaddress ===

== References ==
<references>
<ref name="0MQ-RFC2">[http://rfc.zeromq.org/spec:2 The Size-Prefixed Blob Format], iMatix Corporation.</ref>
<ref name="protobuf">[http://code.google.com/apis/protocolbuffers/docs/encoding.html Protocol Buffers Encoding], Google.</ref>
<ref name="RFC2045">[http://tools.ietf.org/html/rfc2045 Multipurpose Internet Mail Extensions (MIME)], Freed & Borenstein, First Virtual.</ref>
<ref name="RFC2119">[http://tools.ietf.org/html/rfc2119 Key words for use in RFCs to Indicate Requirement Levels], S. Bradner. IETF.</ref>
<ref name="RFC2616">[http://tools.ietf.org/html/rfc2616 Hypertext Transfer Protocol -- HTTP/1.1], Fielding, et al, W3C.</ref>
<ref name="RFC4627">[http://tools.ietf.org/html/rfc4627 The application/json Media Type for JavaScript Object Notation (JSON)], D. Crockford. JSON.org.</ref>
<ref name="SSE">[http://dev.w3.org/html5/eventsource/ Server-Sent Events], Ian Hickson, Google, Inc.</ref>
<ref name="SPDY">[http://www.chromium.org/spdy/spdy-protocol/spdy-protocol-draft2 SPDY Protocol], various. Google, Inc.</ref>
<ref name="WebSocket">[http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-06 The WebSocket protocol], Ian Hickson, Google, Inc.</ref>
<ref name="XML">[http://www.w3.org/TR/REC-xml Extensible Markup Language (XML) 1.0 (Second Edition)], Tim Bray, Jean Paoli, C. M. Sperberg-McQueen and Eve Maler, W3C.</ref>
</references>

Fallback Nodes

2011-03-09T21:12:16Z

M0Ray: /* IPv4 Nodes */

This is a list of nodes which are considered reliable. Nodes from this list which are down for more than 24 hours will be automatically removed and status of each node is displayed and updated every hour by [[User:WikiBot|WikiBot]].

== How to use this list ==

=== Connect to nodes ===

You can connect to these nodes with the ''-addnode=ip'' switch instead of the usual node harvesting process (through IRC or via the embedded nodelist). You can connect to more than one node by using ''-addnode=ip'' more than once. It is usually a good idea to connect to more than one of these nodes.

==== Nodes without a fixed ip ====

If the node IP is not fixed (see "Fixed" column), you will have to resolve the node's name (first column) each time the IP changes. Some nodes may have their ip change once a day, some others once a month, and some others may stay on the same IP for years. Still, as long as the IP is not fixed, there is no guarantee it will stay the same.

The [[Original Bitcoin client]] do not support hostnames to the ''-addnode'' parameter, so you must do the resolving part for it. For example on linux:
bitcoind -addnode=$(host theymos.ath.cx |sed s/"^.*has address "//)

=== IP Transactions ===

You can also send [[IP Transactions]] to these nodes. If you include your bitcoin address in the "message" field, you may have your coins back.

=== Tor network ===

To use tor .onion addresses, you need to map virtual ips via the ''torrc'' file:

mapaddress 192.0.2.2 ijzt2eeizty3p5xe.onion
mapaddress 192.0.2.3 j43z65b6r2usg3vk.onion
mapaddress 192.0.2.4 pvuif6nonbhj3o3r.onion

Once you have configured and restarted tor, 192.0.2.2 will connect to ijzt2eeizty3p5xe.onion when accessed through the Tor proxy (and likewise for the other IPs/onions). You can then run Bitcoin with -addnode=192.0.2.2, or even send bitcoins to that IP address. You can use any arbitrary IP addresses with MapAddress, though some of the common non-routable ranges (10.*, 192.168.*) will not work due to a Bitcoin bug. 192.0.2.1-192.0.2.255 is the recommended range because it is both non-routable and compatible with Bitcoin.

== Nodes list ==

=== IPv4 Nodes ===

{|class="wikitable sortable"
! Hostname !! Owner !! IP !! Fixed !! Status !! Last Seen (GMT) !! Accepts IP transactions
|-

| ndrix.com || mndrix || 64.22.103.150 || {{Table Value Yes}} || {{Fallback Nodes/Node Up|version=0.3.20[.2]}} || 2011-03-09 21:00:04 || ?
|-
| bitcoin-otc.com || nanotube || 69.163.132.101 || {{Table Value Yes}} || {{Fallback Nodes/Node Up|version=0.3.20[.2]}} || 2011-03-09 21:00:04 || No
|-
| 69.164.218.197 || Gavin Andresen || 69.164.218.197 || {{Table Value Yes}} || {{Fallback Nodes/Node Up|version=0.3.20[.2]}} || 2011-03-09 21:00:04 || ?
|-
| 217.157.1.202 || kseistrup || 217.157.1.202 || {{Table Value Yes}} || {{Fallback Nodes/Node Up|version=0.3.20[.2]}} || 2011-03-09 21:00:05 || ?
|-
| 178.63.15.200 || hendi || 178.63.15.200 || {{Table Value Yes}} || {{Fallback Nodes/Node Up|version=0.3.20[.1]}} || 2011-03-09 21:00:05 || ?
|-
| lfmcal.dontexist.org || lfm || 75.158.131.108 || {{Table Value Unknown}} || {{Fallback Nodes/Node Up|version=0.3.20[.1]}} || 2011-03-09 21:00:11 || Yes
|-
| nat.router.dashjr.org || Luke-Jr || 71.1.73.218 || {{Table Value No}} || {{Fallback Nodes/Node Up|version=0.3.20[.1]}} || 2011-03-09 21:00:09 || ?
|-
| bitcoin.sipa.be || sipa || 178.18.90.41 || {{Table Value Yes}} || {{Fallback Nodes/Node Up|version=0.3.19[.2]}} || 2011-03-09 21:00:09 || No
|-
| theymos.ath.cx || theymos || 99.27.237.13 || {{Table Value Unknown}} || {{Fallback Nodes/Node Up|version=0.3.19[.2]}} || 2011-03-09 21:00:09 || Yes
|-
| 109.75.176.193 || MagicalTux [DE] || 109.75.176.193 || {{Table Value Yes}} || {{Fallback Nodes/Node Up|version=0.3.19}} || 2011-03-09 21:00:09 || No
|-
| bitcoins.ca || humble || 142.58.248.28 || {{Table Value Yes}} || {{Fallback Nodes/Node Up|version=0.3.19}} || 2011-03-09 21:00:09 || Yes
|-
| 174.120.185.74 || MagicalTux [US] || 174.120.185.74 || {{Table Value Yes}} || {{Fallback Nodes/Node Up|version=0.3.19}} || 2011-03-09 21:00:09 || No
|-
| 178.63.62.15 || MagicalTux [DE] || 178.63.62.15 || {{Table Value Yes}} || {{Fallback Nodes/Node Up|version=0.3.19}} || 2011-03-09 21:00:10 || No
|-
| lyasoff.com || ? || 200.35.150.50 || {{Table Value Yes}} || {{Fallback Nodes/Node Up|version=0.3.19}} || 2011-03-09 21:00:10 || ?
|-
| bitlex.co.cc || BitLex || 78.34.69.123 || {{Table Value No}} || {{Fallback Nodes/Node Up|version=0.3.19}} || 2011-03-09 21:00:10 || Yes
|-
| fallback.bitcoin.me.uk || Vladimir || 142.58.248.28 || {{Table Value No}} || {{Fallback Nodes/Node Up|version=0.3.19}} || 2011-03-09 21:00:10 || No
|-
| 74.82.216.10 || thufir || 74.82.216.10 || {{Table Value Yes}} || {{Fallback Nodes/Node Up|version=0.3.10}} || 2011-03-09 21:00:11 || Yes
|-
| 74.57.236.239 || ? || 74.57.236.239 || {{Table Value Yes}} || {{Fallback Nodes/Node Old|version=0.3.0}} || 2011-03-09 21:00:11 || ?
|-
| bitcoin.samara-lab.ru || m0Ray


|}

=== Tor nodes ===

{|class="wikitable sortable"
! Hostname !! Owner !! Status !! Last Seen (GMT) !! Accepts IP transactions
|-
| ijzt2eeizty3p5xe.onion || ? || ? || 2011-02-11 || Yes
|-
| j43z65b6r2usg3vk.onion || Dybbuk || ? || 2011-02-11 || Yes
|-
| pvuif6nonbhj3o3r.onion || ? || ? || 2011-02-11 || Yes
|-
| c5qvugpewwyyy5oz.onion || ? || ? || 2011-02-11 || Yes
|-
| vso3r6cmjoomhhgg.onion || echelon || ? || 2011-02-11 || Yes
|-
| rnam4cxam62nkcyf.onion || BitLex || ? || 2011-02-11 || Yes
|-
| bitcoinbudtoeks7.onion || ? || ? || 2011-02-11 || ?
|-
| iy6ni3wkqazp4ytu.onion || ? || ? || 2011-02-11 || ?
|-
| h4kklwodpcmo6cbq.onion || ? || ? || 2011-02-11 || ?
|-
| vv6kcfscuntybrzm.onion || ? || ? || 2011-02-11 || ?
|-
| nlnsivjku4x4lu5n.onion || ? || ? || 2011-02-11 || ?
|-
| xqzfakpeuvrobvpj.onion || ? || ? || 2010-11-13 || No
|}

== Adding a node ==

Before adding yourself as a fallback node, you should be sure your node will stay online for a long time. If a node is offline for more than 24 hours it will be removed from the list. To accept IP transactions you will have to add the ''-allowreceivebyip'' flag to your command line parameters.

To add a node in this list, you just need the ip/hostname and your name, the other fields will be filled automatically. Insert the following lines before the <tt>END NODELIST</tt> line:

<nowiki>|-
| ip || your name</nowiki>

Please note that a bot will connect to your node every hour to check its status and version.