opnet 1.2.1 → 1.2.3

package/src/transactions/Transaction.ts

@@ -1,6 +1,8 @@
+import { Network } from '@btc-vision/bitcoin';
 import { BigNumberish } from '../common/CommonTypes.js';
 import { OPNetTransactionTypes } from '../interfaces/opnet/OPNetTransactionTypes.js';
 import { ITransactionBase } from './interfaces/ITransaction.js';
+import { ProofOfWorkChallenge, RawProofOfWorkChallenge } from './interfaces/ProofOfWorkChallenge.js';
 import { TransactionInput } from './metadata/TransactionInput.js';
 import { ITransactionOutput, TransactionOutput } from './metadata/TransactionOutput.js';
 import { TransactionReceipt } from './metadata/TransactionReceipt.js';
@@ -57,13 +59,21 @@ export abstract class TransactionBase<T extends OPNetTransactionTypes>
      */
     public readonly gasUsed: bigint;
 
-    protected constructor(transaction: ITransactionBase<T>) {
-        super({
-            receipt: transaction.receipt,
-            receiptProofs: transaction.receiptProofs,
-            events: transaction.events,
-            revert: transaction.revert,
-        });
+    /**
+     * @description The proof of work challenge.
+     */
+    public readonly pow?: ProofOfWorkChallenge;
+
+    protected constructor(transaction: ITransactionBase<T>, network: Network) {
+        super(
+            {
+                receipt: transaction.receipt,
+                receiptProofs: transaction.receiptProofs,
+                events: transaction.events,
+                revert: transaction.revert,
+            },
+            network,
+        );
 
         this.id = transaction.id;
         this.hash = transaction.hash;
@@ -77,7 +87,19 @@ export abstract class TransactionBase<T extends OPNetTransactionTypes>
         );
 
         this.OPNetType = transaction.OPNetType;
-
         this.gasUsed = BigInt(transaction.gasUsed || '0x00') || 0n;
+
+        if (transaction.pow) {
+            this.pow = this.decodeProofOfWorkChallenge(transaction.pow as RawProofOfWorkChallenge);
+        }
+    }
+
+    private decodeProofOfWorkChallenge(challenge: RawProofOfWorkChallenge): ProofOfWorkChallenge {
+        return {
+            preimage: Buffer.from(challenge.preimage, 'base64'),
+            reward: BigInt(challenge.reward) || 0n,
+            difficulty: BigInt(challenge.difficulty || '0'),
+            version: challenge.version || 0,
+        };
     }
 }

package/src/transactions/TransactionParser.ts

@@ -1,3 +1,4 @@
+import { Network } from '@btc-vision/bitcoin';
 import { OPNetTransactionTypes } from '../interfaces/opnet/OPNetTransactionTypes.js';
 import { DeploymentTransaction } from './decoders/DeploymentTransaction.js';
 import { GenericTransaction } from './decoders/GenericTransaction.js';
@@ -14,6 +15,7 @@ import { TransactionBase } from './Transaction.js';
 export class TransactionParser {
     public static parseTransactions(
         transactions: ITransaction[],
+        network: Network,
     ): TransactionBase<OPNetTransactionTypes>[] {
         if (!transactions) {
             return [];
@@ -23,7 +25,7 @@ export class TransactionParser {
         for (const transaction of transactions) {
             if (!transaction) throw new Error(`Something went wrong while parsing transactions`);
 
-            transactionArray.push(this.parseTransaction(transaction));
+            transactionArray.push(this.parseTransaction(transaction, network));
         }
 
         return transactionArray;
@@ -31,6 +33,7 @@ export class TransactionParser {
 
     public static parseTransaction(
         transaction: ITransaction,
+        network: Network,
     ): TransactionBase<OPNetTransactionTypes> {
         if (!transaction) throw new Error('Transaction is required');
 
@@ -38,15 +41,11 @@ export class TransactionParser {
 
         switch (opnetType) {
             case OPNetTransactionTypes.Generic:
-                return new GenericTransaction(transaction as IGenericTransaction);
+                return new GenericTransaction(transaction as IGenericTransaction, network);
             case OPNetTransactionTypes.Interaction:
-                return new InteractionTransaction(transaction as IInteractionTransaction);
+                return new InteractionTransaction(transaction as IInteractionTransaction, network);
             case OPNetTransactionTypes.Deployment:
-                return new DeploymentTransaction(transaction as IDeploymentTransaction);
-            //case OPNetTransactionTypes.WrapInteraction:
-            //    return new WrapTransaction(transaction as IWrapTransaction);
-            //case OPNetTransactionTypes.UnwrapInteraction:
-            //    return new UnwrapTransaction(transaction as IUnwrapTransaction);
+                return new DeploymentTransaction(transaction as IDeploymentTransaction, network);
             default:
                 throw new Error('Unknown transaction type');
         }

package/src/transactions/decoders/DeploymentTransaction.ts

@@ -1,3 +1,4 @@
+import { Network } from '@btc-vision/bitcoin';
 import { Address } from '@btc-vision/transaction';
 import { OPNetTransactionTypes } from '../../interfaces/opnet/OPNetTransactionTypes.js';
 import { IDeploymentTransaction } from '../interfaces/transactions/IDeploymentTransaction.js';
@@ -26,8 +27,8 @@ export class DeploymentTransaction
 
     public readonly from?: Address;
 
-    constructor(transaction: IDeploymentTransaction) {
-        super(transaction);
+    constructor(transaction: IDeploymentTransaction, network: Network) {
+        super(transaction, network);
 
         try {
             this.from = new Address(Buffer.from(transaction.from as string, 'base64'));

package/src/transactions/decoders/GenericTransaction.ts

@@ -1,3 +1,4 @@
+import { Network } from '@btc-vision/bitcoin';
 import { OPNetTransactionTypes } from '../../interfaces/opnet/OPNetTransactionTypes.js';
 import { IGenericTransaction } from '../interfaces/ITransaction.js';
 import { TransactionBase } from '../Transaction.js';
@@ -13,7 +14,7 @@ export class GenericTransaction
     extends TransactionBase<OPNetTransactionTypes.Generic>
     implements IGenericTransaction
 {
-    public constructor(transaction: IGenericTransaction) {
-        super(transaction);
+    public constructor(transaction: IGenericTransaction, network: Network) {
+        super(transaction, network);
     }
 }

package/src/transactions/decoders/InteractionTransaction.ts

@@ -1,3 +1,4 @@
+import { Network } from '@btc-vision/bitcoin';
 import { Address } from '@btc-vision/transaction';
 import { Buffer } from 'buffer';
 import { InteractionType } from '../../interfaces/opnet/OPNetTransactionTypes.js';
@@ -52,8 +53,8 @@ export class InteractionTransaction
      */
     public readonly contractTweakedPublicKey: Address;
 
-    constructor(transaction: IInteractionTransaction) {
-        super(transaction);
+    constructor(transaction: IInteractionTransaction, network: Network) {
+        super(transaction, network);
 
         this.contractTweakedPublicKey = new Address(
             Buffer.from(transaction.contractTweakedPublicKey as string, 'base64'),

package/src/transactions/interfaces/ITransaction.ts

@@ -3,6 +3,7 @@ import { OPNetTransactionTypes } from '../../interfaces/opnet/OPNetTransactionTy
 import { ITransactionInput, TransactionInput } from '../metadata/TransactionInput.js';
 import { ITransactionOutput, TransactionOutput } from '../metadata/TransactionOutput.js';
 import { ITransactionReceipt } from './ITransactionReceipt.js';
+import { ProofOfWorkChallenge, RawProofOfWorkChallenge } from './ProofOfWorkChallenge.js';
 import { IDeploymentTransaction } from './transactions/IDeploymentTransaction.js';
 import { IInteractionTransaction } from './transactions/IInteractionTransaction.js';
 
@@ -57,6 +58,11 @@ export interface ITransactionBase<T extends OPNetTransactionTypes> extends ITran
      * @description The amount of gas used by the transaction.
      */
     readonly gasUsed: string | bigint;
+
+    /**
+     * @description The raw proof of work challenge.
+     */
+    readonly pow?: RawProofOfWorkChallenge | ProofOfWorkChallenge;
 }
 
 /**

package/src/transactions/interfaces/ProofOfWorkChallenge.ts

@@ -0,0 +1,13 @@
+export interface ProofOfWorkChallenge {
+    readonly preimage: Buffer;
+    readonly reward: bigint;
+    readonly difficulty?: bigint;
+    readonly version?: number;
+}
+
+export interface RawProofOfWorkChallenge {
+    readonly preimage: string;
+    readonly reward: string;
+    readonly difficulty?: string;
+    readonly version?: number;
+}

package/src/transactions/interfaces/transactions/ICommonTransaction.ts

@@ -1,6 +1,7 @@
 import { Address } from '@btc-vision/transaction';
 import { OPNetTransactionTypes } from '../../../interfaces/opnet/OPNetTransactionTypes.js';
 import { ITransactionBase } from '../ITransaction.js';
+import { ProofOfWorkChallenge } from '../ProofOfWorkChallenge.js';
 
 export interface ICommonTransaction<T extends OPNetTransactionTypes> extends ITransactionBase<T> {
     /**
@@ -22,4 +23,9 @@ export interface ICommonTransaction<T extends OPNetTransactionTypes> extends ITr
      * @description Was the binary data compressed?
      */
     readonly wasCompressed?: boolean;
+
+    /**
+     * @description The proof of work challenge.
+     */
+    readonly pow?: ProofOfWorkChallenge;
 }

package/src/transactions/metadata/TransactionInput.ts

@@ -1,4 +1,4 @@
-import { ScriptSig } from '@btc-vision/bsi-bitcoin-rpc';
+import { ScriptSig } from '@btc-vision/bitcoin-rpc';
 
 /**
  * Transaction input interface

package/src/transactions/metadata/TransactionOutput.ts

@@ -1,5 +1,5 @@
 import { script } from '@btc-vision/bitcoin';
-import { ScriptPubKey } from '@btc-vision/bsi-bitcoin-rpc';
+import { ScriptPubKey } from '@btc-vision/bitcoin-rpc';
 
 /**
  * Transaction output interface

package/src/transactions/metadata/TransactionReceipt.ts

@@ -1,4 +1,5 @@
-import { NetEvent } from '@btc-vision/transaction';
+import { Network } from '@btc-vision/bitcoin';
+import { Address, NetEvent } from '@btc-vision/transaction';
 import {
     ContractEvents,
     ITransactionReceipt,
@@ -31,41 +32,53 @@ export class TransactionReceipt implements ITransactionReceipt {
      */
     public readonly revert?: Buffer;
 
-    constructor(receipt: ITransactionReceipt) {
+    constructor(receipt: ITransactionReceipt, network: Network) {
         this.receipt = receipt.receipt
             ? Buffer.from(receipt.receipt as string, 'base64')
             : undefined;
 
         this.receiptProofs = receipt.receiptProofs || [];
 
-        this.events = receipt.events ? this.parseEvents(receipt.events) : {};
+        this.events = receipt.events ? this.parseEvents(receipt.events, network) : {};
         this.revert = receipt.revert ? Buffer.from(receipt.revert as string, 'base64') : undefined;
     }
 
     /**
      * @description Parse transaction events.
      * @param events - The events to parse.
+     * @param network - The network to use.
      * @private
      */
-    private parseEvents(events: RawContractEvents | ContractEvents): ContractEvents {
+    private parseEvents(
+        events: RawContractEvents | ContractEvents,
+        network: Network,
+    ): ContractEvents {
         const parsedEvents: ContractEvents = {};
 
         if (!Array.isArray(events)) {
             for (const [key, value] of Object.entries(events)) {
-                parsedEvents[key] = (value as NetEventDocument[]).map((event: NetEventDocument) => {
-                    return this.decodeEvent(event);
-                });
+                const ca = Address.fromString(key);
+                const caP2tr = ca.p2tr(network);
+                parsedEvents[caP2tr] = (value as NetEventDocument[]).map(
+                    (event: NetEventDocument) => {
+                        return this.decodeEvent(event);
+                    },
+                );
             }
         } else {
             for (const event of events) {
                 const parsedEvent = this.decodeEvent(event);
                 const contractAddress = event.contractAddress;
 
-                if (!parsedEvents[contractAddress]) {
-                    parsedEvents[contractAddress] = [];
+                // TODO: Add a weak cache to avoid parsing the same address multiple times?
+                const ca = Address.fromString(contractAddress);
+                const caP2tr = ca.p2tr(network);
+
+                if (!parsedEvents[caP2tr]) {
+                    parsedEvents[caP2tr] = [];
                 }
 
-                parsedEvents[contractAddress].push(parsedEvent);
+                parsedEvents[caP2tr].push(parsedEvent);
             }
         }
 
@@ -74,7 +87,6 @@ export class TransactionReceipt implements ITransactionReceipt {
 
     private decodeEvent(event: NetEventDocument): NetEvent {
         let eventData: Uint8Array;
-
         if (typeof event.data === 'string') {
             const buf = Buffer.from(event.data, 'base64');
             eventData = new Uint8Array(buf.buffer, buf.byteOffset, buf.byteLength);

package/browser/abi/shared/interfaces/motoswap/IEwmaContract.d.ts

@@ -1,46 +0,0 @@
-import { Address } from '@btc-vision/transaction';
-import { CallResult } from '../../../../contracts/CallResult.js';
-import { IOP_NETContract } from '../opnet/IOP_NETContract.js';
-export type ReserveEWMA = CallResult<{
-    reserved: bigint;
-}>;
-export type AddLiquidity = CallResult<{
-    ok: boolean;
-}>;
-export type RemoveLiquidity = CallResult<{
-    totalTokensReturned: bigint;
-}>;
-export type Swap = CallResult<{
-    ok: boolean;
-}>;
-export type GetReserve = CallResult<{
-    liquidity: bigint;
-    reservedLiquidity: bigint;
-}>;
-export type GetQuote = CallResult<{
-    tokensOut: bigint;
-    requiredSatoshis: bigint;
-    currentPrice: bigint;
-}>;
-export type SetQuote = CallResult<{
-    ok: boolean;
-}>;
-export type PriorityQueueCost = CallResult<{
-    cost: bigint;
-}>;
-export type GetProviderDetails = CallResult<{
-    liquidity: bigint;
-    reserved: bigint;
-    btcReceiver: string;
-}>;
-export interface IEwmaContract extends IOP_NETContract {
-    reserve(token: Address, maximumAmountIn: bigint, minimumAmountOut: bigint): Promise<ReserveEWMA>;
-    addLiquidity(token: Address, receiver: string, amountIn: bigint, priority: boolean): Promise<AddLiquidity>;
-    removeLiquidity(token: Address): Promise<RemoveLiquidity>;
-    swap(token: Address, isSimulation: boolean): Promise<Swap>;
-    getReserve(token: Address): Promise<GetReserve>;
-    getQuote(token: Address, satoshisIn: bigint): Promise<GetQuote>;
-    setQuote(token: Address, p0: bigint): Promise<SetQuote>;
-    priorityQueueCost(token: Address): Promise<PriorityQueueCost>;
-    getProviderDetails(token: Address): Promise<GetProviderDetails>;
-}

package/browser/abi/shared/json/motoswap/EWMA_ABI.d.ts

@@ -1,3 +0,0 @@
-import { BitcoinInterfaceAbi } from '../../../interfaces/BitcoinInterfaceAbi.js';
-export declare const EwmaEvents: BitcoinInterfaceAbi;
-export declare const EwmaAbi: BitcoinInterfaceAbi;

package/build/abi/shared/interfaces/motoswap/IEwmaContract.d.ts

@@ -1,46 +0,0 @@
-import { Address } from '@btc-vision/transaction';
-import { CallResult } from '../../../../contracts/CallResult.js';
-import { IOP_NETContract } from '../opnet/IOP_NETContract.js';
-export type ReserveEWMA = CallResult<{
-    reserved: bigint;
-}>;
-export type AddLiquidity = CallResult<{
-    ok: boolean;
-}>;
-export type RemoveLiquidity = CallResult<{
-    totalTokensReturned: bigint;
-}>;
-export type Swap = CallResult<{
-    ok: boolean;
-}>;
-export type GetReserve = CallResult<{
-    liquidity: bigint;
-    reservedLiquidity: bigint;
-}>;
-export type GetQuote = CallResult<{
-    tokensOut: bigint;
-    requiredSatoshis: bigint;
-    currentPrice: bigint;
-}>;
-export type SetQuote = CallResult<{
-    ok: boolean;
-}>;
-export type PriorityQueueCost = CallResult<{
-    cost: bigint;
-}>;
-export type GetProviderDetails = CallResult<{
-    liquidity: bigint;
-    reserved: bigint;
-    btcReceiver: string;
-}>;
-export interface IEwmaContract extends IOP_NETContract {
-    reserve(token: Address, maximumAmountIn: bigint, minimumAmountOut: bigint): Promise<ReserveEWMA>;
-    addLiquidity(token: Address, receiver: string, amountIn: bigint, priority: boolean): Promise<AddLiquidity>;
-    removeLiquidity(token: Address): Promise<RemoveLiquidity>;
-    swap(token: Address, isSimulation: boolean): Promise<Swap>;
-    getReserve(token: Address): Promise<GetReserve>;
-    getQuote(token: Address, satoshisIn: bigint): Promise<GetQuote>;
-    setQuote(token: Address, p0: bigint): Promise<SetQuote>;
-    priorityQueueCost(token: Address): Promise<PriorityQueueCost>;
-    getProviderDetails(token: Address): Promise<GetProviderDetails>;
-}

package/build/abi/shared/json/motoswap/EWMA_ABI.d.ts

@@ -1,3 +0,0 @@
-import { BitcoinInterfaceAbi } from '../../../interfaces/BitcoinInterfaceAbi.js';
-export declare const EwmaEvents: BitcoinInterfaceAbi;
-export declare const EwmaAbi: BitcoinInterfaceAbi;

package/src/abi/shared/interfaces/motoswap/IEwmaContract.ts

@@ -1,188 +0,0 @@
-import { Address } from '@btc-vision/transaction';
-import { CallResult } from '../../../../contracts/CallResult.js';
-import { IOP_NETContract } from '../opnet/IOP_NETContract.js';
-
-/**
- * @description Represents the result of the reserve function call.
- */
-export type ReserveEWMA = CallResult<{
-    reserved: bigint;
-}>;
-
-/**
- * @description Represents the result of the addLiquidity function call.
- */
-export type AddLiquidity = CallResult<{
-    ok: boolean;
-}>;
-
-/**
- * @description Represents the result of the removeLiquidity function call.
- */
-export type RemoveLiquidity = CallResult<{
-    totalTokensReturned: bigint;
-}>;
-
-/**
- * @description Represents the result of the swap function call.
- */
-export type Swap = CallResult<{
-    ok: boolean;
-}>;
-
-/**
- * @description Represents the result of the getReserve function call.
- */
-export type GetReserve = CallResult<{
-    liquidity: bigint;
-    reservedLiquidity: bigint;
-}>;
-
-/**
- * @description Represents the result of the getQuote function call.
- */
-export type GetQuote = CallResult<{
-    tokensOut: bigint;
-    requiredSatoshis: bigint;
-    currentPrice: bigint;
-}>;
-
-/**
- * @description Represents the result of the setQuote function call.
- */
-export type SetQuote = CallResult<{
-    ok: boolean;
-}>;
-
-/**
- * @description Represents the result of the priorityQueueCost function call.
- */
-export type PriorityQueueCost = CallResult<{
-    cost: bigint;
-}>;
-
-/**
- * @description Represents the result of the getProviderDetails function call.
- */
-export type GetProviderDetails = CallResult<{
-    liquidity: bigint;
-    reserved: bigint;
-    btcReceiver: string;
-}>;
-
-/**
- * @description This interface represents the OP_NET contract.
- * @interface IOP_NETContract
- * @extends {IOP_NETContract}
- * @category Contracts
- *
- * @example
- * import { Address } from '@btc-vision/transaction';
- * import { IOP_NETContract } from '../abi/shared/interfaces/IOP_NETContract.js';
- * import { OP_NET_ABI } from '../abi/shared/json/OP_NET_ABI.js';
- * import { CallResult } from '../contracts/CallResult.js';
- * import { getContract } from '../contracts/Contract.js';
- * import { JSONRpcProvider } from '../providers/JSONRpcProvider.js';
- *
- * const provider: JSONRpcProvider = new JSONRpcProvider('https://regtest.opnet.org');
- * const contract: IOP_NETContract = getContract<IOP_NETContract>(
- *     'bcrt1pyrs3eqwnrmd4ql3nwvx66yzp0wc24xd2t9pf8699ln340pjs7f3sar3tum',
- *     OP_NET_ABI,
- *     provider,
- *     networks.regtest,
- * );
- *
- * const tokenAddress: Address = new Address([
- *    40, 11, 228, 172, 219, 50, 169, 155, 163, 235, 250, 102, 169, 29, 219, 65, 167, 183, 161, 210,
- *    254, 244, 21, 57, 153, 34, 205, 138, 4, 72, 92, 2,
- * ]);
- *
- * const reserveExample = await contract.reserve(
- *     tokenAddress,
- *     BigInt("1000000000000000000"), // maximumAmountIn
- *     BigInt("500000000000000000")   // minimumAmountOut
- * );
- *
- * console.log('Reserved:', reserveExample.properties.reserved);
- */
-export interface IEwmaContract extends IOP_NETContract {
-    /**
-     * @description Reserves a certain amount of tokens.
-     * @param token - The address of the token to reserve.
-     * @param maximumAmountIn - The maximum amount of tokens to reserve.
-     * @param minimumAmountOut - The minimum amount of tokens expected out.
-     * @returns {Promise<ReserveEWMA>}
-     */
-    reserve(
-        token: Address,
-        maximumAmountIn: bigint,
-        minimumAmountOut: bigint,
-    ): Promise<ReserveEWMA>;
-
-    /**
-     * @description Adds liquidity to the contract.
-     * @param token - The address of the token to add liquidity for.
-     * @param receiver - The receiver of the liquidity.
-     * @param amountIn - The amount of tokens to add.
-     * @param priority - Whether to prioritize the liquidity addition.
-     * @returns {Promise<AddLiquidity>}
-     */
-    addLiquidity(
-        token: Address,
-        receiver: string,
-        amountIn: bigint,
-        priority: boolean,
-    ): Promise<AddLiquidity>;
-
-    /**
-     * @description Removes liquidity from the contract.
-     * @param token - The address of the token to remove liquidity for.
-     * @returns {Promise<RemoveLiquidity>}
-     */
-    removeLiquidity(token: Address): Promise<RemoveLiquidity>;
-
-    /**
-     * @description Executes a swap operation.
-     * @param token - The address of the token to swap.
-     * @param isSimulation - Whether the swap is a simulation.
-     * @returns {Promise<Swap>}
-     */
-    swap(token: Address, isSimulation: boolean): Promise<Swap>;
-
-    /**
-     * @description Retrieves the reserve information for a token.
-     * @param token - The address of the token.
-     * @returns {Promise<GetReserve>}
-     */
-    getReserve(token: Address): Promise<GetReserve>;
-
-    /**
-     * @description Retrieves a quote for swapping tokens.
-     * @param token - The address of the token.
-     * @param satoshisIn - The amount of satoshis to swap.
-     * @returns {Promise<GetQuote>}
-     */
-    getQuote(token: Address, satoshisIn: bigint): Promise<GetQuote>;
-
-    /**
-     * @description Sets a new quote for a token.
-     * @param token - The address of the token.
-     * @param p0 - The new quote parameter.
-     * @returns {Promise<SetQuote>}
-     */
-    setQuote(token: Address, p0: bigint): Promise<SetQuote>;
-
-    /**
-     * @description Retrieves the cost of the priority queue for a token.
-     * @param token - The address of the token.
-     * @returns {Promise<PriorityQueueCost>}
-     */
-    priorityQueueCost(token: Address): Promise<PriorityQueueCost>;
-
-    /**
-     * @description Retrieves the provider details for a token.
-     * @param token - The address of the token.
-     * @returns {Promise<GetProviderDetails>}
-     */
-    getProviderDetails(token: Address): Promise<GetProviderDetails>;
-}