Readonly aggregateInputAmount

Readonly aggregateOutputAmount

Readonly changeAmount

Readonly feeAmount

Readonly id

Readonly mass

Readonly minimumSignatures

Readonly paymentAmount

Readonly transaction

Readonly type

addresses

• addresses(): any[]

• List of unique addresses used by transaction inputs. This method can be used to determine addresses used by transaction inputs in order to select private keys needed for transaction signing.

  Returns any[]

createInputSignature

• createInputSignature(input_index, private_key, sighash_type?): string

• Creates and returns a signature for the input at the specified index.

  Parameters

  • input_index: number

  • private_key: PrivateKey

  • Optional sighash_type: SighashType

  Returns string

fillInput

• fillInput(input_index, signature_script): void

• Sets a signature to the input at the specified index.

  Parameters

  • input_index: number

  • signature_script: string | Uint8Array

  Returns void

free

• free(): void

• Returns void

getUtxoEntries

• getUtxoEntries(): any[]

• Provides a list of UTXO entries used by the transaction.

  Returns any[]

serializeToJSON

• serializeToJSON(): string

• Serializes the transaction to a JSON string. The schema of the JSON is defined by ISerializableTransaction. Once serialized, the transaction can be deserialized using Transaction.deserializeFromJSON.

  Returns string

  See

  Transaction, ISerializableTransaction

serializeToObject

• serializeToObject(): Transaction | ITransaction

• Serializes the transaction to a pure JavaScript Object. The schema of the JavaScript object is defined by ISerializableTransaction.

  Returns Transaction | ITransaction

  See

  • ISerializableTransaction
  • Transaction, ISerializableTransaction

serializeToSafeJSON

• serializeToSafeJSON(): string

• Serializes the transaction to a "Safe" JSON schema where it converts all bigint values to string to avoid potential client-side precision loss. Once serialized, the transaction can be deserialized using Transaction.deserializeFromSafeJSON.

  Returns string

  See

  Transaction, ISerializableTransaction

sign

• sign(js_value, check_fully_signed?): void

• Signs transaction with supplied [Array] or [PrivateKey] or an array of raw private key bytes (encoded as Uint8Array or as hex strings)

  Parameters

  • js_value: (string | Uint8Array | PrivateKey)[]

  • Optional check_fully_signed: boolean

  Returns void

signInput

• signInput(input_index, private_key, sighash_type?): void

• Signs the input at the specified index with the supplied private key and an optional SighashType.

  Parameters

  • input_index: number

  • private_key: PrivateKey

  • Optional sighash_type: SighashType

  Returns void

submit

• submit(wasm_rpc_client): Promise<string>

• Submit transaction to the supplied [RpcClient] IMPORTANT: This method will remove UTXOs from the associated UtxoContext if one was used to create the transaction and will return UTXOs back to UtxoContext in case of a failed submission.

  Important

  Make sure to consume the returned txid value. Always invoke this method as follows let txid = await pendingTransaction.submit(rpc);. If you do not consume the returned value and the rpc object is temporary, the GC will collect the rpc object passed to submit() potentially causing a panic.

  Parameters

  • wasm_rpc_client: RpcClient

  Returns Promise<string>

  See

  RpcClient.submitTransaction

toJSON

• toJSON(): Object
• • Return copy of self without private attributes.

  Returns Object

toString

• toString(): string

• Return stringified version of self.

  Returns string