Class OPNetLimitedProvider

Allows to fetch UTXO data from any OPNET node

Index

Constructors

Methods

broadcastTransaction fetchUnWrapParameters fetchUTXO fetchUTXOMultiAddr fetchWrapParameters rpcMethod splitUTXOs

Constructors

constructor

new OPNetLimitedProvider(opnetAPIUrl): OPNetLimitedProvider
Parameters
- opnetAPIUrl: string
Returns OPNetLimitedProvider
- Defined in src/utxo/OPNetLimitedProvider.ts:28

Methods

broadcastTransaction

broadcastTransaction(transaction, psbt): Promise<undefined | BroadcastResponse>
Broadcasts a transaction to the OPNET node
Parameters
- transaction: string
  The transaction to broadcast
- psbt: boolean
  Whether the transaction is a PSBT
Returns Promise<undefined | BroadcastResponse>
- The response from the OPNET node
- Defined in src/utxo/OPNetLimitedProvider.ts:169

fetchUnWrapParameters

fetchUnWrapParameters(amount, receiver): Promise<undefined | UnwrapGeneration>
Fetches the wrap parameters from the OPNET node
Parameters
- amount: bigint
  The amount to wrap
- receiver: Address
  The receiver address
Returns Promise<undefined | UnwrapGeneration>
- The wrap parameters fetched
Throws
- If wrap parameters could not be fetched
- Defined in src/utxo/OPNetLimitedProvider.ts:307

fetchUTXO

fetchUTXO(settings): Promise<UTXO[]>
Fetches UTXO data from the OPNET node
Parameters
- settings: FetchUTXOParams
  The settings to fetch UTXO data
Returns Promise<UTXO[]>
- The UTXOs fetched
Throws
- If UTXOs could not be fetched
- Defined in src/utxo/OPNetLimitedProvider.ts:36

fetchUTXOMultiAddr

fetchUTXOMultiAddr(settings): Promise<UTXO[]>
Fetches UTXO data from the OPNET node for multiple addresses
Parameters
- settings: FetchUTXOParamsMultiAddress
  The settings to fetch UTXO data
Returns Promise<UTXO[]>
- The UTXOs fetched
Throws
- If UTXOs could not be fetched
- Defined in src/utxo/OPNetLimitedProvider.ts:125

fetchWrapParameters

fetchWrapParameters(amount): Promise<undefined | WrappedGeneration>
Fetches the wrap parameters from the OPNET node
Parameters
- amount: bigint
  The amount to wrap
Returns Promise<undefined | WrappedGeneration>
- The wrap parameters fetched
Throws
- If wrap parameters could not be fetched
- Defined in src/utxo/OPNetLimitedProvider.ts:283

rpcMethod

rpcMethod(method, paramsMethod): Promise<unknown>
Fetches to the OPNET node
Parameters
- method: string
- paramsMethod: unknown[]
Returns Promise<unknown>
- Defined in src/utxo/OPNetLimitedProvider.ts:235

splitUTXOs

splitUTXOs(wallet, network, splitInputsInto, amountPerUTXO): Promise<BroadcastResponse | {
error: string;
}>
Splits UTXOs into smaller UTXOs
Parameters
- wallet: Wallet
  The wallet to split UTXOs
- network: Network
  The network to split UTXOs
- splitInputsInto: number
  The number of UTXOs to split into
- amountPerUTXO: bigint
  The amount per UTXO
Returns Promise<BroadcastResponse | {
error: string;
}>
- The response from the OPNET node or an error
- Defined in src/utxo/OPNetLimitedProvider.ts:191