npm - @layerzerolabs/lz-corekit-evm - Versions diffs - 3.0.15 → 3.0.16 - Mend

@layerzerolabs/lz-corekit-evm 3.0.15 → 3.0.16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (9) hide show

package/CHANGELOG.md CHANGED Viewed

@@ -1,5 +1,14 @@
 # @layerzerolabs/lz-corekit-evm
+## 3.0.16
+### Patch Changes
+- 87a4bc9: islander mainnet
+- Updated dependencies [87a4bc9]
+  - @layerzerolabs/lz-core@3.0.16
+  - @layerzerolabs/lz-utilities@3.0.16
 ## 3.0.15
 ### Patch Changes

package/README.md CHANGED Viewed

@@ -1 +1,98 @@
-# @layerzerolabs/lz-corekit
+# @layerzerolabs/lz-corekit-evm
+The EVM CoreKit is a comprehensive SDK designed to interact with the EVM-compatible blockchain. It provides a set of utilities and modules to facilitate the development and integration of applications with the EVM-compatible blockchain.
+## Features
+- **Retrieve Account Information**: Gets the balance of the specified address.
+- **Retrieve Block Information**: Gets the block height, timestamp and related transactions of the specified block.
+- **Transaction Management**: Get, build, sign, send and confirm transactions.
+## Installation
+To install the EVM CoreKit, you can use npm or yarn:
+```sh
+npm install @layerzerolabs/lz-corekit-evm
+```
+or
+```sh
+yarn add @layerzerolabs/lz-corekit-evm
+```
+## Usage
+### Initialization
+```typescript
+import { EvmProvider } from "@layerzerolabs/lz-corekit-evm";
+// url is the EVM-compatible chain full node url
+const url = "http://127.0.0.1:8502";
+const provider = EvmProvider.from(url);
+```
+### Retrieve Account Information
+#### Get Account Balance
+```typescript
+import { EvmProvider } from "@layerzerolabs/lz-corekit-evm";
+// url is the EVM-compatible chain full node url
+const url = "http://127.0.0.1:8502";
+const provider = EvmProvider.from(url);
+const address = "0x1";
+const balance = await provider.getBalance(address);
+```
+### Retrieve Block Information
+#### Get Latest Block Height
+```typescript
+import { EvmProvider } from "@layerzerolabs/lz-corekit-evm";
+// url is the EVM-compatible chain full node url
+const url = "http://127.0.0.1:8502";
+const provider = EvmProvider.from(url);
+const number = await provider.getBlockNumber();
+```
+### Transaction Management
+#### Get Transaction by hash
+```typescript
+import { EvmProvider } from "@layerzerolabs/lz-corekit-evm";
+// url is the EVM-compatible chain full node url
+const url = "http://127.0.0.1:8502";
+const provider = EvmProvider.from(url);
+const hash = "0x1";
+const tx = await provider.getTransaction(hash);
+```
+#### Sign, Send and Confirm Transaction
+```typescript
+import { EvmProvider, EvmSigner } from '@layerzerolabs/lz-corekit-evm'
+import { SignedTransaction, TransactionReceipt, TransactionRequest } from '@layerzerolabs/lz-core'
+// url is the EVM-compatible chain full node url
+const url = "http://127.0.0.1:8502"
+const provider = EvmProvider.from(url)
+const privateKey = '0x1234'
+const signer = EvmSigner.from(privateKey)
+signer.connect(provider)
+const tx: TransactionRequest = ...
+const stx: SignedTransaction = await signer.signTransaction(tx)
+const receipt: TransactionReceipt = await signer.sendAndConfirm(stx)
+```

package/dist/index.cjs CHANGED Viewed

@@ -5,10 +5,22 @@ var lzCore = require('@layerzerolabs/lz-core');
 // src/providers/evm.ts
 var EvmProvider = class _EvmProvider {
+  /**
+   * Creates an instance of EvmProvider.
+   *
+   * @param {string} url - The URL of the EVM node.
+   */
   constructor(url) {
     this.url = url;
     this.nativeProvider = new ethers.ethers.providers.JsonRpcProvider(url);
   }
+  /**
+   * Creates an instance of EvmProvider from the given source.
+   *
+   * @param {string} source - The source to create the provider from.
+   * @returns {EvmProvider} The created EvmProvider instance.
+   * @throws {Error} If the source parameter is not a string.
+   */
   static from(source) {
     if (typeof source === "string") {
       return new _EvmProvider(source);
@@ -16,61 +28,155 @@ var EvmProvider = class _EvmProvider {
       throw new Error("Invalid parameters");
     }
   }
+  /**
+   * Gets the native EVM provider instance.
+   *
+   * @returns {ethers.providers.JsonRpcProvider} The native EVM provider instance.
+   */
   get native() {
     return this.nativeProvider;
   }
+  /**
+   * Gets the balance of the specified address.
+   *
+   * @param {string} address - The address to get the balance of.
+   * @returns {Promise<string>} A promise that resolves to the balance of the address.
+   */
   async getBalance(address) {
     return (await this.nativeProvider.getBalance(address)).toString();
   }
+  /**
+   * Gets 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.
+   */
   async getBlock(blockTag) {
     const response = await this.nativeProvider.getBlock(blockTag);
     return lzCore.Block.from(response);
   }
+  /**
+   * Gets 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.
+   */
   async getBlockWithTransactions(blockTag) {
     const response = await this.nativeProvider.getBlockWithTransactions(blockTag);
     return lzCore.BlockWithTransactions.from(response);
   }
+  /**
+   * Gets the current block number.
+   *
+   * @returns {Promise<number>} A promise that resolves to the current block number.
+   */
   async getBlockNumber() {
     return this.nativeProvider.getBlockNumber();
   }
+  /**
+   * Gets the current slot number for commitment, not suitable for EVM.
+   *
+   * @param {Finality} [finality] - The commitment level (optional).
+   * @returns {Promise<number>} A promise that resolves to the current slot number.
+   * @throws {Error} Method not implemented.
+   */
   // eslint-disable-next-line @typescript-eslint/require-await
   async getSlot(_finality) {
     await Promise.resolve();
     throw new Error("Method not implemented.");
   }
+  /**
+   * Gets the UNIX timestamp for the block identified by blockTag.
+   *
+   * @param {BlockTag} blockTag - The block tag to specify the block.
+   * @returns {Promise<number>} A promise that resolves to the UNIX timestamp of the block.
+   */
   async getBlockTimestamp(blockTag) {
     return this.nativeProvider.getBlock(blockTag).then((block) => block.timestamp);
   }
+  /**
+   * Gets information about a transaction.
+   *
+   * @param {string} txHash - The hash of the transaction.
+   * @returns {Promise<TransactionResponse>} A promise that resolves to the transaction response.
+   */
   async getTransaction(txHash) {
     const response = await this.nativeProvider.getTransaction(txHash);
     return lzCore.TransactionResponse.from(response);
   }
+  /**
+   * Gets the receipt of a transaction.
+   *
+   * @param {string} txHash - The hash of the transaction.
+   * @returns {Promise<TransactionReceipt>} A promise that resolves to the transaction receipt.
+   */
   async getTransactionReceipt(txHash) {
     const response = await this.nativeProvider.getTransactionReceipt(txHash);
     return lzCore.TransactionReceipt.from(response);
   }
+  /**
+   * Gets the number of transactions sent from the specified 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 (optional).
+   * @returns {Promise<number>} A promise that resolves to the number of transactions sent from the address.
+   */
   async getTransactionCount(addressOrName, blockTag) {
     return this.nativeProvider.getTransactionCount(addressOrName, blockTag);
   }
+  /**
+   * Sends a signed transaction to the blockchain.
+   *
+   * @param {SignedTransaction} transaction - The signed transaction to send.
+   * @param {object} [sendOptions] - Optional parameters for sending the transaction.
+   * @returns {Promise<TransactionPending>} A promise that resolves to the pending transaction.
+   */
   async sendTransaction(transaction, _sendOptions) {
     const stx = transaction.signed;
     const response = await this.nativeProvider.sendTransaction(stx);
     return lzCore.TransactionPending.from(response);
   }
+  /**
+   * Confirms a pending transaction.
+   *
+   * @param {TransactionPending} pending - The pending transaction to confirm.
+   * @param {object} [opts] - Optional parameters for the confirmation.
+   * @returns {Promise<TransactionReceipt>} A promise that resolves to the transaction receipt.
+   */
   async confirmTransaction(pending, _opts) {
     const nativePending = pending.pending;
     const response = await nativePending.wait();
     return lzCore.TransactionReceipt.from(response);
   }
+  /**
+   * Sends a signed transaction and waits for confirmation.
+   *
+   * @param {SignedTransaction} transaction - The signed transaction to send.
+   * @param {object} [opts] - Optional parameters for sending and confirming the transaction.
+   * @returns {Promise<TransactionReceipt>} A promise that resolves to the transaction receipt.
+   */
   async sendAndConfirm(transaction, opts) {
     const pending = await this.sendTransaction(transaction, opts);
     return this.confirmTransaction(pending, opts);
   }
 };
 var EvmSigner = class {
+  /**
+   * Creates an instance of EvmSigner.
+   *
+   * @param {ethers.Signer} signer - The EVM signer to use.
+   */
   constructor(signer) {
     this.nativeSigner = signer;
   }
+  /**
+   * Creates an instance of EvmSigner from the given source.
+   *
+   * @param {ethers.Signer | string} source - The source to create the signer from.
+   * @param {string} [path] - The derivation path (optional).
+   * @returns {EvmSigner} The created EvmSigner instance.
+   * @throws {Error} If the source parameter is invalid.
+   */
   static from(source, path) {
     if (source instanceof ethers.ethers.Signer) {
       return new this(source);
@@ -81,9 +187,21 @@ var EvmSigner = class {
       return new this(ethers.ethers.Wallet.fromMnemonic(source, path));
     }
   }
+  /**
+   * Gets the native EVM signer instance.
+   *
+   * @returns {ethers.Signer} The native EVM signer instance.
+   */
   get native() {
     return this.nativeSigner;
   }
+  /**
+   * Connects the signer to a provider.
+   *
+   * @param {Provider} provider - The provider to connect to.
+   * @returns {this} The connected signer.
+   * @throws {Error} If the provider is not an instance of ethers.providers.Provider.
+   */
   connect(provider) {
     if (!(provider.native instanceof ethers.ethers.providers.Provider)) {
       throw new Error("Only ethers.providers.Provider is supported.");
@@ -91,18 +209,42 @@ var EvmSigner = class {
     this.nativeSigner = this.nativeSigner.connect(provider.native);
     return this;
   }
+  /**
+   * Gets the address of the signer.
+   *
+   * @returns {Promise<string>} A promise that resolves to the address of the signer.
+   */
   async getAddress() {
     return this.nativeSigner.getAddress();
   }
+  /**
+   * Gets the address of the signer.
+   *
+   * @returns {string} The address of the signer.
+   */
   get address() {
     return this.nativeSigner.address;
   }
+  /**
+   * Sends a signed transaction and waits for confirmation.
+   *
+   * @param {SignedTransaction} transaction - The signed transaction to send.
+   * @param {object} [opts] - Optional parameters for sending and confirming the transaction.
+   * @returns {Promise<TransactionReceipt>} A promise that resolves to the transaction receipt.
+   */
   async sendAndConfirm(transaction, opts) {
     const pending = await this.sendTransaction(transaction);
     const response = pending.pending;
     const receipt = await response.wait(opts?.confirmations);
     return lzCore.TransactionReceipt.from(receipt);
   }
+  /**
+   * Sends a signed transaction.
+   *
+   * @param {SignedTransaction} transaction - The signed transaction to send.
+   * @returns {Promise<TransactionPending>} A promise that resolves to the pending transaction.
+   * @throws {Error} If no provider is attached to the signer.
+   */
   async sendTransaction(transaction) {
     const stx = transaction.signed;
     if (this.nativeSigner.provider === void 0) {
@@ -111,16 +253,35 @@ var EvmSigner = class {
     const response = await this.nativeSigner.provider.sendTransaction(stx);
     return lzCore.TransactionPending.from(response);
   }
+  /**
+   * Signs a transaction.
+   *
+   * @param {TransactionRequest} transaction - The transaction request to sign.
+   * @returns {Promise<SignedTransaction>} A promise that resolves to the signed transaction.
+   */
   async signTransaction(transaction) {
     const tx = transaction.request;
     const populatedTransaction = await this.nativeSigner.populateTransaction(tx);
     const response = await this.nativeSigner.signTransaction(populatedTransaction);
     return lzCore.SignedTransaction.from(response);
   }
+  /**
+   * Signs a buffer (e.g., a message hash) using the native EVM signer.
+   *
+   * @param {Uint8Array} buffer - The buffer to sign.
+   * @returns {Promise<Uint8Array>} A promise that resolves to the signed buffer as a Uint8Array.
+   */
   async signBuffer(buffer) {
     const signedMessage = await this.nativeSigner.signMessage(buffer);
     return ethers.ethers.utils.arrayify(signedMessage);
   }
+  /**
+   * Builds a transaction.
+   *
+   * @param {unknown} buildTxRequest - The transaction request to build.
+   * @returns {Promise<TransactionRequest>} A promise that resolves to the built transaction request.
+   * @throws {Error} Method not implemented.
+   */
   async buildTransaction(buildTxRequest) {
     return Promise.reject(new Error("Method not implemented."));
   }

package/dist/index.cjs.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"sources":["../src/providers/evm.ts","../src/signers/evm.ts"],"names":["ethers","SignedTransaction","TransactionPending","TransactionReceipt"],"mappings":";AAAA,SAAS,cAAc;AAEvB;AAAA,EACI;AAAA,EAEA;AAAA,EAIA;AAAA,EACA;AAAA,EACA;AAAA,OACG;AAEA,IAAM,cAAN,MAAM,aAAgC;AAAA,EAGzC,YAAmB,KAAa;AAAb;AACf,SAAK,iBAAiB,IAAI,OAAO,UAAU,gBAAgB,GAAG;AAAA,EAClE;AAAA,EAIA,OAAO,KAAK,QAA6B;AACrC,QAAI,OAAO,WAAW,UAAU;AAC5B,aAAO,IAAI,aAAY,MAAM;AAAA,IACjC,OAAO;AACH,YAAM,IAAI,MAAM,oBAAoB;AAAA,IACxC;AAAA,EACJ;AAAA,EAEA,IAAI,SAA2C;AAC3C,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,MAAM,WAAW,SAAkC;AAC/C,YAAQ,MAAM,KAAK,eAAe,WAAW,OAAO,GAAG,SAAS;AAAA,EACpE;AAAA,EAEA,MAAM,SAAS,UAA2C;AACtD,UAAM,WAAW,MAAM,KAAK,eAAe,SAAS,QAAQ;AAC5D,WAAO,MAAM,KAAK,QAAQ;AAAA,EAC9B;AAAA,EAEA,MAAM,yBAAyB,UAA2D;AACtF,UAAM,WAAW,MAAM,KAAK,eAAe,yBAAyB,QAAQ;AAC5E,WAAO,sBAAsB,KAAK,QAAQ;AAAA,EAC9C;AAAA,EAEA,MAAM,iBAAkC;AACpC,WAAO,KAAK,eAAe,eAAe;AAAA,EAC9C;AAAA;AAAA,EAGA,MAAM,QAAQ,WAAuC;AACjD,UAAM,QAAQ,QAAQ;AACtB,UAAM,IAAI,MAAM,yBAAyB;AAAA,EAC7C;AAAA,EAEA,MAAM,kBAAkB,UAA4C;AAChE,WAAO,KAAK,eAAe,SAAS,QAAQ,EAAE,KAAK,CAAC,UAAU,MAAM,SAAS;AAAA,EACjF;AAAA,EAEA,MAAM,eAAe,QAA8C;AAC/D,UAAM,WAAW,MAAM,KAAK,eAAe,eAAe,MAAM;AAChE,WAAO,oBAAoB,KAAK,QAAQ;AAAA,EAC5C;AAAA,EAEA,MAAM,sBAAsB,QAA6C;AACrE,UAAM,WAAW,MAAM,KAAK,eAAe,sBAAsB,MAAM;AACvE,WAAO,mBAAmB,KAAK,QAAQ;AAAA,EAC3C;AAAA,EAEA,MAAM,oBACF,eACA,UACe;AACf,WAAO,KAAK,eAAe,oBAAoB,eAAe,QAAQ;AAAA,EAC1E;AAAA,EAEA,MAAM,gBAAgB,aAAgC,cAAoD;AAEtG,UAAM,MAAM,YAAY;AAExB,UAAM,WAAW,MAAM,KAAK,eAAe,gBAAgB,GAAG;AAC9D,WAAO,mBAAmB,KAAK,QAAQ;AAAA,EAC3C;AAAA,EAEA,MAAM,mBAAmB,SAA6B,OAA6C;AAC/F,UAAM,gBAAgB,QAAQ;AAC9B,UAAM,WAAW,MAAM,cAAc,KAAK;AAC1C,WAAO,mBAAmB,KAAK,QAAQ;AAAA,EAC3C;AAAA,EAEA,MAAM,eAAe,aAAgC,MAA4C;AAC7F,UAAM,UAAU,MAAM,KAAK,gBAAgB,aAAa,IAAI;AAC5D,WAAO,KAAK,mBAAmB,SAAS,IAAI;AAAA,EAChD;AACJ;;;AClGA,SAAS,UAAAA,eAAc;AAEvB;AAAA,EAEI,qBAAAC;AAAA,EAEA,sBAAAC;AAAA,EACA,sBAAAC;AAAA,OAEG;AAEA,IAAM,YAAN,MAAkC;AAAA,EAG7B,YAAY,QAAuB;AACvC,SAAK,eAAe;AAAA,EACxB;AAAA,EAEA,OAAO,KAAK,QAAgC,MAA0B;AAClE,QAAI,kBAAkBH,QAAO,QAAQ;AACjC,aAAO,IAAI,KAAK,MAAM;AAAA,IAC1B;AACA,QAAI,SAAS,QAAW;AACpB,aAAO,IAAI,KAAK,IAAIA,QAAO,OAAO,MAAM,CAAC;AAAA,IAC7C,OAAO;AACH,aAAO,IAAI,KAAKA,QAAO,OAAO,aAAa,QAAQ,IAAI,CAAC;AAAA,IAC5D;AAAA,EACJ;AAAA,EAEA,IAAI,SAAwB;AACxB,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,QAAQ,UAA0B;AAC9B,QAAI,EAAE,SAAS,kBAAkBA,QAAO,UAAU,WAAW;AACzD,YAAM,IAAI,MAAM,8CAA8C;AAAA,IAClE;AAEA,SAAK,eAAe,KAAK,aAAa,QAAQ,SAAS,MAAM;AAC7D,WAAO;AAAA,EACX;AAAA,EAEA,MAAM,aAA8B;AAChC,WAAO,KAAK,aAAa,WAAW;AAAA,EACxC;AAAA,EAEA,IAAI,UAAkB;AAClB,WAAQ,KAAK,aAAqD;AAAA,EACtE;AAAA,EAEA,MAAM,eACF,aACA,MAC2B;AAC3B,UAAM,UAAU,MAAM,KAAK,gBAAgB,WAAW;AACtD,UAAM,WAAW,QAAQ;AACzB,UAAM,UAAU,MAAM,SAAS,KAAK,MAAM,aAAa;AACvD,WAAOG,oBAAmB,KAAK,OAAO;AAAA,EAC1C;AAAA,EAEA,MAAM,gBAAgB,aAA6D;AAE/E,UAAM,MAAM,YAAY;AACxB,QAAI,KAAK,aAAa,aAAa,QAAW;AAC1C,YAAM,IAAI,MAAM,oCAAoC;AAAA,IACxD;AAEA,UAAM,WAAW,MAAM,KAAK,aAAa,SAAS,gBAAgB,GAAG;AACrE,WAAOD,oBAAmB,KAAK,QAAQ;AAAA,EAC3C;AAAA,EAEA,MAAM,gBAAgB,aAA6D;AAE/E,UAAM,KAAK,YAAY;AAEvB,UAAM,uBAAuB,MAAM,KAAK,aAAa,oBAAoB,EAAE;AAC3E,UAAM,WAAW,MAAM,KAAK,aAAa,gBAAgB,oBAAoB;AAC7E,WAAOD,mBAAkB,KAAK,QAAQ;AAAA,EAC1C;AAAA,EAEA,MAAM,WAAW,QAAyC;AACtD,UAAM,gBAAgB,MAAM,KAAK,aAAa,YAAY,MAAM;AAChE,WAAOD,QAAO,MAAM,SAAS,aAAa;AAAA,EAC9C;AAAA,EAEA,MAAM,iBAAiB,gBAAsD;AACzE,WAAO,QAAQ,OAAO,IAAI,MAAM,yBAAyB,CAAC;AAAA,EAC9D;AACJ","sourcesContent":["import { ethers } from 'ethers'\n\nimport {\n Block,\n BlockTag,\n BlockWithTransactions,\n Finality,\n Provider,\n SignedTransaction,\n TransactionPending,\n TransactionReceipt,\n TransactionResponse,\n} from '@layerzerolabs/lz-core'\n\nexport class EvmProvider implements Provider {\n nativeProvider: ethers.providers.JsonRpcProvider\n\n constructor(public url: string) {\n this.nativeProvider = new ethers.providers.JsonRpcProvider(url)\n }\n\n static from(url: string): EvmProvider\n\n static from(source: string): EvmProvider {\n if (typeof source === 'string') {\n return new EvmProvider(source)\n } else {\n throw new Error('Invalid parameters')\n }\n }\n\n get native(): ethers.providers.JsonRpcProvider {\n return this.nativeProvider\n }\n\n async getBalance(address: string): Promise<string> {\n return (await this.nativeProvider.getBalance(address)).toString()\n }\n\n async getBlock(blockTag: string \| number): Promise<Block> {\n const response = await this.nativeProvider.getBlock(blockTag)\n return Block.from(response)\n }\n\n async getBlockWithTransactions(blockTag: string \| number): Promise<BlockWithTransactions> {\n const response = await this.nativeProvider.getBlockWithTransactions(blockTag)\n return BlockWithTransactions.from(response)\n }\n\n async getBlockNumber(): Promise<number> {\n return this.nativeProvider.getBlockNumber()\n }\n\n // eslint-disable-next-line @typescript-eslint/require-await\n async getSlot(_finality?: Finality): Promise<number> {\n await Promise.resolve()\n throw new Error('Method not implemented.')\n }\n\n async getBlockTimestamp(blockTag: string \| number): Promise<number> {\n return this.nativeProvider.getBlock(blockTag).then((block) => block.timestamp)\n }\n\n async getTransaction(txHash: string): Promise<TransactionResponse> {\n const response = await this.nativeProvider.getTransaction(txHash)\n return TransactionResponse.from(response)\n }\n\n async getTransactionReceipt(txHash: string): Promise<TransactionReceipt> {\n const response = await this.nativeProvider.getTransactionReceipt(txHash)\n return TransactionReceipt.from(response)\n }\n\n async getTransactionCount(\n addressOrName: string \| Promise<string>,\n blockTag?: BlockTag \| Promise<BlockTag>\n ): Promise<number> {\n return this.nativeProvider.getTransactionCount(addressOrName, blockTag)\n }\n\n async sendTransaction(transaction: SignedTransaction, _sendOptions?: object): Promise<TransactionPending> {\n type NativeSignedTransaction = Parameters<typeof this.nativeProvider.sendTransaction>[0]\n const stx = transaction.signed as NativeSignedTransaction\n\n const response = await this.nativeProvider.sendTransaction(stx)\n return TransactionPending.from(response)\n }\n\n async confirmTransaction(pending: TransactionPending, _opts?: object): Promise<TransactionReceipt> {\n const nativePending = pending.pending as ethers.providers.TransactionResponse\n const response = await nativePending.wait()\n return TransactionReceipt.from(response)\n }\n\n async sendAndConfirm(transaction: SignedTransaction, opts?: object): Promise<TransactionReceipt> {\n const pending = await this.sendTransaction(transaction, opts)\n return this.confirmTransaction(pending, opts)\n }\n}\n","import { ethers } from 'ethers'\n\nimport {\n Provider,\n SignedTransaction,\n Signer,\n TransactionPending,\n TransactionReceipt,\n TransactionRequest,\n} from '@layerzerolabs/lz-core'\n\nexport class EvmSigner implements Signer {\n private nativeSigner: ethers.Signer\n\n private constructor(signer: ethers.Signer) {\n this.nativeSigner = signer\n }\n\n static from(source: ethers.Signer \| string, path?: string): EvmSigner {\n if (source instanceof ethers.Signer) {\n return new this(source)\n }\n if (path === undefined) {\n return new this(new ethers.Wallet(source))\n } else {\n return new this(ethers.Wallet.fromMnemonic(source, path))\n }\n }\n\n get native(): ethers.Signer {\n return this.nativeSigner\n }\n\n connect(provider: Provider): this {\n if (!(provider.native instanceof ethers.providers.Provider)) {\n throw new Error('Only ethers.providers.Provider is supported.')\n }\n\n this.nativeSigner = this.nativeSigner.connect(provider.native)\n return this\n }\n\n async getAddress(): Promise<string> {\n return this.nativeSigner.getAddress()\n }\n\n get address(): string {\n return (this.nativeSigner as ethers.Signer & { address: string }).address\n }\n\n async sendAndConfirm(\n transaction: SignedTransaction,\n opts?: { confirmations?: number }\n ): Promise<TransactionReceipt> {\n const pending = await this.sendTransaction(transaction)\n const response = pending.pending as ethers.providers.TransactionResponse\n const receipt = await response.wait(opts?.confirmations)\n return TransactionReceipt.from(receipt)\n }\n\n async sendTransaction(transaction: SignedTransaction): Promise<TransactionPending> {\n type NativeSignedTransaction = Parameters<ethers.providers.Provider['sendTransaction']>[0]\n const stx = transaction.signed as NativeSignedTransaction\n if (this.nativeSigner.provider === undefined) {\n throw new Error('No provider attached to the signer')\n }\n\n const response = await this.nativeSigner.provider.sendTransaction(stx)\n return TransactionPending.from(response)\n }\n\n async signTransaction(transaction: TransactionRequest): Promise<SignedTransaction> {\n type NativeTransactionRequest = Parameters<ethers.Signer['populateTransaction']>[0]\n const tx = transaction.request as NativeTransactionRequest\n\n const populatedTransaction = await this.nativeSigner.populateTransaction(tx)\n const response = await this.nativeSigner.signTransaction(populatedTransaction)\n return SignedTransaction.from(response)\n }\n\n async signBuffer(buffer: Uint8Array): Promise<Uint8Array> {\n const signedMessage = await this.nativeSigner.signMessage(buffer)\n return ethers.utils.arrayify(signedMessage)\n }\n\n async buildTransaction(buildTxRequest: unknown): Promise<TransactionRequest> {\n return Promise.reject(new Error('Method not implemented.'))\n }\n}\n"]}
1	+ {"version":3,"sources":["../src/providers/evm.ts","../src/signers/evm.ts"],"names":["ethers","SignedTransaction","TransactionPending","TransactionReceipt"],"mappings":";AAAA,SAAS,cAAc;AAEvB;AAAA,EACI;AAAA,EAEA;AAAA,EAIA;AAAA,EACA;AAAA,EACA;AAAA,OACG;AAMA,IAAM,cAAN,MAAM,aAAgC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQzC,YAAmB,KAAa;AAAb;AACf,SAAK,iBAAiB,IAAI,OAAO,UAAU,gBAAgB,GAAG;AAAA,EAClE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBA,OAAO,KAAK,QAA6B;AACrC,QAAI,OAAO,WAAW,UAAU;AAC5B,aAAO,IAAI,aAAY,MAAM;AAAA,IACjC,OAAO;AACH,YAAM,IAAI,MAAM,oBAAoB;AAAA,IACxC;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAI,SAA2C;AAC3C,WAAO,KAAK;AAAA,EAChB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,WAAW,SAAkC;AAC/C,YAAQ,MAAM,KAAK,eAAe,WAAW,OAAO,GAAG,SAAS;AAAA,EACpE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,SAAS,UAA2C;AACtD,UAAM,WAAW,MAAM,KAAK,eAAe,SAAS,QAAQ;AAC5D,WAAO,MAAM,KAAK,QAAQ;AAAA,EAC9B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,yBAAyB,UAA2D;AACtF,UAAM,WAAW,MAAM,KAAK,eAAe,yBAAyB,QAAQ;AAC5E,WAAO,sBAAsB,KAAK,QAAQ;AAAA,EAC9C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,iBAAkC;AACpC,WAAO,KAAK,eAAe,eAAe;AAAA,EAC9C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAM,QAAQ,WAAuC;AACjD,UAAM,QAAQ,QAAQ;AACtB,UAAM,IAAI,MAAM,yBAAyB;AAAA,EAC7C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,kBAAkB,UAA4C;AAChE,WAAO,KAAK,eAAe,SAAS,QAAQ,EAAE,KAAK,CAAC,UAAU,MAAM,SAAS;AAAA,EACjF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,eAAe,QAA8C;AAC/D,UAAM,WAAW,MAAM,KAAK,eAAe,eAAe,MAAM;AAChE,WAAO,oBAAoB,KAAK,QAAQ;AAAA,EAC5C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,sBAAsB,QAA6C;AACrE,UAAM,WAAW,MAAM,KAAK,eAAe,sBAAsB,MAAM;AACvE,WAAO,mBAAmB,KAAK,QAAQ;AAAA,EAC3C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,oBACF,eACA,UACe;AACf,WAAO,KAAK,eAAe,oBAAoB,eAAe,QAAQ;AAAA,EAC1E;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,gBAAgB,aAAgC,cAAoD;AAEtG,UAAM,MAAM,YAAY;AAExB,UAAM,WAAW,MAAM,KAAK,eAAe,gBAAgB,GAAG;AAC9D,WAAO,mBAAmB,KAAK,QAAQ;AAAA,EAC3C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,mBAAmB,SAA6B,OAA6C;AAC/F,UAAM,gBAAgB,QAAQ;AAC9B,UAAM,WAAW,MAAM,cAAc,KAAK;AAC1C,WAAO,mBAAmB,KAAK,QAAQ;AAAA,EAC3C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,eAAe,aAAgC,MAA4C;AAC7F,UAAM,UAAU,MAAM,KAAK,gBAAgB,aAAa,IAAI;AAC5D,WAAO,KAAK,mBAAmB,SAAS,IAAI;AAAA,EAChD;AACJ;;;ACzMA,SAAS,UAAAA,eAAc;AAEvB;AAAA,EAEI,qBAAAC;AAAA,EAEA,sBAAAC;AAAA,EACA,sBAAAC;AAAA,OAEG;AAMA,IAAM,YAAN,MAAkC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ7B,YAAY,QAAuB;AACvC,SAAK,eAAe;AAAA,EACxB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,OAAO,KAAK,QAAgC,MAA0B;AAClE,QAAI,kBAAkBH,QAAO,QAAQ;AACjC,aAAO,IAAI,KAAK,MAAM;AAAA,IAC1B;AACA,QAAI,SAAS,QAAW;AACpB,aAAO,IAAI,KAAK,IAAIA,QAAO,OAAO,MAAM,CAAC;AAAA,IAC7C,OAAO;AACH,aAAO,IAAI,KAAKA,QAAO,OAAO,aAAa,QAAQ,IAAI,CAAC;AAAA,IAC5D;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAI,SAAwB;AACxB,WAAO,KAAK;AAAA,EAChB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,QAAQ,UAA0B;AAC9B,QAAI,EAAE,SAAS,kBAAkBA,QAAO,UAAU,WAAW;AACzD,YAAM,IAAI,MAAM,8CAA8C;AAAA,IAClE;AAEA,SAAK,eAAe,KAAK,aAAa,QAAQ,SAAS,MAAM;AAC7D,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,aAA8B;AAChC,WAAO,KAAK,aAAa,WAAW;AAAA,EACxC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAI,UAAkB;AAClB,WAAQ,KAAK,aAAqD;AAAA,EACtE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,eACF,aACA,MAC2B;AAC3B,UAAM,UAAU,MAAM,KAAK,gBAAgB,WAAW;AACtD,UAAM,WAAW,QAAQ;AACzB,UAAM,UAAU,MAAM,SAAS,KAAK,MAAM,aAAa;AACvD,WAAOG,oBAAmB,KAAK,OAAO;AAAA,EAC1C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,gBAAgB,aAA6D;AAE/E,UAAM,MAAM,YAAY;AACxB,QAAI,KAAK,aAAa,aAAa,QAAW;AAC1C,YAAM,IAAI,MAAM,oCAAoC;AAAA,IACxD;AAEA,UAAM,WAAW,MAAM,KAAK,aAAa,SAAS,gBAAgB,GAAG;AACrE,WAAOD,oBAAmB,KAAK,QAAQ;AAAA,EAC3C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,gBAAgB,aAA6D;AAE/E,UAAM,KAAK,YAAY;AAEvB,UAAM,uBAAuB,MAAM,KAAK,aAAa,oBAAoB,EAAE;AAC3E,UAAM,WAAW,MAAM,KAAK,aAAa,gBAAgB,oBAAoB;AAC7E,WAAOD,mBAAkB,KAAK,QAAQ;AAAA,EAC1C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,WAAW,QAAyC;AACtD,UAAM,gBAAgB,MAAM,KAAK,aAAa,YAAY,MAAM;AAChE,WAAOD,QAAO,MAAM,SAAS,aAAa;AAAA,EAC9C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,iBAAiB,gBAAsD;AACzE,WAAO,QAAQ,OAAO,IAAI,MAAM,yBAAyB,CAAC;AAAA,EAC9D;AACJ","sourcesContent":["import { ethers } from 'ethers'\n\nimport {\n Block,\n BlockTag,\n BlockWithTransactions,\n Finality,\n Provider,\n SignedTransaction,\n TransactionPending,\n TransactionReceipt,\n TransactionResponse,\n} from '@layerzerolabs/lz-core'\n\n/*\n Represents an EVM (Ethereum Virtual Machine) blockchain provider.\n * Implements the Provider interface for interacting with EVM-compatible blockchains.\n /\nexport class EvmProvider implements Provider {\n nativeProvider: ethers.providers.JsonRpcProvider\n\n /\n Creates an instance of EvmProvider.\n \n @param {string} url - The URL of the EVM node.\n /\n constructor(public url: string) {\n this.nativeProvider = new ethers.providers.JsonRpcProvider(url)\n }\n\n /\n Creates an instance of EvmProvider from the given URL.\n \n @param {string} url - The URL of the EVM node.\n * @returns {EvmProvider} The created EvmProvider instance.\n /\n static from(url: string): EvmProvider\n\n /\n Creates an instance of EvmProvider from the given source.\n \n @param {string} source - The source to create the provider from.\n * @returns {EvmProvider} The created EvmProvider instance.\n * @throws {Error} If the source parameter is not a string.\n /\n static from(source: string): EvmProvider {\n if (typeof source === 'string') {\n return new EvmProvider(source)\n } else {\n throw new Error('Invalid parameters')\n }\n }\n\n /\n Gets the native EVM provider instance.\n \n @returns {ethers.providers.JsonRpcProvider} The native EVM provider instance.\n /\n get native(): ethers.providers.JsonRpcProvider {\n return this.nativeProvider\n }\n\n /\n Gets the balance of the specified address.\n \n @param {string} address - The address to get the balance of.\n * @returns {Promise<string>} A promise that resolves to the balance of the address.\n /\n async getBalance(address: string): Promise<string> {\n return (await this.nativeProvider.getBalance(address)).toString()\n }\n\n /\n Gets the block specified by blockTag.\n \n @param {BlockTag} blockTag - The block tag to specify the block.\n * @returns {Promise<Block>} A promise that resolves to the block.\n /\n async getBlock(blockTag: string \| number): Promise<Block> {\n const response = await this.nativeProvider.getBlock(blockTag)\n return Block.from(response)\n }\n\n /\n Gets the block with transactions specified by blockTag.\n \n @param {BlockTag} blockTag - The block tag to specify the block.\n * @returns {Promise<BlockWithTransactions>} A promise that resolves to the block with transactions.\n /\n async getBlockWithTransactions(blockTag: string \| number): Promise<BlockWithTransactions> {\n const response = await this.nativeProvider.getBlockWithTransactions(blockTag)\n return BlockWithTransactions.from(response)\n }\n\n /\n Gets the current block number.\n \n @returns {Promise<number>} A promise that resolves to the current block number.\n /\n async getBlockNumber(): Promise<number> {\n return this.nativeProvider.getBlockNumber()\n }\n\n /\n Gets the current slot number for commitment, not suitable for EVM.\n \n @param {Finality} [finality] - The commitment level (optional).\n * @returns {Promise<number>} A promise that resolves to the current slot number.\n * @throws {Error} Method not implemented.\n /\n // eslint-disable-next-line @typescript-eslint/require-await\n async getSlot(_finality?: Finality): Promise<number> {\n await Promise.resolve()\n throw new Error('Method not implemented.')\n }\n\n /\n Gets the UNIX timestamp for the block identified by blockTag.\n \n @param {BlockTag} blockTag - The block tag to specify the block.\n * @returns {Promise<number>} A promise that resolves to the UNIX timestamp of the block.\n /\n async getBlockTimestamp(blockTag: string \| number): Promise<number> {\n return this.nativeProvider.getBlock(blockTag).then((block) => block.timestamp)\n }\n\n /\n Gets information about a transaction.\n \n @param {string} txHash - The hash of the transaction.\n * @returns {Promise<TransactionResponse>} A promise that resolves to the transaction response.\n /\n async getTransaction(txHash: string): Promise<TransactionResponse> {\n const response = await this.nativeProvider.getTransaction(txHash)\n return TransactionResponse.from(response)\n }\n\n /\n Gets the receipt of a transaction.\n \n @param {string} txHash - The hash of the transaction.\n * @returns {Promise<TransactionReceipt>} A promise that resolves to the transaction receipt.\n /\n async getTransactionReceipt(txHash: string): Promise<TransactionReceipt> {\n const response = await this.nativeProvider.getTransactionReceipt(txHash)\n return TransactionReceipt.from(response)\n }\n\n /\n Gets the number of transactions sent from the specified address.\n \n @param {string \| Promise<string>} addressOrName - The address to get the number of transactions from.\n * @param {BlockTag \| Promise<BlockTag>} [blockTag] - The block tag to get the number of transactions from (optional).\n * @returns {Promise<number>} A promise that resolves to the number of transactions sent from the address.\n /\n async getTransactionCount(\n addressOrName: string \| Promise<string>,\n blockTag?: BlockTag \| Promise<BlockTag>\n ): Promise<number> {\n return this.nativeProvider.getTransactionCount(addressOrName, blockTag)\n }\n\n /\n Sends a signed transaction to the blockchain.\n \n @param {SignedTransaction} transaction - The signed transaction to send.\n * @param {object} [sendOptions] - Optional parameters for sending the transaction.\n * @returns {Promise<TransactionPending>} A promise that resolves to the pending transaction.\n /\n async sendTransaction(transaction: SignedTransaction, _sendOptions?: object): Promise<TransactionPending> {\n type NativeSignedTransaction = Parameters<typeof this.nativeProvider.sendTransaction>[0]\n const stx = transaction.signed as NativeSignedTransaction\n\n const response = await this.nativeProvider.sendTransaction(stx)\n return TransactionPending.from(response)\n }\n\n /\n Confirms a pending transaction.\n \n @param {TransactionPending} pending - The pending transaction to confirm.\n * @param {object} [opts] - Optional parameters for the confirmation.\n * @returns {Promise<TransactionReceipt>} A promise that resolves to the transaction receipt.\n /\n async confirmTransaction(pending: TransactionPending, _opts?: object): Promise<TransactionReceipt> {\n const nativePending = pending.pending as ethers.providers.TransactionResponse\n const response = await nativePending.wait()\n return TransactionReceipt.from(response)\n }\n\n /\n Sends a signed transaction and waits for confirmation.\n \n @param {SignedTransaction} transaction - The signed transaction to send.\n * @param {object} [opts] - Optional parameters for sending and confirming the transaction.\n * @returns {Promise<TransactionReceipt>} A promise that resolves to the transaction receipt.\n /\n async sendAndConfirm(transaction: SignedTransaction, opts?: object): Promise<TransactionReceipt> {\n const pending = await this.sendTransaction(transaction, opts)\n return this.confirmTransaction(pending, opts)\n }\n}\n","import { ethers } from 'ethers'\n\nimport {\n Provider,\n SignedTransaction,\n Signer,\n TransactionPending,\n TransactionReceipt,\n TransactionRequest,\n} from '@layerzerolabs/lz-core'\n\n/\n Represents an EVM (Ethereum Virtual Machine) blockchain signer.\n * Implements the Signer interface for interacting with EVM-compatible blockchains.\n /\nexport class EvmSigner implements Signer {\n private nativeSigner: ethers.Signer\n\n /\n Creates an instance of EvmSigner.\n \n @param {ethers.Signer} signer - The EVM signer to use.\n /\n private constructor(signer: ethers.Signer) {\n this.nativeSigner = signer\n }\n\n /\n Creates an instance of EvmSigner from the given source.\n \n @param {ethers.Signer \| string} source - The source to create the signer from.\n * @param {string} [path] - The derivation path (optional).\n * @returns {EvmSigner} The created EvmSigner instance.\n * @throws {Error} If the source parameter is invalid.\n /\n static from(source: ethers.Signer \| string, path?: string): EvmSigner {\n if (source instanceof ethers.Signer) {\n return new this(source)\n }\n if (path === undefined) {\n return new this(new ethers.Wallet(source))\n } else {\n return new this(ethers.Wallet.fromMnemonic(source, path))\n }\n }\n\n /\n Gets the native EVM signer instance.\n \n @returns {ethers.Signer} The native EVM signer instance.\n /\n get native(): ethers.Signer {\n return this.nativeSigner\n }\n\n /\n Connects the signer to a provider.\n \n @param {Provider} provider - The provider to connect to.\n * @returns {this} The connected signer.\n * @throws {Error} If the provider is not an instance of ethers.providers.Provider.\n /\n connect(provider: Provider): this {\n if (!(provider.native instanceof ethers.providers.Provider)) {\n throw new Error('Only ethers.providers.Provider is supported.')\n }\n\n this.nativeSigner = this.nativeSigner.connect(provider.native)\n return this\n }\n\n /\n Gets the address of the signer.\n \n @returns {Promise<string>} A promise that resolves to the address of the signer.\n /\n async getAddress(): Promise<string> {\n return this.nativeSigner.getAddress()\n }\n\n /\n Gets the address of the signer.\n \n @returns {string} The address of the signer.\n /\n get address(): string {\n return (this.nativeSigner as ethers.Signer & { address: string }).address\n }\n\n /\n Sends a signed transaction and waits for confirmation.\n \n @param {SignedTransaction} transaction - The signed transaction to send.\n * @param {object} [opts] - Optional parameters for sending and confirming the transaction.\n * @returns {Promise<TransactionReceipt>} A promise that resolves to the transaction receipt.\n /\n async sendAndConfirm(\n transaction: SignedTransaction,\n opts?: { confirmations?: number }\n ): Promise<TransactionReceipt> {\n const pending = await this.sendTransaction(transaction)\n const response = pending.pending as ethers.providers.TransactionResponse\n const receipt = await response.wait(opts?.confirmations)\n return TransactionReceipt.from(receipt)\n }\n\n /\n Sends a signed transaction.\n \n @param {SignedTransaction} transaction - The signed transaction to send.\n * @returns {Promise<TransactionPending>} A promise that resolves to the pending transaction.\n * @throws {Error} If no provider is attached to the signer.\n /\n async sendTransaction(transaction: SignedTransaction): Promise<TransactionPending> {\n type NativeSignedTransaction = Parameters<ethers.providers.Provider['sendTransaction']>[0]\n const stx = transaction.signed as NativeSignedTransaction\n if (this.nativeSigner.provider === undefined) {\n throw new Error('No provider attached to the signer')\n }\n\n const response = await this.nativeSigner.provider.sendTransaction(stx)\n return TransactionPending.from(response)\n }\n\n /\n Signs 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 async signTransaction(transaction: TransactionRequest): Promise<SignedTransaction> {\n type NativeTransactionRequest = Parameters<ethers.Signer['populateTransaction']>[0]\n const tx = transaction.request as NativeTransactionRequest\n\n const populatedTransaction = await this.nativeSigner.populateTransaction(tx)\n const response = await this.nativeSigner.signTransaction(populatedTransaction)\n return SignedTransaction.from(response)\n }\n\n /\n Signs a buffer (e.g., a message hash) using the native EVM signer.\n \n @param {Uint8Array} buffer - The buffer to sign.\n * @returns {Promise<Uint8Array>} A promise that resolves to the signed buffer as a Uint8Array.\n /\n async signBuffer(buffer: Uint8Array): Promise<Uint8Array> {\n const signedMessage = await this.nativeSigner.signMessage(buffer)\n return ethers.utils.arrayify(signedMessage)\n }\n\n /\n Builds a transaction.\n \n @param {unknown} buildTxRequest - The transaction request to build.\n * @returns {Promise<TransactionRequest>} A promise that resolves to the built transaction request.\n * @throws {Error} Method not implemented.\n */\n async buildTransaction(buildTxRequest: unknown): Promise<TransactionRequest> {\n return Promise.reject(new Error('Method not implemented.'))\n }\n}\n"]}

package/dist/index.d.mts CHANGED Viewed

@@ -1,40 +1,208 @@
 import { ethers } from 'ethers';
 import { Provider, Block, BlockWithTransactions, Finality, TransactionResponse, TransactionReceipt, BlockTag, SignedTransaction, TransactionPending, Signer, TransactionRequest } from '@layerzerolabs/lz-core';
+/**
+ * Represents an EVM (Ethereum Virtual Machine) blockchain provider.
+ * Implements the Provider interface for interacting with EVM-compatible blockchains.
+ */
 declare class EvmProvider implements Provider {
     url: string;
     nativeProvider: ethers.providers.JsonRpcProvider;
+    /**
+     * Creates an instance of EvmProvider.
+     *
+     * @param {string} url - The URL of the EVM node.
+     */
     constructor(url: string);
+    /**
+     * Creates an instance of EvmProvider from the given URL.
+     *
+     * @param {string} url - The URL of the EVM node.
+     * @returns {EvmProvider} The created EvmProvider instance.
+     */
     static from(url: string): EvmProvider;
+    /**
+     * Gets the native EVM provider instance.
+     *
+     * @returns {ethers.providers.JsonRpcProvider} The native EVM provider instance.
+     */
     get native(): ethers.providers.JsonRpcProvider;
+    /**
+     * Gets the balance of the specified 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 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: string | number): Promise<Block>;
+    /**
+     * Gets 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: string | number): Promise<BlockWithTransactions>;
+    /**
+     * Gets the current block number.
+     *
+     * @returns {Promise<number>} A promise that resolves to the current block number.
+     */
     getBlockNumber(): Promise<number>;
+    /**
+     * Gets the current slot number for commitment, not suitable for EVM.
+     *
+     * @param {Finality} [finality] - The commitment level (optional).
+     * @returns {Promise<number>} A promise that resolves to the current slot number.
+     * @throws {Error} Method not implemented.
+     */
     getSlot(_finality?: Finality): Promise<number>;
+    /**
+     * Gets the UNIX timestamp for the block identified by blockTag.
+     *
+     * @param {BlockTag} blockTag - The block tag to specify the block.
+     * @returns {Promise<number>} A promise that resolves to the UNIX timestamp of the block.
+     */
     getBlockTimestamp(blockTag: string | number): Promise<number>;
+    /**
+     * Gets 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>;
+    /**
+     * Gets 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>;
+    /**
+     * Gets the number of transactions sent from the specified 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 (optional).
+     * @returns {Promise<number>} A promise that resolves to the number of transactions sent from the address.
+     */
     getTransactionCount(addressOrName: string | Promise<string>, blockTag?: BlockTag | Promise<BlockTag>): Promise<number>;
+    /**
+     * Sends a signed transaction to the blockchain.
+     *
+     * @param {SignedTransaction} transaction - The signed transaction to send.
+     * @param {object} [sendOptions] - Optional parameters for sending the transaction.
+     * @returns {Promise<TransactionPending>} A promise that resolves to the pending transaction.
+     */
     sendTransaction(transaction: SignedTransaction, _sendOptions?: object): Promise<TransactionPending>;
+    /**
+     * Confirms a pending transaction.
+     *
+     * @param {TransactionPending} pending - The pending transaction to confirm.
+     * @param {object} [opts] - Optional parameters for the confirmation.
+     * @returns {Promise<TransactionReceipt>} A promise that resolves to the transaction receipt.
+     */
     confirmTransaction(pending: TransactionPending, _opts?: object): Promise<TransactionReceipt>;
+    /**
+     * Sends a signed transaction and waits for confirmation.
+     *
+     * @param {SignedTransaction} transaction - The signed transaction to send.
+     * @param {object} [opts] - Optional parameters for sending and confirming the transaction.
+     * @returns {Promise<TransactionReceipt>} A promise that resolves to the transaction receipt.
+     */
     sendAndConfirm(transaction: SignedTransaction, opts?: object): Promise<TransactionReceipt>;
 }
+/**
+ * Represents an EVM (Ethereum Virtual Machine) blockchain signer.
+ * Implements the Signer interface for interacting with EVM-compatible blockchains.
+ */
 declare class EvmSigner implements Signer {
     private nativeSigner;
+    /**
+     * Creates an instance of EvmSigner.
+     *
+     * @param {ethers.Signer} signer - The EVM signer to use.
+     */
     private constructor();
+    /**
+     * Creates an instance of EvmSigner from the given source.
+     *
+     * @param {ethers.Signer | string} source - The source to create the signer from.
+     * @param {string} [path] - The derivation path (optional).
+     * @returns {EvmSigner} The created EvmSigner instance.
+     * @throws {Error} If the source parameter is invalid.
+     */
     static from(source: ethers.Signer | string, path?: string): EvmSigner;
+    /**
+     * Gets the native EVM signer instance.
+     *
+     * @returns {ethers.Signer} The native EVM signer instance.
+     */
     get native(): ethers.Signer;
+    /**
+     * Connects the signer to a provider.
+     *
+     * @param {Provider} provider - The provider to connect to.
+     * @returns {this} The connected signer.
+     * @throws {Error} If the provider is not an instance of ethers.providers.Provider.
+     */
     connect(provider: Provider): this;
+    /**
+     * Gets the address of the signer.
+     *
+     * @returns {Promise<string>} A promise that resolves to the address of the signer.
+     */
     getAddress(): Promise<string>;
+    /**
+     * Gets the address of the signer.
+     *
+     * @returns {string} The address of the signer.
+     */
     get address(): string;
+    /**
+     * Sends a signed transaction and waits for confirmation.
+     *
+     * @param {SignedTransaction} transaction - The signed transaction to send.
+     * @param {object} [opts] - Optional parameters for sending and confirming the transaction.
+     * @returns {Promise<TransactionReceipt>} A promise that resolves to the transaction receipt.
+     */
     sendAndConfirm(transaction: SignedTransaction, opts?: {
         confirmations?: number;
     }): Promise<TransactionReceipt>;
+    /**
+     * Sends a signed transaction.
+     *
+     * @param {SignedTransaction} transaction - The signed transaction to send.
+     * @returns {Promise<TransactionPending>} A promise that resolves to the pending transaction.
+     * @throws {Error} If no provider is attached to the signer.
+     */
     sendTransaction(transaction: SignedTransaction): Promise<TransactionPending>;
+    /**
+     * Signs 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>;
+    /**
+     * Signs a buffer (e.g., a message hash) using the native EVM signer.
+     *
+     * @param {Uint8Array} buffer - The buffer to sign.
+     * @returns {Promise<Uint8Array>} A promise that resolves to the signed buffer as a Uint8Array.
+     */
     signBuffer(buffer: Uint8Array): Promise<Uint8Array>;
+    /**
+     * Builds a transaction.
+     *
+     * @param {unknown} buildTxRequest - The transaction request to build.
+     * @returns {Promise<TransactionRequest>} A promise that resolves to the built transaction request.
+     * @throws {Error} Method not implemented.
+     */
     buildTransaction(buildTxRequest: unknown): Promise<TransactionRequest>;
 }

package/dist/index.d.ts CHANGED Viewed

@@ -1,40 +1,208 @@
 import { ethers } from 'ethers';
 import { Provider, Block, BlockWithTransactions, Finality, TransactionResponse, TransactionReceipt, BlockTag, SignedTransaction, TransactionPending, Signer, TransactionRequest } from '@layerzerolabs/lz-core';
+/**
+ * Represents an EVM (Ethereum Virtual Machine) blockchain provider.
+ * Implements the Provider interface for interacting with EVM-compatible blockchains.
+ */
 declare class EvmProvider implements Provider {
     url: string;
     nativeProvider: ethers.providers.JsonRpcProvider;
+    /**
+     * Creates an instance of EvmProvider.
+     *
+     * @param {string} url - The URL of the EVM node.
+     */
     constructor(url: string);
+    /**
+     * Creates an instance of EvmProvider from the given URL.
+     *
+     * @param {string} url - The URL of the EVM node.
+     * @returns {EvmProvider} The created EvmProvider instance.
+     */
     static from(url: string): EvmProvider;
+    /**
+     * Gets the native EVM provider instance.
+     *
+     * @returns {ethers.providers.JsonRpcProvider} The native EVM provider instance.
+     */
     get native(): ethers.providers.JsonRpcProvider;
+    /**
+     * Gets the balance of the specified 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 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: string | number): Promise<Block>;
+    /**
+     * Gets 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: string | number): Promise<BlockWithTransactions>;
+    /**
+     * Gets the current block number.
+     *
+     * @returns {Promise<number>} A promise that resolves to the current block number.
+     */
     getBlockNumber(): Promise<number>;
+    /**
+     * Gets the current slot number for commitment, not suitable for EVM.
+     *
+     * @param {Finality} [finality] - The commitment level (optional).
+     * @returns {Promise<number>} A promise that resolves to the current slot number.
+     * @throws {Error} Method not implemented.
+     */
     getSlot(_finality?: Finality): Promise<number>;
+    /**
+     * Gets the UNIX timestamp for the block identified by blockTag.
+     *
+     * @param {BlockTag} blockTag - The block tag to specify the block.
+     * @returns {Promise<number>} A promise that resolves to the UNIX timestamp of the block.
+     */
     getBlockTimestamp(blockTag: string | number): Promise<number>;
+    /**
+     * Gets 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>;
+    /**
+     * Gets 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>;
+    /**
+     * Gets the number of transactions sent from the specified 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 (optional).
+     * @returns {Promise<number>} A promise that resolves to the number of transactions sent from the address.
+     */
     getTransactionCount(addressOrName: string | Promise<string>, blockTag?: BlockTag | Promise<BlockTag>): Promise<number>;
+    /**
+     * Sends a signed transaction to the blockchain.
+     *
+     * @param {SignedTransaction} transaction - The signed transaction to send.
+     * @param {object} [sendOptions] - Optional parameters for sending the transaction.
+     * @returns {Promise<TransactionPending>} A promise that resolves to the pending transaction.
+     */
     sendTransaction(transaction: SignedTransaction, _sendOptions?: object): Promise<TransactionPending>;
+    /**
+     * Confirms a pending transaction.
+     *
+     * @param {TransactionPending} pending - The pending transaction to confirm.
+     * @param {object} [opts] - Optional parameters for the confirmation.
+     * @returns {Promise<TransactionReceipt>} A promise that resolves to the transaction receipt.
+     */
     confirmTransaction(pending: TransactionPending, _opts?: object): Promise<TransactionReceipt>;
+    /**
+     * Sends a signed transaction and waits for confirmation.
+     *
+     * @param {SignedTransaction} transaction - The signed transaction to send.
+     * @param {object} [opts] - Optional parameters for sending and confirming the transaction.
+     * @returns {Promise<TransactionReceipt>} A promise that resolves to the transaction receipt.
+     */
     sendAndConfirm(transaction: SignedTransaction, opts?: object): Promise<TransactionReceipt>;
 }
+/**
+ * Represents an EVM (Ethereum Virtual Machine) blockchain signer.
+ * Implements the Signer interface for interacting with EVM-compatible blockchains.
+ */
 declare class EvmSigner implements Signer {
     private nativeSigner;
+    /**
+     * Creates an instance of EvmSigner.
+     *
+     * @param {ethers.Signer} signer - The EVM signer to use.
+     */
     private constructor();
+    /**
+     * Creates an instance of EvmSigner from the given source.
+     *
+     * @param {ethers.Signer | string} source - The source to create the signer from.
+     * @param {string} [path] - The derivation path (optional).
+     * @returns {EvmSigner} The created EvmSigner instance.
+     * @throws {Error} If the source parameter is invalid.
+     */
     static from(source: ethers.Signer | string, path?: string): EvmSigner;
+    /**
+     * Gets the native EVM signer instance.
+     *
+     * @returns {ethers.Signer} The native EVM signer instance.
+     */
     get native(): ethers.Signer;
+    /**
+     * Connects the signer to a provider.
+     *
+     * @param {Provider} provider - The provider to connect to.
+     * @returns {this} The connected signer.
+     * @throws {Error} If the provider is not an instance of ethers.providers.Provider.
+     */
     connect(provider: Provider): this;
+    /**
+     * Gets the address of the signer.
+     *
+     * @returns {Promise<string>} A promise that resolves to the address of the signer.
+     */
     getAddress(): Promise<string>;
+    /**
+     * Gets the address of the signer.
+     *
+     * @returns {string} The address of the signer.
+     */
     get address(): string;
+    /**
+     * Sends a signed transaction and waits for confirmation.
+     *
+     * @param {SignedTransaction} transaction - The signed transaction to send.
+     * @param {object} [opts] - Optional parameters for sending and confirming the transaction.
+     * @returns {Promise<TransactionReceipt>} A promise that resolves to the transaction receipt.
+     */
     sendAndConfirm(transaction: SignedTransaction, opts?: {
         confirmations?: number;
     }): Promise<TransactionReceipt>;
+    /**
+     * Sends a signed transaction.
+     *
+     * @param {SignedTransaction} transaction - The signed transaction to send.
+     * @returns {Promise<TransactionPending>} A promise that resolves to the pending transaction.
+     * @throws {Error} If no provider is attached to the signer.
+     */
     sendTransaction(transaction: SignedTransaction): Promise<TransactionPending>;
+    /**
+     * Signs 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>;
+    /**
+     * Signs a buffer (e.g., a message hash) using the native EVM signer.
+     *
+     * @param {Uint8Array} buffer - The buffer to sign.
+     * @returns {Promise<Uint8Array>} A promise that resolves to the signed buffer as a Uint8Array.
+     */
     signBuffer(buffer: Uint8Array): Promise<Uint8Array>;
+    /**
+     * Builds a transaction.
+     *
+     * @param {unknown} buildTxRequest - The transaction request to build.
+     * @returns {Promise<TransactionRequest>} A promise that resolves to the built transaction request.
+     * @throws {Error} Method not implemented.
+     */
     buildTransaction(buildTxRequest: unknown): Promise<TransactionRequest>;
 }

package/dist/index.mjs CHANGED Viewed

@@ -3,10 +3,22 @@ import { Block, BlockWithTransactions, TransactionResponse, TransactionReceipt,
 // src/providers/evm.ts
 var EvmProvider = class _EvmProvider {
+  /**
+   * Creates an instance of EvmProvider.
+   *
+   * @param {string} url - The URL of the EVM node.
+   */
   constructor(url) {
     this.url = url;
     this.nativeProvider = new ethers.providers.JsonRpcProvider(url);
   }
+  /**
+   * Creates an instance of EvmProvider from the given source.
+   *
+   * @param {string} source - The source to create the provider from.
+   * @returns {EvmProvider} The created EvmProvider instance.
+   * @throws {Error} If the source parameter is not a string.
+   */
   static from(source) {
     if (typeof source === "string") {
       return new _EvmProvider(source);
@@ -14,61 +26,155 @@ var EvmProvider = class _EvmProvider {
       throw new Error("Invalid parameters");
     }
   }
+  /**
+   * Gets the native EVM provider instance.
+   *
+   * @returns {ethers.providers.JsonRpcProvider} The native EVM provider instance.
+   */
   get native() {
     return this.nativeProvider;
   }
+  /**
+   * Gets the balance of the specified address.
+   *
+   * @param {string} address - The address to get the balance of.
+   * @returns {Promise<string>} A promise that resolves to the balance of the address.
+   */
   async getBalance(address) {
     return (await this.nativeProvider.getBalance(address)).toString();
   }
+  /**
+   * Gets 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.
+   */
   async getBlock(blockTag) {
     const response = await this.nativeProvider.getBlock(blockTag);
     return Block.from(response);
   }
+  /**
+   * Gets 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.
+   */
   async getBlockWithTransactions(blockTag) {
     const response = await this.nativeProvider.getBlockWithTransactions(blockTag);
     return BlockWithTransactions.from(response);
   }
+  /**
+   * Gets the current block number.
+   *
+   * @returns {Promise<number>} A promise that resolves to the current block number.
+   */
   async getBlockNumber() {
     return this.nativeProvider.getBlockNumber();
   }
+  /**
+   * Gets the current slot number for commitment, not suitable for EVM.
+   *
+   * @param {Finality} [finality] - The commitment level (optional).
+   * @returns {Promise<number>} A promise that resolves to the current slot number.
+   * @throws {Error} Method not implemented.
+   */
   // eslint-disable-next-line @typescript-eslint/require-await
   async getSlot(_finality) {
     await Promise.resolve();
     throw new Error("Method not implemented.");
   }
+  /**
+   * Gets the UNIX timestamp for the block identified by blockTag.
+   *
+   * @param {BlockTag} blockTag - The block tag to specify the block.
+   * @returns {Promise<number>} A promise that resolves to the UNIX timestamp of the block.
+   */
   async getBlockTimestamp(blockTag) {
     return this.nativeProvider.getBlock(blockTag).then((block) => block.timestamp);
   }
+  /**
+   * Gets information about a transaction.
+   *
+   * @param {string} txHash - The hash of the transaction.
+   * @returns {Promise<TransactionResponse>} A promise that resolves to the transaction response.
+   */
   async getTransaction(txHash) {
     const response = await this.nativeProvider.getTransaction(txHash);
     return TransactionResponse.from(response);
   }
+  /**
+   * Gets the receipt of a transaction.
+   *
+   * @param {string} txHash - The hash of the transaction.
+   * @returns {Promise<TransactionReceipt>} A promise that resolves to the transaction receipt.
+   */
   async getTransactionReceipt(txHash) {
     const response = await this.nativeProvider.getTransactionReceipt(txHash);
     return TransactionReceipt.from(response);
   }
+  /**
+   * Gets the number of transactions sent from the specified 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 (optional).
+   * @returns {Promise<number>} A promise that resolves to the number of transactions sent from the address.
+   */
   async getTransactionCount(addressOrName, blockTag) {
     return this.nativeProvider.getTransactionCount(addressOrName, blockTag);
   }
+  /**
+   * Sends a signed transaction to the blockchain.
+   *
+   * @param {SignedTransaction} transaction - The signed transaction to send.
+   * @param {object} [sendOptions] - Optional parameters for sending the transaction.
+   * @returns {Promise<TransactionPending>} A promise that resolves to the pending transaction.
+   */
   async sendTransaction(transaction, _sendOptions) {
     const stx = transaction.signed;
     const response = await this.nativeProvider.sendTransaction(stx);
     return TransactionPending.from(response);
   }
+  /**
+   * Confirms a pending transaction.
+   *
+   * @param {TransactionPending} pending - The pending transaction to confirm.
+   * @param {object} [opts] - Optional parameters for the confirmation.
+   * @returns {Promise<TransactionReceipt>} A promise that resolves to the transaction receipt.
+   */
   async confirmTransaction(pending, _opts) {
     const nativePending = pending.pending;
     const response = await nativePending.wait();
     return TransactionReceipt.from(response);
   }
+  /**
+   * Sends a signed transaction and waits for confirmation.
+   *
+   * @param {SignedTransaction} transaction - The signed transaction to send.
+   * @param {object} [opts] - Optional parameters for sending and confirming the transaction.
+   * @returns {Promise<TransactionReceipt>} A promise that resolves to the transaction receipt.
+   */
   async sendAndConfirm(transaction, opts) {
     const pending = await this.sendTransaction(transaction, opts);
     return this.confirmTransaction(pending, opts);
   }
 };
 var EvmSigner = class {
+  /**
+   * Creates an instance of EvmSigner.
+   *
+   * @param {ethers.Signer} signer - The EVM signer to use.
+   */
   constructor(signer) {
     this.nativeSigner = signer;
   }
+  /**
+   * Creates an instance of EvmSigner from the given source.
+   *
+   * @param {ethers.Signer | string} source - The source to create the signer from.
+   * @param {string} [path] - The derivation path (optional).
+   * @returns {EvmSigner} The created EvmSigner instance.
+   * @throws {Error} If the source parameter is invalid.
+   */
   static from(source, path) {
     if (source instanceof ethers.Signer) {
       return new this(source);
@@ -79,9 +185,21 @@ var EvmSigner = class {
       return new this(ethers.Wallet.fromMnemonic(source, path));
     }
   }
+  /**
+   * Gets the native EVM signer instance.
+   *
+   * @returns {ethers.Signer} The native EVM signer instance.
+   */
   get native() {
     return this.nativeSigner;
   }
+  /**
+   * Connects the signer to a provider.
+   *
+   * @param {Provider} provider - The provider to connect to.
+   * @returns {this} The connected signer.
+   * @throws {Error} If the provider is not an instance of ethers.providers.Provider.
+   */
   connect(provider) {
     if (!(provider.native instanceof ethers.providers.Provider)) {
       throw new Error("Only ethers.providers.Provider is supported.");
@@ -89,18 +207,42 @@ var EvmSigner = class {
     this.nativeSigner = this.nativeSigner.connect(provider.native);
     return this;
   }
+  /**
+   * Gets the address of the signer.
+   *
+   * @returns {Promise<string>} A promise that resolves to the address of the signer.
+   */
   async getAddress() {
     return this.nativeSigner.getAddress();
   }
+  /**
+   * Gets the address of the signer.
+   *
+   * @returns {string} The address of the signer.
+   */
   get address() {
     return this.nativeSigner.address;
   }
+  /**
+   * Sends a signed transaction and waits for confirmation.
+   *
+   * @param {SignedTransaction} transaction - The signed transaction to send.
+   * @param {object} [opts] - Optional parameters for sending and confirming the transaction.
+   * @returns {Promise<TransactionReceipt>} A promise that resolves to the transaction receipt.
+   */
   async sendAndConfirm(transaction, opts) {
     const pending = await this.sendTransaction(transaction);
     const response = pending.pending;
     const receipt = await response.wait(opts?.confirmations);
     return TransactionReceipt.from(receipt);
   }
+  /**
+   * Sends a signed transaction.
+   *
+   * @param {SignedTransaction} transaction - The signed transaction to send.
+   * @returns {Promise<TransactionPending>} A promise that resolves to the pending transaction.
+   * @throws {Error} If no provider is attached to the signer.
+   */
   async sendTransaction(transaction) {
     const stx = transaction.signed;
     if (this.nativeSigner.provider === void 0) {
@@ -109,16 +251,35 @@ var EvmSigner = class {
     const response = await this.nativeSigner.provider.sendTransaction(stx);
     return TransactionPending.from(response);
   }
+  /**
+   * Signs a transaction.
+   *
+   * @param {TransactionRequest} transaction - The transaction request to sign.
+   * @returns {Promise<SignedTransaction>} A promise that resolves to the signed transaction.
+   */
   async signTransaction(transaction) {
     const tx = transaction.request;
     const populatedTransaction = await this.nativeSigner.populateTransaction(tx);
     const response = await this.nativeSigner.signTransaction(populatedTransaction);
     return SignedTransaction.from(response);
   }
+  /**
+   * Signs a buffer (e.g., a message hash) using the native EVM signer.
+   *
+   * @param {Uint8Array} buffer - The buffer to sign.
+   * @returns {Promise<Uint8Array>} A promise that resolves to the signed buffer as a Uint8Array.
+   */
   async signBuffer(buffer) {
     const signedMessage = await this.nativeSigner.signMessage(buffer);
     return ethers.utils.arrayify(signedMessage);
   }
+  /**
+   * Builds a transaction.
+   *
+   * @param {unknown} buildTxRequest - The transaction request to build.
+   * @returns {Promise<TransactionRequest>} A promise that resolves to the built transaction request.
+   * @throws {Error} Method not implemented.
+   */
   async buildTransaction(buildTxRequest) {
     return Promise.reject(new Error("Method not implemented."));
   }

package/dist/index.mjs.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"sources":["../src/providers/evm.ts","../src/signers/evm.ts"],"names":["ethers","SignedTransaction","TransactionPending","TransactionReceipt"],"mappings":";AAAA,SAAS,cAAc;AAEvB;AAAA,EACI;AAAA,EAEA;AAAA,EAIA;AAAA,EACA;AAAA,EACA;AAAA,OACG;AAEA,IAAM,cAAN,MAAM,aAAgC;AAAA,EAGzC,YAAmB,KAAa;AAAb;AACf,SAAK,iBAAiB,IAAI,OAAO,UAAU,gBAAgB,GAAG;AAAA,EAClE;AAAA,EAIA,OAAO,KAAK,QAA6B;AACrC,QAAI,OAAO,WAAW,UAAU;AAC5B,aAAO,IAAI,aAAY,MAAM;AAAA,IACjC,OAAO;AACH,YAAM,IAAI,MAAM,oBAAoB;AAAA,IACxC;AAAA,EACJ;AAAA,EAEA,IAAI,SAA2C;AAC3C,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,MAAM,WAAW,SAAkC;AAC/C,YAAQ,MAAM,KAAK,eAAe,WAAW,OAAO,GAAG,SAAS;AAAA,EACpE;AAAA,EAEA,MAAM,SAAS,UAA2C;AACtD,UAAM,WAAW,MAAM,KAAK,eAAe,SAAS,QAAQ;AAC5D,WAAO,MAAM,KAAK,QAAQ;AAAA,EAC9B;AAAA,EAEA,MAAM,yBAAyB,UAA2D;AACtF,UAAM,WAAW,MAAM,KAAK,eAAe,yBAAyB,QAAQ;AAC5E,WAAO,sBAAsB,KAAK,QAAQ;AAAA,EAC9C;AAAA,EAEA,MAAM,iBAAkC;AACpC,WAAO,KAAK,eAAe,eAAe;AAAA,EAC9C;AAAA;AAAA,EAGA,MAAM,QAAQ,WAAuC;AACjD,UAAM,QAAQ,QAAQ;AACtB,UAAM,IAAI,MAAM,yBAAyB;AAAA,EAC7C;AAAA,EAEA,MAAM,kBAAkB,UAA4C;AAChE,WAAO,KAAK,eAAe,SAAS,QAAQ,EAAE,KAAK,CAAC,UAAU,MAAM,SAAS;AAAA,EACjF;AAAA,EAEA,MAAM,eAAe,QAA8C;AAC/D,UAAM,WAAW,MAAM,KAAK,eAAe,eAAe,MAAM;AAChE,WAAO,oBAAoB,KAAK,QAAQ;AAAA,EAC5C;AAAA,EAEA,MAAM,sBAAsB,QAA6C;AACrE,UAAM,WAAW,MAAM,KAAK,eAAe,sBAAsB,MAAM;AACvE,WAAO,mBAAmB,KAAK,QAAQ;AAAA,EAC3C;AAAA,EAEA,MAAM,oBACF,eACA,UACe;AACf,WAAO,KAAK,eAAe,oBAAoB,eAAe,QAAQ;AAAA,EAC1E;AAAA,EAEA,MAAM,gBAAgB,aAAgC,cAAoD;AAEtG,UAAM,MAAM,YAAY;AAExB,UAAM,WAAW,MAAM,KAAK,eAAe,gBAAgB,GAAG;AAC9D,WAAO,mBAAmB,KAAK,QAAQ;AAAA,EAC3C;AAAA,EAEA,MAAM,mBAAmB,SAA6B,OAA6C;AAC/F,UAAM,gBAAgB,QAAQ;AAC9B,UAAM,WAAW,MAAM,cAAc,KAAK;AAC1C,WAAO,mBAAmB,KAAK,QAAQ;AAAA,EAC3C;AAAA,EAEA,MAAM,eAAe,aAAgC,MAA4C;AAC7F,UAAM,UAAU,MAAM,KAAK,gBAAgB,aAAa,IAAI;AAC5D,WAAO,KAAK,mBAAmB,SAAS,IAAI;AAAA,EAChD;AACJ;;;AClGA,SAAS,UAAAA,eAAc;AAEvB;AAAA,EAEI,qBAAAC;AAAA,EAEA,sBAAAC;AAAA,EACA,sBAAAC;AAAA,OAEG;AAEA,IAAM,YAAN,MAAkC;AAAA,EAG7B,YAAY,QAAuB;AACvC,SAAK,eAAe;AAAA,EACxB;AAAA,EAEA,OAAO,KAAK,QAAgC,MAA0B;AAClE,QAAI,kBAAkBH,QAAO,QAAQ;AACjC,aAAO,IAAI,KAAK,MAAM;AAAA,IAC1B;AACA,QAAI,SAAS,QAAW;AACpB,aAAO,IAAI,KAAK,IAAIA,QAAO,OAAO,MAAM,CAAC;AAAA,IAC7C,OAAO;AACH,aAAO,IAAI,KAAKA,QAAO,OAAO,aAAa,QAAQ,IAAI,CAAC;AAAA,IAC5D;AAAA,EACJ;AAAA,EAEA,IAAI,SAAwB;AACxB,WAAO,KAAK;AAAA,EAChB;AAAA,EAEA,QAAQ,UAA0B;AAC9B,QAAI,EAAE,SAAS,kBAAkBA,QAAO,UAAU,WAAW;AACzD,YAAM,IAAI,MAAM,8CAA8C;AAAA,IAClE;AAEA,SAAK,eAAe,KAAK,aAAa,QAAQ,SAAS,MAAM;AAC7D,WAAO;AAAA,EACX;AAAA,EAEA,MAAM,aAA8B;AAChC,WAAO,KAAK,aAAa,WAAW;AAAA,EACxC;AAAA,EAEA,IAAI,UAAkB;AAClB,WAAQ,KAAK,aAAqD;AAAA,EACtE;AAAA,EAEA,MAAM,eACF,aACA,MAC2B;AAC3B,UAAM,UAAU,MAAM,KAAK,gBAAgB,WAAW;AACtD,UAAM,WAAW,QAAQ;AACzB,UAAM,UAAU,MAAM,SAAS,KAAK,MAAM,aAAa;AACvD,WAAOG,oBAAmB,KAAK,OAAO;AAAA,EAC1C;AAAA,EAEA,MAAM,gBAAgB,aAA6D;AAE/E,UAAM,MAAM,YAAY;AACxB,QAAI,KAAK,aAAa,aAAa,QAAW;AAC1C,YAAM,IAAI,MAAM,oCAAoC;AAAA,IACxD;AAEA,UAAM,WAAW,MAAM,KAAK,aAAa,SAAS,gBAAgB,GAAG;AACrE,WAAOD,oBAAmB,KAAK,QAAQ;AAAA,EAC3C;AAAA,EAEA,MAAM,gBAAgB,aAA6D;AAE/E,UAAM,KAAK,YAAY;AAEvB,UAAM,uBAAuB,MAAM,KAAK,aAAa,oBAAoB,EAAE;AAC3E,UAAM,WAAW,MAAM,KAAK,aAAa,gBAAgB,oBAAoB;AAC7E,WAAOD,mBAAkB,KAAK,QAAQ;AAAA,EAC1C;AAAA,EAEA,MAAM,WAAW,QAAyC;AACtD,UAAM,gBAAgB,MAAM,KAAK,aAAa,YAAY,MAAM;AAChE,WAAOD,QAAO,MAAM,SAAS,aAAa;AAAA,EAC9C;AAAA,EAEA,MAAM,iBAAiB,gBAAsD;AACzE,WAAO,QAAQ,OAAO,IAAI,MAAM,yBAAyB,CAAC;AAAA,EAC9D;AACJ","sourcesContent":["import { ethers } from 'ethers'\n\nimport {\n Block,\n BlockTag,\n BlockWithTransactions,\n Finality,\n Provider,\n SignedTransaction,\n TransactionPending,\n TransactionReceipt,\n TransactionResponse,\n} from '@layerzerolabs/lz-core'\n\nexport class EvmProvider implements Provider {\n nativeProvider: ethers.providers.JsonRpcProvider\n\n constructor(public url: string) {\n this.nativeProvider = new ethers.providers.JsonRpcProvider(url)\n }\n\n static from(url: string): EvmProvider\n\n static from(source: string): EvmProvider {\n if (typeof source === 'string') {\n return new EvmProvider(source)\n } else {\n throw new Error('Invalid parameters')\n }\n }\n\n get native(): ethers.providers.JsonRpcProvider {\n return this.nativeProvider\n }\n\n async getBalance(address: string): Promise<string> {\n return (await this.nativeProvider.getBalance(address)).toString()\n }\n\n async getBlock(blockTag: string \| number): Promise<Block> {\n const response = await this.nativeProvider.getBlock(blockTag)\n return Block.from(response)\n }\n\n async getBlockWithTransactions(blockTag: string \| number): Promise<BlockWithTransactions> {\n const response = await this.nativeProvider.getBlockWithTransactions(blockTag)\n return BlockWithTransactions.from(response)\n }\n\n async getBlockNumber(): Promise<number> {\n return this.nativeProvider.getBlockNumber()\n }\n\n // eslint-disable-next-line @typescript-eslint/require-await\n async getSlot(_finality?: Finality): Promise<number> {\n await Promise.resolve()\n throw new Error('Method not implemented.')\n }\n\n async getBlockTimestamp(blockTag: string \| number): Promise<number> {\n return this.nativeProvider.getBlock(blockTag).then((block) => block.timestamp)\n }\n\n async getTransaction(txHash: string): Promise<TransactionResponse> {\n const response = await this.nativeProvider.getTransaction(txHash)\n return TransactionResponse.from(response)\n }\n\n async getTransactionReceipt(txHash: string): Promise<TransactionReceipt> {\n const response = await this.nativeProvider.getTransactionReceipt(txHash)\n return TransactionReceipt.from(response)\n }\n\n async getTransactionCount(\n addressOrName: string \| Promise<string>,\n blockTag?: BlockTag \| Promise<BlockTag>\n ): Promise<number> {\n return this.nativeProvider.getTransactionCount(addressOrName, blockTag)\n }\n\n async sendTransaction(transaction: SignedTransaction, _sendOptions?: object): Promise<TransactionPending> {\n type NativeSignedTransaction = Parameters<typeof this.nativeProvider.sendTransaction>[0]\n const stx = transaction.signed as NativeSignedTransaction\n\n const response = await this.nativeProvider.sendTransaction(stx)\n return TransactionPending.from(response)\n }\n\n async confirmTransaction(pending: TransactionPending, _opts?: object): Promise<TransactionReceipt> {\n const nativePending = pending.pending as ethers.providers.TransactionResponse\n const response = await nativePending.wait()\n return TransactionReceipt.from(response)\n }\n\n async sendAndConfirm(transaction: SignedTransaction, opts?: object): Promise<TransactionReceipt> {\n const pending = await this.sendTransaction(transaction, opts)\n return this.confirmTransaction(pending, opts)\n }\n}\n","import { ethers } from 'ethers'\n\nimport {\n Provider,\n SignedTransaction,\n Signer,\n TransactionPending,\n TransactionReceipt,\n TransactionRequest,\n} from '@layerzerolabs/lz-core'\n\nexport class EvmSigner implements Signer {\n private nativeSigner: ethers.Signer\n\n private constructor(signer: ethers.Signer) {\n this.nativeSigner = signer\n }\n\n static from(source: ethers.Signer \| string, path?: string): EvmSigner {\n if (source instanceof ethers.Signer) {\n return new this(source)\n }\n if (path === undefined) {\n return new this(new ethers.Wallet(source))\n } else {\n return new this(ethers.Wallet.fromMnemonic(source, path))\n }\n }\n\n get native(): ethers.Signer {\n return this.nativeSigner\n }\n\n connect(provider: Provider): this {\n if (!(provider.native instanceof ethers.providers.Provider)) {\n throw new Error('Only ethers.providers.Provider is supported.')\n }\n\n this.nativeSigner = this.nativeSigner.connect(provider.native)\n return this\n }\n\n async getAddress(): Promise<string> {\n return this.nativeSigner.getAddress()\n }\n\n get address(): string {\n return (this.nativeSigner as ethers.Signer & { address: string }).address\n }\n\n async sendAndConfirm(\n transaction: SignedTransaction,\n opts?: { confirmations?: number }\n ): Promise<TransactionReceipt> {\n const pending = await this.sendTransaction(transaction)\n const response = pending.pending as ethers.providers.TransactionResponse\n const receipt = await response.wait(opts?.confirmations)\n return TransactionReceipt.from(receipt)\n }\n\n async sendTransaction(transaction: SignedTransaction): Promise<TransactionPending> {\n type NativeSignedTransaction = Parameters<ethers.providers.Provider['sendTransaction']>[0]\n const stx = transaction.signed as NativeSignedTransaction\n if (this.nativeSigner.provider === undefined) {\n throw new Error('No provider attached to the signer')\n }\n\n const response = await this.nativeSigner.provider.sendTransaction(stx)\n return TransactionPending.from(response)\n }\n\n async signTransaction(transaction: TransactionRequest): Promise<SignedTransaction> {\n type NativeTransactionRequest = Parameters<ethers.Signer['populateTransaction']>[0]\n const tx = transaction.request as NativeTransactionRequest\n\n const populatedTransaction = await this.nativeSigner.populateTransaction(tx)\n const response = await this.nativeSigner.signTransaction(populatedTransaction)\n return SignedTransaction.from(response)\n }\n\n async signBuffer(buffer: Uint8Array): Promise<Uint8Array> {\n const signedMessage = await this.nativeSigner.signMessage(buffer)\n return ethers.utils.arrayify(signedMessage)\n }\n\n async buildTransaction(buildTxRequest: unknown): Promise<TransactionRequest> {\n return Promise.reject(new Error('Method not implemented.'))\n }\n}\n"]}
1	+ {"version":3,"sources":["../src/providers/evm.ts","../src/signers/evm.ts"],"names":["ethers","SignedTransaction","TransactionPending","TransactionReceipt"],"mappings":";AAAA,SAAS,cAAc;AAEvB;AAAA,EACI;AAAA,EAEA;AAAA,EAIA;AAAA,EACA;AAAA,EACA;AAAA,OACG;AAMA,IAAM,cAAN,MAAM,aAAgC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQzC,YAAmB,KAAa;AAAb;AACf,SAAK,iBAAiB,IAAI,OAAO,UAAU,gBAAgB,GAAG;AAAA,EAClE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBA,OAAO,KAAK,QAA6B;AACrC,QAAI,OAAO,WAAW,UAAU;AAC5B,aAAO,IAAI,aAAY,MAAM;AAAA,IACjC,OAAO;AACH,YAAM,IAAI,MAAM,oBAAoB;AAAA,IACxC;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAI,SAA2C;AAC3C,WAAO,KAAK;AAAA,EAChB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,WAAW,SAAkC;AAC/C,YAAQ,MAAM,KAAK,eAAe,WAAW,OAAO,GAAG,SAAS;AAAA,EACpE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,SAAS,UAA2C;AACtD,UAAM,WAAW,MAAM,KAAK,eAAe,SAAS,QAAQ;AAC5D,WAAO,MAAM,KAAK,QAAQ;AAAA,EAC9B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,yBAAyB,UAA2D;AACtF,UAAM,WAAW,MAAM,KAAK,eAAe,yBAAyB,QAAQ;AAC5E,WAAO,sBAAsB,KAAK,QAAQ;AAAA,EAC9C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,iBAAkC;AACpC,WAAO,KAAK,eAAe,eAAe;AAAA,EAC9C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAM,QAAQ,WAAuC;AACjD,UAAM,QAAQ,QAAQ;AACtB,UAAM,IAAI,MAAM,yBAAyB;AAAA,EAC7C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,kBAAkB,UAA4C;AAChE,WAAO,KAAK,eAAe,SAAS,QAAQ,EAAE,KAAK,CAAC,UAAU,MAAM,SAAS;AAAA,EACjF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,eAAe,QAA8C;AAC/D,UAAM,WAAW,MAAM,KAAK,eAAe,eAAe,MAAM;AAChE,WAAO,oBAAoB,KAAK,QAAQ;AAAA,EAC5C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,sBAAsB,QAA6C;AACrE,UAAM,WAAW,MAAM,KAAK,eAAe,sBAAsB,MAAM;AACvE,WAAO,mBAAmB,KAAK,QAAQ;AAAA,EAC3C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,oBACF,eACA,UACe;AACf,WAAO,KAAK,eAAe,oBAAoB,eAAe,QAAQ;AAAA,EAC1E;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,gBAAgB,aAAgC,cAAoD;AAEtG,UAAM,MAAM,YAAY;AAExB,UAAM,WAAW,MAAM,KAAK,eAAe,gBAAgB,GAAG;AAC9D,WAAO,mBAAmB,KAAK,QAAQ;AAAA,EAC3C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,mBAAmB,SAA6B,OAA6C;AAC/F,UAAM,gBAAgB,QAAQ;AAC9B,UAAM,WAAW,MAAM,cAAc,KAAK;AAC1C,WAAO,mBAAmB,KAAK,QAAQ;AAAA,EAC3C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,eAAe,aAAgC,MAA4C;AAC7F,UAAM,UAAU,MAAM,KAAK,gBAAgB,aAAa,IAAI;AAC5D,WAAO,KAAK,mBAAmB,SAAS,IAAI;AAAA,EAChD;AACJ;;;ACzMA,SAAS,UAAAA,eAAc;AAEvB;AAAA,EAEI,qBAAAC;AAAA,EAEA,sBAAAC;AAAA,EACA,sBAAAC;AAAA,OAEG;AAMA,IAAM,YAAN,MAAkC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ7B,YAAY,QAAuB;AACvC,SAAK,eAAe;AAAA,EACxB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,OAAO,KAAK,QAAgC,MAA0B;AAClE,QAAI,kBAAkBH,QAAO,QAAQ;AACjC,aAAO,IAAI,KAAK,MAAM;AAAA,IAC1B;AACA,QAAI,SAAS,QAAW;AACpB,aAAO,IAAI,KAAK,IAAIA,QAAO,OAAO,MAAM,CAAC;AAAA,IAC7C,OAAO;AACH,aAAO,IAAI,KAAKA,QAAO,OAAO,aAAa,QAAQ,IAAI,CAAC;AAAA,IAC5D;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAI,SAAwB;AACxB,WAAO,KAAK;AAAA,EAChB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,QAAQ,UAA0B;AAC9B,QAAI,EAAE,SAAS,kBAAkBA,QAAO,UAAU,WAAW;AACzD,YAAM,IAAI,MAAM,8CAA8C;AAAA,IAClE;AAEA,SAAK,eAAe,KAAK,aAAa,QAAQ,SAAS,MAAM;AAC7D,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,aAA8B;AAChC,WAAO,KAAK,aAAa,WAAW;AAAA,EACxC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAI,UAAkB;AAClB,WAAQ,KAAK,aAAqD;AAAA,EACtE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,eACF,aACA,MAC2B;AAC3B,UAAM,UAAU,MAAM,KAAK,gBAAgB,WAAW;AACtD,UAAM,WAAW,QAAQ;AACzB,UAAM,UAAU,MAAM,SAAS,KAAK,MAAM,aAAa;AACvD,WAAOG,oBAAmB,KAAK,OAAO;AAAA,EAC1C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,gBAAgB,aAA6D;AAE/E,UAAM,MAAM,YAAY;AACxB,QAAI,KAAK,aAAa,aAAa,QAAW;AAC1C,YAAM,IAAI,MAAM,oCAAoC;AAAA,IACxD;AAEA,UAAM,WAAW,MAAM,KAAK,aAAa,SAAS,gBAAgB,GAAG;AACrE,WAAOD,oBAAmB,KAAK,QAAQ;AAAA,EAC3C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,gBAAgB,aAA6D;AAE/E,UAAM,KAAK,YAAY;AAEvB,UAAM,uBAAuB,MAAM,KAAK,aAAa,oBAAoB,EAAE;AAC3E,UAAM,WAAW,MAAM,KAAK,aAAa,gBAAgB,oBAAoB;AAC7E,WAAOD,mBAAkB,KAAK,QAAQ;AAAA,EAC1C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,WAAW,QAAyC;AACtD,UAAM,gBAAgB,MAAM,KAAK,aAAa,YAAY,MAAM;AAChE,WAAOD,QAAO,MAAM,SAAS,aAAa;AAAA,EAC9C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,iBAAiB,gBAAsD;AACzE,WAAO,QAAQ,OAAO,IAAI,MAAM,yBAAyB,CAAC;AAAA,EAC9D;AACJ","sourcesContent":["import { ethers } from 'ethers'\n\nimport {\n Block,\n BlockTag,\n BlockWithTransactions,\n Finality,\n Provider,\n SignedTransaction,\n TransactionPending,\n TransactionReceipt,\n TransactionResponse,\n} from '@layerzerolabs/lz-core'\n\n/*\n Represents an EVM (Ethereum Virtual Machine) blockchain provider.\n * Implements the Provider interface for interacting with EVM-compatible blockchains.\n /\nexport class EvmProvider implements Provider {\n nativeProvider: ethers.providers.JsonRpcProvider\n\n /\n Creates an instance of EvmProvider.\n \n @param {string} url - The URL of the EVM node.\n /\n constructor(public url: string) {\n this.nativeProvider = new ethers.providers.JsonRpcProvider(url)\n }\n\n /\n Creates an instance of EvmProvider from the given URL.\n \n @param {string} url - The URL of the EVM node.\n * @returns {EvmProvider} The created EvmProvider instance.\n /\n static from(url: string): EvmProvider\n\n /\n Creates an instance of EvmProvider from the given source.\n \n @param {string} source - The source to create the provider from.\n * @returns {EvmProvider} The created EvmProvider instance.\n * @throws {Error} If the source parameter is not a string.\n /\n static from(source: string): EvmProvider {\n if (typeof source === 'string') {\n return new EvmProvider(source)\n } else {\n throw new Error('Invalid parameters')\n }\n }\n\n /\n Gets the native EVM provider instance.\n \n @returns {ethers.providers.JsonRpcProvider} The native EVM provider instance.\n /\n get native(): ethers.providers.JsonRpcProvider {\n return this.nativeProvider\n }\n\n /\n Gets the balance of the specified address.\n \n @param {string} address - The address to get the balance of.\n * @returns {Promise<string>} A promise that resolves to the balance of the address.\n /\n async getBalance(address: string): Promise<string> {\n return (await this.nativeProvider.getBalance(address)).toString()\n }\n\n /\n Gets the block specified by blockTag.\n \n @param {BlockTag} blockTag - The block tag to specify the block.\n * @returns {Promise<Block>} A promise that resolves to the block.\n /\n async getBlock(blockTag: string \| number): Promise<Block> {\n const response = await this.nativeProvider.getBlock(blockTag)\n return Block.from(response)\n }\n\n /\n Gets the block with transactions specified by blockTag.\n \n @param {BlockTag} blockTag - The block tag to specify the block.\n * @returns {Promise<BlockWithTransactions>} A promise that resolves to the block with transactions.\n /\n async getBlockWithTransactions(blockTag: string \| number): Promise<BlockWithTransactions> {\n const response = await this.nativeProvider.getBlockWithTransactions(blockTag)\n return BlockWithTransactions.from(response)\n }\n\n /\n Gets the current block number.\n \n @returns {Promise<number>} A promise that resolves to the current block number.\n /\n async getBlockNumber(): Promise<number> {\n return this.nativeProvider.getBlockNumber()\n }\n\n /\n Gets the current slot number for commitment, not suitable for EVM.\n \n @param {Finality} [finality] - The commitment level (optional).\n * @returns {Promise<number>} A promise that resolves to the current slot number.\n * @throws {Error} Method not implemented.\n /\n // eslint-disable-next-line @typescript-eslint/require-await\n async getSlot(_finality?: Finality): Promise<number> {\n await Promise.resolve()\n throw new Error('Method not implemented.')\n }\n\n /\n Gets the UNIX timestamp for the block identified by blockTag.\n \n @param {BlockTag} blockTag - The block tag to specify the block.\n * @returns {Promise<number>} A promise that resolves to the UNIX timestamp of the block.\n /\n async getBlockTimestamp(blockTag: string \| number): Promise<number> {\n return this.nativeProvider.getBlock(blockTag).then((block) => block.timestamp)\n }\n\n /\n Gets information about a transaction.\n \n @param {string} txHash - The hash of the transaction.\n * @returns {Promise<TransactionResponse>} A promise that resolves to the transaction response.\n /\n async getTransaction(txHash: string): Promise<TransactionResponse> {\n const response = await this.nativeProvider.getTransaction(txHash)\n return TransactionResponse.from(response)\n }\n\n /\n Gets the receipt of a transaction.\n \n @param {string} txHash - The hash of the transaction.\n * @returns {Promise<TransactionReceipt>} A promise that resolves to the transaction receipt.\n /\n async getTransactionReceipt(txHash: string): Promise<TransactionReceipt> {\n const response = await this.nativeProvider.getTransactionReceipt(txHash)\n return TransactionReceipt.from(response)\n }\n\n /\n Gets the number of transactions sent from the specified address.\n \n @param {string \| Promise<string>} addressOrName - The address to get the number of transactions from.\n * @param {BlockTag \| Promise<BlockTag>} [blockTag] - The block tag to get the number of transactions from (optional).\n * @returns {Promise<number>} A promise that resolves to the number of transactions sent from the address.\n /\n async getTransactionCount(\n addressOrName: string \| Promise<string>,\n blockTag?: BlockTag \| Promise<BlockTag>\n ): Promise<number> {\n return this.nativeProvider.getTransactionCount(addressOrName, blockTag)\n }\n\n /\n Sends a signed transaction to the blockchain.\n \n @param {SignedTransaction} transaction - The signed transaction to send.\n * @param {object} [sendOptions] - Optional parameters for sending the transaction.\n * @returns {Promise<TransactionPending>} A promise that resolves to the pending transaction.\n /\n async sendTransaction(transaction: SignedTransaction, _sendOptions?: object): Promise<TransactionPending> {\n type NativeSignedTransaction = Parameters<typeof this.nativeProvider.sendTransaction>[0]\n const stx = transaction.signed as NativeSignedTransaction\n\n const response = await this.nativeProvider.sendTransaction(stx)\n return TransactionPending.from(response)\n }\n\n /\n Confirms a pending transaction.\n \n @param {TransactionPending} pending - The pending transaction to confirm.\n * @param {object} [opts] - Optional parameters for the confirmation.\n * @returns {Promise<TransactionReceipt>} A promise that resolves to the transaction receipt.\n /\n async confirmTransaction(pending: TransactionPending, _opts?: object): Promise<TransactionReceipt> {\n const nativePending = pending.pending as ethers.providers.TransactionResponse\n const response = await nativePending.wait()\n return TransactionReceipt.from(response)\n }\n\n /\n Sends a signed transaction and waits for confirmation.\n \n @param {SignedTransaction} transaction - The signed transaction to send.\n * @param {object} [opts] - Optional parameters for sending and confirming the transaction.\n * @returns {Promise<TransactionReceipt>} A promise that resolves to the transaction receipt.\n /\n async sendAndConfirm(transaction: SignedTransaction, opts?: object): Promise<TransactionReceipt> {\n const pending = await this.sendTransaction(transaction, opts)\n return this.confirmTransaction(pending, opts)\n }\n}\n","import { ethers } from 'ethers'\n\nimport {\n Provider,\n SignedTransaction,\n Signer,\n TransactionPending,\n TransactionReceipt,\n TransactionRequest,\n} from '@layerzerolabs/lz-core'\n\n/\n Represents an EVM (Ethereum Virtual Machine) blockchain signer.\n * Implements the Signer interface for interacting with EVM-compatible blockchains.\n /\nexport class EvmSigner implements Signer {\n private nativeSigner: ethers.Signer\n\n /\n Creates an instance of EvmSigner.\n \n @param {ethers.Signer} signer - The EVM signer to use.\n /\n private constructor(signer: ethers.Signer) {\n this.nativeSigner = signer\n }\n\n /\n Creates an instance of EvmSigner from the given source.\n \n @param {ethers.Signer \| string} source - The source to create the signer from.\n * @param {string} [path] - The derivation path (optional).\n * @returns {EvmSigner} The created EvmSigner instance.\n * @throws {Error} If the source parameter is invalid.\n /\n static from(source: ethers.Signer \| string, path?: string): EvmSigner {\n if (source instanceof ethers.Signer) {\n return new this(source)\n }\n if (path === undefined) {\n return new this(new ethers.Wallet(source))\n } else {\n return new this(ethers.Wallet.fromMnemonic(source, path))\n }\n }\n\n /\n Gets the native EVM signer instance.\n \n @returns {ethers.Signer} The native EVM signer instance.\n /\n get native(): ethers.Signer {\n return this.nativeSigner\n }\n\n /\n Connects the signer to a provider.\n \n @param {Provider} provider - The provider to connect to.\n * @returns {this} The connected signer.\n * @throws {Error} If the provider is not an instance of ethers.providers.Provider.\n /\n connect(provider: Provider): this {\n if (!(provider.native instanceof ethers.providers.Provider)) {\n throw new Error('Only ethers.providers.Provider is supported.')\n }\n\n this.nativeSigner = this.nativeSigner.connect(provider.native)\n return this\n }\n\n /\n Gets the address of the signer.\n \n @returns {Promise<string>} A promise that resolves to the address of the signer.\n /\n async getAddress(): Promise<string> {\n return this.nativeSigner.getAddress()\n }\n\n /\n Gets the address of the signer.\n \n @returns {string} The address of the signer.\n /\n get address(): string {\n return (this.nativeSigner as ethers.Signer & { address: string }).address\n }\n\n /\n Sends a signed transaction and waits for confirmation.\n \n @param {SignedTransaction} transaction - The signed transaction to send.\n * @param {object} [opts] - Optional parameters for sending and confirming the transaction.\n * @returns {Promise<TransactionReceipt>} A promise that resolves to the transaction receipt.\n /\n async sendAndConfirm(\n transaction: SignedTransaction,\n opts?: { confirmations?: number }\n ): Promise<TransactionReceipt> {\n const pending = await this.sendTransaction(transaction)\n const response = pending.pending as ethers.providers.TransactionResponse\n const receipt = await response.wait(opts?.confirmations)\n return TransactionReceipt.from(receipt)\n }\n\n /\n Sends a signed transaction.\n \n @param {SignedTransaction} transaction - The signed transaction to send.\n * @returns {Promise<TransactionPending>} A promise that resolves to the pending transaction.\n * @throws {Error} If no provider is attached to the signer.\n /\n async sendTransaction(transaction: SignedTransaction): Promise<TransactionPending> {\n type NativeSignedTransaction = Parameters<ethers.providers.Provider['sendTransaction']>[0]\n const stx = transaction.signed as NativeSignedTransaction\n if (this.nativeSigner.provider === undefined) {\n throw new Error('No provider attached to the signer')\n }\n\n const response = await this.nativeSigner.provider.sendTransaction(stx)\n return TransactionPending.from(response)\n }\n\n /\n Signs 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 async signTransaction(transaction: TransactionRequest): Promise<SignedTransaction> {\n type NativeTransactionRequest = Parameters<ethers.Signer['populateTransaction']>[0]\n const tx = transaction.request as NativeTransactionRequest\n\n const populatedTransaction = await this.nativeSigner.populateTransaction(tx)\n const response = await this.nativeSigner.signTransaction(populatedTransaction)\n return SignedTransaction.from(response)\n }\n\n /\n Signs a buffer (e.g., a message hash) using the native EVM signer.\n \n @param {Uint8Array} buffer - The buffer to sign.\n * @returns {Promise<Uint8Array>} A promise that resolves to the signed buffer as a Uint8Array.\n /\n async signBuffer(buffer: Uint8Array): Promise<Uint8Array> {\n const signedMessage = await this.nativeSigner.signMessage(buffer)\n return ethers.utils.arrayify(signedMessage)\n }\n\n /\n Builds a transaction.\n \n @param {unknown} buildTxRequest - The transaction request to build.\n * @returns {Promise<TransactionRequest>} A promise that resolves to the built transaction request.\n * @throws {Error} Method not implemented.\n */\n async buildTransaction(buildTxRequest: unknown): Promise<TransactionRequest> {\n return Promise.reject(new Error('Method not implemented.'))\n }\n}\n"]}

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@layerzerolabs/lz-corekit-evm",
-  "version": "3.0.15",
+  "version": "3.0.16",
   "description": "LayerZero Core Library",
   "license": "BUSL-1.1",
   "exports": {
@@ -23,17 +23,15 @@
     "clean-prebuild": "rimraf dist"
   },
   "dependencies": {
-    "@layerzerolabs/lz-core": "^3.0.15",
-    "@layerzerolabs/lz-utilities": "^3.0.15",
+    "@layerzerolabs/lz-core": "^3.0.16",
+    "@layerzerolabs/lz-utilities": "^3.0.16",
     "ethers": "^5.7.2"
   },
   "devDependencies": {
     "@jest/globals": "^29.7.0",
-    "@layerzerolabs/tronweb-typescript": "^0.0.0",
-    "@layerzerolabs/tsup-config-next": "^3.0.15",
-    "@layerzerolabs/typescript-config-next": "^3.0.15",
+    "@layerzerolabs/tsup-config-next": "^3.0.16",
+    "@layerzerolabs/typescript-config-next": "^3.0.16",
     "@types/jest": "^29.5.10",
-    "@types/tronweb": "npm:@layerzerolabs/tronweb-typescript@workspace:^",
     "jest": "^29.7.0",
     "jest-extended": "^4.0.2",
     "rimraf": "^5.0.5",