opnet 1.0.49 → 1.0.50

package/src/providers/AbstractRpcProvider.ts

@@ -1,602 +1,602 @@
-import '../serialize/BigInt.js';
-import { BufferHelper } from '@btc-vision/bsi-binary';
-import { WrappedGeneration, WrappedGenerationParameters } from '@btc-vision/transaction';
-import { Network, networks } from 'bitcoinjs-lib';
-import { IUTXO } from '../bitcoin/interfaces/IUTXO.js';
-
-import { UTXO, UTXOs } from '../bitcoin/UTXOs.js';
-import { Block } from '../block/Block.js';
-import { BlockWitnesses } from '../block/interfaces/BlockWitness.js';
-import { IBlock } from '../block/interfaces/IBlock.js';
-import { BigNumberish, BitcoinAddressLike, BlockTag } from '../common/CommonTypes.js';
-import { CallResult } from '../contracts/CallResult.js';
-import { ContractData } from '../contracts/ContractData.js';
-import { ICallRequestError, ICallResult } from '../contracts/interfaces/ICallResult.js';
-import { IRawContract } from '../contracts/interfaces/IRawContract.js';
-import { OPNetTransactionTypes } from '../interfaces/opnet/OPNetTransactionTypes.js';
-import { IStorageValue } from '../storage/interfaces/IStorageValue.js';
-import { StoredValue } from '../storage/StoredValue.js';
-import { BroadcastedTransaction } from '../transactions/interfaces/BroadcastedTransaction.js';
-import { ITransaction } from '../transactions/interfaces/ITransaction.js';
-import { TransactionReceipt } from '../transactions/metadata/TransactionReceipt.js';
-import { TransactionBase } from '../transactions/Transaction.js';
-import { TransactionParser } from '../transactions/TransactionParser.js';
-import { GenerateTarget } from './interfaces/Generate.js';
-import { JsonRpcPayload } from './interfaces/JSONRpc.js';
-import { JSONRpcMethods } from './interfaces/JSONRpcMethods.js';
-import {
-    JSONRpc2ResponseResult,
-    JsonRpcCallResult,
-    JsonRpcResult,
-    JSONRpcResultError,
-} from './interfaces/JSONRpcResult.js';
-import { ReorgInformation } from './interfaces/ReorgInformation.js';
-
-/**
- * @description This class is used to provide an abstract RPC provider.
- * @abstract
- * @class AbstractRpcProvider
- * @category Providers
- */
-export abstract class AbstractRpcProvider {
-    private nextId: number = 0;
-
-    private network: Network | undefined;
-    private chainId: bigint | undefined;
-
-    protected constructor() {}
-
-    /**
-     * Get the latest block number.
-     * @description This method is used to get the latest block number.
-     * @returns {Promise<number>} The latest block number
-     * @example await getBlockNumber();
-     */
-    public async getBlockNumber(): Promise<bigint> {
-        const payload: JsonRpcPayload = this.buildJsonRpcPayload(
-            JSONRpcMethods.BLOCK_BY_NUMBER,
-            [],
-        );
-
-        const rawBlockNumber: JsonRpcResult = await this.callPayloadSingle(payload);
-        const result: string = rawBlockNumber.result as string;
-
-        return BigInt(result);
-    }
-
-    /**
-     * Get block by number or hash.
-     * @param {BlockTag} blockNumberOrHash The block number or hash
-     * @param {boolean} prefetchTxs Whether to prefetch transactions
-     * @description This method is used to get a block by its number or hash.
-     * @returns {Promise<Block>} The requested block
-     * @throws {Error} If the block is not found
-     * @example await getBlock(123456);
-     */
-    public async getBlock(
-        blockNumberOrHash: BlockTag,
-        prefetchTxs: boolean = false,
-    ): Promise<Block> {
-        const method =
-            typeof blockNumberOrHash === 'string'
-                ? JSONRpcMethods.GET_BLOCK_BY_HASH
-                : JSONRpcMethods.GET_BLOCK_BY_NUMBER;
-
-        const payload: JsonRpcPayload = this.buildJsonRpcPayload(method, [
-            blockNumberOrHash,
-            prefetchTxs,
-        ]);
-
-        const block: JsonRpcResult = await this.callPayloadSingle(payload);
-
-        const result: IBlock = block.result as IBlock;
-        return new Block(result);
-    }
-
-    /**
-     * Get multiple blocks by number or hash.
-     * @param {BlockTag[]} blockNumbers The block numbers or hashes
-     * @param {boolean} prefetchTxs Whether to prefetch transactions
-     * @description This method is used to get multiple blocks by their numbers or hashes.
-     * @returns {Promise<Block[]>} The requested blocks
-     */
-    public async getBlocks(
-        blockNumbers: BlockTag[],
-        prefetchTxs: boolean = false,
-    ): Promise<Block[]> {
-        const payloads: JsonRpcPayload[] = blockNumbers.map((blockNumber) => {
-            return this.buildJsonRpcPayload(JSONRpcMethods.GET_BLOCK_BY_NUMBER, [
-                blockNumber,
-                prefetchTxs,
-            ]);
-        });
-
-        const blocks: JsonRpcCallResult = await this.callMultiplePayloads(payloads);
-
-        if ('error' in blocks) {
-            const error = blocks.error as JSONRpcResultError<JSONRpcMethods.BLOCK_BY_NUMBER>;
-
-            throw new Error(`Error fetching block: ${error.message}`);
-        }
-
-        return blocks.map((block) => {
-            if ('error' in block) {
-                throw new Error(`Error fetching block: ${block.error}`);
-            }
-
-            const result: IBlock = block.result as IBlock;
-
-            return new Block(result);
-        });
-    }
-
-    /**
-     * Get block by hash. This is the same method as getBlock.
-     * @param {string} blockHash The block hash
-     * @description This method is used to get a block by its hash. Note that this method is the same as getBlock.
-     * @returns {Promise<Block>} The requested block
-     * @throws {Error} If the block is not found
-     */
-    public async getBlockByHash(blockHash: string): Promise<Block> {
-        return await this.getBlock(blockHash);
-    }
-
-    /**
-     * Get the bitcoin balance of an address.
-     * @param {BitcoinAddressLike} addressLike The address to get the balance of
-     * @param {boolean} filterOrdinals Whether to filter ordinals or not
-     * @description This method is used to get the balance of a bitcoin address.
-     * @returns {Promise<bigint>} The balance of the address
-     * @example await getBalance('bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq');
-     */
-    public async getBalance(addressLike: BitcoinAddressLike, filterOrdinals: boolean = true): Promise<bigint> {
-        const address: string = addressLike.toString();
-        const payload: JsonRpcPayload = this.buildJsonRpcPayload(JSONRpcMethods.GET_BALANCE, [
-            address,
-            filterOrdinals
-        ]);
-
-        const rawBalance: JsonRpcResult = await this.callPayloadSingle(payload);
-        const result: string = rawBalance.result as string;
-        if (!result || (result && !result.startsWith('0x'))) {
-            throw new Error(`Invalid balance returned from provider: ${result}`);
-        }
-
-        return BigInt(result);
-    }
-
-    /**
-     * Get the UTXOs (Unspent Transaction Outputs) of an address.
-     * @description This method is used to get the UTXOs of a bitcoin address.
-     * @param {BitcoinAddressLike} address The address to get the UTXOs of
-     * @param {boolean} optimize Whether to optimize the UTXOs
-     * @returns {Promise<UTXOs>} The UTXOs of the address
-     * @example await getUXTOs('bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq');
-     * @throws {Error} If something went wrong while fetching the UTXOs
-     */
-    public async getUXTOs(
-        address: BitcoinAddressLike,
-        optimize: boolean = false,
-    ): Promise<unknown> {
-        const addressStr: string = address.toString();
-        const payload: JsonRpcPayload = this.buildJsonRpcPayload(JSONRpcMethods.GET_UTXOS, [
-            addressStr,
-            optimize,
-        ]);
-
-        const rawUXTOs: JsonRpcResult = await this.callPayloadSingle(payload);
-        const result: UTXOs = (rawUXTOs.result as UTXOs) || [];
-
-        return result.map((utxo: IUTXO) => {
-            return new UTXO(utxo);
-        });
-    }
-
-    /**
-     * Get a transaction by its hash or hash id.
-     * @description This method is used to get a transaction by its hash or hash id.
-     * @param {string} txHash The transaction hash
-     * @returns {Promise<TransactionBase<OPNetTransactionTypes>>} The requested transaction
-     * @example await getTransaction('63e77ba9fa4262b3d4d0d9d97fa8a7359534606c3f3af096284662e3f619f374');
-     * @throws {Error} If something went wrong while fetching the transaction
-     */
-    public async getTransaction(txHash: string): Promise<TransactionBase<OPNetTransactionTypes>> {
-        const payload: JsonRpcPayload = this.buildJsonRpcPayload(
-            JSONRpcMethods.GET_TRANSACTION_BY_HASH,
-            [txHash],
-        );
-
-        const rawTransaction: JsonRpcResult = await this.callPayloadSingle(payload);
-        const result: ITransaction = rawTransaction.result as ITransaction;
-
-        if ('error' in rawTransaction) {
-            throw new Error(
-                `Error fetching transaction: ${rawTransaction.error?.message || 'Unknown error'}`,
-            );
-        }
-
-        return TransactionParser.parseTransaction(result);
-    }
-
-    /**
-     * Get a transaction receipt by its hash.
-     * @description This method is used to get a transaction receipt by its hash.
-     * @param {string} txHash The transaction hash
-     * @returns {Promise<TransactionReceipt>} The requested transaction receipt
-     * @example await getTransactionReceipt('63e77ba9fa4262b3d4d0d9d97fa8a7359534606c3f3af096284662e3f619f374');
-     * @throws {Error} Something went wrong while fetching the transaction receipt
-     */
-    public async getTransactionReceipt(txHash: string): Promise<TransactionReceipt> {
-        const payload: JsonRpcPayload = this.buildJsonRpcPayload(
-            JSONRpcMethods.GET_TRANSACTION_RECEIPT,
-            [txHash],
-        );
-
-        const rawTransaction: JsonRpcResult = await this.callPayloadSingle(payload);
-        return new TransactionReceipt(rawTransaction.result);
-    }
-
-    /**
-     * Get the current connected network type.
-     * @description This method is used to get the current connected network type.
-     * @returns {Promise<Network>} The current connected network type
-     * @throws {Error} If the chain id is invalid
-     */
-    public async getNetwork(): Promise<Network> {
-        if (this.network) {
-            return this.network;
-        }
-
-        const network = await this.getChainId();
-        switch (network) {
-            case 1n:
-                return networks.bitcoin;
-            case 2n:
-                return networks.testnet;
-            case 3n:
-                return networks.regtest;
-
-            default:
-                throw new Error(`Invalid chain id: ${network}`);
-        }
-    }
-
-    /**
-     * Get the chain id.
-     * @description This method is used to get the chain id.
-     * @returns {Promise<bigint>} The chain id
-     * @throws {Error} If something went wrong while fetching the chain id
-     */
-    public async getChainId(): Promise<bigint> {
-        if (this.chainId !== undefined) return this.chainId;
-
-        const payload: JsonRpcPayload = this.buildJsonRpcPayload(JSONRpcMethods.CHAIN_ID, []);
-        const rawChainId: JsonRpcResult = await this.callPayloadSingle(payload);
-        if ('error' in rawChainId) {
-            throw new Error(`Something went wrong while fetching: ${rawChainId.error}`);
-        }
-
-        const chainId = rawChainId.result as string;
-        this.chainId = BigInt(chainId);
-
-        return this.chainId;
-    }
-
-    /**
-     * Get the contract code of an address.
-     * @description This method is used to get the contract code of an address.
-     * @param {BitcoinAddressLike} address The address of the contract
-     * @param {boolean} [onlyBytecode] Whether to return only the bytecode
-     * @returns {Promise<ContractData | Buffer>} The contract data or bytecode
-     * @example await getCode('tb1pth90usc4f528aqphpjrfkkdm4vy8hxnt5gps6aau2nva6pxeshtqqzlt3a');
-     * @throws {Error} If something went wrong while fetching the contract code
-     */
-    public async getCode(
-        address: BitcoinAddressLike,
-        onlyBytecode: boolean = false,
-    ): Promise<ContractData | Buffer> {
-        const addressStr: string = address.toString();
-        const payload: JsonRpcPayload = this.buildJsonRpcPayload(JSONRpcMethods.GET_CODE, [
-            addressStr,
-            onlyBytecode,
-        ]);
-
-        const rawCode: JsonRpcResult = await this.callPayloadSingle(payload);
-        if (rawCode.error) {
-            throw new Error(
-                `${rawCode.error.code}: Something went wrong while fetching: ${rawCode.error.message}`,
-            );
-        }
-
-        const result: IRawContract | { bytecode: string } = rawCode.result as
-            | IRawContract
-            | { bytecode: string };
-
-        if ('contractAddress' in result) {
-            return new ContractData(result);
-        } else {
-            return Buffer.from(result.bytecode, 'base64');
-        }
-    }
-
-    /**
-     * Get the storage at a specific address and pointer.
-     * @description This method is used to get the storage at a specific address and pointer.
-     * @param {BitcoinAddressLike} address The address to get the storage from
-     * @param {BigNumberish} rawPointer The pointer to get the storage from as base64 or bigint
-     * @param {boolean} proofs Whether to send proofs or not
-     * @param {BigNumberish} [height] The height to get the storage from
-     * @returns {Promise<StoredValue>} The storage value
-     * @example await getStorageAt('tb1pth90usc4f528aqphpjrfkkdm4vy8hxnt5gps6aau2nva6pxeshtqqzlt3a', 'EXLK/QhEQMI5d9DrthLvozT+UcDQ7WuSPaz7g8GV3AQ=');
-     * @throws {Error} If something went wrong while fetching the storage
-     */
-    public async getStorageAt(
-        address: BitcoinAddressLike,
-        rawPointer: bigint | string,
-        proofs: boolean = true,
-        height?: BigNumberish,
-    ): Promise<StoredValue> {
-        const addressStr: string = address.toString();
-        const pointer: string =
-            typeof rawPointer === 'string' ? rawPointer : this.bigintToBase64(rawPointer);
-
-        const params: [string, string, boolean, string?] = [addressStr, pointer, proofs];
-
-        if (height) {
-            params.push(height.toString());
-        }
-
-        const payload: JsonRpcPayload = this.buildJsonRpcPayload(
-            JSONRpcMethods.GET_STORAGE_AT,
-            params,
-        );
-        const rawStorage: JsonRpcResult = await this.callPayloadSingle(payload);
-        const result: IStorageValue = rawStorage.result as IStorageValue;
-
-        return new StoredValue(result);
-    }
-
-    /**
-     * Call a contract function with a given calldata.
-     * @description This method is used to call a contract function with a given calldata.
-     * @param {BitcoinAddressLike} to The address of the contract
-     * @param {Buffer} data The calldata of the contract function
-     * @param {BitcoinAddressLike} [from] The address to call the contract from
-     * @param {BigNumberish} [height] The height to call the contract from
-     * @returns {Promise<CallResult>} The result of the contract function call
-     * @example await call('tb1pth90usc4f528aqphpjrfkkdm4vy8hxnt5gps6aau2nva6pxeshtqqzlt3a', Buffer.from('0x12345678'));
-     * @throws {Error} If something went wrong while calling the contract
-     */
-    public async call(
-        to: BitcoinAddressLike,
-        data: Buffer | string,
-        from?: BitcoinAddressLike,
-        height?: BigNumberish,
-    ): Promise<CallResult | ICallRequestError> {
-        const toStr: string = to.toString();
-        const fromStr: string | null = from ? from.toString() : null;
-
-        let dataStr: string = Buffer.isBuffer(data) ? this.bufferToHex(data) : data;
-        if (dataStr.startsWith('0x')) {
-            dataStr = dataStr.slice(2);
-        }
-
-        const params: [string, string, string?, string?] = [toStr, dataStr];
-        if (fromStr) {
-            params.push(fromStr);
-        }
-
-        if (height) {
-            params.push(height.toString());
-        }
-
-        const payload: JsonRpcPayload = this.buildJsonRpcPayload(JSONRpcMethods.CALL, params);
-        const rawCall: JsonRpcResult = await this.callPayloadSingle(payload);
-
-        const result: ICallResult = rawCall.result as ICallResult;
-        if ('error' in result) {
-            return result;
-        }
-
-        return new CallResult(result);
-    }
-
-    /**
-     * Send a raw transaction.
-     * @description This method is used to send a raw transaction.
-     * @param {string} tx The raw transaction to send as hex string
-     * @param {boolean} [psbt] Whether the transaction is a PSBT or not
-     * @returns {Promise<BroadcastedTransaction>} The result of the transaction
-     * @example await sendRawTransaction('02000000000101ad897689f66c98daae5fdc3606235c1ad7a17b9e0a6aaa0ea9e58ecc1198ad2a0100000000ffffffff01a154c39400000000160014482038efcc91af945f0c756d07a46401920380520247304402201c1f8718dec637ddb41b42abc44dcbf35a94c6be6a9de8c1db48c9fa6e456b7e022032a4b3286808372a7ac2c5094d6341b4d61b17663f4ccd1c1d92efa85c7dada80121020373626d317ae8788ce3280b491068610d840c23ecb64c14075bbb9f670af52c00000000', false);
-     * @throws {Error} If something went wrong while sending the transaction
-     */
-    public async sendRawTransaction(tx: string, psbt: boolean): Promise<BroadcastedTransaction> {
-        // verify if tx is a valid hex string
-        if (!/^[0-9A-Fa-f]+$/.test(tx)) {
-            throw new Error('sendRawTransaction: Invalid hex string');
-        }
-
-        const payload: JsonRpcPayload = this.buildJsonRpcPayload(
-            JSONRpcMethods.BROADCAST_TRANSACTION,
-            [tx, psbt],
-        );
-
-        const rawTx: JsonRpcResult = await this.callPayloadSingle(payload);
-        const result: BroadcastedTransaction = rawTx.result as BroadcastedTransaction;
-        if (result && result.identifier) {
-            return {
-                ...result,
-                identifier: BigInt(result.identifier),
-            };
-        }
-
-        return result as BroadcastedTransaction;
-    }
-
-    /**
-     * Get block witnesses.
-     * @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.
-     * @param {BlockTag} height The block number or hash, use -1 for latest block
-     * @param {boolean} [trusted] Whether to trust the witnesses or not
-     * @param {number} [limit] The maximum number of witnesses to return
-     * @param {number} [page] The page number of the witnesses
-     * @returns {Promise<BlockWitnesses>} The witnesses of the block
-     * @example await getBlockWitness(123456n);
-     * @throws {Error} If something went wrong while fetching the witnesses
-     */
-    public async getBlockWitness(
-        height: BigNumberish | -1 = -1,
-        trusted?: boolean,
-        limit?: number,
-        page?: number,
-    ): Promise<BlockWitnesses> {
-        const params: [BigNumberish | -1, boolean?, number?, number?] = [height.toString()];
-
-        if (trusted !== undefined && trusted !== null) params.push(trusted);
-        if (limit !== undefined && limit !== null) params.push(limit);
-        if (page !== undefined && page !== null) params.push(page);
-
-        const payload: JsonRpcPayload = this.buildJsonRpcPayload(
-            JSONRpcMethods.BLOCK_WITNESS,
-            params,
-        );
-
-        const rawWitnesses: JsonRpcResult = await this.callPayloadSingle(payload);
-        const result: BlockWitnesses = rawWitnesses.result as BlockWitnesses;
-
-        for (let i = 0; i < result.length; i++) {
-            result[i].blockNumber = BigInt('0x' + result[i].blockNumber);
-        }
-
-        return result;
-    }
-
-    /**
-     * Get reorgs that happened between two blocks.
-     * @description This method is used to get the reorgs that happened between two blocks.
-     * @param {BigNumberish} [fromBlock] The block number to start from
-     * @param {BigNumberish} [toBlock] The block number to end at
-     * @returns {Promise<ReorgInformation>} The reorg information
-     * @example await getReorg(123456n, 123457n);
-     * @throws {Error} If something went wrong while fetching the reorg information
-     */
-    public async getReorg(
-        fromBlock?: BigNumberish,
-        toBlock?: BigNumberish,
-    ): Promise<ReorgInformation[]> {
-        const params: [string?, string?] = [];
-
-        if (fromBlock !== undefined && fromBlock !== null) params.push(fromBlock.toString());
-        if (toBlock !== undefined && toBlock !== null) params.push(toBlock.toString());
-
-        const payload: JsonRpcPayload = this.buildJsonRpcPayload(JSONRpcMethods.REORG, params);
-        const rawReorg: JsonRpcResult = await this.callPayloadSingle(payload);
-
-        const result: ReorgInformation[] = rawReorg.result as ReorgInformation[];
-        if (result.length > 0) {
-            for (let i = 0; i < result.length; i++) {
-                const res = result[i];
-
-                res.fromBlock = BigInt('0x' + res.fromBlock);
-                res.toBlock = BigInt('0x' + res.toBlock);
-            }
-        }
-
-        return result;
-    }
-
-    /**
-     * Generate parameters needed to wrap bitcoin.
-     * @description This method is used to generate the parameters needed to wrap bitcoin.
-     * @param {BigNumberish} amount The amount to wrap
-     * @returns {Promise<WrappedGeneration>} The wrapped generation parameters
-     * @example await requestTrustedPublicKeyForBitcoinWrapping(100000000n);
-     * @throws {Error} If something went wrong while generating the parameters
-     */
-    public async requestTrustedPublicKeyForBitcoinWrapping(
-        amount: BigNumberish,
-    ): Promise<WrappedGeneration> {
-        const payload: JsonRpcPayload = this.buildJsonRpcPayload(JSONRpcMethods.GENERATE, [
-            GenerateTarget.WRAP,
-            amount.toString(),
-        ]);
-
-        const rawPublicKey: JsonRpcResult = await this.callPayloadSingle(payload);
-        const result: WrappedGenerationParameters =
-            rawPublicKey.result as WrappedGenerationParameters;
-
-        return new WrappedGeneration(result);
-    }
-
-    /**
-     * Requests to the OPNET node
-     * @param {JsonRpcPayload | JsonRpcPayload[]} payload The method to call
-     * @returns {Promise<JSONRpc2Result<T extends JSONRpcMethods>>} The result of the request
-     */
-    public abstract _send(payload: JsonRpcPayload | JsonRpcPayload[]): Promise<JsonRpcCallResult>;
-
-    /**
-     * Send a single payload. This method is used to send a single payload.
-     * @param {JsonRpcPayload} payload The payload to send
-     * @returns {Promise<JsonRpcResult>} The result of the payload
-     * @throws {Error} If no data is returned
-     * @private
-     */
-    public async callPayloadSingle(payload: JsonRpcPayload): Promise<JsonRpcResult> {
-        const rawData: JsonRpcCallResult = await this._send(payload);
-        if (!rawData.length) {
-            throw new Error('No data returned');
-        }
-
-        const data = rawData.shift();
-        if (!data) {
-            throw new Error('Block not found');
-        }
-
-        return data as JSONRpc2ResponseResult<JSONRpcMethods>;
-    }
-
-    /**
-     * Send multiple payloads. This method is used to send multiple payloads.
-     * @param {JsonRpcPayload[]} payloads The payloads to send
-     * @returns {Promise<JsonRpcResult>} The result of the payloads
-     */
-    public async callMultiplePayloads(payloads: JsonRpcPayload[]): Promise<JsonRpcCallResult> {
-        const rawData: JsonRpcCallResult[] = (await this._send(
-            payloads,
-        )) as unknown as JsonRpcCallResult[];
-
-        if ('error' in rawData) {
-            throw new Error(`Error fetching block: ${rawData.error}`);
-        }
-
-        const data = rawData.shift();
-        if (!data) {
-            throw new Error('Block not found');
-        }
-
-        return data as JsonRpcCallResult;
-    }
-
-    protected abstract providerUrl(url: string): string;
-
-    private bufferToHex(buffer: Buffer): string {
-        return buffer.toString('hex');
-    }
-
-    private bigintToBase64(bigint: bigint): string {
-        return Buffer.from(BufferHelper.pointerToUint8Array(bigint)).toString('base64');
-    }
-
-    private buildJsonRpcPayload<T extends JSONRpcMethods>(
-        method: T,
-        params: unknown[],
-    ): JsonRpcPayload {
-        return {
-            method: method,
-            params: params,
-            id: this.nextId++,
-            jsonrpc: '2.0',
-        };
-    }
-}
+import '../serialize/BigInt.js';
+import { BufferHelper } from '@btc-vision/bsi-binary';
+import { WrappedGeneration, WrappedGenerationParameters } from '@btc-vision/transaction';
+import { Network, networks } from 'bitcoinjs-lib';
+import { IUTXO } from '../bitcoin/interfaces/IUTXO.js';
+
+import { UTXO, UTXOs } from '../bitcoin/UTXOs.js';
+import { Block } from '../block/Block.js';
+import { BlockWitnesses } from '../block/interfaces/BlockWitness.js';
+import { IBlock } from '../block/interfaces/IBlock.js';
+import { BigNumberish, BitcoinAddressLike, BlockTag } from '../common/CommonTypes.js';
+import { CallResult } from '../contracts/CallResult.js';
+import { ContractData } from '../contracts/ContractData.js';
+import { ICallRequestError, ICallResult } from '../contracts/interfaces/ICallResult.js';
+import { IRawContract } from '../contracts/interfaces/IRawContract.js';
+import { OPNetTransactionTypes } from '../interfaces/opnet/OPNetTransactionTypes.js';
+import { IStorageValue } from '../storage/interfaces/IStorageValue.js';
+import { StoredValue } from '../storage/StoredValue.js';
+import { BroadcastedTransaction } from '../transactions/interfaces/BroadcastedTransaction.js';
+import { ITransaction } from '../transactions/interfaces/ITransaction.js';
+import { TransactionReceipt } from '../transactions/metadata/TransactionReceipt.js';
+import { TransactionBase } from '../transactions/Transaction.js';
+import { TransactionParser } from '../transactions/TransactionParser.js';
+import { GenerateTarget } from './interfaces/Generate.js';
+import { JsonRpcPayload } from './interfaces/JSONRpc.js';
+import { JSONRpcMethods } from './interfaces/JSONRpcMethods.js';
+import {
+    JSONRpc2ResponseResult,
+    JsonRpcCallResult,
+    JsonRpcResult,
+    JSONRpcResultError,
+} from './interfaces/JSONRpcResult.js';
+import { ReorgInformation } from './interfaces/ReorgInformation.js';
+
+/**
+ * @description This class is used to provide an abstract RPC provider.
+ * @abstract
+ * @class AbstractRpcProvider
+ * @category Providers
+ */
+export abstract class AbstractRpcProvider {
+    private nextId: number = 0;
+
+    private network: Network | undefined;
+    private chainId: bigint | undefined;
+
+    protected constructor() {}
+
+    /**
+     * Get the latest block number.
+     * @description This method is used to get the latest block number.
+     * @returns {Promise<number>} The latest block number
+     * @example await getBlockNumber();
+     */
+    public async getBlockNumber(): Promise<bigint> {
+        const payload: JsonRpcPayload = this.buildJsonRpcPayload(
+            JSONRpcMethods.BLOCK_BY_NUMBER,
+            [],
+        );
+
+        const rawBlockNumber: JsonRpcResult = await this.callPayloadSingle(payload);
+        const result: string = rawBlockNumber.result as string;
+
+        return BigInt(result);
+    }
+
+    /**
+     * Get block by number or hash.
+     * @param {BlockTag} blockNumberOrHash The block number or hash
+     * @param {boolean} prefetchTxs Whether to prefetch transactions
+     * @description This method is used to get a block by its number or hash.
+     * @returns {Promise<Block>} The requested block
+     * @throws {Error} If the block is not found
+     * @example await getBlock(123456);
+     */
+    public async getBlock(
+        blockNumberOrHash: BlockTag,
+        prefetchTxs: boolean = false,
+    ): Promise<Block> {
+        const method =
+            typeof blockNumberOrHash === 'string'
+                ? JSONRpcMethods.GET_BLOCK_BY_HASH
+                : JSONRpcMethods.GET_BLOCK_BY_NUMBER;
+
+        const payload: JsonRpcPayload = this.buildJsonRpcPayload(method, [
+            blockNumberOrHash,
+            prefetchTxs,
+        ]);
+
+        const block: JsonRpcResult = await this.callPayloadSingle(payload);
+
+        const result: IBlock = block.result as IBlock;
+        return new Block(result);
+    }
+
+    /**
+     * Get multiple blocks by number or hash.
+     * @param {BlockTag[]} blockNumbers The block numbers or hashes
+     * @param {boolean} prefetchTxs Whether to prefetch transactions
+     * @description This method is used to get multiple blocks by their numbers or hashes.
+     * @returns {Promise<Block[]>} The requested blocks
+     */
+    public async getBlocks(
+        blockNumbers: BlockTag[],
+        prefetchTxs: boolean = false,
+    ): Promise<Block[]> {
+        const payloads: JsonRpcPayload[] = blockNumbers.map((blockNumber) => {
+            return this.buildJsonRpcPayload(JSONRpcMethods.GET_BLOCK_BY_NUMBER, [
+                blockNumber,
+                prefetchTxs,
+            ]);
+        });
+
+        const blocks: JsonRpcCallResult = await this.callMultiplePayloads(payloads);
+
+        if ('error' in blocks) {
+            const error = blocks.error as JSONRpcResultError<JSONRpcMethods.BLOCK_BY_NUMBER>;
+
+            throw new Error(`Error fetching block: ${error.message}`);
+        }
+
+        return blocks.map((block) => {
+            if ('error' in block) {
+                throw new Error(`Error fetching block: ${block.error}`);
+            }
+
+            const result: IBlock = block.result as IBlock;
+
+            return new Block(result);
+        });
+    }
+
+    /**
+     * Get block by hash. This is the same method as getBlock.
+     * @param {string} blockHash The block hash
+     * @description This method is used to get a block by its hash. Note that this method is the same as getBlock.
+     * @returns {Promise<Block>} The requested block
+     * @throws {Error} If the block is not found
+     */
+    public async getBlockByHash(blockHash: string): Promise<Block> {
+        return await this.getBlock(blockHash);
+    }
+
+    /**
+     * Get the bitcoin balance of an address.
+     * @param {BitcoinAddressLike} addressLike The address to get the balance of
+     * @param {boolean} filterOrdinals Whether to filter ordinals or not
+     * @description This method is used to get the balance of a bitcoin address.
+     * @returns {Promise<bigint>} The balance of the address
+     * @example await getBalance('bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq');
+     */
+    public async getBalance(addressLike: BitcoinAddressLike, filterOrdinals: boolean = true): Promise<bigint> {
+        const address: string = addressLike.toString();
+        const payload: JsonRpcPayload = this.buildJsonRpcPayload(JSONRpcMethods.GET_BALANCE, [
+            address,
+            filterOrdinals
+        ]);
+
+        const rawBalance: JsonRpcResult = await this.callPayloadSingle(payload);
+        const result: string = rawBalance.result as string;
+        if (!result || (result && !result.startsWith('0x'))) {
+            throw new Error(`Invalid balance returned from provider: ${result}`);
+        }
+
+        return BigInt(result);
+    }
+
+    /**
+     * Get the UTXOs (Unspent Transaction Outputs) of an address.
+     * @description This method is used to get the UTXOs of a bitcoin address.
+     * @param {BitcoinAddressLike} address The address to get the UTXOs of
+     * @param {boolean} optimize Whether to optimize the UTXOs
+     * @returns {Promise<UTXOs>} The UTXOs of the address
+     * @example await getUXTOs('bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq');
+     * @throws {Error} If something went wrong while fetching the UTXOs
+     */
+    public async getUXTOs(
+        address: BitcoinAddressLike,
+        optimize: boolean = false,
+    ): Promise<unknown> {
+        const addressStr: string = address.toString();
+        const payload: JsonRpcPayload = this.buildJsonRpcPayload(JSONRpcMethods.GET_UTXOS, [
+            addressStr,
+            optimize,
+        ]);
+
+        const rawUXTOs: JsonRpcResult = await this.callPayloadSingle(payload);
+        const result: UTXOs = (rawUXTOs.result as UTXOs) || [];
+
+        return result.map((utxo: IUTXO) => {
+            return new UTXO(utxo);
+        });
+    }
+
+    /**
+     * Get a transaction by its hash or hash id.
+     * @description This method is used to get a transaction by its hash or hash id.
+     * @param {string} txHash The transaction hash
+     * @returns {Promise<TransactionBase<OPNetTransactionTypes>>} The requested transaction
+     * @example await getTransaction('63e77ba9fa4262b3d4d0d9d97fa8a7359534606c3f3af096284662e3f619f374');
+     * @throws {Error} If something went wrong while fetching the transaction
+     */
+    public async getTransaction(txHash: string): Promise<TransactionBase<OPNetTransactionTypes>> {
+        const payload: JsonRpcPayload = this.buildJsonRpcPayload(
+            JSONRpcMethods.GET_TRANSACTION_BY_HASH,
+            [txHash],
+        );
+
+        const rawTransaction: JsonRpcResult = await this.callPayloadSingle(payload);
+        const result: ITransaction = rawTransaction.result as ITransaction;
+
+        if ('error' in rawTransaction) {
+            throw new Error(
+                `Error fetching transaction: ${rawTransaction.error?.message || 'Unknown error'}`,
+            );
+        }
+
+        return TransactionParser.parseTransaction(result);
+    }
+
+    /**
+     * Get a transaction receipt by its hash.
+     * @description This method is used to get a transaction receipt by its hash.
+     * @param {string} txHash The transaction hash
+     * @returns {Promise<TransactionReceipt>} The requested transaction receipt
+     * @example await getTransactionReceipt('63e77ba9fa4262b3d4d0d9d97fa8a7359534606c3f3af096284662e3f619f374');
+     * @throws {Error} Something went wrong while fetching the transaction receipt
+     */
+    public async getTransactionReceipt(txHash: string): Promise<TransactionReceipt> {
+        const payload: JsonRpcPayload = this.buildJsonRpcPayload(
+            JSONRpcMethods.GET_TRANSACTION_RECEIPT,
+            [txHash],
+        );
+
+        const rawTransaction: JsonRpcResult = await this.callPayloadSingle(payload);
+        return new TransactionReceipt(rawTransaction.result);
+    }
+
+    /**
+     * Get the current connected network type.
+     * @description This method is used to get the current connected network type.
+     * @returns {Promise<Network>} The current connected network type
+     * @throws {Error} If the chain id is invalid
+     */
+    public async getNetwork(): Promise<Network> {
+        if (this.network) {
+            return this.network;
+        }
+
+        const network = await this.getChainId();
+        switch (network) {
+            case 1n:
+                return networks.bitcoin;
+            case 2n:
+                return networks.testnet;
+            case 3n:
+                return networks.regtest;
+
+            default:
+                throw new Error(`Invalid chain id: ${network}`);
+        }
+    }
+
+    /**
+     * Get the chain id.
+     * @description This method is used to get the chain id.
+     * @returns {Promise<bigint>} The chain id
+     * @throws {Error} If something went wrong while fetching the chain id
+     */
+    public async getChainId(): Promise<bigint> {
+        if (this.chainId !== undefined) return this.chainId;
+
+        const payload: JsonRpcPayload = this.buildJsonRpcPayload(JSONRpcMethods.CHAIN_ID, []);
+        const rawChainId: JsonRpcResult = await this.callPayloadSingle(payload);
+        if ('error' in rawChainId) {
+            throw new Error(`Something went wrong while fetching: ${rawChainId.error}`);
+        }
+
+        const chainId = rawChainId.result as string;
+        this.chainId = BigInt(chainId);
+
+        return this.chainId;
+    }
+
+    /**
+     * Get the contract code of an address.
+     * @description This method is used to get the contract code of an address.
+     * @param {BitcoinAddressLike} address The address of the contract
+     * @param {boolean} [onlyBytecode] Whether to return only the bytecode
+     * @returns {Promise<ContractData | Buffer>} The contract data or bytecode
+     * @example await getCode('tb1pth90usc4f528aqphpjrfkkdm4vy8hxnt5gps6aau2nva6pxeshtqqzlt3a');
+     * @throws {Error} If something went wrong while fetching the contract code
+     */
+    public async getCode(
+        address: BitcoinAddressLike,
+        onlyBytecode: boolean = false,
+    ): Promise<ContractData | Buffer> {
+        const addressStr: string = address.toString();
+        const payload: JsonRpcPayload = this.buildJsonRpcPayload(JSONRpcMethods.GET_CODE, [
+            addressStr,
+            onlyBytecode,
+        ]);
+
+        const rawCode: JsonRpcResult = await this.callPayloadSingle(payload);
+        if (rawCode.error) {
+            throw new Error(
+                `${rawCode.error.code}: Something went wrong while fetching: ${rawCode.error.message}`,
+            );
+        }
+
+        const result: IRawContract | { bytecode: string } = rawCode.result as
+            | IRawContract
+            | { bytecode: string };
+
+        if ('contractAddress' in result) {
+            return new ContractData(result);
+        } else {
+            return Buffer.from(result.bytecode, 'base64');
+        }
+    }
+
+    /**
+     * Get the storage at a specific address and pointer.
+     * @description This method is used to get the storage at a specific address and pointer.
+     * @param {BitcoinAddressLike} address The address to get the storage from
+     * @param {BigNumberish} rawPointer The pointer to get the storage from as base64 or bigint
+     * @param {boolean} proofs Whether to send proofs or not
+     * @param {BigNumberish} [height] The height to get the storage from
+     * @returns {Promise<StoredValue>} The storage value
+     * @example await getStorageAt('tb1pth90usc4f528aqphpjrfkkdm4vy8hxnt5gps6aau2nva6pxeshtqqzlt3a', 'EXLK/QhEQMI5d9DrthLvozT+UcDQ7WuSPaz7g8GV3AQ=');
+     * @throws {Error} If something went wrong while fetching the storage
+     */
+    public async getStorageAt(
+        address: BitcoinAddressLike,
+        rawPointer: bigint | string,
+        proofs: boolean = true,
+        height?: BigNumberish,
+    ): Promise<StoredValue> {
+        const addressStr: string = address.toString();
+        const pointer: string =
+            typeof rawPointer === 'string' ? rawPointer : this.bigintToBase64(rawPointer);
+
+        const params: [string, string, boolean, string?] = [addressStr, pointer, proofs];
+
+        if (height) {
+            params.push(height.toString());
+        }
+
+        const payload: JsonRpcPayload = this.buildJsonRpcPayload(
+            JSONRpcMethods.GET_STORAGE_AT,
+            params,
+        );
+        const rawStorage: JsonRpcResult = await this.callPayloadSingle(payload);
+        const result: IStorageValue = rawStorage.result as IStorageValue;
+
+        return new StoredValue(result);
+    }
+
+    /**
+     * Call a contract function with a given calldata.
+     * @description This method is used to call a contract function with a given calldata.
+     * @param {BitcoinAddressLike} to The address of the contract
+     * @param {Buffer} data The calldata of the contract function
+     * @param {BitcoinAddressLike} [from] The address to call the contract from
+     * @param {BigNumberish} [height] The height to call the contract from
+     * @returns {Promise<CallResult>} The result of the contract function call
+     * @example await call('tb1pth90usc4f528aqphpjrfkkdm4vy8hxnt5gps6aau2nva6pxeshtqqzlt3a', Buffer.from('0x12345678'));
+     * @throws {Error} If something went wrong while calling the contract
+     */
+    public async call(
+        to: BitcoinAddressLike,
+        data: Buffer | string,
+        from?: BitcoinAddressLike,
+        height?: BigNumberish,
+    ): Promise<CallResult | ICallRequestError> {
+        const toStr: string = to.toString();
+        const fromStr: string | null = from ? from.toString() : null;
+
+        let dataStr: string = Buffer.isBuffer(data) ? this.bufferToHex(data) : data;
+        if (dataStr.startsWith('0x')) {
+            dataStr = dataStr.slice(2);
+        }
+
+        const params: [string, string, string?, string?] = [toStr, dataStr];
+        if (fromStr) {
+            params.push(fromStr);
+        }
+
+        if (height) {
+            params.push(height.toString());
+        }
+
+        const payload: JsonRpcPayload = this.buildJsonRpcPayload(JSONRpcMethods.CALL, params);
+        const rawCall: JsonRpcResult = await this.callPayloadSingle(payload);
+
+        const result: ICallResult = rawCall.result as ICallResult;
+        if ('error' in result) {
+            return result;
+        }
+
+        return new CallResult(result);
+    }
+
+    /**
+     * Send a raw transaction.
+     * @description This method is used to send a raw transaction.
+     * @param {string} tx The raw transaction to send as hex string
+     * @param {boolean} [psbt] Whether the transaction is a PSBT or not
+     * @returns {Promise<BroadcastedTransaction>} The result of the transaction
+     * @example await sendRawTransaction('02000000000101ad897689f66c98daae5fdc3606235c1ad7a17b9e0a6aaa0ea9e58ecc1198ad2a0100000000ffffffff01a154c39400000000160014482038efcc91af945f0c756d07a46401920380520247304402201c1f8718dec637ddb41b42abc44dcbf35a94c6be6a9de8c1db48c9fa6e456b7e022032a4b3286808372a7ac2c5094d6341b4d61b17663f4ccd1c1d92efa85c7dada80121020373626d317ae8788ce3280b491068610d840c23ecb64c14075bbb9f670af52c00000000', false);
+     * @throws {Error} If something went wrong while sending the transaction
+     */
+    public async sendRawTransaction(tx: string, psbt: boolean): Promise<BroadcastedTransaction> {
+        // verify if tx is a valid hex string
+        if (!/^[0-9A-Fa-f]+$/.test(tx)) {
+            throw new Error('sendRawTransaction: Invalid hex string');
+        }
+
+        const payload: JsonRpcPayload = this.buildJsonRpcPayload(
+            JSONRpcMethods.BROADCAST_TRANSACTION,
+            [tx, psbt],
+        );
+
+        const rawTx: JsonRpcResult = await this.callPayloadSingle(payload);
+        const result: BroadcastedTransaction = rawTx.result as BroadcastedTransaction;
+        if (result && result.identifier) {
+            return {
+                ...result,
+                identifier: BigInt(result.identifier),
+            };
+        }
+
+        return result as BroadcastedTransaction;
+    }
+
+    /**
+     * Get block witnesses.
+     * @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.
+     * @param {BlockTag} height The block number or hash, use -1 for latest block
+     * @param {boolean} [trusted] Whether to trust the witnesses or not
+     * @param {number} [limit] The maximum number of witnesses to return
+     * @param {number} [page] The page number of the witnesses
+     * @returns {Promise<BlockWitnesses>} The witnesses of the block
+     * @example await getBlockWitness(123456n);
+     * @throws {Error} If something went wrong while fetching the witnesses
+     */
+    public async getBlockWitness(
+        height: BigNumberish | -1 = -1,
+        trusted?: boolean,
+        limit?: number,
+        page?: number,
+    ): Promise<BlockWitnesses> {
+        const params: [BigNumberish | -1, boolean?, number?, number?] = [height.toString()];
+
+        if (trusted !== undefined && trusted !== null) params.push(trusted);
+        if (limit !== undefined && limit !== null) params.push(limit);
+        if (page !== undefined && page !== null) params.push(page);
+
+        const payload: JsonRpcPayload = this.buildJsonRpcPayload(
+            JSONRpcMethods.BLOCK_WITNESS,
+            params,
+        );
+
+        const rawWitnesses: JsonRpcResult = await this.callPayloadSingle(payload);
+        const result: BlockWitnesses = rawWitnesses.result as BlockWitnesses;
+
+        for (let i = 0; i < result.length; i++) {
+            result[i].blockNumber = BigInt('0x' + result[i].blockNumber);
+        }
+
+        return result;
+    }
+
+    /**
+     * Get reorgs that happened between two blocks.
+     * @description This method is used to get the reorgs that happened between two blocks.
+     * @param {BigNumberish} [fromBlock] The block number to start from
+     * @param {BigNumberish} [toBlock] The block number to end at
+     * @returns {Promise<ReorgInformation>} The reorg information
+     * @example await getReorg(123456n, 123457n);
+     * @throws {Error} If something went wrong while fetching the reorg information
+     */
+    public async getReorg(
+        fromBlock?: BigNumberish,
+        toBlock?: BigNumberish,
+    ): Promise<ReorgInformation[]> {
+        const params: [string?, string?] = [];
+
+        if (fromBlock !== undefined && fromBlock !== null) params.push(fromBlock.toString());
+        if (toBlock !== undefined && toBlock !== null) params.push(toBlock.toString());
+
+        const payload: JsonRpcPayload = this.buildJsonRpcPayload(JSONRpcMethods.REORG, params);
+        const rawReorg: JsonRpcResult = await this.callPayloadSingle(payload);
+
+        const result: ReorgInformation[] = rawReorg.result as ReorgInformation[];
+        if (result.length > 0) {
+            for (let i = 0; i < result.length; i++) {
+                const res = result[i];
+
+                res.fromBlock = BigInt('0x' + res.fromBlock);
+                res.toBlock = BigInt('0x' + res.toBlock);
+            }
+        }
+
+        return result;
+    }
+
+    /**
+     * Generate parameters needed to wrap bitcoin.
+     * @description This method is used to generate the parameters needed to wrap bitcoin.
+     * @param {BigNumberish} amount The amount to wrap
+     * @returns {Promise<WrappedGeneration>} The wrapped generation parameters
+     * @example await requestTrustedPublicKeyForBitcoinWrapping(100000000n);
+     * @throws {Error} If something went wrong while generating the parameters
+     */
+    public async requestTrustedPublicKeyForBitcoinWrapping(
+        amount: BigNumberish,
+    ): Promise<WrappedGeneration> {
+        const payload: JsonRpcPayload = this.buildJsonRpcPayload(JSONRpcMethods.GENERATE, [
+            GenerateTarget.WRAP,
+            amount.toString(),
+        ]);
+
+        const rawPublicKey: JsonRpcResult = await this.callPayloadSingle(payload);
+        const result: WrappedGenerationParameters =
+            rawPublicKey.result as WrappedGenerationParameters;
+
+        return new WrappedGeneration(result);
+    }
+
+    /**
+     * Requests to the OPNET node
+     * @param {JsonRpcPayload | JsonRpcPayload[]} payload The method to call
+     * @returns {Promise<JSONRpc2Result<T extends JSONRpcMethods>>} The result of the request
+     */
+    public abstract _send(payload: JsonRpcPayload | JsonRpcPayload[]): Promise<JsonRpcCallResult>;
+
+    /**
+     * Send a single payload. This method is used to send a single payload.
+     * @param {JsonRpcPayload} payload The payload to send
+     * @returns {Promise<JsonRpcResult>} The result of the payload
+     * @throws {Error} If no data is returned
+     * @private
+     */
+    public async callPayloadSingle(payload: JsonRpcPayload): Promise<JsonRpcResult> {
+        const rawData: JsonRpcCallResult = await this._send(payload);
+        if (!rawData.length) {
+            throw new Error('No data returned');
+        }
+
+        const data = rawData.shift();
+        if (!data) {
+            throw new Error('Block not found');
+        }
+
+        return data as JSONRpc2ResponseResult<JSONRpcMethods>;
+    }
+
+    /**
+     * Send multiple payloads. This method is used to send multiple payloads.
+     * @param {JsonRpcPayload[]} payloads The payloads to send
+     * @returns {Promise<JsonRpcResult>} The result of the payloads
+     */
+    public async callMultiplePayloads(payloads: JsonRpcPayload[]): Promise<JsonRpcCallResult> {
+        const rawData: JsonRpcCallResult[] = (await this._send(
+            payloads,
+        )) as unknown as JsonRpcCallResult[];
+
+        if ('error' in rawData) {
+            throw new Error(`Error fetching block: ${rawData.error}`);
+        }
+
+        const data = rawData.shift();
+        if (!data) {
+            throw new Error('Block not found');
+        }
+
+        return data as JsonRpcCallResult;
+    }
+
+    protected abstract providerUrl(url: string): string;
+
+    private bufferToHex(buffer: Buffer): string {
+        return buffer.toString('hex');
+    }
+
+    private bigintToBase64(bigint: bigint): string {
+        return Buffer.from(BufferHelper.pointerToUint8Array(bigint)).toString('base64');
+    }
+
+    private buildJsonRpcPayload<T extends JSONRpcMethods>(
+        method: T,
+        params: unknown[],
+    ): JsonRpcPayload {
+        return {
+            method: method,
+            params: params,
+            id: this.nextId++,
+            jsonrpc: '2.0',
+        };
+    }
+}