Class Utils

This class provides helper funcitons that can be used acorss the library

Hierarchy

Utils

Index

Constructors

Methods

byteArrayToHexString convertGRpcUtxosToRustUtxos convertRustTransactionToGRpcTransaction createTransaction estimateFee getOutputSum getUtxosSum getXPrivateKey getXPublicKey hexStringToByteArray sendTransaction signTransaction

Constructors

constructor

new Utils(): Utils
Returns Utils

Methods

`Static` byteArrayToHexString

byteArrayToHexString(byteArray: number[]): string
Parameters
- byteArray: number[]
Returns string
- Defined in lib/Utils.ts:36

`Static` convertGRpcUtxosToRustUtxos

convertGRpcUtxosToRustUtxos(utxos: UtxosByAddressesEntry[]): UTXO[]
Parameters
- utxos: UtxosByAddressesEntry[]
Returns UTXO[]
- Defined in lib/Utils.ts:46

`Static` convertRustTransactionToGRpcTransaction

convertRustTransactionToGRpcTransaction(transaction: Transaction): RpcTransaction
Parameters
- transaction: Transaction
Returns RpcTransaction
- Defined in lib/Utils.ts:69

`Static` createTransaction

createTransaction(__namedParameters: CreateTransactionProps): Promise<MutableTransaction>
createTransaction returns a MutableTransaction object from WASM js, which can be used to sign, by calling Utils.signTransaction.

You can call tx.toRpcTransaction(), which converts it to RPC object which can be used for Rust's wRPC submitTransaction endpoint.

If you want to submit the MutableTransaction object to gRPC endpoint, you need to call Utils.convertRustTransactionToGRpcTransaction
Parameters
- __namedParameters: CreateTransactionProps
Returns Promise<MutableTransaction>
- Defined in lib/Utils.ts:177

`Static` estimateFee

estimateFee(__namedParameters: {
outputs: SendOutputProps[];
utxos: UtxosByAddressesEntry[];
}): Promise<bigint>
estimateFee calls minimumTransactionFee in WASM js to calculate the minimum fee in order to send amount to recepient, given the available utxos
Parameters
- __namedParameters: {
  outputs: SendOutputProps[];
  utxos: UtxosByAddressesEntry[];
  }
  - outputs: SendOutputProps[]
  - utxos: UtxosByAddressesEntry[]
Returns Promise<bigint>
- Defined in lib/Utils.ts:114

`Static` getOutputSum

getOutputSum(outputs: SendOutputProps[]): bigint
Parameters
- outputs: SendOutputProps[]
Returns bigint
- Defined in lib/Utils.ts:279

`Static` getUtxosSum

getUtxosSum(utxos: UtxosByAddressesEntry[]): bigint
Parameters
- utxos: UtxosByAddressesEntry[]
Returns bigint
- Defined in lib/Utils.ts:272

`Static` getXPrivateKey

getXPrivateKey(xprv: string, accountIndex: bigint): Promise<XPrivateKey>
Parameters
- xprv: string
- accountIndex: bigint
Returns Promise<XPrivateKey>
- Defined in lib/Utils.ts:106

`Static` getXPublicKey

getXPublicKey(xprv: string, accountIndex: bigint): Promise<XPublicKey>
Parameters
- xprv: string
- accountIndex: bigint
Returns Promise<XPublicKey>
- Defined in lib/Utils.ts:102

`Static` hexStringToByteArray

hexStringToByteArray(hexStr?: string): undefined | number[]
Parameters
- Optional hexStr: string
Returns undefined | number[]
- Defined in lib/Utils.ts:40

`Static` sendTransaction

sendTransaction(__namedParameters: SendCommonProps & SendTransactionProps): Promise<SubmitTransactionResponseMessage>
Parameters
- __namedParameters: SendCommonProps & SendTransactionProps
Returns Promise<SubmitTransactionResponseMessage>
- Defined in lib/Utils.ts:223

`Static` signTransaction

signTransaction(tx: MutableTransaction, privateKeys: PrivateKey[]): MutableTransaction
signTransaction calls signTransaction in WASM js to sign the MutableTransaction object given an array of privateKeys
Parameters
- tx: MutableTransaction
- privateKeys: PrivateKey[]
Returns MutableTransaction
- Defined in lib/Utils.ts:219

Class Utils

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns Utils

Methods

Static byteArrayToHexString

Parameters

byteArray: number[]

Returns string

Static convertGRpcUtxosToRustUtxos

Parameters

utxos: UtxosByAddressesEntry[]

Returns UTXO[]

Static convertRustTransactionToGRpcTransaction

Parameters

transaction: Transaction

Returns RpcTransaction

Static createTransaction

Parameters

__namedParameters: CreateTransactionProps

Returns Promise<MutableTransaction>

Static estimateFee

Parameters

__namedParameters: { outputs: SendOutputProps[]; utxos: UtxosByAddressesEntry[]; }

outputs: SendOutputProps[]

utxos: UtxosByAddressesEntry[]

Returns Promise<bigint>

Static getOutputSum

Parameters

outputs: SendOutputProps[]

Returns bigint

Static getUtxosSum

Parameters

utxos: UtxosByAddressesEntry[]

Returns bigint

Static getXPrivateKey

Parameters

xprv: string

accountIndex: bigint

Returns Promise<XPrivateKey>

Static getXPublicKey

Parameters

xprv: string

accountIndex: bigint

Returns Promise<XPublicKey>

Static hexStringToByteArray

Parameters

Optional hexStr: string

Returns undefined | number[]

Static sendTransaction

Parameters

__namedParameters: SendCommonProps & SendTransactionProps

Returns Promise<SubmitTransactionResponseMessage>

Static signTransaction

Parameters

tx: MutableTransaction

privateKeys: PrivateKey[]

Returns MutableTransaction

Settings

Member Visibility

Theme

On This Page

`Static` byteArrayToHexString

`Static` convertGRpcUtxosToRustUtxos

`Static` convertRustTransactionToGRpcTransaction

`Static` createTransaction

`Static` estimateFee

__namedParameters: {
outputs: SendOutputProps[];
utxos: UtxosByAddressesEntry[];
}

`Static` getOutputSum

`Static` getUtxosSum

`Static` getXPrivateKey

`Static` getXPublicKey

`Static` hexStringToByteArray

`Optional` hexStr: string

`Static` sendTransaction

`Static` signTransaction