Class JSONRpcProvider

Description

This class is used to provide a JSON RPC provider. JSONRpcProvider

Hierarchy (view full)

AbstractRpcProvider
- JSONRpcProvider

Constructors

constructor

new JSONRpcProvider(url, timeout?): JSONRpcProvider
Parameters
- url: string
- timeout: number = 10_000
Returns JSONRpcProvider
Overrides AbstractRpcProvider.constructor
- Defined in src/providers/JSONRpcProvider.ts:13

Properties

`Readonly`url

url: string

Accessors

utxoManager

get utxoManager(): UTXOsManager
Get the UTXO manager.

Returns UTXOsManager
Inherited from AbstractRpcProvider.utxoManager
- Defined in src/providers/AbstractRpcProvider.ts:53

Methods

_send

_send(payload): Promise<JsonRpcCallResult>
Parameters
- payload: JsonRpcPayload | JsonRpcPayload[]
  The payload to send
Returns Promise<JsonRpcCallResult>
- The result of the call
Description
Sends a JSON RPC payload to the provider.
Overrides AbstractRpcProvider._send
- Defined in src/providers/JSONRpcProvider.ts:27

buildJsonRpcPayload

buildJsonRpcPayload<T>(method, params): JsonRpcPayload
Build a JSON RPC payload. This method is used to build a JSON RPC payload.
Type Parameters
- T extends JSONRpcMethods
Parameters
- method: T
  The method to call
- params: unknown[]
  The parameters to send
Returns JsonRpcPayload
The JSON RPC payload
Inherited from AbstractRpcProvider.buildJsonRpcPayload
- Defined in src/providers/AbstractRpcProvider.ts:570

call

call(to, data, from?, height?): Promise<ICallRequestError | CallResult<{}>>
Call a contract function with a given calldata.
Parameters
- to: BitcoinAddressLike
  The address of the contract
- data: string | Buffer
  The calldata of the contract function
- Optionalfrom: BitcoinAddressLike
  The address to call the contract from
- Optionalheight: BigNumberish
  The height to call the contract from
Returns Promise<ICallRequestError | CallResult<{}>>
The result of the contract function call
Description
This method is used to call a contract function with a given calldata.

Example
```
await call('tb1pth90usc4f528aqphpjrfkkdm4vy8hxnt5gps6aau2nva6pxeshtqqzlt3a', Buffer.from('0x12345678'));
```
Throws
If something went wrong while calling the contract
Inherited from AbstractRpcProvider.call
- Defined in src/providers/AbstractRpcProvider.ts:353

callMultiplePayloads

callMultiplePayloads(payloads): Promise<JsonRpcCallResult>
Send multiple payloads. This method is used to send multiple payloads.
Parameters
- payloads: JsonRpcPayload[]
  The payloads to send
Returns Promise<JsonRpcCallResult>
The result of the payloads
Inherited from AbstractRpcProvider.callMultiplePayloads
- Defined in src/providers/AbstractRpcProvider.ts:547

getBalance

getBalance(addressLike, filterOrdinals?): Promise<bigint>
Get the bitcoin balance of an address.
Parameters
- addressLike: BitcoinAddressLike
  The address to get the balance of
- filterOrdinals: boolean = true
  Whether to filter ordinals or not
Returns Promise<bigint>
The balance of the address
Description
This method is used to get the balance of a bitcoin address.

Example
```
await getBalance('bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq');
```
Inherited from AbstractRpcProvider.getBalance
- Defined in src/providers/AbstractRpcProvider.ts:159

getBlock

getBlock(blockNumberOrHash, prefetchTxs?): Promise<Block>
Get block by number or hash.
Parameters
- blockNumberOrHash: BlockTag
  The block number or hash
- prefetchTxs: boolean = false
  Whether to prefetch transactions
Returns Promise<Block>
The requested block
Description
This method is used to get a block by its number or hash.

Throws
If the block is not found

Example
```
await getBlock(123456);
```
Inherited from AbstractRpcProvider.getBlock
- Defined in src/providers/AbstractRpcProvider.ts:84

getBlockByHash

getBlockByHash(blockHash): Promise<Block>
Get block by hash. This is the same method as getBlock.
Parameters
- blockHash: string
  The block hash
Returns Promise<Block>
The requested block

Description
This method is used to get a block by its hash. Note that this method is the same as getBlock.

Throws
If the block is not found
Inherited from AbstractRpcProvider.getBlockByHash
- Defined in src/providers/AbstractRpcProvider.ts:147

getBlockNumber

getBlockNumber(): Promise<bigint>
Get the latest block number.

Returns Promise<bigint>
The latest block number
Description
This method is used to get the latest block number.

Example
```
await getBlockNumber();
```
Inherited from AbstractRpcProvider.getBlockNumber
- Defined in src/providers/AbstractRpcProvider.ts:63

getBlocks

getBlocks(blockNumbers, prefetchTxs?): Promise<Block[]>
Get multiple blocks by number or hash.
Parameters
- blockNumbers: BlockTag[]
  The block numbers or hashes
- prefetchTxs: boolean = false
  Whether to prefetch transactions
Returns Promise<Block[]>
The requested blocks

Description
This method is used to get multiple blocks by their numbers or hashes.
Inherited from AbstractRpcProvider.getBlocks
- Defined in src/providers/AbstractRpcProvider.ts:111

getBlockWitness

getBlockWitness(height?, trusted?, limit?, page?): Promise<BlockWitnesses>
Get block witnesses.
Parameters
- height: BigNumberish = -1
  The block number or hash, use -1 for latest block
- Optionaltrusted: boolean
  Whether to trust the witnesses or not
- Optionallimit: number
  The maximum number of witnesses to return
- Optionalpage: number
  The page number of the witnesses
Returns Promise<BlockWitnesses>
The witnesses of the block
Description
This method is used to get the witnesses of a block. This proves that the action executed inside a block are valid and confirmed by the network. If the minimum number of witnesses are not met, the block is considered as potentially invalid.

Example
```
await getBlockWitness(123456n);
```
Throws
If something went wrong while fetching the witnesses
Inherited from AbstractRpcProvider.getBlockWitness
- Defined in src/providers/AbstractRpcProvider.ts:430

getChainId

getChainId(): Promise<bigint>
Get the chain id.

Returns Promise<bigint>
The chain id

Description
This method is used to get the chain id.

Throws
If something went wrong while fetching the chain id
Inherited from AbstractRpcProvider.getChainId
- Defined in src/providers/AbstractRpcProvider.ts:253

getCode

getCode(address, onlyBytecode?): Promise<Buffer | ContractData>
Get the contract code of an address.
Parameters
- address: BitcoinAddressLike
  The address of the contract
- OptionalonlyBytecode: boolean = false
  Whether to return only the bytecode
Returns Promise<Buffer | ContractData>
The contract data or bytecode
Description
This method is used to get the contract code of an address.

Example
```
await getCode('tb1pth90usc4f528aqphpjrfkkdm4vy8hxnt5gps6aau2nva6pxeshtqqzlt3a');
```
Throws
If something went wrong while fetching the contract code
Inherited from AbstractRpcProvider.getCode
- Defined in src/providers/AbstractRpcProvider.ts:277

getNetwork

getNetwork(): Promise<Network>
Get the current connected network type.

Returns Promise<Network>
The current connected network type

Description
This method is used to get the current connected network type.

Throws
If the chain id is invalid
Inherited from AbstractRpcProvider.getNetwork
- Defined in src/providers/AbstractRpcProvider.ts:228

getReorg

getReorg(fromBlock?, toBlock?): Promise<ReorgInformation[]>
Get reorgs that happened between two blocks.
Parameters
- OptionalfromBlock: BigNumberish
  The block number to start from
- OptionaltoBlock: BigNumberish
  The block number to end at
Returns Promise<ReorgInformation[]>
The reorg information
Description
This method is used to get the reorgs that happened between two blocks.

Example
```
await getReorg(123456n, 123457n);
```
Throws
If something went wrong while fetching the reorg information
Inherited from AbstractRpcProvider.getReorg
- Defined in src/providers/AbstractRpcProvider.ts:466

getStorageAt

getStorageAt(address, rawPointer, proofs?, height?): Promise<StoredValue>
Get the storage at a specific address and pointer.
Parameters
- address: BitcoinAddressLike
  The address to get the storage from
- rawPointer: string | bigint
  The pointer to get the storage from as base64 or bigint
- proofs: boolean = true
  Whether to send proofs or not
- Optionalheight: BigNumberish
  The height to get the storage from
Returns Promise<StoredValue>
The storage value
Description
This method is used to get the storage at a specific address and pointer.

Example
```
await getStorageAt('tb1pth90usc4f528aqphpjrfkkdm4vy8hxnt5gps6aau2nva6pxeshtqqzlt3a', 'EXLK/QhEQMI5d9DrthLvozT+UcDQ7WuSPaz7g8GV3AQ=');
```
Throws
If something went wrong while fetching the storage
Inherited from AbstractRpcProvider.getStorageAt
- Defined in src/providers/AbstractRpcProvider.ts:316

getTransaction

getTransaction(txHash): Promise<TransactionBase<OPNetTransactionTypes>>
Get a transaction by its hash or hash id.
Parameters
- txHash: string
  The transaction hash
Returns Promise<TransactionBase<OPNetTransactionTypes>>
The requested transaction
Description
This method is used to get a transaction by its hash or hash id.

Example
```
await getTransaction('63e77ba9fa4262b3d4d0d9d97fa8a7359534606c3f3af096284662e3f619f374');
```
Throws
If something went wrong while fetching the transaction
Inherited from AbstractRpcProvider.getTransaction
- Defined in src/providers/AbstractRpcProvider.ts:186

getTransactionReceipt

getTransactionReceipt(txHash): Promise<TransactionReceipt>
Get a transaction receipt by its hash.
Parameters
- txHash: string
  The transaction hash
Returns Promise<TransactionReceipt>
The requested transaction receipt
Description
This method is used to get a transaction receipt by its hash.

Example
```
await getTransactionReceipt('63e77ba9fa4262b3d4d0d9d97fa8a7359534606c3f3af096284662e3f619f374');
```
Throws
Something went wrong while fetching the transaction receipt
Inherited from AbstractRpcProvider.getTransactionReceipt
- Defined in src/providers/AbstractRpcProvider.ts:212

`Protected`providerUrl

providerUrl(url): string
Parameters
- url: string
Returns string
Overrides AbstractRpcProvider.providerUrl
- Defined in src/providers/JSONRpcProvider.ts:69

requestTrustedPublicKeyForBitcoinWrapping

requestTrustedPublicKeyForBitcoinWrapping(amount): Promise<WrappedGeneration>
Generate parameters needed to wrap bitcoin.
Parameters
- amount: BigNumberish
  The amount to wrap
Returns Promise<WrappedGeneration>
The wrapped generation parameters
Description
This method is used to generate the parameters needed to wrap bitcoin.

Example
```
await requestTrustedPublicKeyForBitcoinWrapping(100000000n);
```
Throws
If something went wrong while generating the parameters
Inherited from AbstractRpcProvider.requestTrustedPublicKeyForBitcoinWrapping
- Defined in src/providers/AbstractRpcProvider.ts:499

sendRawTransaction

sendRawTransaction(tx, psbt?): Promise<BroadcastedTransaction>
Send a raw transaction.
Parameters
- tx: string
  The raw transaction to send as hex string
- Optionalpsbt: boolean
  Whether the transaction is a PSBT or not
Returns Promise<BroadcastedTransaction>
The result of the transaction
Description
This method is used to send a raw transaction.

Example
```
await sendRawTransaction('02000000000101ad897689f66c98daae5fdc3606235c1ad7a17b9e0a6aaa0ea9e58ecc1198ad2a0100000000ffffffff01a154c39400000000160014482038efcc91af945f0c756d07a46401920380520247304402201c1f8718dec637ddb41b42abc44dcbf35a94c6be6a9de8c1db48c9fa6e456b7e022032a4b3286808372a7ac2c5094d6341b4d61b17663f4ccd1c1d92efa85c7dada80121020373626d317ae8788ce3280b491068610d840c23ecb64c14075bbb9f670af52c00000000', false);
```
Throws
If something went wrong while sending the transaction
Inherited from AbstractRpcProvider.sendRawTransaction
- Defined in src/providers/AbstractRpcProvider.ts:396

Class JSONRpcProvider

Description

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns JSONRpcProvider

Properties

Readonlyurl

Accessors

utxoManager

Returns UTXOsManager

Methods

_send

Parameters

Returns Promise<JsonRpcCallResult>

Description

buildJsonRpcPayload

Type Parameters

Parameters

Returns JsonRpcPayload

call

Parameters

Returns Promise<ICallRequestError | CallResult<{}>>

Description

Example

Throws

callMultiplePayloads

Parameters

Returns Promise<JsonRpcCallResult>

getBalance

Parameters

Returns Promise<bigint>

Description

Example

getBlock

Parameters

Returns Promise<Block>

Description

Throws

Example

getBlockByHash

Parameters

Returns Promise<Block>

Description

Throws

getBlockNumber

Returns Promise<bigint>

Description

Example

getBlocks

Parameters

Returns Promise<Block[]>

Description

getBlockWitness

Parameters

Returns Promise<BlockWitnesses>

Description

Example

Throws

getChainId

Returns Promise<bigint>

Description

Throws

getCode

Parameters

Returns Promise<Buffer | ContractData>

Description

Example

Throws

getNetwork

Returns Promise<Network>

Description

Throws

getReorg

`Readonly`url

`Protected`providerUrl