opnet 1.0.13 → 1.0.15

package/CONTRIBUTING.md

@@ -0,0 +1,71 @@
+# Contributing Guidelines
+
+Thank you for considering contributing to our project! Please take a moment to
+review the following guidelines before submitting your contribution.
+
+## Pull Requests
+
+When submitting a pull request, please make sure to follow these guidelines:
+
+### Before You Begin
+
+1. **Fork the repository**: If you haven't already, fork the repository to your
+   GitHub account.
+
+2. **Create a new branch**: Create a new branch for your feature or bug fix.
+   This helps keep the main branch clean and makes it easier to review your
+   changes.
+
+3. **Ensure your code is up-to-date**: Before starting work, make sure your
+   forked repository is up-to-date with the latest changes from the main
+   repository.
+
+### Making Changes
+
+1. **Follow coding conventions**: Make sure your code follows the existing
+   coding style and conventions used in the project.
+
+2. **Write descriptive commit messages**: Write clear and descriptive commit
+   messages that explain the purpose of your changes.
+
+3. **Test your changes**: Before submitting your pull request, make sure to test
+   your changes thoroughly to ensure they work as expected.
+
+### Submitting the Pull Request
+
+1. **Create a descriptive title**: Use a clear and descriptive title for your
+   pull request that summarizes the purpose of your changes.
+
+2. **Provide a detailed description**: Include a detailed description of the
+   changes you've made and any relevant context that reviewers should know.
+
+3. **Link related issues**: If your pull request addresses a specific issue,
+   make sure to reference it in the description using GitHub's issue linking
+   syntax (`#issue_number`).
+
+4. **Review and address feedback**: Be responsive to any feedback or comments
+   you receive on your pull request and make any necessary changes.
+
+## Issues
+
+When submitting an issue, please provide as much information as possible to help
+us understand and address the problem. Follow these guidelines when creating an
+issue:
+
+1. **Use a descriptive title**: Use a clear and descriptive title that
+   summarizes the issue you're experiencing.
+
+2. **Provide detailed steps to reproduce**: Include detailed steps to reproduce
+   the issue, including any relevant code or configuration.
+
+3. **Include relevant information**: Provide any relevant information such as
+   error messages, screenshots, or logs that can help diagnose the problem.
+
+4. **Specify your environment**: If the issue is related to a specific
+   environment (e.g., operating system, browser), please specify it in your
+   issue description.
+
+5. **Check for existing issues**: Before submitting a new issue, please check if
+   a similar issue has already been reported to avoid duplicates.
+
+Thank you for your contributions!

package/README.md

@@ -22,7 +22,7 @@ and other Bitcoin-related technologies.
 
 ### Prerequisites
 
-- Node.js version 20.x or higher
+- Node.js version 16.x or higher
 - npm (Node Package Manager)
 
 ### Installation
@@ -31,6 +31,11 @@ and other Bitcoin-related technologies.
 npm i opnet
 ```
 
+### Documentation
+
+Documentation available at [https://dev.opnet.org](https://dev.opnet.org) or in
+the `docs/` directory of the repository.
+
 #### Development
 
 1. Clone the repository:
@@ -46,12 +51,6 @@ npm i opnet
    npm i
    ```
 
-## Usage
-
-Refer to the `docs/` directory for detailed guides on how to use OPNet. Start
-with `getting_started.md` and explore `api_reference.md` for comprehensive
-information about the functions available.
-
 ## Contribution
 
 Contributions are welcome! Please read through the `CONTRIBUTING.md` file for

package/browser/_version.d.ts

@@ -1 +1 @@
-export declare const version = "1.0.12";
+export declare const version = "1.0.15";

package/browser/abi/BaseContractProperty.d.ts

@@ -0,0 +1,3 @@
+import { CallResult } from '../contracts/CallResult.js';
+import { ICallRequestError } from '../contracts/interfaces/ICallResult.js';
+export type BaseContractProperty = CallResult | ICallRequestError;

package/browser/abi/BitcoinAbiTypes.d.ts

@@ -0,0 +1,4 @@
+export declare enum BitcoinAbiTypes {
+    Function = "function",
+    Event = "event"
+}

package/browser/abi/BitcoinInterface.d.ts

@@ -0,0 +1,9 @@
+import { BitcoinInterfaceAbi } from './interfaces/BitcoinInterfaceAbi.js';
+export declare class BitcoinInterface {
+    readonly abi: BitcoinInterfaceAbi;
+    constructor(abi: BitcoinInterfaceAbi);
+    static from(abi: BitcoinInterface | BitcoinInterfaceAbi): BitcoinInterface;
+    hasFunction(name: string): boolean;
+    private verifyAbi;
+    private verifyAbiValues;
+}

package/browser/abi/interfaces/BaseContractProperties.d.ts

@@ -0,0 +1,4 @@
+import { BaseContractProperty } from '../BaseContractProperty.js';
+export interface BaseContractProperties {
+    [key: symbol]: BaseContractProperty;
+}

package/browser/abi/interfaces/BitcoinAbiValue.d.ts

@@ -0,0 +1,5 @@
+import { ABIDataTypes } from '@btc-vision/bsi-binary';
+export interface BitcoinAbiValue {
+    name: string;
+    type: ABIDataTypes;
+}

package/browser/abi/interfaces/BitcoinInterfaceAbi.d.ts

@@ -0,0 +1,11 @@
+import { BitcoinAbiTypes } from '../BitcoinAbiTypes.js';
+import { BitcoinAbiValue } from './BitcoinAbiValue.js';
+export interface BitcoinInterfaceAbiBase {
+    readonly constant?: boolean;
+    readonly name: string;
+    readonly inputs?: BitcoinAbiValue[];
+    readonly outputs?: BitcoinAbiValue[];
+    readonly type: BitcoinAbiTypes;
+    readonly payable?: boolean;
+}
+export type BitcoinInterfaceAbi = BitcoinInterfaceAbiBase[];

package/browser/bitcoin/UTXOs.d.ts

@@ -1,10 +1,5 @@
 import { ScriptPubKey } from '@btc-vision/bsi-bitcoin-rpc';
-export interface IUTXO {
-    readonly transactionId: string;
-    readonly outputIndex: number;
-    readonly value: bigint | string;
-    readonly scriptPubKey: ScriptPubKey;
-}
+import { IUTXO } from './interfaces/IUTXO.js';
 export declare class UTXO implements IUTXO {
     readonly transactionId: string;
     readonly outputIndex: number;

package/browser/bitcoin/interfaces/IUTXO.d.ts

@@ -0,0 +1,7 @@
+import { ScriptPubKey } from '@btc-vision/bsi-bitcoin-rpc';
+export interface IUTXO {
+    readonly transactionId: string;
+    readonly outputIndex: number;
+    readonly value: bigint | string;
+    readonly scriptPubKey: ScriptPubKey;
+}

package/browser/common/CommonTypes.d.ts

@@ -1,3 +1,4 @@
 import { BitcoinAddress } from '../bitcoin/BitcoinAddress.js';
 export type BitcoinAddressLike = string | BitcoinAddress;
 export type PointerLike = bigint | string;
+export type DecodedCallResult = bigint | string | boolean | number | Uint8Array | Array<bigint> | Array<string> | Array<boolean> | Array<number> | Array<Uint8Array>;

package/browser/contracts/CallResult.d.ts

@@ -1,10 +1,13 @@
-import { NetEvent } from '@btc-vision/bsi-binary';
-import { BufferReader } from 'bitcoinjs-lib/src/bufferutils.js';
+import { BinaryReader, NetEvent } from '@btc-vision/bsi-binary';
+import { DecodedCallResult } from '../common/CommonTypes.js';
 import { IAccessList } from './interfaces/IAccessList.js';
 import { ICallResultData } from './interfaces/ICallResult.js';
 export declare class CallResult implements ICallResultData {
-    readonly result: BufferReader;
+    readonly result: BinaryReader;
     readonly events: NetEvent[];
     readonly accessList: IAccessList;
+    readonly decoded: Array<DecodedCallResult>;
     constructor(iCallResult: ICallResultData);
+    setDecoded(decoded: Array<DecodedCallResult>): void;
+    private base64ToUint8Array;
 }

package/browser/contracts/Contract.d.ts

@@ -0,0 +1,28 @@
+import { BaseContractProperty } from '../abi/BaseContractProperty.js';
+import { BitcoinInterface } from '../abi/BitcoinInterface.js';
+import { BaseContractProperties } from '../abi/interfaces/BaseContractProperties.js';
+import { BitcoinInterfaceAbi } from '../abi/interfaces/BitcoinInterfaceAbi.js';
+import { BitcoinAddressLike } from '../common/CommonTypes.js';
+import { AbstractRpcProvider } from '../providers/AbstractRpcProvider.js';
+import { IContract } from './interfaces/IContract.js';
+declare const internal: unique symbol;
+export declare abstract class IBaseContract<T extends BaseContractProperties> implements IContract {
+    readonly address: BitcoinAddressLike;
+    readonly interface: BitcoinInterface;
+    readonly provider: AbstractRpcProvider;
+    readonly [internal]: keyof T | undefined;
+    private events;
+    protected constructor(address: BitcoinAddressLike, abi: BitcoinInterface | BitcoinInterfaceAbi, provider: AbstractRpcProvider);
+    protected getFunction(name: symbol): BaseContractProperty | undefined | string | number | symbol;
+    private defineInternalFunctions;
+    private encodeFunctionData;
+    private encodeInput;
+    private decodeOutput;
+    private callFunction;
+}
+export declare class BaseContract<T extends BaseContractProperties> extends IBaseContract<T> {
+    constructor(address: BitcoinAddressLike, abi: BitcoinInterface | BitcoinInterfaceAbi, provider: AbstractRpcProvider);
+    private proxify;
+}
+export declare function getContract<T extends BaseContractProperties>(address: BitcoinAddressLike, abi: BitcoinInterface | BitcoinInterfaceAbi, provider: AbstractRpcProvider): BaseContract<T> & Omit<T, keyof BaseContract<T>>;
+export {};

package/browser/contracts/interfaces/ICallResult.d.ts

@@ -1,11 +1,10 @@
-import { NetEvent } from '@btc-vision/bsi-binary';
-import { BufferReader } from 'bitcoinjs-lib/src/bufferutils.js';
+import { BinaryReader, NetEvent } from '@btc-vision/bsi-binary';
 import { IAccessList } from './IAccessList.js';
 export interface ICallRequestError {
     readonly error: string;
 }
 export interface ICallResultData {
-    readonly result: string | BufferReader;
+    readonly result: string | BinaryReader;
     readonly events: NetEvent[];
     readonly accessList: IAccessList;
 }

package/browser/contracts/interfaces/IContract.d.ts

@@ -0,0 +1,4 @@
+import { BitcoinAddressLike } from '../../common/CommonTypes.js';
+export interface IContract {
+    readonly address: BitcoinAddressLike;
+}

package/browser/crypto/crypto-browser.d.ts

@@ -31,3 +31,10 @@ export function createHash(algo: any): import("@noble/hashes/utils").Hash<{
 export function createHmac(_algo: any, key: any): import("@noble/hashes/hmac").HMAC<any>;
 export function pbkdf2Sync(password: any, salt: any, iterations: any, keylen: any, _algo: any): Uint8Array;
 export function randomBytes(length: any): Uint8Array;
+declare namespace _default {
+    export { createHash };
+    export { createHmac };
+    export { pbkdf2Sync };
+    export { randomBytes };
+}
+export default _default;