JSDoc: Class: CoinView

Constructor

new CoinView()

Create a coin view.

Properties:

Name	Type	Description
`map`	Object
`undo`	UndoCoins

Source:

coins/coinview.js, line 36

Methods

(static) read(br, tx) → {CoinView}

Read serialized view data from a buffer reader as it pertains to a transaction.

Parameters:

Name	Type	Description
`br`	BufferReader
`tx`	TX

Source:

coins/coinview.js, line 596

Returns:

Type: CoinView

add(hash, coins) → {Coins}

Add coins to the collection.

Parameters:

Name	Type	Description
`hash`	Hash
`coins`	Coins

Source:

coins/coinview.js, line 76

Returns:

Type: Coins

addCoin(coin) → {CoinEntry|null}

Add a coin to the collection.

Parameters:

Name	Type	Description
`coin`	Coin

Source:

coins/coinview.js, line 162

Returns:

Type: CoinEntry | null

addEntry(prevout, coin) → {CoinEntry|null}

Add an entry to the collection.

Parameters:

Name	Type	Description
`prevout`	Outpoint
`coin`	CoinEntry

Source:

coins/coinview.js, line 150

Returns:

Type: CoinEntry | null

addIndex(tx, index, height) → {CoinEntry|null}

Add an output to the collection by output index.

Parameters:

Name	Type	Description
`tx`	TX
`index`	Number
`height`	Number

Source:

coins/coinview.js, line 188

Returns:

Type: CoinEntry | null

addOutput(prevout, output) → {CoinEntry|null}

Add an output to the collection.

Parameters:

Name	Type	Description
`prevout`	Outpoint
`output`	Output

Source:

coins/coinview.js, line 174

Returns:

Type: CoinEntry | null

addPath(prevout, path) → {Path|null}

Add an HD path to the collection. Implemented in WalletCoinView

Parameters:

Name	Type	Description
`prevout`	Outpoint
`path`	Path

Source:

coins/coinview.js, line 422

Returns:

Type: Path | null

addTX(tx, height) → {Coins}

Add a tx to the collection.

Parameters:

Name	Type	Description
`tx`	TX
`height`	Number

Source:

coins/coinview.js, line 120

Returns:

Type: Coins

ensure(hash) → {Coins}

Ensure existence of coins object in the collection.

Parameters:

Name	Type	Description
`hash`	Hash

Source:

coins/coinview.js, line 87

Returns:

Type: Coins

get(hash) → {Coins}

Get coins.

Parameters:

Name	Type	Description
`hash`	Hash

Source:

coins/coinview.js, line 55

Returns:

coins

Type: Coins

getCoin(prevout) → {Coin|null}

Get a single coin by prevout.

Parameters:

Name	Type	Description
`prevout`	Outpoint

Source:

coins/coinview.js, line 287

Returns:

Type: Coin | null

getCoinFor(input) → {Coin|null}

Get a single coin by input.

Parameters:

Name	Type	Description
`input`	Input

Source:

coins/coinview.js, line 389

Returns:

Type: Coin | null

getEntry(prevout) → {CoinEntry|null}

Get a single entry by prevout.

Parameters:

Name	Type	Description
`prevout`	Outpoint

Source:

coins/coinview.js, line 255

Returns:

Type: CoinEntry | null

getEntryFor(input) → {CoinEntry|null}

Get a single entry by input.

Parameters:

Name	Type	Description
`input`	Input

Source:

coins/coinview.js, line 369

Returns:

Type: CoinEntry | null

getHeight(prevout) → {Number}

Get coins height by prevout.

Parameters:

Name	Type	Description
`prevout`	Outpoint

Source:

coins/coinview.js, line 329

Returns:

Type: Number

getHeightFor(input) → {Number}

Get coins height by input.

Parameters:

Name	Type	Description
`input`	Input

Source:

coins/coinview.js, line 432

Returns:

Type: Number

getOutput(prevout) → {Output|null}

Get a single output by prevout.

Parameters:

Name	Type	Description
`prevout`	Outpoint

Source:

coins/coinview.js, line 302

Returns:

Type: Output | null

getOutputFor(input) → {Output|null}

Get a single output by input.

Parameters:

Name	Type	Description
`input`	Input

Source:

coins/coinview.js, line 399

Returns:

Type: Output | null

getPath(prevout) → {null}

Get an HD path by prevout. Implemented in WalletCoinView.

Parameters:

Name	Type	Description
`prevout`	Outpoint

Source:

coins/coinview.js, line 319

Returns:

Type: null

getPathFor(input) → {null}

Get a single path by input. Implemented in WalletCoinView.

Parameters:

Name	Type	Description
`input`	Input

Source:

coins/coinview.js, line 410

Returns:

Type: null

getSize(tx) → {Number}

Calculate serialization size.

Parameters:

Name	Type	Description
`tx`	TX

Source:

coins/coinview.js, line 527

Returns:

Type: Number

has(hash) → {Boolean}

Test whether the view has an entry.

Parameters:

Name	Type	Description
`hash`	Hash

Source:

coins/coinview.js, line 65

Returns:

Type: Boolean

hasEntry(prevout) → {Boolean}

Test whether the view has an entry by prevout.

Parameters:

Name	Type	Description
`prevout`	Outpoint

Source:

coins/coinview.js, line 239

Returns:

Type: Boolean

hasEntryFor(input) → {Boolean}

Test whether the view has an entry by input.

Parameters:

Name	Type	Description
`input`	Input

Source:

coins/coinview.js, line 359

Returns:

Type: Boolean

isCoinbase(prevout) → {Boolean}

Get coins coinbase flag by prevout.

Parameters:

Name	Type	Description
`prevout`	Outpoint

Source:

coins/coinview.js, line 344

Returns:

Type: Boolean

isCoinbaseFor(input) → {Boolean}

Get coins coinbase flag by input.

Parameters:

Name	Type	Description
`input`	Input

Source:

coins/coinview.js, line 442

Returns:

Type: Boolean

isUnspent(prevout) → {Boolean}

Test whether an entry has been spent by prevout.

Parameters:

Name	Type	Description
`prevout`	Outpoint

Source:

coins/coinview.js, line 271

Returns:

Type: Boolean

isUnspentFor(input) → {Boolean}

Test whether an entry has been spent by input.

Parameters:

Name	Type	Description
`input`	Input

Source:

coins/coinview.js, line 379

Returns:

Type: Boolean

read(br, tx)

Read serialized view data from a buffer reader as it pertains to a transaction.

Parameters:

Name	Type	Description
`br`	BufferReader
`tx`	TX

Source:

coins/coinview.js, line 575

(async) readCoin(db, prevout) → {Promise}

Retrieve coins from database.

Parameters:

Name	Type	Description
`db`	ChainDB
`prevout`	Outpoint

Source:

coins/coinview.js, line 454

Returns:

Returns CoinEntry.

Type: Promise

(async) readInputs(db, tx) → {Promise}

Read all input coins into unspent map.

Parameters:

Name	Type	Description
`db`	ChainDB
`tx`	TX

Source:

coins/coinview.js, line 476

Returns:

Returns {Boolean}.

Type: Promise

remove(hash) → (nullable) {Coins}

Remove coins from the collection.

Parameters:

Name	Type	Description
`hash`	Hash

Source:

coins/coinview.js, line 102

Returns:

Type: Coins

removeEntry(prevout) → {CoinEntry|null}

Remove an output.

Parameters:

Name	Type	Description
`prevout`	Outpoint

Source:

coins/coinview.js, line 223

Returns:

Type: CoinEntry | null

removeTX(tx, height) → {Coins}

Remove a tx from the collection.

Parameters:

Name	Type	Description
`tx`	TX
`height`	Number

Source:

coins/coinview.js, line 133

Returns:

Type: Coins

spendEntry(prevout) → {CoinEntry|null}

Spend an output.

Parameters:

Name	Type	Description
`prevout`	Outpoint

Source:

coins/coinview.js, line 200

Returns:

Type: CoinEntry | null

(async) spendInputs(db, tx) → {Promise}

Spend coins for transaction.

Parameters:

Name	Type	Description
`db`	ChainDB
`tx`	TX

Source:

coins/coinview.js, line 495

Returns:

Returns {Boolean}.

Type: Promise

write(bw, tx) → {BufioWriter}

Write coin data to buffer writer as it pertains to a transaction.

Parameters:

Name	Type	Description
`bw`	BufioWriter
`tx`	TX

Source:

coins/coinview.js, line 552

Returns:

Type: BufioWriter