opnet 1.0.20 → 1.0.22

package/README.md

@@ -1,4 +1,4 @@
-# OPNet - Smart Contracts on Bitcoin L1
+# OP_NET - Smart Contracts on Bitcoin L1
 
 ![Bitcoin](https://img.shields.io/badge/Bitcoin-000?style=for-the-badge&logo=bitcoin&logoColor=white)
 ![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)
@@ -55,7 +55,7 @@ the `docs/` directory of the repository.
 
 Contributions are welcome! Please read through the `CONTRIBUTING.md` file for
 guidelines on how to submit issues, feature requests, and pull requests. We
-appreciate your input and encourage you to help us improve OPNet.
+appreciate your input and encourage you to help us improve OP_NET.
 
 ## License
 

package/browser/_version.d.ts

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

package/browser/abi/BitcoinInterface.d.ts

@@ -4,6 +4,7 @@ export declare class BitcoinInterface {
     constructor(abi: BitcoinInterfaceAbi);
     static from(abi: BitcoinInterface | BitcoinInterfaceAbi): BitcoinInterface;
     hasFunction(name: string): boolean;
+    hasEvent(name: string): boolean;
     private verifyAbi;
     private verifyAbiValues;
 }

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

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

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

@@ -1,11 +1,16 @@
 import { BitcoinAbiTypes } from '../BitcoinAbiTypes.js';
 import { BitcoinAbiValue } from './BitcoinAbiValue.js';
-export interface BitcoinInterfaceAbiBase {
-    readonly constant?: boolean;
+export interface BitcoinInterfaceAbiBase<T extends BitcoinAbiTypes> {
     readonly name: string;
+    readonly type: T;
+}
+export interface FunctionBaseData extends BitcoinInterfaceAbiBase<BitcoinAbiTypes.Function> {
+    readonly constant?: boolean;
+    readonly payable?: boolean;
     readonly inputs?: BitcoinAbiValue[];
     readonly outputs?: BitcoinAbiValue[];
-    readonly type: BitcoinAbiTypes;
-    readonly payable?: boolean;
 }
-export type BitcoinInterfaceAbi = BitcoinInterfaceAbiBase[];
+export interface EventBaseData extends BitcoinInterfaceAbiBase<BitcoinAbiTypes.Event> {
+    readonly values: BitcoinAbiValue[];
+}
+export type BitcoinInterfaceAbi = (FunctionBaseData | EventBaseData)[];

package/browser/block/interfaces/BlockWitness.d.ts

@@ -0,0 +1,11 @@
+export interface IBlockWitnessAPI {
+    readonly trusted: boolean;
+    readonly signature: string;
+    readonly identity?: string;
+    readonly opnetPubKey?: string;
+}
+export interface IBlockWitness {
+    blockNumber: bigint | string;
+    readonly witnesses: IBlockWitnessAPI[];
+}
+export type BlockWitnesses = IBlockWitness[];

package/browser/contracts/CallResult.d.ts

@@ -1,13 +1,15 @@
 import { BinaryReader, NetEvent } from '@btc-vision/bsi-binary';
 import { DecodedCallResult } from '../common/CommonTypes.js';
+import { ContractDecodedObjectResult, DecodedOutput } from './Contract.js';
 import { IAccessList } from './interfaces/IAccessList.js';
 import { ICallResultData } from './interfaces/ICallResult.js';
-export declare class CallResult implements ICallResultData {
+export declare class CallResult<T extends ContractDecodedObjectResult = {}> implements ICallResultData {
     readonly result: BinaryReader;
     readonly events: NetEvent[];
     readonly accessList: IAccessList;
     readonly decoded: Array<DecodedCallResult>;
+    properties: T;
     constructor(iCallResult: ICallResultData);
-    setDecoded(decoded: Array<DecodedCallResult>): void;
+    setDecoded(decoded: DecodedOutput): void;
     private base64ToUint8Array;
 }

package/browser/contracts/Contract.d.ts

@@ -1,11 +1,21 @@
+import { NetEvent } from '@btc-vision/bsi-binary';
 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 { BitcoinAddressLike, DecodedCallResult } from '../common/CommonTypes.js';
 import { AbstractRpcProvider } from '../providers/AbstractRpcProvider.js';
+import { ContractEvents } from '../transactions/interfaces/ITransactionReceipt.js';
 import { IContract } from './interfaces/IContract.js';
+import { OPNetEvent } from './OPNetEvent.js';
 declare const internal: unique symbol;
+export type ContractDecodedObjectResult = {
+    [key: string]: DecodedCallResult;
+};
+export type DecodedOutput = {
+    values: Array<DecodedCallResult>;
+    obj: ContractDecodedObjectResult;
+};
 export declare abstract class IBaseContract<T extends BaseContractProperties> implements IContract {
     readonly address: BitcoinAddressLike;
     readonly interface: BitcoinInterface;
@@ -13,6 +23,8 @@ export declare abstract class IBaseContract<T extends BaseContractProperties> im
     readonly [internal]: keyof T | undefined;
     private events;
     protected constructor(address: BitcoinAddressLike, abi: BitcoinInterface | BitcoinInterfaceAbi, provider: AbstractRpcProvider);
+    decodeEvents(events: NetEvent[] | ContractEvents): OPNetEvent[];
+    decodeEvent(event: NetEvent): OPNetEvent;
     protected getFunction(name: symbol): BaseContractProperty | undefined | string | number | symbol;
     private defineInternalFunctions;
     private encodeFunctionData;

package/browser/contracts/ContractData.d.ts

@@ -1,8 +1,10 @@
 /// <reference types="node" />
+import { Address } from '@btc-vision/bsi-binary';
 import { IRawContract } from './interfaces/IRawContract.js';
 export declare class ContractData implements IRawContract {
-    readonly contractAddress: string;
-    readonly virtualAddress: string;
+    readonly contractAddress: Address;
+    readonly virtualAddress: Address;
+    readonly p2trAddress: Address;
     readonly bytecode: Buffer;
     readonly wasCompressed: boolean;
     readonly deployedTransactionId: string;
@@ -10,6 +12,6 @@ export declare class ContractData implements IRawContract {
     readonly deployerPubKey: Buffer;
     readonly contractSeed: Buffer;
     readonly contractSaltHash: Buffer;
-    readonly deployerAddress: string;
+    readonly deployerAddress: Address;
     constructor(raw: IRawContract);
 }

package/browser/contracts/OPNetEvent.d.ts

@@ -0,0 +1,15 @@
+import { NetEvent } from '@btc-vision/bsi-binary';
+import { DecodedCallResult } from '../common/CommonTypes.js';
+import { ContractDecodedObjectResult, DecodedOutput } from './Contract.js';
+export interface IDecodedEvent extends NetEvent {
+    readonly values: Array<DecodedCallResult>;
+}
+export declare class OPNetEvent<T extends ContractDecodedObjectResult = {}> extends NetEvent implements IDecodedEvent {
+    readonly eventType: string;
+    readonly eventDataSelector: bigint;
+    readonly eventData: Uint8Array;
+    properties: T;
+    values: Array<DecodedCallResult>;
+    constructor(eventType: string, eventDataSelector: bigint, eventData: Uint8Array);
+    setDecoded(decoded: DecodedOutput): void;
+}

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

@@ -1,4 +1,9 @@
+import { NetEvent } from '@btc-vision/bsi-binary';
 import { BitcoinAddressLike } from '../../common/CommonTypes.js';
+import { ContractEvents } from '../../transactions/interfaces/ITransactionReceipt.js';
+import { OPNetEvent } from '../OPNetEvent.js';
 export interface IContract {
     readonly address: BitcoinAddressLike;
+    decodeEvents(events: NetEvent[] | ContractEvents): OPNetEvent[];
+    decodeEvent(event: NetEvent): OPNetEvent;
 }

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

@@ -1,7 +1,9 @@
 /// <reference types="node" />
+import { Address } from '@btc-vision/bsi-binary';
 export interface IRawContract {
-    readonly contractAddress: string;
-    readonly virtualAddress: string;
+    readonly contractAddress: Address;
+    readonly virtualAddress: Address;
+    readonly p2trAddress: Address;
     readonly bytecode: Buffer | string;
     readonly wasCompressed: boolean;
     readonly deployedTransactionId: string;
@@ -9,5 +11,5 @@ export interface IRawContract {
     readonly deployerPubKey: Buffer | string;
     readonly contractSeed: Buffer | string;
     readonly contractSaltHash: Buffer | string;
-    readonly deployerAddress: string;
+    readonly deployerAddress: Address;
 }

package/browser/generator/WrappedGenerationParameters.d.ts

@@ -0,0 +1,9 @@
+import { GenerationConstraints, WrappedGenerationParameters } from '../providers/interfaces/Generate.js';
+export declare class WrappedGeneration implements WrappedGenerationParameters {
+    readonly constraints: GenerationConstraints;
+    readonly entities: string[];
+    readonly keys: string[];
+    readonly signature: string;
+    readonly vault: string;
+    constructor(params: WrappedGenerationParameters);
+}