@layerzerolabs/lz-core 3.0.14 → 3.0.16

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @layerzerolabs/lz-core
 
+## 3.0.16
+
+### Patch Changes
+
+- 87a4bc9: islander mainnet
+
+## 3.0.15
+
+### Patch Changes
+
+- 67856bd: endpoints
+- Updated dependencies [67856bd]
+  - @layerzerolabs/lz-foundation@3.0.15
+
 ## 3.0.14
 
 ### Patch Changes

package/README.md

@@ -1,8 +1,164 @@
-# layerzero-core
+# @layerzerolabs/lz-core
 
 This package defines the core interface for the tooling stack, containing only neutral interfaces that are unrelated to the LayerZero protocol.
 
+## Features
+
 - `Transaction` Interface: Used for expressing transactions in different stages.
 - `Provider` Interface: Defines the connectors to a chain node.
 - `Signer` Interface: Handles message and transaction signing.
 - The `signHash` function is implemented in this package instead of `lz-utilities` or `lz-foundation` to minimize dependencies.
+
+## Installation
+
+To install the LayerZero Core package, you can use npm or yarn:
+
+```sh
+npm install @layerzerolabs/lz-core
+```
+
+or
+
+```sh
+yarn add @layerzerolabs/lz-core
+```
+
+## Usage
+
+### Transaction Interfaces
+
+#### TransactionRequest
+
+Represents the request of a transaction.
+
+```typescript
+import { TransactionRequest } from "@layerzerolabs/lz-core";
+
+const request = TransactionRequest.from({
+    to: "0xRecipientAddress",
+    value: "1000000000000000000", // 1 ETH
+});
+console.log(`Transaction Request: ${JSON.stringify(request)}`);
+```
+
+#### TransactionResponse
+
+Represents the response of a transaction.
+
+```typescript
+import { TransactionResponse } from "@layerzerolabs/lz-core";
+
+const response = TransactionResponse.from({
+    hash: "0xTransactionHash",
+    status: 1,
+});
+console.log(`Transaction Response: ${JSON.stringify(response)}`);
+```
+
+### Provider Interface
+
+Defines the connectors to a chain node.
+
+```typescript
+import { Provider } from "@layerzerolabs/lz-core";
+
+class MyProvider implements Provider {
+    url = "https://mainnet.infura.io/v3/YOUR_INFURA_PROJECT_ID";
+
+    async getBlock(blockTag) {
+        // Implementation to get block
+    }
+
+    async getBlockWithTransactions(blockTag) {
+        // Implementation to get block with transactions
+    }
+
+    async getTransaction(txHash) {
+        // Implementation to get transaction
+    }
+
+    async getTransactionReceipt(txHash) {
+        // Implementation to get transaction receipt
+    }
+
+    async getBlockNumber() {
+        // Implementation to get block number
+    }
+
+    async getSlot(commitment) {
+        // Implementation to get slot
+    }
+
+    async getTransactionCount(addressOrName, blockTag) {
+        // Implementation to get transaction count
+    }
+
+    async getBalance(address) {
+        // Implementation to get balance
+    }
+
+    async getBlockTimestamp(blockTag) {
+        // Implementation to get block timestamp
+    }
+
+    async sendTransaction(transaction, sendOptions) {
+        // Implementation to send transaction
+    }
+
+    async confirmTransaction(pending, opts) {
+        // Implementation to confirm transaction
+    }
+
+    async sendAndConfirm(transaction, opts) {
+        // Implementation to send and confirm transaction
+    }
+
+    readonly native = {}; // Native provider instance
+}
+
+const provider = new MyProvider();
+console.log(`Provider URL: ${provider.url}`);
+```
+
+### Signer Interface
+
+Handles message and transaction signing.
+
+```typescript
+import { Signer, TransactionRequest, SignedTransaction, TransactionPending, TransactionReceipt } from "@layerzerolabs/lz-core";
+
+class MySigner implements Signer {
+    async connect(provider) {
+        // Implementation to connect to provider
+    }
+
+    async buildTransaction(buildTxRequest) {
+        // Implementation to build transaction
+    }
+
+    async signTransaction(transaction) {
+        // Implementation to sign transaction
+    }
+
+    async sendTransaction(transaction, sendOptions) {
+        // Implementation to send transaction
+    }
+
+    async sendAndConfirm(transaction, opts) {
+        // Implementation to send and confirm transaction
+    }
+
+    async signBuffer(buffer) {
+        // Implementation to sign buffer
+    }
+
+    async getAddress() {
+        // Implementation to get address
+    }
+
+    native = {}; // Native signer instance
+}
+
+const signer = new MySigner();
+console.log(`Signer Address: ${await signer.getAddress()}`);
+```

package/dist/index.cjs

@@ -6,6 +6,12 @@ var Block = class _Block {
     this.block = block;
     this.type = "Block";
   }
+  /**
+   * Creates an instance of Block from a non-promise value.
+   *
+   * @param {NonPromise<T>} raw - The raw value to create the Block from.
+   * @returns {Block} The created Block instance.
+   */
   static from(raw) {
     return new _Block(raw);
   }
@@ -15,6 +21,12 @@ var BlockWithTransactions = class _BlockWithTransactions {
     this.block = block;
     this.type = "BlockWithTransactions";
   }
+  /**
+   * Creates an instance of BlockWithTransactions from a non-promise value.
+   *
+   * @param {NonPromise<T>} raw - The raw value to create the BlockWithTransactions from.
+   * @returns {BlockWithTransactions} The created BlockWithTransactions instance.
+   */
   static from(raw) {
     return new _BlockWithTransactions(raw);
   }
@@ -24,6 +36,12 @@ var TransactionRequest = class _TransactionRequest {
     this.request = request;
     this.type = "TransactionRequest";
   }
+  /**
+   * Creates an instance of TransactionRequest from a non-promise value.
+   *
+   * @param {Exclude<NonPromise<T>, TransactionTypes>} raw - The raw value to create the TransactionRequest from.
+   * @returns {TransactionRequest} The created TransactionRequest instance.
+   */
   static from(raw) {
     return new _TransactionRequest(raw);
   }
@@ -33,6 +51,12 @@ var TransactionResponse = class _TransactionResponse {
     this.response = response;
     this.type = "TransactionResponse";
   }
+  /**
+   * Creates an instance of TransactionResponse from a non-promise value.
+   *
+   * @param {Exclude<NonPromise<T>, TransactionTypes>} raw - The raw value to create the TransactionResponse from.
+   * @returns {TransactionResponse} The created TransactionResponse instance.
+   */
   static from(raw) {
     return new _TransactionResponse(raw);
   }
@@ -42,6 +66,12 @@ var TransactionReceipt = class _TransactionReceipt {
     this.receipt = receipt;
     this.type = "TransactionReceipt";
   }
+  /**
+   * Creates an instance of TransactionReceipt from a non-promise value.
+   *
+   * @param {Exclude<NonPromise<T>, TransactionTypes>} raw - The raw value to create the TransactionReceipt from.
+   * @returns {TransactionReceipt} The created TransactionReceipt instance.
+   */
   static from(raw) {
     return new _TransactionReceipt(raw);
   }
@@ -51,6 +81,12 @@ var SignedTransaction = class _SignedTransaction {
     this.signed = signed;
     this.type = "SignedTransaction";
   }
+  /**
+   * Creates an instance of SignedTransaction from a non-promise value.
+   *
+   * @param {Exclude<NonPromise<T>, TransactionTypes>} raw - The raw value to create the SignedTransaction from.
+   * @returns {SignedTransaction} The created SignedTransaction instance.
+   */
   static from(raw) {
     return new _SignedTransaction(raw);
   }
@@ -60,6 +96,12 @@ var TransactionPending = class _TransactionPending {
     this.pending = pending;
     this.type = "TransactionPending";
   }
+  /**
+   * Creates an instance of TransactionPending from a non-promise value.
+   *
+   * @param {Exclude<NonPromise<T>, TransactionTypes>} raw - The raw value to create the TransactionPending from.
+   * @returns {TransactionPending} The created TransactionPending instance.
+   */
   static from(raw) {
     return new _TransactionPending(raw);
   }

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/transaction.ts","../src/signer.ts"],"names":[],"mappings":";AAmBO,IAAM,QAAN,MAAM,OAAM;AAAA,EAEP,YAAmB,OAAgB;AAAhB;AAD3B,SAAS,OAAO;AAAA,EAC4B;AAAA,EAC5C,OAAO,KAAQ,KAA2B;AACtC,WAAO,IAAI,OAAM,GAAG;AAAA,EACxB;AACJ;AAKO,IAAM,wBAAN,MAAM,uBAAsB;AAAA,EAEvB,YAAmB,OAAgB;AAAhB;AAD3B,SAAS,OAAO;AAAA,EAC4B;AAAA,EAC5C,OAAO,KAAQ,KAA2C;AACtD,WAAO,IAAI,uBAAsB,GAAG;AAAA,EACxC;AACJ;AAyBO,IAAM,qBAAN,MAAM,oBAAmB;AAAA,EAEpB,YAAmB,SAAkB;AAAlB;AAD3B,SAAS,OAAO;AAAA,EAC8B;AAAA,EAC9C,OAAO,KAAQ,KAAmE;AAC9E,WAAO,IAAI,oBAAmB,GAAG;AAAA,EACrC;AACJ;AAKO,IAAM,sBAAN,MAAM,qBAAoB;AAAA,EAErB,YAAmB,UAAmB;AAAnB;AAD3B,SAAS,OAAO;AAAA,EAC+B;AAAA,EAC/C,OAAO,KAAQ,KAAoE;AAC/E,WAAO,IAAI,qBAAoB,GAAG;AAAA,EACtC;AACJ;AAKO,IAAM,qBAAN,MAAM,oBAAmB;AAAA,EAEpB,YAAmB,SAAkB;AAAlB;AAD3B,SAAS,OAAO;AAAA,EAC8B;AAAA,EAC9C,OAAO,KAAQ,KAAmE;AAC9E,WAAO,IAAI,oBAAmB,GAAG;AAAA,EACrC;AACJ;AAKO,IAAM,oBAAN,MAAM,mBAAkB;AAAA,EAEnB,YAAmB,QAAiB;AAAjB;AAD3B,SAAS,OAAO;AAAA,EAC6B;AAAA,EAC7C,OAAO,KAAQ,KAAkE;AAC7E,WAAO,IAAI,mBAAkB,GAAG;AAAA,EACpC;AACJ;AAKO,IAAM,qBAAN,MAAM,oBAAmB;AAAA,EAEpB,YAAmB,SAAkB;AAAlB;AAD3B,SAAS,OAAO;AAAA,EAC8B;AAAA,EAC9C,OAAO,KAAQ,KAAmE;AAC9E,WAAO,IAAI,oBAAmB,GAAG;AAAA,EACrC;AACJ;;;ACtDO,SAAS,cAAiB,KAAqC;AAClE,MAAI,OAAO,QAAQ,YAAY,QAAQ;AAAM,WAAO;AACpD,QAAM,KAAM,IAA8B;AAC1C,SAAO,OAAO,OAAO,cAAc,OAAO,GAAG,WAAW,YAAY,GAAG,WAAW;AACtF","sourcesContent":["import { NonPromise } from './promise'\n\n/**\n * By declare a unique field `type` in each class, it ensure that the instance of one class can not\n *  be assigned to a variable of another class. Furthermore, it also help to distinguish the type of\n * the instance at runtime.\n * By private the constructor, it ensure that the instance of the class can only be created by the\n * static method `from`, and which can enforce the type of the input parameter should not be a promise.\n * Finally, it will be helpful for the compiler to infer the type of the instance and avoid the mistake.\n */\n\n/**\n * TransactionHash represents a transaction hash.\n */\nexport type TransactionHash = string | number\n\n/**\n * Block represents a block.\n */\nexport class Block {\n    readonly type = 'Block'\n    private constructor(public block: unknown) {}\n    static from<T>(raw: NonPromise<T>): Block {\n        return new Block(raw)\n    }\n}\n\n/**\n * BlockWithTransactions represents a block with transactions.\n */\nexport class BlockWithTransactions {\n    readonly type = 'BlockWithTransactions'\n    private constructor(public block: unknown) {}\n    static from<T>(raw: NonPromise<T>): BlockWithTransactions {\n        return new BlockWithTransactions(raw)\n    }\n}\n\n/**\n * BlockTag represents a block tag.\n */\nexport type BlockTag = string | number\n\n/**\n * Finality represents the finality of a block.\n */\nexport type Finality = 'confirmed' | 'finalized'\n\n/**\n * A union type to represent all the possible types of a transaction.\n */\ntype TransactionTypes =\n    | TransactionRequest\n    | TransactionResponse\n    | TransactionReceipt\n    | SignedTransaction\n    | TransactionPending\n\n/**\n * TransactionRequest represents the request of a transaction.\n */\nexport class TransactionRequest {\n    readonly type = 'TransactionRequest'\n    private constructor(public request: unknown) {}\n    static from<T>(raw: Exclude<NonPromise<T>, TransactionTypes>): TransactionRequest {\n        return new TransactionRequest(raw)\n    }\n}\n\n/**\n * TransactionResponse represents the response of a transaction.\n */\nexport class TransactionResponse {\n    readonly type = 'TransactionResponse'\n    private constructor(public response: unknown) {}\n    static from<T>(raw: Exclude<NonPromise<T>, TransactionTypes>): TransactionResponse {\n        return new TransactionResponse(raw)\n    }\n}\n\n/**\n * TransactionReceipt represents the receipt of a transaction.\n */\nexport class TransactionReceipt {\n    readonly type = 'TransactionReceipt'\n    private constructor(public receipt: unknown) {}\n    static from<T>(raw: Exclude<NonPromise<T>, TransactionTypes>): TransactionReceipt {\n        return new TransactionReceipt(raw)\n    }\n}\n\n/**\n * SignedTransaction represents a signed transaction.\n */\nexport class SignedTransaction {\n    readonly type = 'SignedTransaction'\n    private constructor(public signed: unknown) {}\n    static from<T>(raw: Exclude<NonPromise<T>, TransactionTypes>): SignedTransaction {\n        return new SignedTransaction(raw)\n    }\n}\n\n/**\n * TransactionPending represents a pending transaction.\n */\nexport class TransactionPending {\n    readonly type = 'TransactionPending'\n    private constructor(public pending: unknown) {}\n    static from<T>(raw: Exclude<NonPromise<T>, TransactionTypes>): TransactionPending {\n        return new TransactionPending(raw)\n    }\n}\n","import { Provider } from './provider'\nimport { SignedTransaction, TransactionPending, TransactionReceipt, TransactionRequest } from './transaction'\n\nexport interface Signer<T = unknown> {\n    /**\n     * Connect to a provider\n     * @param provider\n     */\n    connect(provider: Provider): Signer<T>\n\n    /**\n     * Sign a transaction\n     * @param buildTxRequest\n     */\n    buildTransaction(buildTxRequest: T): Promise<TransactionRequest>\n\n    /**\n     * Sign a transaction\n     * @param transaction\n     */\n    signTransaction(transaction: TransactionRequest): Promise<SignedTransaction>\n\n    /**\n     * Send a transaction\n     * @param transaction\n     * @param sendOptions\n     */\n    sendTransaction(transaction: SignedTransaction, sendOptions?: unknown): Promise<TransactionPending>\n\n    /**\n     * Send a transaction and wait for confirmation\n     * @param transaction\n     * @param opts\n     */\n    sendAndConfirm(transaction: SignedTransaction, opts?: unknown): Promise<TransactionReceipt>\n\n    /**\n     * Sign a buffer (e.g. a message hash)\n     */\n    signBuffer(buffer: Uint8Array): Promise<Uint8Array>\n\n    /**\n     * returns the address of the signer\n     * this function NEED to return a Promise because ethers.Signer.getAddress() return a Promise<string>\n     */\n    getAddress(): Promise<string>\n\n    /**\n     * Native signer object\n     */\n    native: unknown\n}\n\nexport interface Connectable<T> {\n    connect<U>(provider: U): T\n}\n\nexport function isConnectable<T>(obj: unknown): obj is Connectable<T> {\n    if (typeof obj !== 'object' || obj === null) return false\n    const fn = (obj as { connect?: unknown }).connect\n    return typeof fn === 'function' && typeof fn.length === 'number' && fn.length === 1\n}\n"]}
+{"version":3,"sources":["../src/transaction.ts","../src/signer.ts"],"names":[],"mappings":";AAmBO,IAAM,QAAN,MAAM,OAAM;AAAA,EAEP,YAAmB,OAAgB;AAAhB;AAD3B,SAAS,OAAO;AAAA,EAC4B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ5C,OAAO,KAAQ,KAA2B;AACtC,WAAO,IAAI,OAAM,GAAG;AAAA,EACxB;AACJ;AAKO,IAAM,wBAAN,MAAM,uBAAsB;AAAA,EAEvB,YAAmB,OAAgB;AAAhB;AAD3B,SAAS,OAAO;AAAA,EAC4B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ5C,OAAO,KAAQ,KAA2C;AACtD,WAAO,IAAI,uBAAsB,GAAG;AAAA,EACxC;AACJ;AAyBO,IAAM,qBAAN,MAAM,oBAAmB;AAAA,EAEpB,YAAmB,SAAkB;AAAlB;AAD3B,SAAS,OAAO;AAAA,EAC8B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ9C,OAAO,KAAQ,KAAmE;AAC9E,WAAO,IAAI,oBAAmB,GAAG;AAAA,EACrC;AACJ;AAKO,IAAM,sBAAN,MAAM,qBAAoB;AAAA,EAErB,YAAmB,UAAmB;AAAnB;AAD3B,SAAS,OAAO;AAAA,EAC+B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ/C,OAAO,KAAQ,KAAoE;AAC/E,WAAO,IAAI,qBAAoB,GAAG;AAAA,EACtC;AACJ;AAKO,IAAM,qBAAN,MAAM,oBAAmB;AAAA,EAEpB,YAAmB,SAAkB;AAAlB;AAD3B,SAAS,OAAO;AAAA,EAC8B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ9C,OAAO,KAAQ,KAAmE;AAC9E,WAAO,IAAI,oBAAmB,GAAG;AAAA,EACrC;AACJ;AAKO,IAAM,oBAAN,MAAM,mBAAkB;AAAA,EAEnB,YAAmB,QAAiB;AAAjB;AAD3B,SAAS,OAAO;AAAA,EAC6B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ7C,OAAO,KAAQ,KAAkE;AAC7E,WAAO,IAAI,mBAAkB,GAAG;AAAA,EACpC;AACJ;AAKO,IAAM,qBAAN,MAAM,oBAAmB;AAAA,EAEpB,YAAmB,SAAkB;AAAlB;AAD3B,SAAS,OAAO;AAAA,EAC8B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ9C,OAAO,KAAQ,KAAmE;AAC9E,WAAO,IAAI,oBAAmB,GAAG;AAAA,EACrC;AACJ;;;AChEO,SAAS,cAAiB,KAAqC;AAClE,MAAI,OAAO,QAAQ,YAAY,QAAQ;AAAM,WAAO;AACpD,QAAM,KAAM,IAA8B;AAC1C,SAAO,OAAO,OAAO,cAAc,OAAO,GAAG,WAAW,YAAY,GAAG,WAAW;AACtF","sourcesContent":["import { NonPromise } from './promise'\n\n/**\n * By declare a unique field `type` in each class, it ensure that the instance of one class can not\n *  be assigned to a variable of another class. Furthermore, it also help to distinguish the type of\n * the instance at runtime.\n * By private the constructor, it ensure that the instance of the class can only be created by the\n * static method `from`, and which can enforce the type of the input parameter should not be a promise.\n * Finally, it will be helpful for the compiler to infer the type of the instance and avoid the mistake.\n */\n\n/**\n * TransactionHash represents a transaction hash.\n */\nexport type TransactionHash = string | number\n\n/**\n * Block represents a block.\n */\nexport class Block {\n    readonly type = 'Block'\n    private constructor(public block: unknown) {}\n\n    /**\n     * Creates an instance of Block from a non-promise value.\n     *\n     * @param {NonPromise<T>} raw - The raw value to create the Block from.\n     * @returns {Block} The created Block instance.\n     */\n    static from<T>(raw: NonPromise<T>): Block {\n        return new Block(raw)\n    }\n}\n\n/**\n * BlockWithTransactions represents a block with transactions.\n */\nexport class BlockWithTransactions {\n    readonly type = 'BlockWithTransactions'\n    private constructor(public block: unknown) {}\n\n    /**\n     * Creates an instance of BlockWithTransactions from a non-promise value.\n     *\n     * @param {NonPromise<T>} raw - The raw value to create the BlockWithTransactions from.\n     * @returns {BlockWithTransactions} The created BlockWithTransactions instance.\n     */\n    static from<T>(raw: NonPromise<T>): BlockWithTransactions {\n        return new BlockWithTransactions(raw)\n    }\n}\n\n/**\n * BlockTag represents a block tag.\n */\nexport type BlockTag = string | number\n\n/**\n * Finality represents the finality of a block.\n */\nexport type Finality = 'confirmed' | 'finalized'\n\n/**\n * A union type to represent all the possible types of a transaction.\n */\ntype TransactionTypes =\n    | TransactionRequest\n    | TransactionResponse\n    | TransactionReceipt\n    | SignedTransaction\n    | TransactionPending\n\n/**\n * TransactionRequest represents the request of a transaction.\n */\nexport class TransactionRequest {\n    readonly type = 'TransactionRequest'\n    private constructor(public request: unknown) {}\n\n    /**\n     * Creates an instance of TransactionRequest from a non-promise value.\n     *\n     * @param {Exclude<NonPromise<T>, TransactionTypes>} raw - The raw value to create the TransactionRequest from.\n     * @returns {TransactionRequest} The created TransactionRequest instance.\n     */\n    static from<T>(raw: Exclude<NonPromise<T>, TransactionTypes>): TransactionRequest {\n        return new TransactionRequest(raw)\n    }\n}\n\n/**\n * TransactionResponse represents the response of a transaction.\n */\nexport class TransactionResponse {\n    readonly type = 'TransactionResponse'\n    private constructor(public response: unknown) {}\n\n    /**\n     * Creates an instance of TransactionResponse from a non-promise value.\n     *\n     * @param {Exclude<NonPromise<T>, TransactionTypes>} raw - The raw value to create the TransactionResponse from.\n     * @returns {TransactionResponse} The created TransactionResponse instance.\n     */\n    static from<T>(raw: Exclude<NonPromise<T>, TransactionTypes>): TransactionResponse {\n        return new TransactionResponse(raw)\n    }\n}\n\n/**\n * TransactionReceipt represents the receipt of a transaction.\n */\nexport class TransactionReceipt {\n    readonly type = 'TransactionReceipt'\n    private constructor(public receipt: unknown) {}\n\n    /**\n     * Creates an instance of TransactionReceipt from a non-promise value.\n     *\n     * @param {Exclude<NonPromise<T>, TransactionTypes>} raw - The raw value to create the TransactionReceipt from.\n     * @returns {TransactionReceipt} The created TransactionReceipt instance.\n     */\n    static from<T>(raw: Exclude<NonPromise<T>, TransactionTypes>): TransactionReceipt {\n        return new TransactionReceipt(raw)\n    }\n}\n\n/**\n * SignedTransaction represents a signed transaction.\n */\nexport class SignedTransaction {\n    readonly type = 'SignedTransaction'\n    private constructor(public signed: unknown) {}\n\n    /**\n     * Creates an instance of SignedTransaction from a non-promise value.\n     *\n     * @param {Exclude<NonPromise<T>, TransactionTypes>} raw - The raw value to create the SignedTransaction from.\n     * @returns {SignedTransaction} The created SignedTransaction instance.\n     */\n    static from<T>(raw: Exclude<NonPromise<T>, TransactionTypes>): SignedTransaction {\n        return new SignedTransaction(raw)\n    }\n}\n\n/**\n * TransactionPending represents a pending transaction.\n */\nexport class TransactionPending {\n    readonly type = 'TransactionPending'\n    private constructor(public pending: unknown) {}\n\n    /**\n     * Creates an instance of TransactionPending from a non-promise value.\n     *\n     * @param {Exclude<NonPromise<T>, TransactionTypes>} raw - The raw value to create the TransactionPending from.\n     * @returns {TransactionPending} The created TransactionPending instance.\n     */\n    static from<T>(raw: Exclude<NonPromise<T>, TransactionTypes>): TransactionPending {\n        return new TransactionPending(raw)\n    }\n}\n","import { Provider } from './provider'\nimport { SignedTransaction, TransactionPending, TransactionReceipt, TransactionRequest } from './transaction'\n\n/**\n * Interface representing a signer.\n *\n * @template T - The type of the transaction request.\n */\nexport interface Signer<T = unknown> {\n    /**\n     * Connect to a provider.\n     *\n     * @param {Provider} provider - The provider to connect to.\n     * @returns {Signer<T>} The connected signer.\n     */\n    connect(provider: Provider): Signer<T>\n\n    /**\n     * Build a transaction.\n     *\n     * @param {T} buildTxRequest - The transaction request to build.\n     * @returns {Promise<TransactionRequest>} A promise that resolves to the built transaction request.\n     */\n    buildTransaction(buildTxRequest: T): Promise<TransactionRequest>\n\n    /**\n     * Sign a transaction.\n     *\n     * @param {TransactionRequest} transaction - The transaction request to sign.\n     * @returns {Promise<SignedTransaction>} A promise that resolves to the signed transaction.\n     */\n    signTransaction(transaction: TransactionRequest): Promise<SignedTransaction>\n\n    /**\n     * Send a transaction.\n     *\n     * @param {SignedTransaction} transaction - The signed transaction to send.\n     * @param {unknown} [sendOptions] - Optional parameters for sending the transaction.\n     * @returns {Promise<TransactionPending>} A promise that resolves to the pending transaction.\n     */\n    sendTransaction(transaction: SignedTransaction, sendOptions?: unknown): Promise<TransactionPending>\n\n    /**\n     * Send a transaction and wait for confirmation.\n     *\n     * @param {SignedTransaction} transaction - The signed transaction to send.\n     * @param {unknown} [opts] - Optional parameters for sending and confirming the transaction.\n     * @returns {Promise<TransactionReceipt>} A promise that resolves to the transaction receipt.\n     */\n    sendAndConfirm(transaction: SignedTransaction, opts?: unknown): Promise<TransactionReceipt>\n\n    /**\n     * Sign a buffer (e.g. a message hash).\n     *\n     * @param {Uint8Array} buffer - The buffer to sign.\n     * @returns {Promise<Uint8Array>} A promise that resolves to the signed buffer.\n     */\n    signBuffer(buffer: Uint8Array): Promise<Uint8Array>\n\n    /**\n     * Get the address of the signer.\n     * this function NEED to return a Promise because ethers.Signer.getAddress() return a Promise<string>\n     *\n     * @returns {Promise<string>} A promise that resolves to the address of the signer.\n     */\n    getAddress(): Promise<string>\n\n    /**\n     * Native signer object\n     */\n    native: unknown\n}\n\n/**\n * Interface representing a connectable object.\n *\n * @template T - The type of the connectable object.\n */\nexport interface Connectable<T> {\n    /**\n     * Connect to a provider.\n     *\n     * @template U - The type of the provider.\n     * @param {U} provider - The provider to connect to.\n     * @returns {T} The connected object.\n     */\n    connect<U>(provider: U): T\n}\n\n/**\n * Check if an object is connectable.\n *\n * @template T - The type of the connectable object.\n * @param {unknown} obj - The object to check.\n * @returns {obj is Connectable<T>} True if the object is connectable, false otherwise.\n */\nexport function isConnectable<T>(obj: unknown): obj is Connectable<T> {\n    if (typeof obj !== 'object' || obj === null) return false\n    const fn = (obj as { connect?: unknown }).connect\n    return typeof fn === 'function' && typeof fn.length === 'number' && fn.length === 1\n}\n"]}

package/dist/index.d.mts

@@ -1,3 +1,10 @@
+/**
+ * A utility type that excludes `Promise` types.
+ *
+ * @template T - The type to be checked.
+ * @typeParam T - The type to be checked.
+ * @returns `T` if `T` is not a `Promise`, otherwise `never`.
+ */
 type NonPromise<T> = T extends Promise<unknown> ? never : T;
 
 /**
@@ -19,6 +26,12 @@ declare class Block {
     block: unknown;
     readonly type = "Block";
     private constructor();
+    /**
+     * Creates an instance of Block from a non-promise value.
+     *
+     * @param {NonPromise<T>} raw - The raw value to create the Block from.
+     * @returns {Block} The created Block instance.
+     */
     static from<T>(raw: NonPromise<T>): Block;
 }
 /**
@@ -28,6 +41,12 @@ declare class BlockWithTransactions {
     block: unknown;
     readonly type = "BlockWithTransactions";
     private constructor();
+    /**
+     * Creates an instance of BlockWithTransactions from a non-promise value.
+     *
+     * @param {NonPromise<T>} raw - The raw value to create the BlockWithTransactions from.
+     * @returns {BlockWithTransactions} The created BlockWithTransactions instance.
+     */
     static from<T>(raw: NonPromise<T>): BlockWithTransactions;
 }
 /**
@@ -49,6 +68,12 @@ declare class TransactionRequest {
     request: unknown;
     readonly type = "TransactionRequest";
     private constructor();
+    /**
+     * Creates an instance of TransactionRequest from a non-promise value.
+     *
+     * @param {Exclude<NonPromise<T>, TransactionTypes>} raw - The raw value to create the TransactionRequest from.
+     * @returns {TransactionRequest} The created TransactionRequest instance.
+     */
     static from<T>(raw: Exclude<NonPromise<T>, TransactionTypes>): TransactionRequest;
 }
 /**
@@ -58,6 +83,12 @@ declare class TransactionResponse {
     response: unknown;
     readonly type = "TransactionResponse";
     private constructor();
+    /**
+     * Creates an instance of TransactionResponse from a non-promise value.
+     *
+     * @param {Exclude<NonPromise<T>, TransactionTypes>} raw - The raw value to create the TransactionResponse from.
+     * @returns {TransactionResponse} The created TransactionResponse instance.
+     */
     static from<T>(raw: Exclude<NonPromise<T>, TransactionTypes>): TransactionResponse;
 }
 /**
@@ -67,6 +98,12 @@ declare class TransactionReceipt {
     receipt: unknown;
     readonly type = "TransactionReceipt";
     private constructor();
+    /**
+     * Creates an instance of TransactionReceipt from a non-promise value.
+     *
+     * @param {Exclude<NonPromise<T>, TransactionTypes>} raw - The raw value to create the TransactionReceipt from.
+     * @returns {TransactionReceipt} The created TransactionReceipt instance.
+     */
     static from<T>(raw: Exclude<NonPromise<T>, TransactionTypes>): TransactionReceipt;
 }
 /**
@@ -76,6 +113,12 @@ declare class SignedTransaction {
     signed: unknown;
     readonly type = "SignedTransaction";
     private constructor();
+    /**
+     * Creates an instance of SignedTransaction from a non-promise value.
+     *
+     * @param {Exclude<NonPromise<T>, TransactionTypes>} raw - The raw value to create the SignedTransaction from.
+     * @returns {SignedTransaction} The created SignedTransaction instance.
+     */
     static from<T>(raw: Exclude<NonPromise<T>, TransactionTypes>): SignedTransaction;
 }
 /**
@@ -85,66 +128,85 @@ declare class TransactionPending {
     pending: unknown;
     readonly type = "TransactionPending";
     private constructor();
+    /**
+     * Creates an instance of TransactionPending from a non-promise value.
+     *
+     * @param {Exclude<NonPromise<T>, TransactionTypes>} raw - The raw value to create the TransactionPending from.
+     * @returns {TransactionPending} The created TransactionPending instance.
+     */
     static from<T>(raw: Exclude<NonPromise<T>, TransactionTypes>): TransactionPending;
 }
 
+/**
+ * Interface representing a blockchain provider.
+ */
 interface Provider {
     /**
-     * the url of the provider
-     * @returns string
+     * The URL of the provider.
+     * @returns {string} The URL of the provider.
      */
     url: string;
     /**
-     * Get the block specified by blockTag
-     * @param {BlockTag} [blockTag]
-     * @returns
+     * Get the block specified by blockTag.
+     * @param {BlockTag} blockTag - The block tag to specify the block.
+     * @returns {Promise<Block>} A promise that resolves to the block.
      */
     getBlock(blockTag: BlockTag): Promise<Block>;
+    /**
+     * Get the block with transactions specified by blockTag.
+     * @param {BlockTag} blockTag - The block tag to specify the block.
+     * @returns {Promise<BlockWithTransactions>} A promise that resolves to the block with transactions.
+     */
     getBlockWithTransactions(blockTag: BlockTag): Promise<BlockWithTransactions>;
     /**
-     * Get information about a transaction
-     * @param {string} txHash
-     * @returns
+     * Get information about a transaction.
+     * @param {string} txHash - The hash of the transaction.
+     * @returns {Promise<TransactionResponse>} A promise that resolves to the transaction response.
      */
     getTransaction(txHash: string): Promise<TransactionResponse>;
     /**
-     * Get the receipt of a transaction
-     * @param txHash
+     * Get the receipt of a transaction.
+     * @param {string} txHash - The hash of the transaction.
+     * @returns {Promise<TransactionReceipt>} A promise that resolves to the transaction receipt.
      */
     getTransactionReceipt(txHash: string): Promise<TransactionReceipt>;
     /**
-     * Get the current block number
-     * @returns Promise<number> the current block number
+     * Get the current block number.
+     * @returns {Promise<number>} A promise that resolves to the current block number.
      */
     getBlockNumber(): Promise<number>;
     /**
-     * Get the current slot number for commitment
-     * @param commitment
+     * Get the current slot number for commitment.
+     * @param {Finality} [commitment] - The commitment level.
+     * @returns {Promise<number>} A promise that resolves to the current slot number.
      */
     getSlot(commitment?: Finality): Promise<number>;
     /**
-     * Get the number of transactions sent from this address
-     * @param {string|Promise<string>} addressOrName The address to get the numbers of transactions from
-     * @param {BlockTag|Promise<BlockTag>} [blockTag] The block tag to get the numbers of transactions from
-     * @returns Promise<number> The number of transactions sent from this address
+     * Get the number of transactions sent from this address.
+     * @param {string | Promise<string>} addressOrName - The address to get the number of transactions from.
+     * @param {BlockTag | Promise<BlockTag>} [blockTag] - The block tag to get the number of transactions from.
+     * @returns {Promise<number>} A promise that resolves to the number of transactions sent from this address.
      */
     getTransactionCount(addressOrName: string | Promise<string>, blockTag?: BlockTag | Promise<BlockTag>): Promise<number>;
     /**
-     * Get the balance of an address
-     * @param address
+     * Get the balance of an address.
+     * @param {string} address - The address to get the balance of.
+     * @returns {Promise<string>} A promise that resolves to the balance of the address.
      */
     getBalance(address: string): Promise<string>;
     /**
-     * Gets the UNIX timestamp for the block identified by blockTag.  The UNIX timestamp is defined as the count of
-     * seconds since the Unix Epoch on January 1st, 1970 at UTC.  If blockTag is not provided, the latest block is used.
-     * @param {string?} blockTag
-     * @returns Promise<number> the UNIX timestamp of the block identified by blockTag
+     * Gets the UNIX timestamp for the block identified by blockTag.
+     * The UNIX timestamp is defined as the count of seconds since the Unix Epoch on January 1st, 1970 at UTC.
+     * If blockTag is not provided, the latest block is used.
+     * @param {BlockTag} blockTag - The block tag to specify the block.
+     * @returns {Promise<number>} A promise that resolves to the UNIX timestamp of the block identified by blockTag.
      */
     getBlockTimestamp(blockTag: BlockTag): Promise<number>;
     /**
-     * sendTransaction sends a signed transaction in bytes to the blockchain.
-     * @param transaction
-     * @param sendOptions
+     * Send a signed transaction in bytes to the blockchain.
+     * @param {SignedTransaction} transaction - The signed transaction to send.
+     * @param {unknown} [sendOptions] - Optional parameters for sending the transaction.
+     * @returns {Promise<TransactionPending>} A promise that resolves to the pending transaction.
      */
     sendTransaction(transaction: SignedTransaction, sendOptions?: unknown): Promise<TransactionPending>;
     /**
@@ -155,49 +217,73 @@ interface Provider {
      */
     confirmTransaction(pending: TransactionPending, opts?: unknown): Promise<TransactionReceipt>;
     /**
-     * Send a transaction and wait for confirmation
-     * @param transaction
-     * @param opts
+     * Send a transaction and wait for confirmation.
+     * @param {SignedTransaction} transaction - The signed transaction to send.
+     * @param {unknown} [opts] - Optional parameters for sending and confirming the transaction.
+     * @returns {Promise<TransactionReceipt>} A promise that resolves to the transaction receipt.
      */
     sendAndConfirm(transaction: SignedTransaction, opts?: unknown): Promise<TransactionReceipt>;
+    /**
+     * The native provider instance.
+     */
     readonly native: unknown;
 }
 
+/**
+ * Interface representing a signer.
+ *
+ * @template T - The type of the transaction request.
+ */
 interface Signer<T = unknown> {
     /**
-     * Connect to a provider
-     * @param provider
+     * Connect to a provider.
+     *
+     * @param {Provider} provider - The provider to connect to.
+     * @returns {Signer<T>} The connected signer.
      */
     connect(provider: Provider): Signer<T>;
     /**
-     * Sign a transaction
-     * @param buildTxRequest
+     * Build a transaction.
+     *
+     * @param {T} buildTxRequest - The transaction request to build.
+     * @returns {Promise<TransactionRequest>} A promise that resolves to the built transaction request.
      */
     buildTransaction(buildTxRequest: T): Promise<TransactionRequest>;
     /**
-     * Sign a transaction
-     * @param transaction
+     * Sign a transaction.
+     *
+     * @param {TransactionRequest} transaction - The transaction request to sign.
+     * @returns {Promise<SignedTransaction>} A promise that resolves to the signed transaction.
      */
     signTransaction(transaction: TransactionRequest): Promise<SignedTransaction>;
     /**
-     * Send a transaction
-     * @param transaction
-     * @param sendOptions
+     * Send a transaction.
+     *
+     * @param {SignedTransaction} transaction - The signed transaction to send.
+     * @param {unknown} [sendOptions] - Optional parameters for sending the transaction.
+     * @returns {Promise<TransactionPending>} A promise that resolves to the pending transaction.
      */
     sendTransaction(transaction: SignedTransaction, sendOptions?: unknown): Promise<TransactionPending>;
     /**
-     * Send a transaction and wait for confirmation
-     * @param transaction
-     * @param opts
+     * Send a transaction and wait for confirmation.
+     *
+     * @param {SignedTransaction} transaction - The signed transaction to send.
+     * @param {unknown} [opts] - Optional parameters for sending and confirming the transaction.
+     * @returns {Promise<TransactionReceipt>} A promise that resolves to the transaction receipt.
      */
     sendAndConfirm(transaction: SignedTransaction, opts?: unknown): Promise<TransactionReceipt>;
     /**
-     * Sign a buffer (e.g. a message hash)
+     * Sign a buffer (e.g. a message hash).
+     *
+     * @param {Uint8Array} buffer - The buffer to sign.
+     * @returns {Promise<Uint8Array>} A promise that resolves to the signed buffer.
      */
     signBuffer(buffer: Uint8Array): Promise<Uint8Array>;
     /**
-     * returns the address of the signer
+     * Get the address of the signer.
      * this function NEED to return a Promise because ethers.Signer.getAddress() return a Promise<string>
+     *
+     * @returns {Promise<string>} A promise that resolves to the address of the signer.
      */
     getAddress(): Promise<string>;
     /**
@@ -205,9 +291,28 @@ interface Signer<T = unknown> {
      */
     native: unknown;
 }
+/**
+ * Interface representing a connectable object.
+ *
+ * @template T - The type of the connectable object.
+ */
 interface Connectable<T> {
+    /**
+     * Connect to a provider.
+     *
+     * @template U - The type of the provider.
+     * @param {U} provider - The provider to connect to.
+     * @returns {T} The connected object.
+     */
     connect<U>(provider: U): T;
 }
+/**
+ * Check if an object is connectable.
+ *
+ * @template T - The type of the connectable object.
+ * @param {unknown} obj - The object to check.
+ * @returns {obj is Connectable<T>} True if the object is connectable, false otherwise.
+ */
 declare function isConnectable<T>(obj: unknown): obj is Connectable<T>;
 
 export { Block, type BlockTag, BlockWithTransactions, type Connectable, type Finality, type Provider, SignedTransaction, type Signer, type TransactionHash, TransactionPending, TransactionReceipt, TransactionRequest, TransactionResponse, isConnectable };

package/dist/index.d.ts

@@ -1,3 +1,10 @@
+/**
+ * A utility type that excludes `Promise` types.
+ *
+ * @template T - The type to be checked.
+ * @typeParam T - The type to be checked.
+ * @returns `T` if `T` is not a `Promise`, otherwise `never`.
+ */
 type NonPromise<T> = T extends Promise<unknown> ? never : T;
 
 /**
@@ -19,6 +26,12 @@ declare class Block {
     block: unknown;
     readonly type = "Block";
     private constructor();
+    /**
+     * Creates an instance of Block from a non-promise value.
+     *
+     * @param {NonPromise<T>} raw - The raw value to create the Block from.
+     * @returns {Block} The created Block instance.
+     */
     static from<T>(raw: NonPromise<T>): Block;
 }
 /**
@@ -28,6 +41,12 @@ declare class BlockWithTransactions {
     block: unknown;
     readonly type = "BlockWithTransactions";
     private constructor();
+    /**
+     * Creates an instance of BlockWithTransactions from a non-promise value.
+     *
+     * @param {NonPromise<T>} raw - The raw value to create the BlockWithTransactions from.
+     * @returns {BlockWithTransactions} The created BlockWithTransactions instance.
+     */
     static from<T>(raw: NonPromise<T>): BlockWithTransactions;
 }
 /**
@@ -49,6 +68,12 @@ declare class TransactionRequest {
     request: unknown;
     readonly type = "TransactionRequest";
     private constructor();
+    /**
+     * Creates an instance of TransactionRequest from a non-promise value.
+     *
+     * @param {Exclude<NonPromise<T>, TransactionTypes>} raw - The raw value to create the TransactionRequest from.
+     * @returns {TransactionRequest} The created TransactionRequest instance.
+     */
     static from<T>(raw: Exclude<NonPromise<T>, TransactionTypes>): TransactionRequest;
 }
 /**
@@ -58,6 +83,12 @@ declare class TransactionResponse {
     response: unknown;
     readonly type = "TransactionResponse";
     private constructor();
+    /**
+     * Creates an instance of TransactionResponse from a non-promise value.
+     *
+     * @param {Exclude<NonPromise<T>, TransactionTypes>} raw - The raw value to create the TransactionResponse from.
+     * @returns {TransactionResponse} The created TransactionResponse instance.
+     */
     static from<T>(raw: Exclude<NonPromise<T>, TransactionTypes>): TransactionResponse;
 }
 /**
@@ -67,6 +98,12 @@ declare class TransactionReceipt {
     receipt: unknown;
     readonly type = "TransactionReceipt";
     private constructor();
+    /**
+     * Creates an instance of TransactionReceipt from a non-promise value.
+     *
+     * @param {Exclude<NonPromise<T>, TransactionTypes>} raw - The raw value to create the TransactionReceipt from.
+     * @returns {TransactionReceipt} The created TransactionReceipt instance.
+     */
     static from<T>(raw: Exclude<NonPromise<T>, TransactionTypes>): TransactionReceipt;
 }
 /**
@@ -76,6 +113,12 @@ declare class SignedTransaction {
     signed: unknown;
     readonly type = "SignedTransaction";
     private constructor();
+    /**
+     * Creates an instance of SignedTransaction from a non-promise value.
+     *
+     * @param {Exclude<NonPromise<T>, TransactionTypes>} raw - The raw value to create the SignedTransaction from.
+     * @returns {SignedTransaction} The created SignedTransaction instance.
+     */
     static from<T>(raw: Exclude<NonPromise<T>, TransactionTypes>): SignedTransaction;
 }
 /**
@@ -85,66 +128,85 @@ declare class TransactionPending {
     pending: unknown;
     readonly type = "TransactionPending";
     private constructor();
+    /**
+     * Creates an instance of TransactionPending from a non-promise value.
+     *
+     * @param {Exclude<NonPromise<T>, TransactionTypes>} raw - The raw value to create the TransactionPending from.
+     * @returns {TransactionPending} The created TransactionPending instance.
+     */
     static from<T>(raw: Exclude<NonPromise<T>, TransactionTypes>): TransactionPending;
 }
 
+/**
+ * Interface representing a blockchain provider.
+ */
 interface Provider {
     /**
-     * the url of the provider
-     * @returns string
+     * The URL of the provider.
+     * @returns {string} The URL of the provider.
      */
     url: string;
     /**
-     * Get the block specified by blockTag
-     * @param {BlockTag} [blockTag]
-     * @returns
+     * Get the block specified by blockTag.
+     * @param {BlockTag} blockTag - The block tag to specify the block.
+     * @returns {Promise<Block>} A promise that resolves to the block.
      */
     getBlock(blockTag: BlockTag): Promise<Block>;
+    /**
+     * Get the block with transactions specified by blockTag.
+     * @param {BlockTag} blockTag - The block tag to specify the block.
+     * @returns {Promise<BlockWithTransactions>} A promise that resolves to the block with transactions.
+     */
     getBlockWithTransactions(blockTag: BlockTag): Promise<BlockWithTransactions>;
     /**
-     * Get information about a transaction
-     * @param {string} txHash
-     * @returns
+     * Get information about a transaction.
+     * @param {string} txHash - The hash of the transaction.
+     * @returns {Promise<TransactionResponse>} A promise that resolves to the transaction response.
      */
     getTransaction(txHash: string): Promise<TransactionResponse>;
     /**
-     * Get the receipt of a transaction
-     * @param txHash
+     * Get the receipt of a transaction.
+     * @param {string} txHash - The hash of the transaction.
+     * @returns {Promise<TransactionReceipt>} A promise that resolves to the transaction receipt.
      */
     getTransactionReceipt(txHash: string): Promise<TransactionReceipt>;
     /**
-     * Get the current block number
-     * @returns Promise<number> the current block number
+     * Get the current block number.
+     * @returns {Promise<number>} A promise that resolves to the current block number.
      */
     getBlockNumber(): Promise<number>;
     /**
-     * Get the current slot number for commitment
-     * @param commitment
+     * Get the current slot number for commitment.
+     * @param {Finality} [commitment] - The commitment level.
+     * @returns {Promise<number>} A promise that resolves to the current slot number.
      */
     getSlot(commitment?: Finality): Promise<number>;
     /**
-     * Get the number of transactions sent from this address
-     * @param {string|Promise<string>} addressOrName The address to get the numbers of transactions from
-     * @param {BlockTag|Promise<BlockTag>} [blockTag] The block tag to get the numbers of transactions from
-     * @returns Promise<number> The number of transactions sent from this address
+     * Get the number of transactions sent from this address.
+     * @param {string | Promise<string>} addressOrName - The address to get the number of transactions from.
+     * @param {BlockTag | Promise<BlockTag>} [blockTag] - The block tag to get the number of transactions from.
+     * @returns {Promise<number>} A promise that resolves to the number of transactions sent from this address.
      */
     getTransactionCount(addressOrName: string | Promise<string>, blockTag?: BlockTag | Promise<BlockTag>): Promise<number>;
     /**
-     * Get the balance of an address
-     * @param address
+     * Get the balance of an address.
+     * @param {string} address - The address to get the balance of.
+     * @returns {Promise<string>} A promise that resolves to the balance of the address.
      */
     getBalance(address: string): Promise<string>;
     /**
-     * Gets the UNIX timestamp for the block identified by blockTag.  The UNIX timestamp is defined as the count of
-     * seconds since the Unix Epoch on January 1st, 1970 at UTC.  If blockTag is not provided, the latest block is used.
-     * @param {string?} blockTag
-     * @returns Promise<number> the UNIX timestamp of the block identified by blockTag
+     * Gets the UNIX timestamp for the block identified by blockTag.
+     * The UNIX timestamp is defined as the count of seconds since the Unix Epoch on January 1st, 1970 at UTC.
+     * If blockTag is not provided, the latest block is used.
+     * @param {BlockTag} blockTag - The block tag to specify the block.
+     * @returns {Promise<number>} A promise that resolves to the UNIX timestamp of the block identified by blockTag.
      */
     getBlockTimestamp(blockTag: BlockTag): Promise<number>;
     /**
-     * sendTransaction sends a signed transaction in bytes to the blockchain.
-     * @param transaction
-     * @param sendOptions
+     * Send a signed transaction in bytes to the blockchain.
+     * @param {SignedTransaction} transaction - The signed transaction to send.
+     * @param {unknown} [sendOptions] - Optional parameters for sending the transaction.
+     * @returns {Promise<TransactionPending>} A promise that resolves to the pending transaction.
      */
     sendTransaction(transaction: SignedTransaction, sendOptions?: unknown): Promise<TransactionPending>;
     /**
@@ -155,49 +217,73 @@ interface Provider {
      */
     confirmTransaction(pending: TransactionPending, opts?: unknown): Promise<TransactionReceipt>;
     /**
-     * Send a transaction and wait for confirmation
-     * @param transaction
-     * @param opts
+     * Send a transaction and wait for confirmation.
+     * @param {SignedTransaction} transaction - The signed transaction to send.
+     * @param {unknown} [opts] - Optional parameters for sending and confirming the transaction.
+     * @returns {Promise<TransactionReceipt>} A promise that resolves to the transaction receipt.
      */
     sendAndConfirm(transaction: SignedTransaction, opts?: unknown): Promise<TransactionReceipt>;
+    /**
+     * The native provider instance.
+     */
     readonly native: unknown;
 }
 
+/**
+ * Interface representing a signer.
+ *
+ * @template T - The type of the transaction request.
+ */
 interface Signer<T = unknown> {
     /**
-     * Connect to a provider
-     * @param provider
+     * Connect to a provider.
+     *
+     * @param {Provider} provider - The provider to connect to.
+     * @returns {Signer<T>} The connected signer.
      */
     connect(provider: Provider): Signer<T>;
     /**
-     * Sign a transaction
-     * @param buildTxRequest
+     * Build a transaction.
+     *
+     * @param {T} buildTxRequest - The transaction request to build.
+     * @returns {Promise<TransactionRequest>} A promise that resolves to the built transaction request.
      */
     buildTransaction(buildTxRequest: T): Promise<TransactionRequest>;
     /**
-     * Sign a transaction
-     * @param transaction
+     * Sign a transaction.
+     *
+     * @param {TransactionRequest} transaction - The transaction request to sign.
+     * @returns {Promise<SignedTransaction>} A promise that resolves to the signed transaction.
      */
     signTransaction(transaction: TransactionRequest): Promise<SignedTransaction>;
     /**
-     * Send a transaction
-     * @param transaction
-     * @param sendOptions
+     * Send a transaction.
+     *
+     * @param {SignedTransaction} transaction - The signed transaction to send.
+     * @param {unknown} [sendOptions] - Optional parameters for sending the transaction.
+     * @returns {Promise<TransactionPending>} A promise that resolves to the pending transaction.
      */
     sendTransaction(transaction: SignedTransaction, sendOptions?: unknown): Promise<TransactionPending>;
     /**
-     * Send a transaction and wait for confirmation
-     * @param transaction
-     * @param opts
+     * Send a transaction and wait for confirmation.
+     *
+     * @param {SignedTransaction} transaction - The signed transaction to send.
+     * @param {unknown} [opts] - Optional parameters for sending and confirming the transaction.
+     * @returns {Promise<TransactionReceipt>} A promise that resolves to the transaction receipt.
      */
     sendAndConfirm(transaction: SignedTransaction, opts?: unknown): Promise<TransactionReceipt>;
     /**
-     * Sign a buffer (e.g. a message hash)
+     * Sign a buffer (e.g. a message hash).
+     *
+     * @param {Uint8Array} buffer - The buffer to sign.
+     * @returns {Promise<Uint8Array>} A promise that resolves to the signed buffer.
      */
     signBuffer(buffer: Uint8Array): Promise<Uint8Array>;
     /**
-     * returns the address of the signer
+     * Get the address of the signer.
      * this function NEED to return a Promise because ethers.Signer.getAddress() return a Promise<string>
+     *
+     * @returns {Promise<string>} A promise that resolves to the address of the signer.
      */
     getAddress(): Promise<string>;
     /**
@@ -205,9 +291,28 @@ interface Signer<T = unknown> {
      */
     native: unknown;
 }
+/**
+ * Interface representing a connectable object.
+ *
+ * @template T - The type of the connectable object.
+ */
 interface Connectable<T> {
+    /**
+     * Connect to a provider.
+     *
+     * @template U - The type of the provider.
+     * @param {U} provider - The provider to connect to.
+     * @returns {T} The connected object.
+     */
     connect<U>(provider: U): T;
 }
+/**
+ * Check if an object is connectable.
+ *
+ * @template T - The type of the connectable object.
+ * @param {unknown} obj - The object to check.
+ * @returns {obj is Connectable<T>} True if the object is connectable, false otherwise.
+ */
 declare function isConnectable<T>(obj: unknown): obj is Connectable<T>;
 
 export { Block, type BlockTag, BlockWithTransactions, type Connectable, type Finality, type Provider, SignedTransaction, type Signer, type TransactionHash, TransactionPending, TransactionReceipt, TransactionRequest, TransactionResponse, isConnectable };

package/dist/index.mjs

@@ -4,6 +4,12 @@ var Block = class _Block {
     this.block = block;
     this.type = "Block";
   }
+  /**
+   * Creates an instance of Block from a non-promise value.
+   *
+   * @param {NonPromise<T>} raw - The raw value to create the Block from.
+   * @returns {Block} The created Block instance.
+   */
   static from(raw) {
     return new _Block(raw);
   }
@@ -13,6 +19,12 @@ var BlockWithTransactions = class _BlockWithTransactions {
     this.block = block;
     this.type = "BlockWithTransactions";
   }
+  /**
+   * Creates an instance of BlockWithTransactions from a non-promise value.
+   *
+   * @param {NonPromise<T>} raw - The raw value to create the BlockWithTransactions from.
+   * @returns {BlockWithTransactions} The created BlockWithTransactions instance.
+   */
   static from(raw) {
     return new _BlockWithTransactions(raw);
   }
@@ -22,6 +34,12 @@ var TransactionRequest = class _TransactionRequest {
     this.request = request;
     this.type = "TransactionRequest";
   }
+  /**
+   * Creates an instance of TransactionRequest from a non-promise value.
+   *
+   * @param {Exclude<NonPromise<T>, TransactionTypes>} raw - The raw value to create the TransactionRequest from.
+   * @returns {TransactionRequest} The created TransactionRequest instance.
+   */
   static from(raw) {
     return new _TransactionRequest(raw);
   }
@@ -31,6 +49,12 @@ var TransactionResponse = class _TransactionResponse {
     this.response = response;
     this.type = "TransactionResponse";
   }
+  /**
+   * Creates an instance of TransactionResponse from a non-promise value.
+   *
+   * @param {Exclude<NonPromise<T>, TransactionTypes>} raw - The raw value to create the TransactionResponse from.
+   * @returns {TransactionResponse} The created TransactionResponse instance.
+   */
   static from(raw) {
     return new _TransactionResponse(raw);
   }
@@ -40,6 +64,12 @@ var TransactionReceipt = class _TransactionReceipt {
     this.receipt = receipt;
     this.type = "TransactionReceipt";
   }
+  /**
+   * Creates an instance of TransactionReceipt from a non-promise value.
+   *
+   * @param {Exclude<NonPromise<T>, TransactionTypes>} raw - The raw value to create the TransactionReceipt from.
+   * @returns {TransactionReceipt} The created TransactionReceipt instance.
+   */
   static from(raw) {
     return new _TransactionReceipt(raw);
   }
@@ -49,6 +79,12 @@ var SignedTransaction = class _SignedTransaction {
     this.signed = signed;
     this.type = "SignedTransaction";
   }
+  /**
+   * Creates an instance of SignedTransaction from a non-promise value.
+   *
+   * @param {Exclude<NonPromise<T>, TransactionTypes>} raw - The raw value to create the SignedTransaction from.
+   * @returns {SignedTransaction} The created SignedTransaction instance.
+   */
   static from(raw) {
     return new _SignedTransaction(raw);
   }
@@ -58,6 +94,12 @@ var TransactionPending = class _TransactionPending {
     this.pending = pending;
     this.type = "TransactionPending";
   }
+  /**
+   * Creates an instance of TransactionPending from a non-promise value.
+   *
+   * @param {Exclude<NonPromise<T>, TransactionTypes>} raw - The raw value to create the TransactionPending from.
+   * @returns {TransactionPending} The created TransactionPending instance.
+   */
   static from(raw) {
     return new _TransactionPending(raw);
   }

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/transaction.ts","../src/signer.ts"],"names":[],"mappings":";AAmBO,IAAM,QAAN,MAAM,OAAM;AAAA,EAEP,YAAmB,OAAgB;AAAhB;AAD3B,SAAS,OAAO;AAAA,EAC4B;AAAA,EAC5C,OAAO,KAAQ,KAA2B;AACtC,WAAO,IAAI,OAAM,GAAG;AAAA,EACxB;AACJ;AAKO,IAAM,wBAAN,MAAM,uBAAsB;AAAA,EAEvB,YAAmB,OAAgB;AAAhB;AAD3B,SAAS,OAAO;AAAA,EAC4B;AAAA,EAC5C,OAAO,KAAQ,KAA2C;AACtD,WAAO,IAAI,uBAAsB,GAAG;AAAA,EACxC;AACJ;AAyBO,IAAM,qBAAN,MAAM,oBAAmB;AAAA,EAEpB,YAAmB,SAAkB;AAAlB;AAD3B,SAAS,OAAO;AAAA,EAC8B;AAAA,EAC9C,OAAO,KAAQ,KAAmE;AAC9E,WAAO,IAAI,oBAAmB,GAAG;AAAA,EACrC;AACJ;AAKO,IAAM,sBAAN,MAAM,qBAAoB;AAAA,EAErB,YAAmB,UAAmB;AAAnB;AAD3B,SAAS,OAAO;AAAA,EAC+B;AAAA,EAC/C,OAAO,KAAQ,KAAoE;AAC/E,WAAO,IAAI,qBAAoB,GAAG;AAAA,EACtC;AACJ;AAKO,IAAM,qBAAN,MAAM,oBAAmB;AAAA,EAEpB,YAAmB,SAAkB;AAAlB;AAD3B,SAAS,OAAO;AAAA,EAC8B;AAAA,EAC9C,OAAO,KAAQ,KAAmE;AAC9E,WAAO,IAAI,oBAAmB,GAAG;AAAA,EACrC;AACJ;AAKO,IAAM,oBAAN,MAAM,mBAAkB;AAAA,EAEnB,YAAmB,QAAiB;AAAjB;AAD3B,SAAS,OAAO;AAAA,EAC6B;AAAA,EAC7C,OAAO,KAAQ,KAAkE;AAC7E,WAAO,IAAI,mBAAkB,GAAG;AAAA,EACpC;AACJ;AAKO,IAAM,qBAAN,MAAM,oBAAmB;AAAA,EAEpB,YAAmB,SAAkB;AAAlB;AAD3B,SAAS,OAAO;AAAA,EAC8B;AAAA,EAC9C,OAAO,KAAQ,KAAmE;AAC9E,WAAO,IAAI,oBAAmB,GAAG;AAAA,EACrC;AACJ;;;ACtDO,SAAS,cAAiB,KAAqC;AAClE,MAAI,OAAO,QAAQ,YAAY,QAAQ;AAAM,WAAO;AACpD,QAAM,KAAM,IAA8B;AAC1C,SAAO,OAAO,OAAO,cAAc,OAAO,GAAG,WAAW,YAAY,GAAG,WAAW;AACtF","sourcesContent":["import { NonPromise } from './promise'\n\n/**\n * By declare a unique field `type` in each class, it ensure that the instance of one class can not\n *  be assigned to a variable of another class. Furthermore, it also help to distinguish the type of\n * the instance at runtime.\n * By private the constructor, it ensure that the instance of the class can only be created by the\n * static method `from`, and which can enforce the type of the input parameter should not be a promise.\n * Finally, it will be helpful for the compiler to infer the type of the instance and avoid the mistake.\n */\n\n/**\n * TransactionHash represents a transaction hash.\n */\nexport type TransactionHash = string | number\n\n/**\n * Block represents a block.\n */\nexport class Block {\n    readonly type = 'Block'\n    private constructor(public block: unknown) {}\n    static from<T>(raw: NonPromise<T>): Block {\n        return new Block(raw)\n    }\n}\n\n/**\n * BlockWithTransactions represents a block with transactions.\n */\nexport class BlockWithTransactions {\n    readonly type = 'BlockWithTransactions'\n    private constructor(public block: unknown) {}\n    static from<T>(raw: NonPromise<T>): BlockWithTransactions {\n        return new BlockWithTransactions(raw)\n    }\n}\n\n/**\n * BlockTag represents a block tag.\n */\nexport type BlockTag = string | number\n\n/**\n * Finality represents the finality of a block.\n */\nexport type Finality = 'confirmed' | 'finalized'\n\n/**\n * A union type to represent all the possible types of a transaction.\n */\ntype TransactionTypes =\n    | TransactionRequest\n    | TransactionResponse\n    | TransactionReceipt\n    | SignedTransaction\n    | TransactionPending\n\n/**\n * TransactionRequest represents the request of a transaction.\n */\nexport class TransactionRequest {\n    readonly type = 'TransactionRequest'\n    private constructor(public request: unknown) {}\n    static from<T>(raw: Exclude<NonPromise<T>, TransactionTypes>): TransactionRequest {\n        return new TransactionRequest(raw)\n    }\n}\n\n/**\n * TransactionResponse represents the response of a transaction.\n */\nexport class TransactionResponse {\n    readonly type = 'TransactionResponse'\n    private constructor(public response: unknown) {}\n    static from<T>(raw: Exclude<NonPromise<T>, TransactionTypes>): TransactionResponse {\n        return new TransactionResponse(raw)\n    }\n}\n\n/**\n * TransactionReceipt represents the receipt of a transaction.\n */\nexport class TransactionReceipt {\n    readonly type = 'TransactionReceipt'\n    private constructor(public receipt: unknown) {}\n    static from<T>(raw: Exclude<NonPromise<T>, TransactionTypes>): TransactionReceipt {\n        return new TransactionReceipt(raw)\n    }\n}\n\n/**\n * SignedTransaction represents a signed transaction.\n */\nexport class SignedTransaction {\n    readonly type = 'SignedTransaction'\n    private constructor(public signed: unknown) {}\n    static from<T>(raw: Exclude<NonPromise<T>, TransactionTypes>): SignedTransaction {\n        return new SignedTransaction(raw)\n    }\n}\n\n/**\n * TransactionPending represents a pending transaction.\n */\nexport class TransactionPending {\n    readonly type = 'TransactionPending'\n    private constructor(public pending: unknown) {}\n    static from<T>(raw: Exclude<NonPromise<T>, TransactionTypes>): TransactionPending {\n        return new TransactionPending(raw)\n    }\n}\n","import { Provider } from './provider'\nimport { SignedTransaction, TransactionPending, TransactionReceipt, TransactionRequest } from './transaction'\n\nexport interface Signer<T = unknown> {\n    /**\n     * Connect to a provider\n     * @param provider\n     */\n    connect(provider: Provider): Signer<T>\n\n    /**\n     * Sign a transaction\n     * @param buildTxRequest\n     */\n    buildTransaction(buildTxRequest: T): Promise<TransactionRequest>\n\n    /**\n     * Sign a transaction\n     * @param transaction\n     */\n    signTransaction(transaction: TransactionRequest): Promise<SignedTransaction>\n\n    /**\n     * Send a transaction\n     * @param transaction\n     * @param sendOptions\n     */\n    sendTransaction(transaction: SignedTransaction, sendOptions?: unknown): Promise<TransactionPending>\n\n    /**\n     * Send a transaction and wait for confirmation\n     * @param transaction\n     * @param opts\n     */\n    sendAndConfirm(transaction: SignedTransaction, opts?: unknown): Promise<TransactionReceipt>\n\n    /**\n     * Sign a buffer (e.g. a message hash)\n     */\n    signBuffer(buffer: Uint8Array): Promise<Uint8Array>\n\n    /**\n     * returns the address of the signer\n     * this function NEED to return a Promise because ethers.Signer.getAddress() return a Promise<string>\n     */\n    getAddress(): Promise<string>\n\n    /**\n     * Native signer object\n     */\n    native: unknown\n}\n\nexport interface Connectable<T> {\n    connect<U>(provider: U): T\n}\n\nexport function isConnectable<T>(obj: unknown): obj is Connectable<T> {\n    if (typeof obj !== 'object' || obj === null) return false\n    const fn = (obj as { connect?: unknown }).connect\n    return typeof fn === 'function' && typeof fn.length === 'number' && fn.length === 1\n}\n"]}
+{"version":3,"sources":["../src/transaction.ts","../src/signer.ts"],"names":[],"mappings":";AAmBO,IAAM,QAAN,MAAM,OAAM;AAAA,EAEP,YAAmB,OAAgB;AAAhB;AAD3B,SAAS,OAAO;AAAA,EAC4B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ5C,OAAO,KAAQ,KAA2B;AACtC,WAAO,IAAI,OAAM,GAAG;AAAA,EACxB;AACJ;AAKO,IAAM,wBAAN,MAAM,uBAAsB;AAAA,EAEvB,YAAmB,OAAgB;AAAhB;AAD3B,SAAS,OAAO;AAAA,EAC4B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ5C,OAAO,KAAQ,KAA2C;AACtD,WAAO,IAAI,uBAAsB,GAAG;AAAA,EACxC;AACJ;AAyBO,IAAM,qBAAN,MAAM,oBAAmB;AAAA,EAEpB,YAAmB,SAAkB;AAAlB;AAD3B,SAAS,OAAO;AAAA,EAC8B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ9C,OAAO,KAAQ,KAAmE;AAC9E,WAAO,IAAI,oBAAmB,GAAG;AAAA,EACrC;AACJ;AAKO,IAAM,sBAAN,MAAM,qBAAoB;AAAA,EAErB,YAAmB,UAAmB;AAAnB;AAD3B,SAAS,OAAO;AAAA,EAC+B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ/C,OAAO,KAAQ,KAAoE;AAC/E,WAAO,IAAI,qBAAoB,GAAG;AAAA,EACtC;AACJ;AAKO,IAAM,qBAAN,MAAM,oBAAmB;AAAA,EAEpB,YAAmB,SAAkB;AAAlB;AAD3B,SAAS,OAAO;AAAA,EAC8B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ9C,OAAO,KAAQ,KAAmE;AAC9E,WAAO,IAAI,oBAAmB,GAAG;AAAA,EACrC;AACJ;AAKO,IAAM,oBAAN,MAAM,mBAAkB;AAAA,EAEnB,YAAmB,QAAiB;AAAjB;AAD3B,SAAS,OAAO;AAAA,EAC6B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ7C,OAAO,KAAQ,KAAkE;AAC7E,WAAO,IAAI,mBAAkB,GAAG;AAAA,EACpC;AACJ;AAKO,IAAM,qBAAN,MAAM,oBAAmB;AAAA,EAEpB,YAAmB,SAAkB;AAAlB;AAD3B,SAAS,OAAO;AAAA,EAC8B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ9C,OAAO,KAAQ,KAAmE;AAC9E,WAAO,IAAI,oBAAmB,GAAG;AAAA,EACrC;AACJ;;;AChEO,SAAS,cAAiB,KAAqC;AAClE,MAAI,OAAO,QAAQ,YAAY,QAAQ;AAAM,WAAO;AACpD,QAAM,KAAM,IAA8B;AAC1C,SAAO,OAAO,OAAO,cAAc,OAAO,GAAG,WAAW,YAAY,GAAG,WAAW;AACtF","sourcesContent":["import { NonPromise } from './promise'\n\n/**\n * By declare a unique field `type` in each class, it ensure that the instance of one class can not\n *  be assigned to a variable of another class. Furthermore, it also help to distinguish the type of\n * the instance at runtime.\n * By private the constructor, it ensure that the instance of the class can only be created by the\n * static method `from`, and which can enforce the type of the input parameter should not be a promise.\n * Finally, it will be helpful for the compiler to infer the type of the instance and avoid the mistake.\n */\n\n/**\n * TransactionHash represents a transaction hash.\n */\nexport type TransactionHash = string | number\n\n/**\n * Block represents a block.\n */\nexport class Block {\n    readonly type = 'Block'\n    private constructor(public block: unknown) {}\n\n    /**\n     * Creates an instance of Block from a non-promise value.\n     *\n     * @param {NonPromise<T>} raw - The raw value to create the Block from.\n     * @returns {Block} The created Block instance.\n     */\n    static from<T>(raw: NonPromise<T>): Block {\n        return new Block(raw)\n    }\n}\n\n/**\n * BlockWithTransactions represents a block with transactions.\n */\nexport class BlockWithTransactions {\n    readonly type = 'BlockWithTransactions'\n    private constructor(public block: unknown) {}\n\n    /**\n     * Creates an instance of BlockWithTransactions from a non-promise value.\n     *\n     * @param {NonPromise<T>} raw - The raw value to create the BlockWithTransactions from.\n     * @returns {BlockWithTransactions} The created BlockWithTransactions instance.\n     */\n    static from<T>(raw: NonPromise<T>): BlockWithTransactions {\n        return new BlockWithTransactions(raw)\n    }\n}\n\n/**\n * BlockTag represents a block tag.\n */\nexport type BlockTag = string | number\n\n/**\n * Finality represents the finality of a block.\n */\nexport type Finality = 'confirmed' | 'finalized'\n\n/**\n * A union type to represent all the possible types of a transaction.\n */\ntype TransactionTypes =\n    | TransactionRequest\n    | TransactionResponse\n    | TransactionReceipt\n    | SignedTransaction\n    | TransactionPending\n\n/**\n * TransactionRequest represents the request of a transaction.\n */\nexport class TransactionRequest {\n    readonly type = 'TransactionRequest'\n    private constructor(public request: unknown) {}\n\n    /**\n     * Creates an instance of TransactionRequest from a non-promise value.\n     *\n     * @param {Exclude<NonPromise<T>, TransactionTypes>} raw - The raw value to create the TransactionRequest from.\n     * @returns {TransactionRequest} The created TransactionRequest instance.\n     */\n    static from<T>(raw: Exclude<NonPromise<T>, TransactionTypes>): TransactionRequest {\n        return new TransactionRequest(raw)\n    }\n}\n\n/**\n * TransactionResponse represents the response of a transaction.\n */\nexport class TransactionResponse {\n    readonly type = 'TransactionResponse'\n    private constructor(public response: unknown) {}\n\n    /**\n     * Creates an instance of TransactionResponse from a non-promise value.\n     *\n     * @param {Exclude<NonPromise<T>, TransactionTypes>} raw - The raw value to create the TransactionResponse from.\n     * @returns {TransactionResponse} The created TransactionResponse instance.\n     */\n    static from<T>(raw: Exclude<NonPromise<T>, TransactionTypes>): TransactionResponse {\n        return new TransactionResponse(raw)\n    }\n}\n\n/**\n * TransactionReceipt represents the receipt of a transaction.\n */\nexport class TransactionReceipt {\n    readonly type = 'TransactionReceipt'\n    private constructor(public receipt: unknown) {}\n\n    /**\n     * Creates an instance of TransactionReceipt from a non-promise value.\n     *\n     * @param {Exclude<NonPromise<T>, TransactionTypes>} raw - The raw value to create the TransactionReceipt from.\n     * @returns {TransactionReceipt} The created TransactionReceipt instance.\n     */\n    static from<T>(raw: Exclude<NonPromise<T>, TransactionTypes>): TransactionReceipt {\n        return new TransactionReceipt(raw)\n    }\n}\n\n/**\n * SignedTransaction represents a signed transaction.\n */\nexport class SignedTransaction {\n    readonly type = 'SignedTransaction'\n    private constructor(public signed: unknown) {}\n\n    /**\n     * Creates an instance of SignedTransaction from a non-promise value.\n     *\n     * @param {Exclude<NonPromise<T>, TransactionTypes>} raw - The raw value to create the SignedTransaction from.\n     * @returns {SignedTransaction} The created SignedTransaction instance.\n     */\n    static from<T>(raw: Exclude<NonPromise<T>, TransactionTypes>): SignedTransaction {\n        return new SignedTransaction(raw)\n    }\n}\n\n/**\n * TransactionPending represents a pending transaction.\n */\nexport class TransactionPending {\n    readonly type = 'TransactionPending'\n    private constructor(public pending: unknown) {}\n\n    /**\n     * Creates an instance of TransactionPending from a non-promise value.\n     *\n     * @param {Exclude<NonPromise<T>, TransactionTypes>} raw - The raw value to create the TransactionPending from.\n     * @returns {TransactionPending} The created TransactionPending instance.\n     */\n    static from<T>(raw: Exclude<NonPromise<T>, TransactionTypes>): TransactionPending {\n        return new TransactionPending(raw)\n    }\n}\n","import { Provider } from './provider'\nimport { SignedTransaction, TransactionPending, TransactionReceipt, TransactionRequest } from './transaction'\n\n/**\n * Interface representing a signer.\n *\n * @template T - The type of the transaction request.\n */\nexport interface Signer<T = unknown> {\n    /**\n     * Connect to a provider.\n     *\n     * @param {Provider} provider - The provider to connect to.\n     * @returns {Signer<T>} The connected signer.\n     */\n    connect(provider: Provider): Signer<T>\n\n    /**\n     * Build a transaction.\n     *\n     * @param {T} buildTxRequest - The transaction request to build.\n     * @returns {Promise<TransactionRequest>} A promise that resolves to the built transaction request.\n     */\n    buildTransaction(buildTxRequest: T): Promise<TransactionRequest>\n\n    /**\n     * Sign a transaction.\n     *\n     * @param {TransactionRequest} transaction - The transaction request to sign.\n     * @returns {Promise<SignedTransaction>} A promise that resolves to the signed transaction.\n     */\n    signTransaction(transaction: TransactionRequest): Promise<SignedTransaction>\n\n    /**\n     * Send a transaction.\n     *\n     * @param {SignedTransaction} transaction - The signed transaction to send.\n     * @param {unknown} [sendOptions] - Optional parameters for sending the transaction.\n     * @returns {Promise<TransactionPending>} A promise that resolves to the pending transaction.\n     */\n    sendTransaction(transaction: SignedTransaction, sendOptions?: unknown): Promise<TransactionPending>\n\n    /**\n     * Send a transaction and wait for confirmation.\n     *\n     * @param {SignedTransaction} transaction - The signed transaction to send.\n     * @param {unknown} [opts] - Optional parameters for sending and confirming the transaction.\n     * @returns {Promise<TransactionReceipt>} A promise that resolves to the transaction receipt.\n     */\n    sendAndConfirm(transaction: SignedTransaction, opts?: unknown): Promise<TransactionReceipt>\n\n    /**\n     * Sign a buffer (e.g. a message hash).\n     *\n     * @param {Uint8Array} buffer - The buffer to sign.\n     * @returns {Promise<Uint8Array>} A promise that resolves to the signed buffer.\n     */\n    signBuffer(buffer: Uint8Array): Promise<Uint8Array>\n\n    /**\n     * Get the address of the signer.\n     * this function NEED to return a Promise because ethers.Signer.getAddress() return a Promise<string>\n     *\n     * @returns {Promise<string>} A promise that resolves to the address of the signer.\n     */\n    getAddress(): Promise<string>\n\n    /**\n     * Native signer object\n     */\n    native: unknown\n}\n\n/**\n * Interface representing a connectable object.\n *\n * @template T - The type of the connectable object.\n */\nexport interface Connectable<T> {\n    /**\n     * Connect to a provider.\n     *\n     * @template U - The type of the provider.\n     * @param {U} provider - The provider to connect to.\n     * @returns {T} The connected object.\n     */\n    connect<U>(provider: U): T\n}\n\n/**\n * Check if an object is connectable.\n *\n * @template T - The type of the connectable object.\n * @param {unknown} obj - The object to check.\n * @returns {obj is Connectable<T>} True if the object is connectable, false otherwise.\n */\nexport function isConnectable<T>(obj: unknown): obj is Connectable<T> {\n    if (typeof obj !== 'object' || obj === null) return false\n    const fn = (obj as { connect?: unknown }).connect\n    return typeof fn === 'function' && typeof fn.length === 'number' && fn.length === 1\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@layerzerolabs/lz-core",
-  "version": "3.0.14",
+  "version": "3.0.16",
   "description": "LayerZero Core Library",
   "license": "BUSL-1.1",
   "exports": {
@@ -22,17 +22,10 @@
     "clean": "$npm_execpath clean-prebuild && rimraf .turbo",
     "clean-prebuild": "rimraf dist"
   },
-  "dependencies": {
-    "@layerzerolabs/lz-foundation": "^3.0.14",
-    "@noble/ed25519": "^1.7.1",
-    "@noble/hashes": "^1.3.2",
-    "@noble/secp256k1": "^1.7.1",
-    "tiny-invariant": "^1.3.1"
-  },
   "devDependencies": {
     "@jest/globals": "^29.7.0",
-    "@layerzerolabs/tsup-config-next": "^3.0.14",
-    "@layerzerolabs/typescript-config-next": "^3.0.14",
+    "@layerzerolabs/tsup-config-next": "^3.0.16",
+    "@layerzerolabs/typescript-config-next": "^3.0.16",
     "@types/jest": "^29.5.10",
     "jest": "^29.7.0",
     "rimraf": "^5.0.5",