Skip to content

bitcoinjs-lib / Transaction

Class: Transaction ​

Defined in: ts_src/transaction.ts:66

Represents a Bitcoin transaction.

Constructors ​

Constructor ​

new Transaction(): Transaction

Returns ​

Transaction

Properties ​

ins ​

ins: TxInput[] = []

Defined in: ts_src/transaction.ts:149


locktime ​

locktime: number = 0

Defined in: ts_src/transaction.ts:148


outs ​

outs: TxOutput[] = []

Defined in: ts_src/transaction.ts:150


version ​

version: number = 1

Defined in: ts_src/transaction.ts:147


ADVANCED_TRANSACTION_FLAG ​

readonly static ADVANCED_TRANSACTION_FLAG: 1 = 0x01

Defined in: ts_src/transaction.ts:76


ADVANCED_TRANSACTION_MARKER ​

readonly static ADVANCED_TRANSACTION_MARKER: 0 = 0x00

Defined in: ts_src/transaction.ts:75


DEFAULT_SEQUENCE ​

readonly static DEFAULT_SEQUENCE: 4294967295 = 0xffffffff

Defined in: ts_src/transaction.ts:67


SIGHASH_ALL ​

readonly static SIGHASH_ALL: 1 = 0x01

Defined in: ts_src/transaction.ts:69


SIGHASH_ANYONECANPAY ​

readonly static SIGHASH_ANYONECANPAY: 128 = 0x80

Defined in: ts_src/transaction.ts:72


SIGHASH_DEFAULT ​

readonly static SIGHASH_DEFAULT: 0 = 0x00

Defined in: ts_src/transaction.ts:68


SIGHASH_INPUT_MASK ​

readonly static SIGHASH_INPUT_MASK: 128 = 0x80

Defined in: ts_src/transaction.ts:74


SIGHASH_NONE ​

readonly static SIGHASH_NONE: 2 = 0x02

Defined in: ts_src/transaction.ts:70


SIGHASH_OUTPUT_MASK ​

readonly static SIGHASH_OUTPUT_MASK: 3 = 0x03

Defined in: ts_src/transaction.ts:73


SIGHASH_SINGLE ​

readonly static SIGHASH_SINGLE: 3 = 0x03

Defined in: ts_src/transaction.ts:71

Methods ​

addInput() ​

addInput(hash, index, sequence?, scriptSig?): number

Defined in: ts_src/transaction.ts:158

Parameters ​

hash ​

Uint8Array

index ​

number

sequence? ​

number

scriptSig? ​

Uint8Array

Returns ​

number


addOutput() ​

addOutput(scriptPubKey, value): number

Defined in: ts_src/transaction.ts:190

Parameters ​

scriptPubKey ​

Uint8Array

value ​

bigint

Returns ​

number


byteLength() ​

byteLength(_ALLOW_WITNESS?): number

Defined in: ts_src/transaction.ts:227

Parameters ​

_ALLOW_WITNESS? ​

boolean = true

Returns ​

number


clone() ​

clone(): Transaction

Defined in: ts_src/transaction.ts:248

Returns ​

Transaction


getHash() ​

getHash(forWitness?): Uint8Array

Defined in: ts_src/transaction.ts:611

Parameters ​

forWitness? ​

boolean

Returns ​

Uint8Array


getId() ​

getId(): string

Defined in: ts_src/transaction.ts:617

Returns ​

string


hashForSignature() ​

hashForSignature(inIndex, prevOutScript, hashType): Uint8Array

Defined in: ts_src/transaction.ts:281

Hash transaction for signing a specific input.

Bitcoin uses a different hash for each signed transaction input. This method copies the transaction, makes the necessary changes based on the hashType, and then hashes the result. This hash can then be used to sign the provided transaction input.

Parameters ​

inIndex ​

number

prevOutScript ​

Uint8Array

hashType ​

number

Returns ​

Uint8Array


hashForWitnessV0() ​

hashForWitnessV0(inIndex, prevOutScript, value, hashType): Uint8Array

Defined in: ts_src/transaction.ts:512

Parameters ​

inIndex ​

number

prevOutScript ​

Uint8Array

value ​

bigint

hashType ​

number

Returns ​

Uint8Array


hashForWitnessV1() ​

hashForWitnessV1(inIndex, prevOutScripts, values, hashType, leafHash?, annex?): Uint8Array

Defined in: ts_src/transaction.ts:358

Parameters ​

inIndex ​

number

prevOutScripts ​

Uint8Array[]

values ​

bigint[]

hashType ​

number

leafHash? ​

Uint8Array

annex? ​

Uint8Array

Returns ​

Uint8Array


hasWitnesses() ​

hasWitnesses(): boolean

Defined in: ts_src/transaction.ts:205

Returns ​

boolean


isCoinbase() ​

isCoinbase(): boolean

Defined in: ts_src/transaction.ts:152

Returns ​

boolean


setInputScript() ​

setInputScript(index, scriptSig): void

Defined in: ts_src/transaction.ts:630

Parameters ​

index ​

number

scriptSig ​

Uint8Array

Returns ​

void


setWitness() ​

setWitness(index, witness): void

Defined in: ts_src/transaction.ts:636

Parameters ​

index ​

number

witness ​

Uint8Array[]

Returns ​

void


stripWitnesses() ​

stripWitnesses(): void

Defined in: ts_src/transaction.ts:211

Returns ​

void


toBuffer() ​

toBuffer(buffer?, initialOffset?): Uint8Array

Defined in: ts_src/transaction.ts:622

Parameters ​

buffer? ​

Uint8Array

initialOffset? ​

number

Returns ​

Uint8Array


toHex() ​

toHex(): string

Defined in: ts_src/transaction.ts:626

Returns ​

string


virtualSize() ​

virtualSize(): number

Defined in: ts_src/transaction.ts:223

Returns ​

number


weight() ​

weight(): number

Defined in: ts_src/transaction.ts:217

Returns ​

number


fromBuffer() ​

static fromBuffer(buffer, _NO_STRICT?): Transaction

Defined in: ts_src/transaction.ts:78

Parameters ​

buffer ​

Uint8Array

_NO_STRICT? ​

boolean

Returns ​

Transaction


fromHex() ​

static fromHex(hex): Transaction

Defined in: ts_src/transaction.ts:135

Parameters ​

hex ​

string

Returns ​

Transaction


isCoinbaseHash() ​

static isCoinbaseHash(buffer): boolean

Defined in: ts_src/transaction.ts:139

Parameters ​

buffer ​

Uint8Array

Returns ​

boolean

Released under the MIT License.