opnet 1.5.13 → 1.5.16

package/browser/transactions/Transaction.d.ts

@@ -19,6 +19,7 @@ export declare abstract class TransactionBase<T extends OPNetTransactionTypes> e
     readonly gasUsed: bigint;
     readonly specialGasUsed: bigint;
     readonly pow?: ProofOfWorkChallenge;
+    readonly blockNumber?: bigint;
     protected constructor(transaction: ITransactionBase<T>, network: Network);
     private decodeProofOfWorkChallenge;
 }

package/browser/transactions/interfaces/ITransaction.d.ts

@@ -8,6 +8,7 @@ import { IDeploymentTransaction } from './transactions/IDeploymentTransaction.js
 import { IInteractionTransaction } from './transactions/IInteractionTransaction.js';
 export interface ITransactionBase<T extends OPNetTransactionTypes> extends ITransactionReceipt {
     readonly id: string;
+    readonly blockNumber?: string | bigint;
     readonly hash: string;
     readonly index: number;
     readonly burnedBitcoin: string | BigNumberish;

package/build/_version.d.ts

@@ -1 +1 @@
-export declare const version = "1.5.13";
+export declare const version = "1.5.16";

package/build/_version.js

@@ -1 +1 @@
-export const version = '1.5.13';
+export const version = '1.5.16';

package/build/block/BlockGasParameters.d.ts

@@ -1,3 +1,20 @@
+export interface FeeRecommendation {
+    low: string;
+    medium: string;
+    high: string;
+}
+export interface RawBitcoinFees {
+    readonly conservative: string;
+    readonly recommended: FeeRecommendation;
+}
+export interface BitcoinFees {
+    readonly conservative: number;
+    readonly recommended: {
+        readonly low: number;
+        readonly medium: number;
+        readonly high: number;
+    };
+}
 export interface IBlockGasParameters {
     readonly blockNumber: bigint;
     readonly gasUsed: bigint;
@@ -5,6 +22,7 @@ export interface IBlockGasParameters {
     readonly ema: bigint;
     readonly baseGas: bigint;
     readonly gasPerSat: bigint;
+    readonly bitcoin: BitcoinFees;
 }
 export interface IBlockGasParametersInput {
     readonly blockNumber: string;
@@ -13,6 +31,7 @@ export interface IBlockGasParametersInput {
     readonly ema: string;
     readonly baseGas: string;
     readonly gasPerSat: string;
+    readonly bitcoin: RawBitcoinFees;
 }
 export declare class BlockGasParameters implements IBlockGasParameters {
     readonly blockNumber: bigint;
@@ -21,5 +40,6 @@ export declare class BlockGasParameters implements IBlockGasParameters {
     readonly ema: bigint;
     readonly baseGas: bigint;
     readonly gasPerSat: bigint;
+    readonly bitcoin: BitcoinFees;
     constructor(data: IBlockGasParametersInput);
 }

package/build/block/BlockGasParameters.js

@@ -5,6 +5,7 @@ export class BlockGasParameters {
     ema;
     baseGas;
     gasPerSat;
+    bitcoin;
     constructor(data) {
         this.blockNumber = BigInt(data.blockNumber);
         this.gasUsed = BigInt(data.gasUsed);
@@ -12,5 +13,13 @@ export class BlockGasParameters {
         this.ema = BigInt(data.ema);
         this.baseGas = BigInt(data.baseGas);
         this.gasPerSat = BigInt(data.gasPerSat);
+        this.bitcoin = {
+            conservative: Number(data.bitcoin.conservative),
+            recommended: {
+                low: Number(data.bitcoin.recommended.low),
+                medium: Number(data.bitcoin.recommended.medium),
+                high: Number(data.bitcoin.recommended.high),
+            },
+        };
     }
 }

package/build/contracts/CallResult.d.ts

@@ -6,6 +6,7 @@ import { ContractDecodedObjectResult, DecodedOutput } from './Contract.js';
 import { IAccessList } from './interfaces/IAccessList.js';
 import { EventList, ICallResultData } from './interfaces/ICallResult.js';
 import { OPNetEvent } from './OPNetEvent.js';
+import { BitcoinFees } from '../block/BlockGasParameters.js';
 export interface TransactionParameters {
     readonly signer?: Signer | ECPairInterface;
     readonly refundTo: string;
@@ -50,6 +51,7 @@ export declare class CallResult<T extends ContractDecodedObjectResult = {}, U ex
     setTo(to: string, address: Address): void;
     sendTransaction(interactionParams: TransactionParameters, amountAddition?: bigint): Promise<InteractionTransactionReceipt>;
     setGasEstimation(estimatedGas: bigint, refundedGas: bigint): void;
+    setBitcoinFee(fees: BitcoinFees): void;
     setDecoded(decoded: DecodedOutput): void;
     setEvents(events: U): void;
     setCalldata(calldata: Buffer): void;

package/build/contracts/CallResult.js

@@ -15,6 +15,7 @@ export class CallResult {
     events = [];
     to;
     address;
+    #bitcoinFees;
     #rawEvents;
     #provider;
     constructor(callResult, provider) {
@@ -119,7 +120,7 @@ export class CallResult {
                 calldata: this.calldata,
                 priorityFee: priorityFee,
                 gasSatFee: this.bigintMax(this.estimatedSatGas, interactionParams.minGas || 0n),
-                feeRate: interactionParams.feeRate || 10,
+                feeRate: interactionParams.feeRate || this.#bitcoinFees?.conservative || 10,
                 from: interactionParams.refundTo,
                 utxos: UTXOs,
                 to: this.to,
@@ -164,6 +165,9 @@ export class CallResult {
         this.estimatedSatGas = estimatedGas;
         this.estimatedRefundedGasInSat = refundedGas;
     }
+    setBitcoinFee(fees) {
+        this.#bitcoinFees = fees;
+    }
     setDecoded(decoded) {
         this.properties = Object.freeze(decoded.obj);
     }

package/build/contracts/Contract.js

@@ -452,8 +452,7 @@ export class IBaseContract {
             obj: obj,
         };
     }
-    async estimateGas(gas) {
-        const gasParameters = await this.currentGasParameters();
+    estimateGas(gas, gasParameters) {
         const gasPerSat = gasParameters.gasPerSat;
         const exactGas = (gas * gasPerSat) / 1000000000000n;
         const finalGas = (exactGas * 100n) / (100n - 30n);
@@ -484,8 +483,10 @@ export class IBaseContract {
             response.setTo(this.p2opOrTweaked, address);
             response.setDecoded(decoded);
             response.setCalldata(buffer);
-            const gas = await this.estimateGas(response.estimatedGas || 0n);
-            const gasRefunded = await this.estimateGas(response.refundedGas || 0n);
+            const gasParameters = await this.currentGasParameters();
+            const gas = this.estimateGas(response.estimatedGas || 0n, gasParameters);
+            const gasRefunded = this.estimateGas(response.refundedGas || 0n, gasParameters);
+            response.setBitcoinFee(gasParameters.bitcoin);
             response.setGasEstimation(gas, gasRefunded);
             response.setEvents(this.decodeEvents(response.rawEvents));
             return response;

package/build/transactions/Transaction.d.ts

@@ -19,6 +19,7 @@ export declare abstract class TransactionBase<T extends OPNetTransactionTypes> e
     readonly gasUsed: bigint;
     readonly specialGasUsed: bigint;
     readonly pow?: ProofOfWorkChallenge;
+    readonly blockNumber?: bigint;
     protected constructor(transaction: ITransactionBase<T>, network: Network);
     private decodeProofOfWorkChallenge;
 }

package/build/transactions/Transaction.js

@@ -14,6 +14,7 @@ export class TransactionBase extends TransactionReceipt {
     gasUsed;
     specialGasUsed;
     pow;
+    blockNumber;
     constructor(transaction, network) {
         super({
             receipt: transaction.receipt,
@@ -26,6 +27,8 @@ export class TransactionBase extends TransactionReceipt {
         this.id = transaction.id;
         this.hash = transaction.hash;
         this.index = transaction.index;
+        if (transaction.blockNumber)
+            this.blockNumber = BigInt(transaction.blockNumber);
         this.burnedBitcoin = BigInt(transaction.burnedBitcoin) || 0n;
         this.priorityFee = BigInt(transaction.priorityFee) || 0n;
         this.inputs = transaction.inputs.map((input) => new TransactionInput(input));

package/build/transactions/interfaces/ITransaction.d.ts

@@ -8,6 +8,7 @@ import { IDeploymentTransaction } from './transactions/IDeploymentTransaction.js
 import { IInteractionTransaction } from './transactions/IInteractionTransaction.js';
 export interface ITransactionBase<T extends OPNetTransactionTypes> extends ITransactionReceipt {
     readonly id: string;
+    readonly blockNumber?: string | bigint;
     readonly hash: string;
     readonly index: number;
     readonly burnedBitcoin: string | BigNumberish;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "opnet",
   "type": "module",
-  "version": "1.5.13",
+  "version": "1.5.16",
   "author": "OP_NET",
   "description": "The perfect library for building Bitcoin-based applications.",
   "engines": {

package/src/_version.ts

@@ -1 +1 @@
-export const version = '1.5.13';
+export const version = '1.5.16';

package/src/block/BlockGasParameters.ts

@@ -1,3 +1,23 @@
+export interface FeeRecommendation {
+    low: string;
+    medium: string;
+    high: string;
+}
+
+export interface RawBitcoinFees {
+    readonly conservative: string;
+    readonly recommended: FeeRecommendation;
+}
+
+export interface BitcoinFees {
+    readonly conservative: number;
+    readonly recommended: {
+        readonly low: number;
+        readonly medium: number;
+        readonly high: number;
+    };
+}
+
 export interface IBlockGasParameters {
     readonly blockNumber: bigint;
     readonly gasUsed: bigint;
@@ -5,6 +25,7 @@ export interface IBlockGasParameters {
     readonly ema: bigint;
     readonly baseGas: bigint;
     readonly gasPerSat: bigint;
+    readonly bitcoin: BitcoinFees;
 }
 
 export interface IBlockGasParametersInput {
@@ -14,6 +35,7 @@ export interface IBlockGasParametersInput {
     readonly ema: string;
     readonly baseGas: string;
     readonly gasPerSat: string;
+    readonly bitcoin: RawBitcoinFees;
 }
 
 export class BlockGasParameters implements IBlockGasParameters {
@@ -23,6 +45,7 @@ export class BlockGasParameters implements IBlockGasParameters {
     public readonly ema: bigint;
     public readonly baseGas: bigint;
     public readonly gasPerSat: bigint;
+    public readonly bitcoin: BitcoinFees;
 
     public constructor(data: IBlockGasParametersInput) {
         this.blockNumber = BigInt(data.blockNumber);
@@ -31,5 +54,14 @@ export class BlockGasParameters implements IBlockGasParameters {
         this.ema = BigInt(data.ema);
         this.baseGas = BigInt(data.baseGas);
         this.gasPerSat = BigInt(data.gasPerSat);
+
+        this.bitcoin = {
+            conservative: Number(data.bitcoin.conservative),
+            recommended: {
+                low: Number(data.bitcoin.recommended.low),
+                medium: Number(data.bitcoin.recommended.medium),
+                high: Number(data.bitcoin.recommended.high),
+            },
+        };
     }
 }

package/src/contracts/CallResult.ts

@@ -18,6 +18,7 @@ import { IAccessList } from './interfaces/IAccessList.js';
 import { EventList, ICallResultData, RawEventList } from './interfaces/ICallResult.js';
 import { OPNetEvent } from './OPNetEvent.js';
 import { TransactionHelper } from './TransactionHelpper.js';
+import { BitcoinFees } from '../block/BlockGasParameters.js';
 
 const factory = new TransactionFactory();
 
@@ -73,6 +74,8 @@ export class CallResult<
     public to: string | undefined;
     public address: Address | undefined;
 
+    #bitcoinFees: BitcoinFees | undefined;
+
     readonly #rawEvents: EventList;
     readonly #provider: AbstractRpcProvider;
 
@@ -228,7 +231,7 @@ export class CallResult<
                 calldata: this.calldata,
                 priorityFee: priorityFee,
                 gasSatFee: this.bigintMax(this.estimatedSatGas, interactionParams.minGas || 0n),
-                feeRate: interactionParams.feeRate || 10,
+                feeRate: interactionParams.feeRate || this.#bitcoinFees?.conservative || 10,
                 from: interactionParams.refundTo,
                 utxos: UTXOs,
                 to: this.to,
@@ -295,6 +298,10 @@ export class CallResult<
         this.estimatedRefundedGasInSat = refundedGas;
     }
 
+    public setBitcoinFee(fees: BitcoinFees): void {
+        this.#bitcoinFees = fees;
+    }
+
     public setDecoded(decoded: DecodedOutput): void {
         this.properties = Object.freeze(decoded.obj) as T;
     }

package/src/contracts/Contract.ts

@@ -672,9 +672,7 @@ export abstract class IBaseContract<T extends BaseContractProperties> implements
         };
     }
 
-    private async estimateGas(gas: bigint): Promise<bigint> {
-        const gasParameters = await this.currentGasParameters();
-
+    private estimateGas(gas: bigint, gasParameters: BlockGasParameters): bigint {
         const gasPerSat = gasParameters.gasPerSat;
         const exactGas = (gas * gasPerSat) / 1000000000000n;
 
@@ -723,9 +721,11 @@ export abstract class IBaseContract<T extends BaseContractProperties> implements
             response.setDecoded(decoded);
             response.setCalldata(buffer);
 
-            const gas = await this.estimateGas(response.estimatedGas || 0n);
-            const gasRefunded = await this.estimateGas(response.refundedGas || 0n);
+            const gasParameters = await this.currentGasParameters();
+            const gas = this.estimateGas(response.estimatedGas || 0n, gasParameters);
+            const gasRefunded = this.estimateGas(response.refundedGas || 0n, gasParameters);
 
+            response.setBitcoinFee(gasParameters.bitcoin);
             response.setGasEstimation(gas, gasRefunded);
             response.setEvents(this.decodeEvents(response.rawEvents));
 

package/src/transactions/Transaction.ts

@@ -79,6 +79,11 @@ export abstract class TransactionBase<T extends OPNetTransactionTypes>
      */
     public readonly pow?: ProofOfWorkChallenge;
 
+    /**
+     * @description The block number in which the transaction was included.
+     */
+    public readonly blockNumber?: bigint;
+
     protected constructor(transaction: ITransactionBase<T>, network: Network) {
         super(
             {
@@ -96,6 +101,8 @@ export abstract class TransactionBase<T extends OPNetTransactionTypes>
         this.hash = transaction.hash;
         this.index = transaction.index;
 
+        if (transaction.blockNumber) this.blockNumber = BigInt(transaction.blockNumber);
+
         this.burnedBitcoin = BigInt(transaction.burnedBitcoin) || 0n;
         this.priorityFee = BigInt(transaction.priorityFee) || 0n;
 

package/src/transactions/interfaces/ITransaction.ts

@@ -19,6 +19,11 @@ export interface ITransactionBase<T extends OPNetTransactionTypes> extends ITran
      */
     readonly id: string;
 
+    /**
+     * @description The block number in which the transaction was included.
+     */
+    readonly blockNumber?: string | bigint;
+
     /**
      * @description The transaction "hash".
      */