Class: Bitcoin

Constructor

new Bitcoin(settingsopt)

Creates an instance of the Bitcoin service.

Parameters:

Name Type Attributes Description

settings

Object

Map of configuration options for the Bitcoin service.

Properties

Name	Type	Attributes	Description
`network`	String	<optional>	One of `regtest`, `testnet`, or `mainnet`.
`nodes`	Array	<optional>	List of address:port pairs to trust.
`seeds`	Array	<optional>	Bitcoin peers to request chain from (address:port).
`fullnode`	Boolean	<optional>	Run a full node.

Source:

services/bitcoin.js, line 41

Extends

Service

Members

UAString

User Agent string for the Bitcoin P2P network.

Source:

services/bitcoin.js, line 229

height

Chain height (`=== length - 1`)

Source:

services/bitcoin.js, line 247

tip

Chain tip (block hash of the chain with the most Proof of Work)

Source:

services/bitcoin.js, line 236

(static) MutableTransaction

Provides bcoin's implementation of `MTX` internally. This static may be removed in the future.

Deprecated:

Source:

services/bitcoin.js, line 214

(static) Transaction

Provides bcoin's implementation of `TX` internally. This static may be removed in the future.

Deprecated:

Source:

services/bitcoin.js, line 205

Methods

(async) _GET(path) → {Promise}

Retrieve a value from the Service's state.

Parameters:

Name	Type	Description
`path`	String	Path of the value to retrieve.

Overrides:

Service#_GET

Source:

types/service.js, line 663

Returns:

Resolves with the result.

Type: Promise

(async) _PUT(path, value, commitopt) → {Promise}

Store a value in the Service's state.

Parameters:

Name	Type	Attributes	Default	Description
`path`	String			Path to store the value at.
`value`	Object			Document to store.
`commit`	Boolean	<optional>	false	Sign the resulting state.

Overrides:

Service#_PUT

Source:

types/service.js, line 697

Returns:

Resolves with with stored document.

Type: Promise

(async) _buildPSBT(options) → {PSBT}

Create a Partially-Signed Bitcoin Transaction (PSBT).

Parameters:

Name	Type	Description
`options`	Object	Parameters for the PSBT.

Source:

services/bitcoin.js, line 1442

Returns:

Instance of the PSBT.

Type: PSBT

(async) _connectSPV()

Initiate outbound connections to configured SPV nodes.

Source:

services/bitcoin.js, line 818

(async) _createContractProposal(options) → {ContractProposal}

Creates an unsigned Bitcoin transaction.

Parameters:

Name	Type	Description
`options`	Object

Source:

services/bitcoin.js, line 1204

Returns:

Instance of the proposal.

Type: ContractProposal

(async) _handleBlockFromSPV(msg)

Hand a Block message as supplied by an SPV client.

Parameters:

Name	Type	Description
`msg`	BlockMessage	A Message as passed by the SPV source.

Source:

services/bitcoin.js, line 703

(async) _handleCommittedBlock(block)

Receive a committed block.

Parameters:

Name	Type	Description
`block`	Block	Block to handle.

Source:

services/bitcoin.js, line 472

(async) _handlePeerPacket(msg)

Process a message from a peer in the Bitcoin network.

Parameters:

Name	Type	Description
`msg`	PeerPacket	Message from peer.

Source:

services/bitcoin.js, line 638

(async) _handleTransactionFromSPV(tx)

Verify and interpret a BitcoinTransaction, as received from an SPVSource.

Parameters:

Name	Type	Description
`tx`	BitcoinTransaction	Incoming transaction from the SPV source.

Source:

services/bitcoin.js, line 732

(async) _prepareTransaction(obj)

Prepares a Transaction for storage.

Parameters:

Name	Type	Description
`obj`	Transaction	Transaction to prepare.

Source:

services/bitcoin.js, line 461

(async) _processSpendMessage(message) → {BitcoinTransactionID}

Process a spend message.

Parameters:

Name Type Description

message

SpendMessage

Generic-level message for spending.

Properties

Name	Type	Description
`amount`	String	Amount (in BTC) to spend.
`destination`	String	Destination for funds.

Source:

services/bitcoin.js, line 408

Returns:

Hex-encoded representation of the transaction ID.

Type: BitcoinTransactionID

(async) _registerActor(actor) → {Promise}

Parameters:

Name	Type	Description
`actor`	Object	Instance of the Actor.

Overrides:

Service#_registerActor

Source:

types/service.js, line 975

Returns:

Resolves upon successful registration.

Type: Promise

(async) _requestBlockAtHeight(height) → {Object}

Retrieve the equivalent to `getblockhash` from Bitcoin Core.

Parameters:

Name	Type	Description
`height`	Number	Height of block to retrieve.

Source:

services/bitcoin.js, line 1122

Returns:

The block hash.

Type: Object

(async) _send(message)

Sends a message.

Parameters:

Name	Type	Description
`message`	Mixed	Message to send.

Overrides:

Service#_send

Source:

types/service.js, line 1104

(async) _subscribeToShard(shard)

Attach event handlers for a supplied list of addresses.

Parameters:

Name	Type	Description
`shard`	Shard	List of addresses to monitor.

Source:

services/bitcoin.js, line 804

beat() → {Service}

Compute latest state.

Overrides:

Service#beat

Source:

types/service.js, line 257

Fires:

Message#event:beat

Returns:

Type: Service

(async) broadcast(tx)

Broadcast a transaction to the Bitcoin network.

Parameters:

Name	Type	Description
`tx`	TX	Bitcoin transaction

Source:

services/bitcoin.js, line 381

(async) connect(addr)

Connect to a Fabric Peer.

Parameters:

Name	Type	Description
`addr`	String	Address to connect to.

Overrides:

Service#connect

Source:

services/bitcoin.js, line 1022

get(path) → {Mixed}

Retrieve a key from the State.

Parameters:

Name	Type	Description
`path`	Path	Key to retrieve.

Overrides:

Service#get

Source:

types/service.js, line 302

Returns:

Type: Mixed

handler(message) → {Service}

Default route handler for an incoming message. Follows the Activity Streams 2.0 spec: https://www.w3.org/TR/activitystreams-core/

Parameters:

Name	Type	Description
`message`	Activity	Message object.

Overrides:

Service#handler

Source:

types/service.js, line 447

Returns:

Chainable method.

Type: Service

init()

Called by Web Components. TODO: move to @fabric/http/types/spa

Overrides:

Service#init

Source:

types/service.js, line 240

lock(durationopt) → {Boolean}

Attempt to acquire a lock for `duration` seconds.

Parameters:

Name	Type	Attributes	Default	Description
`duration`	Number	<optional>	1000	Number of milliseconds to hold lock.

Overrides:

Service#lock

Source:

types/service.js, line 466

Returns:

true if locked, false if unable to lock.

Type: Boolean

(async) route(msg) → {Promise}

Resolve a State from a particular Message object.

Parameters:

Name	Type	Description
`msg`	Message	Explicit Fabric Message.

Overrides:

Service#route

Source:

types/service.js, line 515

Returns:

Resolves with resulting State.

Type: Promise

(async) send(channel, message) → {Service}

Send a message to a channel.

Parameters:

Name	Type	Description
`channel`	String	Channel name to which the message will be sent.
`message`	String	Content of the message to send.

Overrides:

Service#send

Source:

types/service.js, line 852

Returns:

Chainable method.

Type: Service

set(path) → {Mixed}

Set a key in the State to a particular value.

Parameters:

Name	Type	Description
`path`	Path	Key to retrieve.

Overrides:

Service#set

Source:

types/service.js, line 317

Returns:

Type: Mixed

(async) start()

Start the Bitcoin service, including the initiation of outbound requests.

Overrides:

Service#start

Source:

services/bitcoin.js, line 1745

(async) stop()

Stop the Bitcoin service.

Source:

services/bitcoin.js, line 1867

tick() → {Number}

Move forward one clock cycle.

Overrides:

Service#tick

Source:

types/service.js, line 248

Returns:

Type: Number

trust(source) → {Service}

Explicitly trust all events from a known source.

Parameters:

Name	Type	Description
`source`	EventEmitter	Emitter of events.

Overrides:

Service#trust

Source:

types/service.js, line 328

Returns:

Instance of Service after binding events.

Type: Service