opnet 1.0.13 → 1.0.15

package/src/scripts/testContract.ts

@@ -0,0 +1,51 @@
+import { ABIDataTypes } from '@btc-vision/bsi-binary';
+import { BaseContractProperty } from '../abi/BaseContractProperty.js';
+import { BitcoinAbiTypes } from '../abi/BitcoinAbiTypes.js';
+import { BaseContractProperties } from '../abi/interfaces/BaseContractProperties.js';
+import { BitcoinInterfaceAbi } from '../abi/interfaces/BitcoinInterfaceAbi.js';
+import { BitcoinAddressLike } from '../common/CommonTypes.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://testnet.opnet.org');
+
+interface TestContract extends BaseContractProperties {
+    giveFreeMoney(bool: true): Promise<BaseContractProperty>;
+
+    balanceOf(address: BitcoinAddressLike): Promise<BaseContractProperty>;
+}
+
+(async () => {
+    const abi: BitcoinInterfaceAbi = [
+        {
+            name: 'balanceOf',
+            inputs: [
+                {
+                    name: 'address',
+                    type: ABIDataTypes.ADDRESS,
+                },
+            ],
+            outputs: [
+                {
+                    name: 'balance',
+                    type: ABIDataTypes.UINT256,
+                },
+            ],
+            type: BitcoinAbiTypes.Function,
+        },
+    ];
+
+    const contract: TestContract = getContract<TestContract>(
+        'tb1pth90usc4f528aqphpjrfkkdm4vy8hxnt5gps6aau2nva6pxeshtqqzlt3a',
+        abi,
+        provider,
+    );
+
+    // 13sBQqJdnAdc7v5tnX3ifYqAMoFX79VfLy
+    const res: CallResult = (await contract.balanceOf(
+        'bc1p134a291b21a4ef28c961daee77a75e81cd7c0f00733a152930f76746a3e9',
+    )) as CallResult;
+
+    console.log('Balance:', res.decoded);
+})();

package/src/scripts/{test.ts → testMethods.ts}

@@ -1,54 +1,52 @@
-import { JSONRpcProvider } from '../providers/JSONRpcProvider.js';
-
-const provider: JSONRpcProvider = new JSONRpcProvider('https://testnet.opnet.org');
-
-/*
-    const blockNumber = await provider.getBlockNumber();
-    console.log('Current network height:', blockNumber);
-
-    const block = await provider.getBlock(2810101n, true);
-    console.log('Block ->', block.transactions[2]);
-
-    const balance = await provider.getBalance('tb1qcfszz8dcvsz9mcp70ezw5zy2r3ydr0cfz60d3t');
-    console.log('Balance out:', balance);
-
-    const utxos = await provider.getUXTOs('tb1qcfszz8dcvsz9mcp70ezw5zy2r3ydr0cfz60d3t');
-    console.log('UTXOs:', utxos);
-
-    const transaction = await provider.getTransaction(
-        '63e77ba9fa4262b3d4d0d9d97fa8a7359534606c3f3af096284662e3f619f374',
-    );
-
-    console.log('Transaction:', transaction);
-
-    const receipt = await provider.getTransactionReceipt(
-        '63e77ba9fa4262b3d4d0d9d97fa8a7359534606c3f3af096284662e3f619f374',
-    );
-    console.log('Receipt:', receipt);
-*/
-
-(async () => {
-    const net = await provider.getNetwork();
-    console.log(net);
-
-    const code = await provider.getCode(
-        'tb1pth90usc4f528aqphpjrfkkdm4vy8hxnt5gps6aau2nva6pxeshtqqzlt3a',
-    );
-
-    console.log('Code:', code);
-
-    const pointerValue = await provider.getStorageAt(
-        'tb1pth90usc4f528aqphpjrfkkdm4vy8hxnt5gps6aau2nva6pxeshtqqzlt3a',
-        'EXLK/QhEQMI5d9DrthLvozT+UcDQ7WuSPaz7g8GV3AQ=',
-        true,
-    );
-
-    console.log('Pointer value:', pointerValue);
-
-    const callResult = await provider.call(
-        'tb1pth90usc4f528aqphpjrfkkdm4vy8hxnt5gps6aau2nva6pxeshtqqzlt3a',
-        '82d62f3d3133734251714a646e416463377635746e583369665971414d6f4658373956664c79000000000000000000000000000000000000000000000000000000000000',
-    );
-
-    console.log('Call result:', callResult);
-})();
+import { JSONRpcProvider } from '../providers/JSONRpcProvider.js';
+
+const provider: JSONRpcProvider = new JSONRpcProvider('https://testnet.opnet.org');
+
+(async () => {
+    const blockNumber = await provider.getBlockNumber();
+    console.log('Current network height:', blockNumber);
+
+    const block = await provider.getBlock(2810101n, true);
+    console.log('Block ->', block.transactions[2]);
+
+    const balance = await provider.getBalance('tb1qcfszz8dcvsz9mcp70ezw5zy2r3ydr0cfz60d3t');
+    console.log('Balance out:', balance);
+
+    const utxos = await provider.getUXTOs('tb1qcfszz8dcvsz9mcp70ezw5zy2r3ydr0cfz60d3t');
+    console.log('UTXOs:', utxos);
+
+    const transaction = await provider.getTransaction(
+        '63e77ba9fa4262b3d4d0d9d97fa8a7359534606c3f3af096284662e3f619f374',
+    );
+
+    console.log('Transaction:', transaction);
+
+    const receipt = await provider.getTransactionReceipt(
+        '63e77ba9fa4262b3d4d0d9d97fa8a7359534606c3f3af096284662e3f619f374',
+    );
+    console.log('Receipt:', receipt);
+
+    const net = await provider.getNetwork();
+    console.log(net);
+
+    const code = await provider.getCode(
+        'tb1pth90usc4f528aqphpjrfkkdm4vy8hxnt5gps6aau2nva6pxeshtqqzlt3a',
+    );
+
+    console.log('Code:', code);
+
+    const pointerValue = await provider.getStorageAt(
+        'tb1pth90usc4f528aqphpjrfkkdm4vy8hxnt5gps6aau2nva6pxeshtqqzlt3a',
+        'EXLK/QhEQMI5d9DrthLvozT+UcDQ7WuSPaz7g8GV3AQ=',
+        true,
+    );
+
+    console.log('Pointer value:', pointerValue);
+
+    const callResult = await provider.call(
+        'tb1pth90usc4f528aqphpjrfkkdm4vy8hxnt5gps6aau2nva6pxeshtqqzlt3a',
+        '82d62f3d3133734251714a646e416463377635746e583369665971414d6f4658373956664c79000000000000000000000000000000000000000000000000000000000000',
+    );
+
+    console.log('Call result:', callResult);
+})();

package/src/scripts/test_abi.json

@@ -0,0 +1,31 @@
+[
+  {
+    "constant": true,
+    "inputs": [],
+    "name": "name",
+    "outputs": [
+      {
+        "name": "",
+        "type": "string"
+      }
+    ],
+    "type": "function"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": true,
+        "name": "src",
+        "type": "address"
+      },
+      {
+        "indexed": false,
+        "name": "wad",
+        "type": "uint256"
+      }
+    ],
+    "name": "Withdrawal",
+    "type": "event"
+  }
+]

package/src/storage/StoredValue.ts

@@ -1,30 +1,35 @@
-import { BufferHelper } from '@btc-vision/bsi-binary';
-import { IStorageValue } from './interfaces/IStorageValue.js';
-
-export class StoredValue implements IStorageValue {
-    public readonly pointer: bigint;
-    public readonly value: Buffer;
-
-    public readonly height: bigint;
-    public readonly proofs: string[];
-
-    constructor(iStoredValue: IStorageValue) {
-        this.pointer =
-            typeof iStoredValue.pointer === 'string'
-                ? this.base64ToBigInt(iStoredValue.pointer)
-                : iStoredValue.pointer;
-
-        if (iStoredValue.value instanceof Buffer) {
-            this.value = iStoredValue.value;
-        } else {
-            this.value = Buffer.from(iStoredValue.value, 'base64');
-        }
-
-        this.height = BigInt(iStoredValue.height);
-        this.proofs = iStoredValue.proofs || [];
-    }
-
-    private base64ToBigInt(base64: string): bigint {
-        return BufferHelper.uint8ArrayToPointer(Buffer.from(base64, 'base64'));
-    }
-}
+import { BufferHelper } from '@btc-vision/bsi-binary';
+import { IStorageValue } from './interfaces/IStorageValue.js';
+
+/**
+ * @description This class is used represent a stored value.
+ * @class StoredValue
+ * @category Storage
+ */
+export class StoredValue implements IStorageValue {
+    public readonly pointer: bigint;
+    public readonly value: Buffer;
+
+    public readonly height: bigint;
+    public readonly proofs: string[];
+
+    constructor(iStoredValue: IStorageValue) {
+        this.pointer =
+            typeof iStoredValue.pointer === 'string'
+                ? this.base64ToBigInt(iStoredValue.pointer)
+                : iStoredValue.pointer;
+
+        if (iStoredValue.value instanceof Buffer) {
+            this.value = iStoredValue.value;
+        } else {
+            this.value = Buffer.from(iStoredValue.value, 'base64');
+        }
+
+        this.height = BigInt(iStoredValue.height);
+        this.proofs = iStoredValue.proofs || [];
+    }
+
+    private base64ToBigInt(base64: string): bigint {
+        return BufferHelper.uint8ArrayToPointer(Buffer.from(base64, 'base64'));
+    }
+}

package/src/storage/interfaces/IStorageValue.ts

@@ -1,10 +1,15 @@
-import { BigNumberish } from 'ethers';
-import { PointerLike } from '../../common/CommonTypes.js';
-
-export interface IStorageValue {
-    readonly pointer: PointerLike;
-    readonly value: string | Buffer;
-
-    readonly height: BigNumberish;
-    readonly proofs?: string[];
-}
+import { BigNumberish } from 'ethers';
+import { PointerLike } from '../../common/CommonTypes.js';
+
+/**
+ * @description This interface is used to represent a stored value.
+ * @interface IStorageValue
+ * @category Storage
+ */
+export interface IStorageValue {
+    readonly pointer: PointerLike;
+    readonly value: string | Buffer;
+
+    readonly height: BigNumberish;
+    readonly proofs?: string[];
+}

package/src/transactions/DeploymentTransaction.ts

@@ -1,36 +1,41 @@
-import { OPNetTransactionTypes } from '../interfaces/opnet/OPNetTransactionTypes.js';
-import { IDeploymentTransaction } from './interfaces/ITransaction.js';
-import { TransactionBase } from './Transaction.js';
-
-export class DeploymentTransaction
-    extends TransactionBase<OPNetTransactionTypes.Deployment>
-    implements IDeploymentTransaction
-{
-    public readonly contractAddress: string;
-    public readonly virtualAddress: string;
-
-    public readonly bytecode: Buffer;
-    public readonly wasCompressed: boolean;
-
-    public readonly deployerPubKey: Buffer;
-    public readonly deployerAddress: string;
-
-    public readonly contractSeed: Buffer;
-    public readonly contractSaltHash: Buffer;
-
-    constructor(transaction: IDeploymentTransaction) {
-        super(transaction);
-
-        this.contractAddress = transaction.contractAddress;
-        this.virtualAddress = transaction.virtualAddress;
-
-        this.bytecode = Buffer.from(transaction.bytecode as string, 'base64');
-        this.wasCompressed = transaction.wasCompressed;
-
-        this.deployerPubKey = Buffer.from(transaction.deployerPubKey as string, 'base64');
-        this.deployerAddress = transaction.deployerAddress;
-
-        this.contractSeed = Buffer.from(transaction.contractSeed as string, 'base64');
-        this.contractSaltHash = Buffer.from(transaction.contractSaltHash as string, 'base64');
-    }
-}
+import { OPNetTransactionTypes } from '../interfaces/opnet/OPNetTransactionTypes.js';
+import { IDeploymentTransaction } from './interfaces/ITransaction.js';
+import { TransactionBase } from './Transaction.js';
+
+/**
+ * @description This class is used to provide a deployment transaction.
+ * @class DeploymentTransaction
+ * @category Transactions
+ */
+export class DeploymentTransaction
+    extends TransactionBase<OPNetTransactionTypes.Deployment>
+    implements IDeploymentTransaction
+{
+    public readonly contractAddress: string;
+    public readonly virtualAddress: string;
+
+    public readonly bytecode: Buffer;
+    public readonly wasCompressed: boolean;
+
+    public readonly deployerPubKey: Buffer;
+    public readonly deployerAddress: string;
+
+    public readonly contractSeed: Buffer;
+    public readonly contractSaltHash: Buffer;
+
+    constructor(transaction: IDeploymentTransaction) {
+        super(transaction);
+
+        this.contractAddress = transaction.contractAddress;
+        this.virtualAddress = transaction.virtualAddress;
+
+        this.bytecode = Buffer.from(transaction.bytecode as string, 'base64');
+        this.wasCompressed = transaction.wasCompressed;
+
+        this.deployerPubKey = Buffer.from(transaction.deployerPubKey as string, 'base64');
+        this.deployerAddress = transaction.deployerAddress;
+
+        this.contractSeed = Buffer.from(transaction.contractSeed as string, 'base64');
+        this.contractSaltHash = Buffer.from(transaction.contractSaltHash as string, 'base64');
+    }
+}

package/src/transactions/GenericTransaction.ts

@@ -1,12 +1,19 @@
-import { OPNetTransactionTypes } from '../interfaces/opnet/OPNetTransactionTypes.js';
-import { IGenericTransaction } from './interfaces/ITransaction.js';
-import { TransactionBase } from './Transaction.js';
-
-export class GenericTransaction
-    extends TransactionBase<OPNetTransactionTypes.Generic>
-    implements IGenericTransaction
-{
-    constructor(transaction: IGenericTransaction) {
-        super(transaction);
-    }
-}
+import { OPNetTransactionTypes } from '../interfaces/opnet/OPNetTransactionTypes.js';
+import { IGenericTransaction } from './interfaces/ITransaction.js';
+import { TransactionBase } from './Transaction.js';
+
+/**
+ * @description This class is used to create a generic transaction.
+ * @class GenericTransaction
+ * @extends {TransactionBase<OPNetTransactionTypes.Generic>}
+ * @implements {IGenericTransaction}
+ * @category Transactions
+ */
+export class GenericTransaction
+    extends TransactionBase<OPNetTransactionTypes.Generic>
+    implements IGenericTransaction
+{
+    constructor(transaction: IGenericTransaction) {
+        super(transaction);
+    }
+}

package/src/transactions/InteractionTransaction.ts

@@ -1,40 +1,44 @@
-import { NetEvent } from '@btc-vision/bsi-binary';
-import { Buffer } from 'buffer';
-import { OPNetTransactionTypes } from '../interfaces/opnet/OPNetTransactionTypes.js';
-import { IInteractionTransaction } from './interfaces/ITransaction.js';
-import { TransactionBase } from './Transaction.js';
-
-export class InteractionTransaction
-    extends TransactionBase<OPNetTransactionTypes.Interaction>
-    implements IInteractionTransaction
-{
-    public readonly calldata: Buffer;
-    public readonly senderPubKeyHash: Buffer;
-    public readonly contractSecret: Buffer;
-    public readonly interactionPubKey: Buffer;
-
-    public readonly wasCompressed: boolean;
-    public readonly events: NetEvent[];
-
-    public readonly receipt?: Buffer;
-
-    public readonly receiptProofs?: string[];
-
-    constructor(transaction: IInteractionTransaction) {
-        super(transaction);
-
-        this.calldata = Buffer.from(transaction.calldata as string, 'base64');
-        this.senderPubKeyHash = Buffer.from(transaction.senderPubKeyHash as string, 'base64');
-        this.contractSecret = Buffer.from(transaction.contractSecret as string, 'base64');
-        this.interactionPubKey = Buffer.from(transaction.interactionPubKey as string, 'base64');
-
-        this.wasCompressed = transaction.wasCompressed;
-
-        this.events = transaction.events;
-        this.receipt = transaction.receipt
-            ? Buffer.from(transaction.receipt as string, 'base64')
-            : undefined;
-
-        this.receiptProofs = transaction.receiptProofs;
-    }
-}
+import { NetEvent } from '@btc-vision/bsi-binary';
+import { Buffer } from 'buffer';
+import { OPNetTransactionTypes } from '../interfaces/opnet/OPNetTransactionTypes.js';
+import { IInteractionTransaction } from './interfaces/ITransaction.js';
+import { TransactionBase } from './Transaction.js';
+
+/**
+ * Interaction transaction.
+ * @category Transactions
+ */
+export class InteractionTransaction
+    extends TransactionBase<OPNetTransactionTypes.Interaction>
+    implements IInteractionTransaction
+{
+    public readonly calldata: Buffer;
+    public readonly senderPubKeyHash: Buffer;
+    public readonly contractSecret: Buffer;
+    public readonly interactionPubKey: Buffer;
+
+    public readonly wasCompressed: boolean;
+    public readonly events: NetEvent[];
+
+    public readonly receipt?: Buffer;
+
+    public readonly receiptProofs?: string[];
+
+    constructor(transaction: IInteractionTransaction) {
+        super(transaction);
+
+        this.calldata = Buffer.from(transaction.calldata as string, 'base64');
+        this.senderPubKeyHash = Buffer.from(transaction.senderPubKeyHash as string, 'base64');
+        this.contractSecret = Buffer.from(transaction.contractSecret as string, 'base64');
+        this.interactionPubKey = Buffer.from(transaction.interactionPubKey as string, 'base64');
+
+        this.wasCompressed = transaction.wasCompressed;
+
+        this.events = transaction.events;
+        this.receipt = transaction.receipt
+            ? Buffer.from(transaction.receipt as string, 'base64')
+            : undefined;
+
+        this.receiptProofs = transaction.receiptProofs;
+    }
+}

package/src/transactions/Transaction.ts

@@ -4,6 +4,14 @@ import { ITransactionBase } from './interfaces/ITransaction.js';
 import { TransactionInput } from './TransactionInput.js';
 import { ITransactionOutput, TransactionOutput } from './TransactionOutput.js';
 
+/**
+ * @description This class is used to provide a base transaction.
+ * @class Transaction
+ * @implements {ITransactionBase<T>}
+ * @template T
+ * @category Transactions
+ * @abstract
+ */
 export abstract class TransactionBase<T extends OPNetTransactionTypes>
     implements ITransactionBase<T>
 {

package/src/transactions/TransactionInput.ts

@@ -1,5 +1,9 @@
 import { ScriptSig } from '@btc-vision/bsi-bitcoin-rpc';
 
+/**
+ * Transaction input interface
+ * @category ITransactions
+ */
 export interface ITransactionInput {
     readonly originalTransactionId: string | undefined;
     readonly outputTransactionIndex: number | undefined;
@@ -10,6 +14,10 @@ export interface ITransactionInput {
     readonly transactionInWitness?: string[];
 }
 
+/**
+ * Transaction input
+ * @category ITransactions
+ */
 export class TransactionInput implements ITransactionInput {
     public readonly originalTransactionId: string | undefined;
     public readonly outputTransactionIndex: number | undefined;

package/src/transactions/TransactionOutput.ts

@@ -1,6 +1,10 @@
 import { ScriptPubKey } from '@btc-vision/bsi-bitcoin-rpc';
 import { script } from 'bitcoinjs-lib';
 
+/**
+ * Transaction output interface
+ * @category ITransactions
+ */
 export interface ITransactionOutput {
     readonly index: number;
     readonly scriptPubKey: {
@@ -12,6 +16,10 @@ export interface ITransactionOutput {
     readonly value: string;
 }
 
+/**
+ * Transaction output
+ * @category Transactions
+ */
 export class TransactionOutput {
     public readonly value: bigint;
     public readonly index: number;

package/src/transactions/TransactionParser.ts

@@ -1,43 +1,47 @@
-import { OPNetTransactionTypes } from '../interfaces/opnet/OPNetTransactionTypes.js';
-import { DeploymentTransaction } from './DeploymentTransaction.js';
-import { GenericTransaction } from './GenericTransaction.js';
-import { InteractionTransaction } from './InteractionTransaction.js';
-import {
-    IDeploymentTransaction,
-    IGenericTransaction,
-    IInteractionTransaction,
-    ITransaction,
-} from './interfaces/ITransaction.js';
-import { TransactionBase } from './Transaction.js';
-
-export class TransactionParser {
-    public static parseTransactions(
-        transactions: ITransaction[],
-    ): TransactionBase<OPNetTransactionTypes>[] {
-        if (!transactions) {
-            return [];
-        }
-
-        const transactionArray: TransactionBase<OPNetTransactionTypes>[] = [];
-        for (let transaction of transactions) {
-            transactionArray.push(this.parseTransaction(transaction));
-        }
-
-        return transactionArray;
-    }
-
-    public static parseTransaction(
-        transaction: ITransaction,
-    ): TransactionBase<OPNetTransactionTypes> {
-        switch (transaction.OPNetType) {
-            case OPNetTransactionTypes.Generic:
-                return new GenericTransaction(transaction as IGenericTransaction);
-            case OPNetTransactionTypes.Interaction:
-                return new InteractionTransaction(transaction as IInteractionTransaction);
-            case OPNetTransactionTypes.Deployment:
-                return new DeploymentTransaction(transaction as IDeploymentTransaction);
-            default:
-                throw new Error('Unknown transaction type');
-        }
-    }
-}
+import { OPNetTransactionTypes } from '../interfaces/opnet/OPNetTransactionTypes.js';
+import { DeploymentTransaction } from './DeploymentTransaction.js';
+import { GenericTransaction } from './GenericTransaction.js';
+import { InteractionTransaction } from './InteractionTransaction.js';
+import {
+    IDeploymentTransaction,
+    IGenericTransaction,
+    IInteractionTransaction,
+    ITransaction,
+} from './interfaces/ITransaction.js';
+import { TransactionBase } from './Transaction.js';
+
+/**
+ * Transaction parser
+ * @category Transactions
+ */
+export class TransactionParser {
+    public static parseTransactions(
+        transactions: ITransaction[],
+    ): TransactionBase<OPNetTransactionTypes>[] {
+        if (!transactions) {
+            return [];
+        }
+
+        const transactionArray: TransactionBase<OPNetTransactionTypes>[] = [];
+        for (let transaction of transactions) {
+            transactionArray.push(this.parseTransaction(transaction));
+        }
+
+        return transactionArray;
+    }
+
+    public static parseTransaction(
+        transaction: ITransaction,
+    ): TransactionBase<OPNetTransactionTypes> {
+        switch (transaction.OPNetType) {
+            case OPNetTransactionTypes.Generic:
+                return new GenericTransaction(transaction as IGenericTransaction);
+            case OPNetTransactionTypes.Interaction:
+                return new InteractionTransaction(transaction as IInteractionTransaction);
+            case OPNetTransactionTypes.Deployment:
+                return new DeploymentTransaction(transaction as IDeploymentTransaction);
+            default:
+                throw new Error('Unknown transaction type');
+        }
+    }
+}