opnet 1.0.13 → 1.0.15

package/src/transactions/TransactionReceipt.ts

@@ -1,18 +1,22 @@
-import { NetEvent } from '@btc-vision/bsi-binary';
-import { ITransactionReceipt } from './interfaces/ITransactionReceipt.js';
-
-export class TransactionReceipt implements ITransactionReceipt {
-    public readonly receipt: Buffer | null;
-    public readonly receiptProofs: string[];
-    public readonly events: NetEvent[];
-
-    public readonly revert?: Buffer;
-
-    constructor(receipt: ITransactionReceipt) {
-        this.receipt = receipt.receipt ? Buffer.from(receipt.receipt as string, 'base64') : null;
-        this.receiptProofs = receipt.receiptProofs || [];
-        this.events = receipt.events || [];
-
-        this.revert = receipt.revert ? Buffer.from(receipt.revert as string, 'base64') : undefined;
-    }
-}
+import { NetEvent } from '@btc-vision/bsi-binary';
+import { ITransactionReceipt } from './interfaces/ITransactionReceipt.js';
+
+/**
+ * Transaction receipt
+ * @category Transactions
+ */
+export class TransactionReceipt implements ITransactionReceipt {
+    public readonly receipt: Buffer | null;
+    public readonly receiptProofs: string[];
+    public readonly events: NetEvent[];
+
+    public readonly revert?: Buffer;
+
+    constructor(receipt: ITransactionReceipt) {
+        this.receipt = receipt.receipt ? Buffer.from(receipt.receipt as string, 'base64') : null;
+        this.receiptProofs = receipt.receiptProofs || [];
+        this.events = receipt.events || [];
+
+        this.revert = receipt.revert ? Buffer.from(receipt.revert as string, 'base64') : undefined;
+    }
+}

package/src/transactions/interfaces/ITransaction.ts

@@ -1,52 +1,78 @@
-import { NetEvent } from '@btc-vision/bsi-binary';
-import { BigNumberish } from 'ethers';
-import { OPNetTransactionTypes } from '../../interfaces/opnet/OPNetTransactionTypes.js';
-import { ITransactionInput, TransactionInput } from '../TransactionInput.js';
-import { ITransactionOutput, TransactionOutput } from '../TransactionOutput.js';
-
-export interface ITransactionBase<T extends OPNetTransactionTypes> {
-    readonly id: string;
-    readonly hash: string;
-
-    readonly index: number; // Mark the order of the transaction in the block
-
-    readonly burnedBitcoin: string | BigNumberish;
-    readonly revert?: string | Buffer;
-
-    readonly inputs: ITransactionInput[] | TransactionInput[];
-    readonly outputs: ITransactionOutput[] | TransactionOutput[];
-
-    readonly OPNetType: T;
-}
-
-export interface IGenericTransaction extends ITransactionBase<OPNetTransactionTypes.Generic> {}
-
-export interface IDeploymentTransaction extends ITransactionBase<OPNetTransactionTypes.Deployment> {
-    readonly contractAddress: string;
-    readonly virtualAddress: string;
-
-    readonly bytecode: Buffer | string;
-    readonly wasCompressed: boolean;
-
-    readonly deployerPubKey: Buffer | string;
-    readonly deployerAddress: string;
-
-    readonly contractSeed: Buffer | string;
-    readonly contractSaltHash: Buffer | string;
-}
-
-export interface IInteractionTransaction
-    extends ITransactionBase<OPNetTransactionTypes.Interaction> {
-    readonly calldata: string | Buffer;
-    readonly senderPubKeyHash: string | Buffer;
-    readonly contractSecret: string | Buffer;
-    readonly interactionPubKey: string | Buffer;
-
-    readonly wasCompressed: boolean;
-
-    readonly events: NetEvent[];
-    readonly receipt?: string | Buffer;
-    readonly receiptProofs?: string[];
-}
-
-export type ITransaction = IDeploymentTransaction | IInteractionTransaction | IGenericTransaction;
+import { NetEvent } from '@btc-vision/bsi-binary';
+import { BigNumberish } from 'ethers';
+import { OPNetTransactionTypes } from '../../interfaces/opnet/OPNetTransactionTypes.js';
+import { ITransactionInput, TransactionInput } from '../TransactionInput.js';
+import { ITransactionOutput, TransactionOutput } from '../TransactionOutput.js';
+
+/**
+ * @description This interface represents the base of a transaction.
+ * @interface ITransactionBase
+ * @template T
+ * @category ITransactions
+ */
+export interface ITransactionBase<T extends OPNetTransactionTypes> {
+    readonly id: string;
+    readonly hash: string;
+
+    readonly index: number; // Mark the order of the transaction in the block
+
+    readonly burnedBitcoin: string | BigNumberish;
+    readonly revert?: string | Buffer;
+
+    readonly inputs: ITransactionInput[] | TransactionInput[];
+    readonly outputs: ITransactionOutput[] | TransactionOutput[];
+
+    readonly OPNetType: T;
+}
+
+/**
+ * @description This interface represents a generic transaction.
+ * @interface IGenericTransaction
+ * @category ITransactions
+ */
+export interface IGenericTransaction extends ITransactionBase<OPNetTransactionTypes.Generic> {}
+
+/**
+ * @description This interface represents a deployment transaction.
+ * @interface IDeploymentTransaction
+ * @category ITransactions
+ */
+export interface IDeploymentTransaction extends ITransactionBase<OPNetTransactionTypes.Deployment> {
+    readonly contractAddress: string;
+    readonly virtualAddress: string;
+
+    readonly bytecode: Buffer | string;
+    readonly wasCompressed: boolean;
+
+    readonly deployerPubKey: Buffer | string;
+    readonly deployerAddress: string;
+
+    readonly contractSeed: Buffer | string;
+    readonly contractSaltHash: Buffer | string;
+}
+
+/**
+ * @description This interface represents an interaction transaction.
+ * @interface IInteractionTransaction
+ * @category ITransactions
+ */
+export interface IInteractionTransaction
+    extends ITransactionBase<OPNetTransactionTypes.Interaction> {
+    readonly calldata: string | Buffer;
+    readonly senderPubKeyHash: string | Buffer;
+    readonly contractSecret: string | Buffer;
+    readonly interactionPubKey: string | Buffer;
+
+    readonly wasCompressed: boolean;
+
+    readonly events: NetEvent[];
+    readonly receipt?: string | Buffer;
+    readonly receiptProofs?: string[];
+}
+
+/**
+ * @description This type represents a transaction.
+ * @type ITransaction
+ * @category ITransactions
+ */
+export type ITransaction = IDeploymentTransaction | IInteractionTransaction | IGenericTransaction;

package/src/transactions/interfaces/ITransactionReceipt.ts

@@ -1,9 +1,14 @@
-import { NetEvent } from '@btc-vision/bsi-binary';
-
-export interface ITransactionReceipt {
-    readonly receipt: string | null | Buffer;
-    readonly receiptProofs: string[];
-    readonly events: NetEvent[];
-
-    readonly revert?: string | Buffer;
-}
+import { NetEvent } from '@btc-vision/bsi-binary';
+
+/**
+ * @description This interface represents a transaction receipt.
+ * @interface ITransactionReceipt
+ * @category ITransactions
+ */
+export interface ITransactionReceipt {
+    readonly receipt: string | null | Buffer;
+    readonly receiptProofs: string[];
+    readonly events: NetEvent[];
+
+    readonly revert?: string | Buffer;
+}

package/src/utils/BitcoinUtils.ts

@@ -0,0 +1,22 @@
+import BigNumber from 'bignumber.js';
+import { BigNumberish } from 'ethers';
+
+/**
+ * Bitcoin Utilities
+ * @description This class is used to provide utility functions for Bitcoin.
+ * @class BitcoinUtils
+ * @category Utils
+ */
+export class BitcoinUtils {
+    /**
+     * Get Satoshis or any other unit, bitcoin by default.
+     * @description This function is used to format a value in satoshis to Bitcoin.
+     * @param value Value in satoshis or any other unit
+     * @param decimals Default is 8
+     */
+    public static formatUnits(value: BigNumberish, decimals: number = 8): string {
+        const bn: BigNumber = new BigNumber(value.toString());
+
+        return bn.dividedBy(new BigNumber(10).pow(decimals)).toString();
+    }
+}

package/webpack.config.js

@@ -1,75 +1,71 @@
-import webpack from 'webpack';
-
-export default {
-    mode: 'production',
-    entry: './src/index.ts',
-    watch: false,
-    output: {
-        filename: 'index.js',
-        path: import.meta.dirname + '/browser',
-        libraryTarget: 'module',
-    },
-    node: {
-        __dirname: false,
-    },
-    experiments: {
-        outputModule: true,
-        asyncWebAssembly: true,
-        syncWebAssembly: true,
-    },
-    resolve: {
-        extensionAlias: {
-            '.js': ['.js', '.ts'],
-        },
-        modules: ['.', 'node_modules'],
-        extensions: ['.*', '.js', '.jsx', '.tsx', '.ts', '.wasm'],
-        fallback: {
-            buffer: import.meta.resolve('buffer/'),
-
-            assert: import.meta.resolve('assert/'),
-            crypto: import.meta.resolve('./src/crypto/crypto-browser.js'),
-            http: import.meta.resolve('stream-http/'),
-            https: import.meta.resolve('https-browserify/'),
-            os: import.meta.resolve('os-browserify/browser/'),
-            stream: import.meta.resolve('stream-browserify'),
-            process: import.meta.resolve('process/browser'),
-        },
-    },
-    cache: false,
-    module: {
-        rules: [
-            {
-                test: /\.(js|jsx|tsx|ts)$/,
-                exclude: /node_modules/,
-                resolve: {
-                    fullySpecified: false,
-                },
-                use: [
-                    {
-                        loader: 'babel-loader',
-                    },
-                    {
-                        loader: 'ts-loader',
-                        options: {
-                            configFile: 'tsconfig.webpack.json',
-                        },
-                    },
-                ],
-            },
-        ],
-    },
-    optimization: {
-        usedExports: true,
-    },
-    plugins: [
-        new webpack.ProvidePlugin({
-            Buffer: ['buffer', 'Buffer'],
-            process: 'process/browser',
-            stream: 'stream-browserify',
-        }),
-
-        /*new NodePolyfillPlugin({
-            excludeAliases: ['console', 'buffer'],
-        }),*/
-    ],
-};
+import webpack from 'webpack';
+
+export default {
+    mode: 'production',
+    entry: './src/index.ts',
+    watch: false,
+    output: {
+        filename: 'index.js',
+        path: import.meta.dirname + '/browser',
+        libraryTarget: 'module',
+    },
+    node: {
+        __dirname: false,
+    },
+    experiments: {
+        outputModule: true,
+        asyncWebAssembly: true,
+        syncWebAssembly: true,
+    },
+    resolve: {
+        extensionAlias: {
+            '.js': ['.js', '.ts'],
+        },
+        modules: ['.', 'node_modules'],
+        extensions: ['.*', '.js', '.jsx', '.tsx', '.ts', '.wasm'],
+        fallback: {
+            buffer: import.meta.resolve('buffer/'),
+
+            assert: import.meta.resolve('assert/'),
+            crypto: import.meta.resolve('./src/crypto/crypto-browser.js'),
+            http: import.meta.resolve('stream-http/'),
+            https: import.meta.resolve('https-browserify/'),
+            os: import.meta.resolve('os-browserify/browser/'),
+            stream: import.meta.resolve('stream-browserify'),
+            process: import.meta.resolve('process/browser'),
+        },
+    },
+    cache: false,
+    module: {
+        rules: [
+            {
+                test: /\.(js|jsx|tsx|ts)$/,
+                exclude: /node_modules/,
+                resolve: {
+                    fullySpecified: false,
+                },
+                use: [
+                    {
+                        loader: 'babel-loader',
+                    },
+                    {
+                        loader: 'ts-loader',
+                        options: {
+                            configFile: 'tsconfig.webpack.json',
+                        },
+                    },
+                ],
+            },
+        ],
+    },
+    optimization: {
+        usedExports: true,
+    },
+    plugins: [
+        new webpack.ProvidePlugin({
+            Buffer: ['buffer', 'Buffer'],
+            process: 'process/browser',
+            stream: 'stream-browserify',
+        }),
+    ],
+};