@layerzerolabs/lz-corekit-iotal1 3.0.143

package/dist/index.d.mts

@@ -0,0 +1,224 @@
+import { IotaClient } from '@iota/iota-sdk/client';
+import { Provider, Block, BlockWithTransactions, Finality, TransactionResponse, TransactionReceipt, BlockTag, SignedTransaction, TransactionPending, Signer, TransactionRequest } from '@layerzerolabs/lz-core';
+import { Ed25519Keypair } from '@iota/iota-sdk/keypairs/ed25519';
+
+/**
+ * Represents an Iota Move blockchain provider.
+ * Implements the Provider interface for interacting with the Iota Move blockchain.
+ */
+declare class IotaL1Provider implements Provider {
+    readonly url: string;
+    readonly authHeader?: {
+        authField: string;
+        authValue: string;
+    } | undefined;
+    readonly nativeProvider: IotaClient;
+    /**
+     * Creates an instance of IotaL1Provider.
+     *
+     * @param {string} url - The URL of the Iota Move node.
+     * @param {string} [faucet] - The URL of the faucet (optional).
+     * @param {string} [indexer] - The URL of the indexer (optional).
+     * @param authHeader
+     */
+    private constructor();
+    /**
+     * Creates an instance of IotaL1Provider from the given parameters.
+     *
+     * @param {string} source - The URL of the Iota Move node.
+     * @param authHeader
+     * @returns {IotaL1Provider} The created IotaL1Provider instance.
+     * @throws {Error} If the source parameter is not a string.
+     */
+    static from(source: string, authHeader?: {
+        authField: string;
+        authValue: string;
+    }): IotaL1Provider;
+    /**
+     * Gets the native Iota Move client instance.
+     *
+     * @returns {IotaClient} The native Iota Move client instance.
+     */
+    get native(): IotaClient;
+    /**
+     * 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.
+     * @throws {Error} If the address is not a valid Iota Move 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.
+     * @throws {Error} If the blockTag is invalid.
+     */
+    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.
+     * @throws {Error} If the blockTag is invalid.
+     */
+    getBlockWithTransactions(blockTag: string | number): Promise<BlockWithTransactions>;
+    /**
+     * Gets the current block number.
+     *
+     * @returns {Promise<number>} A promise that resolves to the current check point.
+     */
+    getBlockNumber(): Promise<number>;
+    /**
+     * Gets the current slot number for commitment, not suitable for Iota Move.
+     *
+     * @param {Finality} [commitment] - 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 timestamp (A string containing a 64-bit unsigned integer) 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 timestamp of the block.
+     * @throws {Error} If the blockTag is invalid.
+     */
+    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.
+     * @throws {Error} If the transaction hash is invalid.
+     */
+    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.
+     * @throws {Error} If the transaction hash is invalid.
+     */
+    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.
+     * @throws {Error} If the address is invalid.
+     */
+    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.
+     * @throws {Error} If the transaction fails.
+     */
+    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 Iota Move blockchain signer.
+ * Implements the Signer interface for interacting with the Iota Move blockchain.
+ */
+declare class IotaL1Signer implements Signer {
+    nativeSigner: Ed25519Keypair;
+    provider: IotaL1Provider | undefined;
+    /**
+     * Creates an instance of IotaL1Signer.
+     *
+     * @param {Ed25519Keypair} signer - The Iota Move account to use as the signer.
+     */
+    private constructor();
+    /**
+     * Creates an instance of IotaL1Signer from the given parameters.
+     *
+     * @param {string | Ed25519Keypair} source - The source to create the signer from, could be a private key, a mnemonics or an Iota Move account.
+     * @param {string} [path] - The derivation path (optional). e.g. m/44'/4218'/0'/0'/0' If  provided, the source is treated as a mnemonics.
+     * @returns {IotaL1Signer} The created IotaL1Signer instance.
+     * @throws {Error} If the parameters are invalid.
+     */
+    static from(source: string | Ed25519Keypair, path?: string): IotaL1Signer;
+    /**
+     * Gets the native Iota Move signer instance.
+     *
+     * @returns {Ed25519Keypair} The native Iota Move signer instance.
+     */
+    get native(): Ed25519Keypair;
+    /**
+     * 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 IotaL1Provider.
+     */
+    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.
+     * @throws {Error} If the provider is not connected.
+     */
+    sendAndConfirm(transaction: SignedTransaction, opts?: object): Promise<TransactionReceipt>;
+    /**
+     * Sends a signed transaction.
+     *
+     * @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.
+     * @throws {Error} If the provider is not connected.
+     */
+    sendTransaction(transaction: SignedTransaction, sendOptions?: object): Promise<TransactionPending>;
+    /**
+     * Signs a transaction.
+     *
+     * @param {TransactionRequest} transaction - The transaction request to sign.
+     * @returns {Promise<SignedTransaction>} A promise that resolves to the signed transaction.
+     * @throws {Error} If the native provider is not connected.
+     */
+    signTransaction(transaction: TransactionRequest): Promise<SignedTransaction>;
+    /**
+     * Signs a buffer (e.g., a message hash) using the native Iota Move 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>;
+}
+
+export { IotaL1Provider, IotaL1Signer };

package/dist/index.d.ts

@@ -0,0 +1,224 @@
+import { IotaClient } from '@iota/iota-sdk/client';
+import { Provider, Block, BlockWithTransactions, Finality, TransactionResponse, TransactionReceipt, BlockTag, SignedTransaction, TransactionPending, Signer, TransactionRequest } from '@layerzerolabs/lz-core';
+import { Ed25519Keypair } from '@iota/iota-sdk/keypairs/ed25519';
+
+/**
+ * Represents an Iota Move blockchain provider.
+ * Implements the Provider interface for interacting with the Iota Move blockchain.
+ */
+declare class IotaL1Provider implements Provider {
+    readonly url: string;
+    readonly authHeader?: {
+        authField: string;
+        authValue: string;
+    } | undefined;
+    readonly nativeProvider: IotaClient;
+    /**
+     * Creates an instance of IotaL1Provider.
+     *
+     * @param {string} url - The URL of the Iota Move node.
+     * @param {string} [faucet] - The URL of the faucet (optional).
+     * @param {string} [indexer] - The URL of the indexer (optional).
+     * @param authHeader
+     */
+    private constructor();
+    /**
+     * Creates an instance of IotaL1Provider from the given parameters.
+     *
+     * @param {string} source - The URL of the Iota Move node.
+     * @param authHeader
+     * @returns {IotaL1Provider} The created IotaL1Provider instance.
+     * @throws {Error} If the source parameter is not a string.
+     */
+    static from(source: string, authHeader?: {
+        authField: string;
+        authValue: string;
+    }): IotaL1Provider;
+    /**
+     * Gets the native Iota Move client instance.
+     *
+     * @returns {IotaClient} The native Iota Move client instance.
+     */
+    get native(): IotaClient;
+    /**
+     * 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.
+     * @throws {Error} If the address is not a valid Iota Move 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.
+     * @throws {Error} If the blockTag is invalid.
+     */
+    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.
+     * @throws {Error} If the blockTag is invalid.
+     */
+    getBlockWithTransactions(blockTag: string | number): Promise<BlockWithTransactions>;
+    /**
+     * Gets the current block number.
+     *
+     * @returns {Promise<number>} A promise that resolves to the current check point.
+     */
+    getBlockNumber(): Promise<number>;
+    /**
+     * Gets the current slot number for commitment, not suitable for Iota Move.
+     *
+     * @param {Finality} [commitment] - 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 timestamp (A string containing a 64-bit unsigned integer) 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 timestamp of the block.
+     * @throws {Error} If the blockTag is invalid.
+     */
+    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.
+     * @throws {Error} If the transaction hash is invalid.
+     */
+    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.
+     * @throws {Error} If the transaction hash is invalid.
+     */
+    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.
+     * @throws {Error} If the address is invalid.
+     */
+    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.
+     * @throws {Error} If the transaction fails.
+     */
+    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 Iota Move blockchain signer.
+ * Implements the Signer interface for interacting with the Iota Move blockchain.
+ */
+declare class IotaL1Signer implements Signer {
+    nativeSigner: Ed25519Keypair;
+    provider: IotaL1Provider | undefined;
+    /**
+     * Creates an instance of IotaL1Signer.
+     *
+     * @param {Ed25519Keypair} signer - The Iota Move account to use as the signer.
+     */
+    private constructor();
+    /**
+     * Creates an instance of IotaL1Signer from the given parameters.
+     *
+     * @param {string | Ed25519Keypair} source - The source to create the signer from, could be a private key, a mnemonics or an Iota Move account.
+     * @param {string} [path] - The derivation path (optional). e.g. m/44'/4218'/0'/0'/0' If  provided, the source is treated as a mnemonics.
+     * @returns {IotaL1Signer} The created IotaL1Signer instance.
+     * @throws {Error} If the parameters are invalid.
+     */
+    static from(source: string | Ed25519Keypair, path?: string): IotaL1Signer;
+    /**
+     * Gets the native Iota Move signer instance.
+     *
+     * @returns {Ed25519Keypair} The native Iota Move signer instance.
+     */
+    get native(): Ed25519Keypair;
+    /**
+     * 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 IotaL1Provider.
+     */
+    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.
+     * @throws {Error} If the provider is not connected.
+     */
+    sendAndConfirm(transaction: SignedTransaction, opts?: object): Promise<TransactionReceipt>;
+    /**
+     * Sends a signed transaction.
+     *
+     * @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.
+     * @throws {Error} If the provider is not connected.
+     */
+    sendTransaction(transaction: SignedTransaction, sendOptions?: object): Promise<TransactionPending>;
+    /**
+     * Signs a transaction.
+     *
+     * @param {TransactionRequest} transaction - The transaction request to sign.
+     * @returns {Promise<SignedTransaction>} A promise that resolves to the signed transaction.
+     * @throws {Error} If the native provider is not connected.
+     */
+    signTransaction(transaction: TransactionRequest): Promise<SignedTransaction>;
+    /**
+     * Signs a buffer (e.g., a message hash) using the native Iota Move 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>;
+}
+
+export { IotaL1Provider, IotaL1Signer };