@layerzerolabs/lz-solana-sdk-v2 3.0.15 → 3.0.17

package/dist/index.d.ts

@@ -8,122 +8,417 @@ import BN from 'bn.js';
 import { EndpointId, Environment, Network } from '@layerzerolabs/lz-definitions';
 import { HashSigner } from '@layerzerolabs/lz-foundation';
 
+/**
+ * Seed for the endpoint.
+ */
 declare const ENDPOINT_SEED = "Endpoint";
+/**
+ * Seed for the message library.
+ */
 declare const MESSAGE_LIB_SEED = "MessageLib";
+/**
+ * Seed for the send library configuration.
+ */
 declare const SEND_LIBRARY_CONFIG_SEED = "SendLibraryConfig";
+/**
+ * Seed for the receive library configuration.
+ */
 declare const RECEIVE_LIBRARY_CONFIG_SEED = "ReceiveLibraryConfig";
+/**
+ * Seed for the nonce.
+ */
 declare const NONCE_SEED = "Nonce";
+/**
+ * Seed for the pending nonce.
+ */
 declare const PENDING_NONCE_SEED = "PendingNonce";
+/**
+ * Seed for the payload hash.
+ */
 declare const PAYLOAD_HASH_SEED = "PayloadHash";
+/**
+ * Seed for the composed message hash.
+ */
 declare const COMPOSED_MESSAGE_HASH_SEED = "ComposedMessageHash";
+/**
+ * Seed for the OApp.
+ */
 declare const OAPP_SEED = "OApp";
+/**
+ * Seed for the count.
+ */
 declare const COUNT_SEED = "Count";
+/**
+ * Seed for the remote.
+ */
 declare const REMOTE_SEED = "Remote";
+/**
+ * Seed for the LzReceive types.
+ */
 declare const LZ_RECEIVE_TYPES_SEED = "LzReceiveTypes";
+/**
+ * Seed for the LzCompose types.
+ */
 declare const LZ_COMPOSE_TYPES_SEED = "LzComposeTypes";
+/**
+ * Seed for the ULN.
+ */
 declare const ULN_SEED = "MessageLib";
+/**
+ * Seed for the ULN configuration.
+ */
 declare const ULN_CONFIG_SEED = "UlnConfig";
+/**
+ * Seed for the send configuration.
+ */
 declare const SEND_CONFIG_SEED = "SendConfig";
+/**
+ * Seed for the receive configuration.
+ */
 declare const RECEIVE_CONFIG_SEED = "ReceiveConfig";
+/**
+ * Seed for the options.
+ */
 declare const OPTIONS_SEED = "Options";
+/**
+ * Seed for the confirmations.
+ */
 declare const CONFIRMATIONS_SEED = "Confirmations";
+/**
+ * Seed for the worker.
+ */
 declare const WORKER_SEED = "Worker";
+/**
+ * Seed for the DVN configuration.
+ */
 declare const DVN_CONFIG_SEED = "DvnConfig";
+/**
+ * Seed for the event authority.
+ */
 declare const EVENT_SEED = "__event_authority";
+/**
+ * Seed for the executor configuration.
+ */
 declare const EXECUTOR_CONFIG_SEED = "ExecutorConfig";
+/**
+ * Seed for the price feed.
+ */
 declare const PRICE_FEED_SEED = "PriceFeed";
+/**
+ * Seed for the peer.
+ */
 declare const PEER_SEED = "Peer";
+/**
+ * Seed for the mint.
+ */
 declare const MINT_SEED = "Mint";
+/**
+ * Seed for the enforced options.
+ */
 declare const ENFORCED_OPTIONS_SEED = "EnforcedOptions";
 /**
- * derive address for endpoint program
+ * Class to derive addresses for the endpoint program.
  */
 declare class EndpointPDADeriver {
     program: PublicKey;
+    /**
+     * Creates an instance of the EndpointPDADeriver class.
+     *
+     * @param {PublicKey} program - The program public key.
+     */
     constructor(program: PublicKey);
+    /**
+     * Derives the setting address.
+     *
+     * @returns {[PublicKey, number]} The derived address and bump seed.
+     */
     setting(): [PublicKey, number];
+    /**
+     * Derives the default send library configuration address.
+     *
+     * @param {number} dstEndpointId - The destination endpoint ID.
+     * @returns {[PublicKey, number]} The derived address and bump seed.
+     */
     defaultSendLibraryConfig(dstEndpointId: number): [PublicKey, number];
+    /**
+     * Derives the send library configuration address.
+     *
+     * @param {PublicKey} sender - The sender public key.
+     * @param {number} dstEndpointId - The destination endpoint ID.
+     * @returns {[PublicKey, number]} The derived address and bump seed.
+     */
     sendLibraryConfig(sender: PublicKey, dstEndpointId: number): [PublicKey, number];
     /**
-     * @param messageLibrary PDA(derive by message lib program)
+     * Derives the message library information address.
+     *
+     * @param {PublicKey} messageLibrary - The message library public key, PDA(derive by message lib program)
+     * @returns {[PublicKey, number]} The derived address and bump seed.
      */
     messageLibraryInfo(messageLibrary: PublicKey): [PublicKey, number];
+    /**
+     * Derives the default receive library configuration address.
+     *
+     * @param {number} srcEndpointId - The source endpoint ID.
+     * @returns {[PublicKey, number]} The derived address and bump seed.
+     */
     defaultReceiveLibraryConfig(srcEndpointId: number): [PublicKey, number];
+    /**
+     * Derives the receive library configuration address.
+     *
+     * @param {PublicKey} receiver - The receiver public key.
+     * @param {number} srcEndpointId - The source endpoint ID.
+     * @returns {[PublicKey, number]} The derived address and bump seed.
+     */
     receiveLibraryConfig(receiver: PublicKey, srcEndpointId: number): [PublicKey, number];
     receiveLibraryTimeout(_dstEndpointId: number): [PublicKey, number];
     defaultMessageLib(): [PublicKey, number];
     blockMessageLib(blockMsgLib: PublicKey): [PublicKey, number];
     /**
-     * @param localOapp
-     * @param remoteChainId
-     * @param remoteOapp
+     * Derives the nonce address.
+     *
+     * @param {PublicKey} localOapp - The local OApp public key.
+     * @param {number} remoteChainId - The remote chain ID.
+     * @param {Uint8Array} remoteOapp - The remote OApp address.
+     * @returns {[PublicKey, number]} The derived address and bump seed.
      */
     nonce(localOapp: PublicKey, remoteChainId: number, remoteOapp: Uint8Array): [PublicKey, number];
+    /**
+     * Derives the pending nonce address.
+     *
+     * @param {PublicKey} localOapp - The local OApp public key.
+     * @param {number} remoteChainId - The remote chain ID.
+     * @param {Uint8Array} remoteOapp - The remote OApp address.
+     * @returns {[PublicKey, number]} The derived address and bump seed.
+     */
     pendingNonce(localOapp: PublicKey, remoteChainId: number, remoteOapp: Uint8Array): [PublicKey, number];
+    /**
+     * Derives the OApp registry address.
+     *
+     * @param {PublicKey} localOapp - The local OApp public key.
+     * @returns {[PublicKey, number]} The derived address and bump seed.
+     */
     oappRegistry(localOapp: PublicKey): [PublicKey, number];
-    /***
-     * @param receiver
-     * @param srcEid
-     * @param sender
-     * @param nonce
-     * @param payloadHash
-     * @srcChainId u32 to Uint8Array([0,0,0,0])
-     * @sender [u8; 32] sender Address
-     * @nonce u64 to Uint8Array([0,0,0,0,0,0,0,0])
-     * @payloadHash [u8; 32]
+    /**
+     * Derives the payload hash address.
+     *
+     * @param {PublicKey} receiver - The receiver public key.
+     * @param {number} srcEid - The source endpoint ID.
+     * @param {Uint8Array} sender - The sender address.
+     * @param {number} nonce - The nonce.
+     * @returns {[PublicKey, number]} The derived address and bump seed.
      */
     payloadHash(receiver: PublicKey, srcEid: number, sender: Uint8Array, nonce: number): [PublicKey, number];
+    /**
+     * Derives the composed message address.
+     *
+     * @param {PublicKey} from - The sender public key.
+     * @param {Uint8Array} guid - The GUID.
+     * @param {number} index - The index.
+     * @param {PublicKey} to - The receiver public key.
+     * @param {Uint8Array} messageHash - The message hash.
+     * @returns {[PublicKey, number]} The derived address and bump seed.
+     */
     composedMessage(from: PublicKey, guid: Uint8Array, index: number, to: PublicKey, messageHash: Uint8Array): [PublicKey, number];
 }
-/***
- * derive address by message lib program
+/**
+ * Class to derive addresses by message library program.
  */
 declare class MessageLibPDADeriver {
     program: PublicKey;
+    /**
+     * Creates an instance of the MessageLibPDADeriver class.
+     *
+     * @param {PublicKey} program - The program public key.
+     */
     constructor(program: PublicKey);
+    /**
+     * Derives the message library address.
+     *
+     * @returns {[PublicKey, number]} The derived address and bump seed.
+     */
     messageLib(): [PublicKey, number];
+    /**
+     * Derives the send configuration address.
+     *
+     * @param {number} eid - The endpoint ID.
+     * @param {PublicKey} oapp - The OApp public key.
+     * @returns {[PublicKey, number]} The derived address and bump seed.
+     */
     sendConfig(eid: number, oapp: PublicKey): [PublicKey, number];
+    /**
+     * Derives the receive configuration address.
+     *
+     * @param {number} eid - The endpoint ID.
+     * @param {PublicKey} oapp - The OApp public key.
+     * @returns {[PublicKey, number]} The derived address and bump seed.
+     */
     receiveConfig(eid: number, oapp: PublicKey): [PublicKey, number];
 }
+/**
+ * Class to derive addresses for the ULN program.
+ * @see {@link MessageLibPDADeriver}
+ */
 declare class UlnPDADeriver extends MessageLibPDADeriver {
+    /**
+     * Derives the setting address.
+     *
+     * @returns {[PublicKey, number]} The derived address and bump seed.
+     */
     setting(): [PublicKey, number];
+    /**
+     * Derives the configuration address.
+     *
+     * @param {number} eid - The endpoint ID.
+     * @returns {[PublicKey, number]} The derived address and bump seed.
+     */
     config(eid: number): [PublicKey, number];
+    /**
+     * Derives the default send configuration address.
+     *
+     * @param {number} eid - The endpoint ID.
+     * @returns {[PublicKey, number]} The derived address and bump seed.
+     */
     defaultSendConfig(eid: number): [PublicKey, number];
+    /**
+     * Derives the default receive configuration address.
+     *
+     * @param {number} eid - The endpoint ID.
+     * @returns {[PublicKey, number]} The derived address and bump seed.
+     */
     defaultReceiveConfig(eid: number): [PublicKey, number];
+    /**
+     * Derives the options address.
+     *
+     * @param {number} eit - The endpoint ID.
+     * @returns {[PublicKey, number]} The derived address and bump seed.
+     */
     options(eit: number): [PublicKey, number];
+    /**
+     * Derives the worker configuration address.
+     *
+     * @param {PublicKey} worker - The worker public key.
+     * @returns {[PublicKey, number]} The derived address and bump seed.
+     */
     workerConfig(worker: PublicKey): [PublicKey, number];
+    /**
+     * Derives the confirmations address.
+     *
+     * @param {Uint8Array} headerHash - The header hash.
+     * @param {Uint8Array} payloadHash - The payload hash.
+     * @param {PublicKey} dvn - The DVN public key.
+     * @returns {[PublicKey, number]} The derived address and bump seed.
+     */
     confirmations(headerHash: Uint8Array, payloadHash: Uint8Array, dvn: PublicKey): [PublicKey, number];
 }
 /**
- * derive address by base oapp program
+ * Class to derive addresses by base OApp program.
  */
 declare class OAppBasePDADeriver {
     program: PublicKey;
+    /**
+     * Creates an instance of the OAppBasePDADeriver class.
+     *
+     * @param {PublicKey} program - The program public key.
+     */
     constructor(program: PublicKey);
+    /**
+     * Derives the remote address.
+     *
+     * @param {number} dstChainId - The destination chain ID.
+     * @returns {[PublicKey, number]} The derived address and bump seed.
+     */
     remote(dstChainId: number): [PublicKey, number];
+    /**
+     * Derives the LzReceive types accounts address.
+     *
+     * @returns {[PublicKey, number]} The derived address and bump seed.
+     */
     lzReceiveTypesAccounts(): [PublicKey, number];
+    /**
+     * Derives the LzCompose types accounts address.
+     *
+     * @returns {[PublicKey, number]} The derived address and bump seed.
+     */
     lzComposeTypesAccounts(): [PublicKey, number];
 }
+/**
+ * Class to derive addresses for the DVN program.
+ */
 declare class DVNDeriver {
     program: PublicKey;
     constructor(program: PublicKey);
+    /**
+     * Derives the authority address.
+     *
+     * @returns {[PublicKey, number]} The derived address and bump seed.
+     */
     authority(): [PublicKey, number];
+    /**
+     * Derives the configuration address.
+     *
+     * @returns {[PublicKey, number]} The derived address and bump seed.
+     */
     config(): [PublicKey, number];
+    /**
+     * Derives the execute hash address.
+     *
+     * @param {Buffer} digestHash - The digest hash.
+     * @returns {[PublicKey, number]} The derived address and bump seed.
+     */
     executeHash(digestHash: Buffer): [PublicKey, number];
 }
+/**
+ * Class for deriving PDA (Program Derived Address) for events.
+ */
 declare class EventPDADeriver {
     program: PublicKey;
+    /**
+     * Creates an instance of the EventPDADeriver class.
+     *
+     * @param {PublicKey} program - The program public key.
+     */
     constructor(program: PublicKey);
+    /**
+     * Derives the event authority PDA.
+     *
+     * @returns {[PublicKey, number]} The event authority PDA and bump seed.
+     */
     eventAuthority(): [PublicKey, number];
 }
+/**
+ * Class for deriving PDA (Program Derived Address) for executors.
+ */
 declare class ExecutorPDADeriver {
     program: PublicKey;
+    /**
+     * Creates an instance of the ExecutorPDADeriver class.
+     *
+     * @param {PublicKey} program - The program public key.
+     */
     constructor(program: PublicKey);
+    /**
+     * Derives the executor configuration PDA.
+     *
+     * @returns {[PublicKey, number]} The executor configuration PDA and bump seed.
+     */
     config(): [PublicKey, number];
 }
+/**
+ * Class for deriving PDA (Program Derived Address) for price feeds.
+ */
 declare class PriceFeedPDADeriver {
     program: PublicKey;
+    /**
+     * Creates an instance of the PriceFeedPDADeriver class.
+     *
+     * @param {PublicKey} program - The program public key.
+     */
     constructor(program: PublicKey);
+    /**
+     * Derives the price feed PDA.
+     *
+     * @returns {[PublicKey, number]} The price feed PDA and bump seed.
+     */
     priceFeed(): [PublicKey, number];
 }
 
@@ -6482,33 +6777,143 @@ declare const PROGRAM_ID$5: PublicKey;
 
 declare const EventEmitDiscriminator = "e445a52e51cb9a1d";
 declare const DefaultMessageLib: PublicKey;
+/**
+ * Class representing an Endpoint.
+ */
 declare class Endpoint {
     program: PublicKey;
     deriver: EndpointPDADeriver;
     eventAuthorityPDA: PublicKey;
+    /**
+     * Creates an instance of the Endpoint class.
+     *
+     * @param {PublicKey} program - The program public key.
+     */
     constructor(program: PublicKey);
     /**
-     * init endpoint settings, including eid, admin, it also registers the blocked message lib
+     * Initializes the endpoint settings, including eid and admin, and registers the blocked message library.
+     *
+     * @param {number} endpointId - The endpoint ID.
+     * @param {PublicKey} payer - The payer public key.
+     * @param {PublicKey} admin - The admin public key.
+     * @returns {TransactionInstruction} The transaction instruction.
      */
     initEndpoint(endpointId: number, payer: PublicKey, admin: PublicKey): TransactionInstruction;
-    /***
+    /**
+     * Registers a library.
      * call this function after endpoint initialized. Only admin can call this function.
+     *
+     * @param {PublicKey} admin - The admin public key.
+     * @param {PublicKey} messageLibProgram - The message library program public key.
+     * @param {types.MessageLibType} [libType=types.MessageLibType.SendAndReceive] - The library type.
+     * @returns {TransactionInstruction} The transaction instruction.
      */
     registerLibrary(admin: PublicKey, messageLibProgram: PublicKey, libType?: MessageLibType): TransactionInstruction;
+    /**
+     * Sets the default send library.
+     *
+     * @param {Connection} connection - The connection to the Solana cluster.
+     * @param {PublicKey} admin - The admin public key.
+     * @param {PublicKey} messageLibProgram - The message library program public key.
+     * @param {number} dstEid - The destination endpoint ID.
+     * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig] - The commitment level or account info configuration.
+     * @returns {Promise<TransactionInstruction | null>} A promise that resolves to the transaction instruction or null if not needed.
+     */
     setDefaultSendLibrary(connection: Connection, admin: PublicKey, messageLibProgram: PublicKey, dstEid: number, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<TransactionInstruction | null>;
+    /**
+     * Sets the default receive library.
+     *
+     * @param {Connection} connection - The connection to the Solana cluster.
+     * @param {PublicKey} admin - The admin public key.
+     * @param {PublicKey} messageLibProgram - The message library program public key.
+     * @param {number} srcEid - The source endpoint ID.
+     * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig] - The commitment level or account info configuration.
+     * @returns {Promise<TransactionInstruction | null>} A promise that resolves to the transaction instruction or null if not needed.
+     */
     setDefaultReceiveLibrary(connection: Connection, admin: PublicKey, messageLibProgram: PublicKey, srcEid: number, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<TransactionInstruction | null>;
+    /**
+     * Initializes the OApp configuration.
+     *
+     * @param {PublicKey} delegate - The delegate public key.
+     * @param {MessageLibInterface} msgLibSDK - The message library SDK.
+     * @param {PublicKey} payer - The payer public key.
+     * @param {PublicKey} oappID - The OApp ID public key.
+     * @param {number} eid - The endpoint ID.
+     * @returns {TransactionInstruction} The transaction instruction.
+     */
     initOAppConfig(delegate: PublicKey, msgLibSDK: MessageLibInterface, payer: PublicKey, oappID: PublicKey, eid: number): TransactionInstruction;
+    /**
+     * Initializes the OApp nonce.
+     *
+     * @param {PublicKey} delegate - The delegate public key.
+     * @param {number} dstEid - The destination endpoint ID.
+     * @param {PublicKey} oappIDPDA - The OApp ID PDA.
+     * @param {Uint8Array} remoteOappAddr - The remote OApp address.
+     * @returns {TransactionInstruction} The transaction instruction.
+     */
     initOAppNonce(delegate: PublicKey, // payer
     dstEid: number, oappIDPDA: PublicKey, remoteOappAddr: Uint8Array): TransactionInstruction;
+    /**
+     * Initializes the send library.
+     *
+     * @param {PublicKey} delegate - The delegate public key.
+     * @param {PublicKey} sender - The sender public key.
+     * @param {number} dstEid - The destination endpoint ID.
+     * @returns {TransactionInstruction} The transaction instruction.
+     */
     initSendLibrary(delegate: PublicKey, sender: PublicKey, dstEid: number): TransactionInstruction;
+    /**
+     * Sets the send library.
+     *
+     * @param {PublicKey} oappAdmin - The OApp admin public key.
+     * @param {PublicKey} oappIDPDA - The OApp ID PDA.
+     * @param {PublicKey} newSendLibProgram - The new send library program public key.
+     * @param {number} dstEid - The destination endpoint ID.
+     * @returns {TransactionInstruction} The transaction instruction.
+     */
     setSendLibrary(oappAdmin: PublicKey, oappIDPDA: PublicKey, newSendLibProgram: PublicKey, dstEid: number): TransactionInstruction;
+    /**
+     * Initializes the receive library.
+     *
+     * @param {PublicKey} delegate - The delegate public key.
+     * @param {PublicKey} receiver - The receiver public key.
+     * @param {number} srcEid - The source endpoint ID.
+     * @returns {TransactionInstruction} The transaction instruction.
+     */
     initReceiveLibrary(delegate: PublicKey, receiver: PublicKey, srcEid: number): TransactionInstruction;
+    /**
+     * Sets the receive library.
+     *
+     * @param {PublicKey} oappAdmin - The OApp admin public key.
+     * @param {PublicKey} oappIDPDA - The OApp ID PDA.
+     * @param {PublicKey} newReceiveLibProgram - The new receive library program public key.
+     * @param {number} srcEid - The source endpoint ID.
+     * @param {bigint | number} [gracePeriod] - The grace period.
+     * @returns {TransactionInstruction} The transaction instruction.
+     */
     setReceiveLibrary(oappAdmin: PublicKey, oappIDPDA: PublicKey, newReceiveLibProgram: PublicKey, srcEid: number, gracePeriod?: bigint | number): TransactionInstruction;
+    /**
+     * Sets the OApp configuration.
+     *
+     * @param {Connection} connection - The connection to the Solana cluster.
+     * @param {PublicKey} oappDelegate - The OApp delegate public key.
+     * @param {PublicKey} oappID - The OApp ID public key.
+     * @param {PublicKey} msgLibProgram - The message library program public key.
+     * @param {number} eid - The endpoint ID.
+     * @param {object} config - The configuration object.
+     * @param {SetConfigType} config.configType - The configuration type.
+     * @param {UlnProgram.types.ExecutorConfig | UlnProgram.types.UlnConfig} config.value - The configuration value.
+     * @param {Commitment} [commitment='confirmed'] - The commitment level.
+     * @returns {Promise<TransactionInstruction>} A promise that resolves to the transaction instruction.
+     * @throws {Error} If the message library version is unsupported.
+     */
     setOappConfig(connection: Connection, oappDelegate: PublicKey, oappID: PublicKey, msgLibProgram: PublicKey, eid: number, config: {
         configType: SetConfigType;
         value: ExecutorConfig | UlnConfig;
     }, commitment?: Commitment): Promise<TransactionInstruction>;
-    /***
+    /**
+     *
+     * Gets the account metadata for the CPI (Cross-Program Invocation) of the quote instruction.
      *
      * caculate the fee for sending a message with ULN:
      *  1. executorFee: feeForGas + feeForOptionType
@@ -6519,14 +6924,58 @@ declare class Endpoint {
      *
      *  The priceRatioDenominator is 10^20
      *  totalFee = executorFee + oracleFee * numOracles(requiredOracles + optionalOracles)
+     *
+     * @param {Connection} connection - The connection to the Solana cluster.
+     * @param {PublicKey} payer - The payer public key.
+     * @param {PacketPath} path - The packet path.
+     * @param {MessageLibInterface} msgLibProgram - The message library program.
+     * @returns {Promise<AccountMeta[]>} A promise that resolves to an array of account metadata.
+     * @throws {Error} If the default send library is not initialized or the message library is blocked.
      */
     getQuoteIXAccountMetaForCPI(connection: Connection, payer: PublicKey, path: PacketPath, msgLibProgram: MessageLibInterface): Promise<AccountMeta[]>;
-    /***
-     * Get the account meta of the send instruction for CPI(Cross-Program Invocation )
+    /**
+     * Gets the account metadata for the CPI (Cross-Program Invocation) of the send instruction.
+     *
+     * @param {Connection} connection - The connection to the Solana cluster.
+     * @param {PublicKey} payer - The payer public key.
+     * @param {PacketPath} path - The packet path.
+     * @param {MessageLibInterface} msgLibProgram - The message library program.
+     * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig] - The commitment level or account info configuration.
+     * @returns {Promise<AccountMeta[]>} A promise that resolves to an array of account metadata.
+     * @throws {Error} If the default send library is not initialized or the message library is blocked.
      */
     getSendIXAccountMetaForCPI(connection: Connection, payer: PublicKey, path: PacketPath, msgLibProgram: MessageLibInterface, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<AccountMeta[]>;
+    /**
+     * Skips a message.
+     *
+     * @param {PublicKey} payer - The payer public key.
+     * @param {PublicKey} sender - The sender public key.
+     * @param {PublicKey} receiver - The receiver public key.
+     * @param {number} srcEid - The source endpoint ID.
+     * @param {string} nonce - The nonce.
+     * @returns {Promise<TransactionInstruction | null>} A promise that resolves to the transaction instruction or null if not needed.
+     */
     skip(payer: PublicKey, sender: PublicKey, receiver: PublicKey, srcEid: number, nonce: string): Promise<TransactionInstruction | null>;
+    /**
+     * Initializes the verification process.
+     *
+     * @param {Connection} connection - The connection to the Solana cluster.
+     * @param {PublicKey} payer - The payer public key.
+     * @param {PublicKey} sender - The sender public key.
+     * @param {PublicKey} receiver - The receiver public key.
+     * @param {number} srcEid - The source endpoint ID.
+     * @param {string} nonce - The nonce.
+     * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig] - The commitment level or account info configuration.
+     * @returns {Promise<TransactionInstruction | null>} A promise that resolves to the transaction instruction or null if not needed.
+     */
     initVerify(connection: Connection, payer: PublicKey, sender: PublicKey, receiver: PublicKey, srcEid: number, nonce: string, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<TransactionInstruction | null>;
+    /**
+     * Gets the account metadata for the CPI (Cross-Program Invocation) of the verify instruction.
+     *
+     * @param {PacketV1Codec} packet - The packet.
+     * @param {PublicKey} receiveLibrary - The receive library public key.
+     * @returns {AccountMeta[]} An array of account metadata.
+     */
     getVerifyIXAccountMetaForCPI(packet: PacketV1Codec, receiveLibrary: PublicKey): AccountMeta[];
     /***
      * resetConfig is only supported by ULN
@@ -6540,27 +6989,93 @@ declare class Endpoint {
     /**
      * @param composer. The composer is usually the PDA of the app's ID. It depends on the oapp's implementation.
      */
+    /**
+     * Gets the account metadata for the CPI (Cross-Program Invocation) of the register OApp instruction.
+     *
+     * @param {PublicKey} payer - The payer public key.
+     * @param {PublicKey} oapp - The OApp public key.
+     * @returns {AccountMeta[]} An array of account metadata.
+     */
     getRegisterOappIxAccountMetaForCPI(payer: PublicKey, oapp: PublicKey): AccountMeta[];
+    /**
+     * Gets the account metadata for the CPI (Cross-Program Invocation) of the skip instruction.
+     *
+     * @param {PublicKey} receiver - The receiver public key.
+     * @param {Uint8Array} sender - The sender address.
+     * @param {number} srcEid - The source endpoint ID.
+     * @param {number} nonce - The nonce.
+     * @returns {AccountMeta[]} An array of account metadata.
+     */
     getSkipIxAccountMetaForCPI(receiver: PublicKey, sender: Uint8Array, srcEid: number, nonce: number): AccountMeta[];
+    /**
+     * Checks if the given message library program is the default send library.
+     *
+     * @param {Connection} connection - The connection to the Solana cluster.
+     * @param {PublicKey} messageLibProgram - The message library program public key.
+     * @param {number} dstEid - The destination endpoint ID.
+     * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig] - The commitment level or account info configuration.
+     * @returns {Promise<boolean>} A promise that resolves to true if the message library program is the default send library, false otherwise.
+     */
     isDefaultSendLibrary(connection: Connection, messageLibProgram: PublicKey, dstEid: number, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<boolean>;
+    /**
+     * Checks if the given message library program is the default receive library.
+     *
+     * @param {Connection} connection - The connection to the Solana cluster.
+     * @param {PublicKey} messageLibProgram - The message library program public key.
+     * @param {number} srcEid - The source endpoint ID.
+     * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig] - The commitment level or account info configuration.
+     * @returns {Promise<boolean>} A promise that resolves to true if the message library program is the default receive library, false otherwise.
+     */
     isDefaultReceiveLibrary(connection: Connection, messageLibProgram: PublicKey, srcEid: number, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<boolean>;
+    /**
+     * Gets the endpoint settings.
+     *
+     * @param {Connection} connection - The connection to the Solana cluster.
+     * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig] - The commitment level or account info configuration.
+     * @returns {Promise<EndpointSettings | null>} A promise that resolves to the endpoint settings or null if not found.
+     */
     getSetting(connection: Connection, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<EndpointSettings | null>;
     /**
+     * Gets the message library information.
      *
-     * @param messageLib  It is a PDA of the message library program
+     * @param {Connection} connection - The connection to the Solana cluster.
+     * @param {PublicKey} messageLibProgram - The message library program public key, It is a PDA of the message library program
+     * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig] - The commitment level or account info configuration.
+     * @returns {Promise<MessageLibInfo | null>} A promise that resolves to the message library information or null if not found.
      */
     getMessageLibInfo(connection: Connection, messageLibProgram: PublicKey, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<MessageLibInfo | null>;
+    /**
+     * Gets the default receive library.
+     *
+     * @param {Connection} connection - The connection to the Solana cluster.
+     * @param {number} srcEid - The source endpoint ID.
+     * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig] - The commitment level or account info configuration.
+     * @returns {Promise<{ msgLib: PublicKey; owner?: PublicKey } | null>} A promise that resolves to the default receive library or null if not found.
+     */
     getDefaultReceiveLibrary(connection: Connection, srcEid: number, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<{
         msgLib: PublicKey;
         owner?: PublicKey;
     } | null>;
+    /**
+     * Gets the default send library.
+     *
+     * @param {Connection} connection - The connection to the Solana cluster.
+     * @param {number} dstEid - The destination endpoint ID.
+     * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig] - The commitment level or account info configuration.
+     * @returns {Promise<{ msgLib: PublicKey; owner?: PublicKey } | null>} A promise that resolves to the default send library or null if not found.
+     */
     getDefaultSendLibrary(connection: Connection, dstEid: number, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<{
         msgLib: PublicKey;
         owner?: PublicKey;
     } | null>;
     /**
-     * get app configured send library
-     * 2 RPC calls
+     * Gets the configured send library for the app.
+     *
+     * @param {Connection} connection - The connection to the Solana cluster.
+     * @param {PublicKey} oappPda - The OApp PDA.
+     * @param {number} dstEid - The destination endpoint ID.
+     * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig='confirmed'] - The commitment level or account info configuration.
+     * @returns {Promise<{ msgLib: PublicKey; programId?: PublicKey; isDefault: boolean } | null>} A promise that resolves to the configured send library or null if not found.
      */
     getSendLibrary(connection: Connection, oappPda: PublicKey, dstEid: number, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<{
         msgLib: PublicKey;
@@ -6568,7 +7083,13 @@ declare class Endpoint {
         isDefault: boolean;
     } | null>;
     /**
-     * get app configured receive library
+     * Gets the configured receive library for the app.
+     *
+     * @param {Connection} connection - The connection to the Solana cluster.
+     * @param {PublicKey} oappPda - The OApp PDA.
+     * @param {number} srcEid - The source endpoint ID.
+     * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig] - The commitment level or account info configuration.
+     * @returns {Promise<{ msgLib: PublicKey; programId?: PublicKey; isDefault: boolean; timeout: { msgLib: PublicKey; expiry: bigint } | null } | null>} A promise that resolves to the configured receive library or null if not found.
      */
     getReceiveLibrary(connection: Connection, oappPda: PublicKey, srcEid: number, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<{
         msgLib: PublicKey;
@@ -6579,11 +7100,70 @@ declare class Endpoint {
             expiry: bigint;
         } | null;
     } | null>;
+    /**
+     * Gets the inbound payload hash.
+     *
+     * @param {Connection} connection - The connection to the Solana cluster.
+     * @param {PublicKey} receiver - The receiver public key.
+     * @param {number} srcEid - The source endpoint ID.
+     * @param {Uint8Array} sender - The sender address.
+     * @param {number} nonce - The nonce.
+     * @param {Uint8Array} _payloadHash - The payload hash.
+     * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig] - The commitment level or account info configuration.
+     * @returns {Promise<PayloadHash | null>} A promise that resolves to the payload hash or null if not found.
+     */
     getInboundPayloadHash(connection: Connection, receiver: PublicKey, srcEid: number, sender: Uint8Array, nonce: number, _payloadHash: Uint8Array, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<PayloadHash | null>;
+    /**
+     * Gets the composed message state.
+     *
+     * @param {Connection} connection - The connection to the Solana cluster.
+     * @param {PublicKey} from - The sender public key.
+     * @param {types.SendComposeParams} params - The send compose parameters.
+     * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig] - The commitment level or account info configuration.
+     * @returns {Promise<ComposeMessageState | null>} A promise that resolves to the composed message state or null if not found.
+     */
     getComposedMessageState(connection: Connection, from: PublicKey, params: SendComposeParams, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<ComposeMessageState | null>;
+    /**
+     * Gets the nonce.
+     *
+     * @param {Connection} connection - The connection to the Solana cluster.
+     * @param {PublicKey} oappIDPDA - The OApp ID PDA.
+     * @param {number} remoteEid - The remote endpoint ID.
+     * @param {Uint8Array} remoteOappAddr - The remote OApp address.
+     * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig] - The commitment level or account info configuration.
+     * @returns {Promise<accounts.Nonce | null>} A promise that resolves to the nonce or null if not found.
+     */
     getNonce(connection: Connection, oappIDPDA: PublicKey, remoteEid: number, remoteOappAddr: Uint8Array, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<Nonce$1 | null>;
+    /**
+     * Gets the pending inbound nonce.
+     *
+     * @param {Connection} connection - The connection to the Solana cluster.
+     * @param {PublicKey} oappIDPDA - The OApp ID PDA.
+     * @param {number} remoteEid - The remote endpoint ID.
+     * @param {Uint8Array} remoteOappAddr - The remote OApp address.
+     * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig] - The commitment level or account info configuration.
+     * @returns {Promise<accounts.PendingInboundNonce | null>} A promise that resolves to the pending inbound nonce or null if not found.
+     */
     getPendingInboundNonce(connection: Connection, oappIDPDA: PublicKey, remoteEid: number, remoteOappAddr: Uint8Array, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<PendingInboundNonce | null>;
+    /**
+     * Gets the message library version.
+     *
+     * @param {Connection} connection - The connection to the Solana cluster.
+     * @param {PublicKey} payer - The payer public key.
+     * @param {PublicKey} messageLibProgram - The message library program public key.
+     * @param {Commitment} [commitment='confirmed'] - The commitment level.
+     * @returns {Promise<Version | null>} A promise that resolves to the version or null if not found.
+     */
     getMessageLibVersion(connection: Connection, payer: PublicKey, messageLibProgram: PublicKey, commitment?: Commitment): Promise<Version$1 | null>;
+    /**
+     * Transfers the admin role to a new admin.
+     *
+     * @param {Connection} connection - The connection to the Solana cluster.
+     * @param {PublicKey} admin - The current admin public key.
+     * @param {PublicKey} newAdmin - The new admin public key.
+     * @param {Commitment} [commitment='confirmed'] - The commitment level.
+     * @returns {Promise<TransactionInstruction | null>} A promise that resolves to the transaction instruction or null if not needed.
+     */
     transferAdmin(connection: Connection, admin: PublicKey, newAdmin: PublicKey, commitment?: Commitment): Promise<TransactionInstruction | null>;
 }
 
@@ -6595,24 +7175,114 @@ declare namespace endpoint {
   export { endpoint_DefaultMessageLib as DefaultMessageLib, endpoint_Endpoint as Endpoint, endpoint_EventEmitDiscriminator as EventEmitDiscriminator, PROGRAM_ID$6 as PROGRAM_ID, index$r as accounts, index$q as errors, index$n as events, index$p as instructions, index$o as types };
 }
 
+/**
+ * Class representing the SimpleMessageLib.
+ * @see {@link MessageLibInterface}
+ */
 declare class SimpleMessageLib implements MessageLibInterface {
     program: PublicKey;
+    /**
+     * The PDA deriver for the message library.
+     */
     deriver: MessageLibPDADeriver;
+    /**
+     * Creates an instance of the SimpleMessageLib class.
+     *
+     * @param {PublicKey} program - The program public key.
+     */
     constructor(program: PublicKey);
+    /**
+     * Initializes the SimpleMessageLib.
+     *
+     * @param {PublicKey} endpointProgram - The endpoint program public key.
+     * @param {PublicKey} payer - The payer public key.
+     * @param {PublicKey} admin - The admin public key.
+     * @param {number} eid - The endpoint ID.
+     * @param {number} nativeFee - The native fee.
+     * @param {number} [lzTokenFee=0] - The LayerZero token fee.
+     *
+     * @returns {TransactionInstruction} The transaction instruction.
+     */
     initSimpleMessageLib(endpointProgram: PublicKey, payer: PublicKey, admin: PublicKey, eid: number, nativeFee: number, lzTokenFee?: number): TransactionInstruction;
+    /**
+     * Sets the whitelist caller.
+     *
+     * @param {PublicKey} admin - The admin public key.
+     * @param {PublicKey} newCaller - The new caller public key.
+     *
+     * @returns {TransactionInstruction} The transaction instruction.
+     */
     setWhitelistCaller(admin: PublicKey, newCaller: PublicKey): TransactionInstruction;
+    /**
+     * Checks if a caller is whitelisted.
+     *
+     * @param {Connection} connection - The connection object.
+     * @param {PublicKey} caller - The caller public key.
+     * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig] - The commitment or config.
+     *
+     * @returns {Promise<boolean>} A promise that resolves to true if the caller is whitelisted, false otherwise.
+     */
     isWhiteListed(connection: Connection, caller: PublicKey, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<boolean>;
+    /**
+     * Gets the whitelisted caller.
+     *
+     * @param {Connection} connection - The connection object.
+     * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig] - The commitment or config.
+     *
+     * @returns {Promise<PublicKey>} A promise that resolves to the whitelisted caller public key.
+     */
     getWhiteListCaller(connection: Connection, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<PublicKey>;
+    /**
+     * Validates a packet.
+     *
+     * @param {Connection} _connection - The connection object.
+     * @param {PublicKey} endpointProgram - The endpoint program public key.
+     * @param {PublicKey} payer - The payer public key.
+     * @param {Uint8Array} encodedPacket - The encoded packet.
+     *
+     * @returns {TransactionInstruction} The transaction instruction.
+     */
     validatePacket(_connection: Connection, endpointProgram: PublicKey, payer: PublicKey, encodedPacket: Uint8Array): TransactionInstruction;
-    /***
-     * Get the account meta of the send instruction for CPI(Cross-Program Invocation )
+    /**
+     * Gets the account meta of the send instruction for CPI (Cross-Program Invocation).
+     *
+     * @param {Connection} _connection - The connection object.
+     * @param {PublicKey} payer - The payer public key.
+     * @param {PacketPath} _path - The packet path.
+     *
+     * @returns {Promise<AccountMeta[]>} A promise that resolves to an array of account meta.
      */
     getSendIXAccountMetaForCPI(_connection: Connection, payer: PublicKey, _path: PacketPath): Promise<AccountMeta[]>;
+    /**
+     * Gets the account meta of the quote instruction for CPI (Cross-Program Invocation).
+     *
+     * @param {Connection} _connection - The connection object.
+     * @param {PublicKey} _payer - The payer public key.
+     * @param {PacketPath} _path - The packet path.
+     * @param {Commitment} [commitment] - The commitment.
+     *
+     * @returns {Promise<AccountMeta[]>} A promise that resolves to an array of account meta.
+     */
     getQuoteIXAccountMetaForCPI(_connection: Connection, _payer: PublicKey, _path: PacketPath, _commitment?: Commitment): Promise<AccountMeta[]>;
-    /***
-     * Get the account meta of the send instruction for CPI(Cross-Program Invocation )
+    /**
+     * Gets the account meta of the init config instruction for CPI (Cross-Program Invocation).
+     *
+     * @param {PublicKey} payer - The payer public key.
+     * @param {PublicKey} oappID - The oapp ID public key.
+     * @param {number} eid - The endpoint ID.
+     *
+     * @returns {AccountMeta[]} An array of account meta.
      */
     getInitConfigIXAccountMetaForCPI(payer: PublicKey, oappID: PublicKey, eid: number): AccountMeta[];
+    /**
+     * Gets the account meta of the set config instruction for CPI (Cross-Program Invocation).
+     *
+     * @param {PublicKey} endpointProgram - The endpoint program public key.
+     * @param {PublicKey} oappID - The oapp ID public key.
+     * @param {number} eid - The endpoint ID.
+     *
+     * @returns {Promise<AccountMeta[]>} A promise that resolves to an array of account meta.
+     */
     getSetConfigIXAccountMetaForCPI(endpointProgram: PublicKey, oappID: PublicKey, eid: number): Promise<AccountMeta[]>;
 }
 
@@ -8370,47 +9040,227 @@ declare namespace index$d {
   export { type index$d_AdminConfigSetEvent as AdminConfigSetEvent, type index$d_FeeWithdrawnEvent as FeeWithdrawnEvent, type index$d_MultisigConfigSetEvent as MultisigConfigSetEvent, index$d_adminConfigSetEventBeet as adminConfigSetEventBeet, index$d_feeWithdrawnEventBeet as feeWithdrawnEventBeet, index$d_multisigConfigSetEventBeet as multisigConfigSetEventBeet };
 }
 
+/**
+ * Interface representing a sign function.
+ */
 interface SignFunc {
+    /**
+     * Signs a message.
+     *
+     * @param {Buffer} message - The message to sign.
+     * @returns {Promise<{ signature: Uint8Array; recoveryId: number }[]>} A promise that resolves to an array of signature objects.
+     */
     sign(message: Buffer): Promise<{
         signature: Uint8Array;
         recoveryId: number;
     }[]>;
 }
+/**
+ * Class representing a Solana signer extension.
+ */
 declare class SolanaSignerExt implements SignFunc {
     private readonly signers;
     private constructor();
+    /**
+     * Creates an instance of the SolanaSignerExt class.
+     *
+     * @param {HashSigner[]} signers - The signers.
+     * @returns {SolanaSignerExt} The SolanaSignerExt instance.
+     */
     static from(signers: HashSigner[]): SolanaSignerExt;
+    /**
+     * Signs a message.
+     *
+     * @param {Buffer} message - The message to sign.
+     * @returns {Promise<{ signature: Uint8Array; recoveryId: number }[]>} A promise that resolves to an array of signature objects.
+     */
     sign(message: Buffer): Promise<{
         signature: Uint8Array;
         recoveryId: number;
     }[]>;
 }
+/**
+ * Class representing a DVN (Decentralized Validator Network).
+ */
 declare class DVN {
     readonly programId: PublicKey;
     dvnDeriver: DVNDeriver;
     vid: number;
     eventAuthority: PublicKey;
+    /**
+     * Creates an instance of the DVN class.
+     *
+     * @param {PublicKey} programId - The program ID.
+     * @param {EndpointId} [endpointId=EndpointId.SOLANA_V2_SANDBOX] - The endpoint ID.
+     */
     constructor(programId: PublicKey, endpointId?: EndpointId);
+    /**
+     * Initializes the DVN.
+     *
+     * @param {Connection} connection - The connection.
+     * @param {PublicKey} payer - The payer.
+     * @param {InitDvnParams} params - The initialization parameters.
+     * @returns {Promise<TransactionInstruction>} A promise that resolves to the transaction instruction.
+     * @throws {Error} If the DVN is already initialized.
+     */
     initDVN(connection: Connection, payer: PublicKey, params: InitDvnParams): Promise<TransactionInstruction>;
+    /**
+     * Gets the digest for a transaction.
+     *
+     * @param {number} vid - The validator ID.
+     * @param {TransactionInstruction} instruction - The transaction instruction.
+     * @param {number} expiration - The expiration time.
+     * @returns {types.ExecuteTransactionDigest} The transaction digest.
+     */
     getDigest(vid: number, instruction: TransactionInstruction, expiration: number): ExecuteTransactionDigest;
+    /**
+     * Gets the execute hash for a given hash bytes.
+     *
+     * @param {Buffer} hashBytes - The hash bytes.
+     * @returns {PublicKey} The execute hash.
+     */
     getExecuteHash(hashBytes: Buffer): PublicKey;
+    /**
+     * Gets the hash bytes for a given digest.
+     *
+     * @param {types.ExecuteTransactionDigest} digest - The transaction digest.
+     * @returns {Buffer} The hash bytes.
+     */
     getHashBytes(digest: ExecuteTransactionDigest): Buffer;
+    /**
+     * Invokes a transaction.
+     *
+     * @param {Connection} connection - The connection.
+     * @param {number} vid - The validator ID.
+     * @param {PublicKey} payer - The payer.
+     * @param {TransactionInstruction} instruction - The transaction instruction.
+     * @param {number} expiration - The expiration time.
+     * @param {SignFunc} sign - The sign function.
+     * @returns {Promise<TransactionInstruction>} A promise that resolves to the transaction instruction.
+     * @throws {Error} If the DVN is not initialized.
+     */
     invoke(connection: Connection, vid: number, payer: PublicKey, instruction: TransactionInstruction, expiration: number, sign: SignFunc): Promise<TransactionInstruction>;
+    /**
+     * Creates a transaction instruction to set the quorum.
+     *
+     * @param {number} quorum - The quorum.
+     * @returns {TransactionInstruction} The transaction instruction.
+     */
     createSetQuorumInstruction(quorum: number): TransactionInstruction;
+    /**
+     * Creates a transaction instruction to set the admins.
+     *
+     * @param {PublicKey[]} admins - The admin public keys.
+     * @returns {TransactionInstruction} The transaction instruction.
+     */
     createSetAdminsInstruction(admins: PublicKey[]): TransactionInstruction;
+    /**
+     * Creates a transaction instruction to set the signers.
+     *
+     * @param {Uint8Array[]} signers - The signer public keys.
+     * @returns {TransactionInstruction} The transaction instruction.
+     */
     createSetSignersInstruction(signers: Uint8Array[]): TransactionInstruction;
+    /**
+     * Creates a transaction instruction to set the allowlist.
+     *
+     * @param {PublicKey[]} allowlist - The allowlist public keys.
+     * @returns {TransactionInstruction} The transaction instruction.
+     */
     createSetAllowlistInstruction(allowlist: PublicKey[]): TransactionInstruction;
+    /**
+     * Creates a transaction instruction to set the denylist.
+     *
+     * @param {PublicKey[]} denylist - The denylist public keys.
+     * @returns {TransactionInstruction} The transaction instruction.
+     */
     createSetDenylistInstruction(denylist: PublicKey[]): TransactionInstruction;
+    /**
+     * Creates a transaction instruction to set the pause state.
+     *
+     * @param {boolean} pause - The pause state.
+     * @returns {TransactionInstruction} The transaction instruction.
+     */
     createSetPauseInstruction(pause: boolean): TransactionInstruction;
+    /**
+     * Creates a transaction instruction to set the default multiplier basis points.
+     *
+     * @param {PublicKey} admin - The admin public key.
+     * @param {number} defaultMultiplierBps - The default multiplier basis points.
+     * @returns {TransactionInstruction} The transaction instruction.
+     */
     createSetDefaultMultiplierBpsInstruction(admin: PublicKey, defaultMultiplierBps: number): TransactionInstruction;
+    /**
+     * Creates a transaction instruction to change the admins.
+     *
+     * @param {PublicKey} admin - The admin public key.
+     * @param {PublicKey[]} admins - The new admin public keys.
+     * @returns {TransactionInstruction} The transaction instruction.
+     */
     createChangeAdminsInstruction(admin: PublicKey, admins: PublicKey[]): TransactionInstruction;
+    /**
+     * Creates a transaction instruction to set the destination configurations.
+     *
+     * @param {PublicKey} admin - The admin public key.
+     * @param {types.DstConfig[]} dstConfigs - The destination configurations.
+     * @returns {TransactionInstruction} The transaction instruction.
+     */
     createSetDstConfigInstruction(admin: PublicKey, dstConfigs: DstConfig$1[]): TransactionInstruction;
+    /**
+     * Creates a transaction instruction to remove the destination configurations.
+     *
+     * @param {PublicKey} admin - The admin public key.
+     * @param {number[]} removeEids - The endpoint IDs to remove.
+     * @returns {TransactionInstruction} The transaction instruction.
+     */
     createRemoveDstConfigInstruction(admin: PublicKey, removeEids: number[]): TransactionInstruction;
+    /**
+     * Creates a transaction instruction to set the message libraries.
+     *
+     * @param {PublicKey[]} msglibPrograms - The message library public keys.
+     * @returns {TransactionInstruction} The transaction instruction.
+     */
     createSetMsgLibsInstruction(msglibPrograms: PublicKey[]): TransactionInstruction;
+    /**
+     * Gets the expiration time.
+     *
+     * @returns {number} The expiration time.
+     */
     _getExpiration(): number;
+    /**
+     * Sets the message libraries.
+     *
+     * @param {Connection} connection - The connection.
+     * @param {PublicKey} payer - The payer.
+     * @param {PublicKey[]} msgLibs - The message library public keys.
+     * @param {SignFunc} sign - The sign function.
+     * @returns {Promise<TransactionInstruction>} A promise that resolves to the transaction instruction.
+     */
     setMsgLibs(connection: Connection, payer: PublicKey, msgLibs: PublicKey[], sign: SignFunc): Promise<TransactionInstruction>;
+    /**
+     * Creates a transaction instruction to set the price feed.
+     *
+     * @param {PublicKey} admin - The admin public key.
+     * @param {PublicKey} priceFeedProgram - The price feed program public key.
+     * @returns {TransactionInstruction} The transaction instruction.
+     */
     createSetPriceFeedInstruction(admin: PublicKey, priceFeedProgram: PublicKey): TransactionInstruction;
+    /**
+     * Gets the account metadata for the CPI (Cross-Program Invocation) of the quote instruction.
+     *
+     * @param {PublicKey} priceFeedConfig - The price feed configuration public key.
+     * @param {PublicKey} priceFeedProgram - The price feed program public key.
+     * @param {boolean} payment - Indicates if payment is required.
+     * @returns {AccountMeta[]} An array of account metadata.
+     */
     getQuoteIXAccountMetaForCPI(priceFeedConfig: PublicKey, priceFeedProgram: PublicKey, payment: boolean): AccountMeta[];
+    /**
+     * Gets the configuration state.
+     *
+     * @param {Connection} connection - The connection to the Solana cluster.
+     * @param {Commitment | GetAccountInfoConfig} [commitment='confirmed'] - The commitment level or account info configuration.
+     * @returns {Promise<accounts.DvnConfig | null>} A promise that resolves to the configuration state or null if not found.
+     */
     getConfigState(connection: Connection, commitment?: Commitment | GetAccountInfoConfig): Promise<DvnConfig | null>;
 }
 
@@ -9950,25 +10800,178 @@ declare const PROGRAM_ADDRESS$2 = "6doghB248px58JSSwG4qejQ46kFMW4AMj7vzJnWZHNZn"
  */
 declare const PROGRAM_ID$3: PublicKey;
 
+/**
+ * Class representing the Executor.
+ */
 declare class Executor {
     program: PublicKey;
     deriver: ExecutorPDADeriver;
+    /**
+     * Creates an instance of the Executor class.
+     *
+     * @param {PublicKey} program - The program public key.
+     */
     constructor(program: PublicKey);
+    /**
+     * Initializes the executor.
+     *
+     * @param {PublicKey} payer - The payer public key.
+     * @param {PublicKey} owner - The owner public key.
+     * @param {PublicKey[]} admins - The admin public keys.
+     * @param {PublicKey[]} executors - The executor public keys.
+     * @param {PublicKey[]} msglibs - The message library public keys.
+     * @param {PublicKey} priceFeed - The price feed public key.
+     *
+     * @returns {TransactionInstruction} The transaction instruction.
+     */
     initExecutor(payer: PublicKey, owner: PublicKey, admins: PublicKey[], executors: PublicKey[], msglibs: PublicKey[], priceFeed: PublicKey): TransactionInstruction;
+    /**
+     * Sets the owner.
+     *
+     * @param {PublicKey} owner - The current owner public key.
+     * @param {PublicKey} newOwner - The new owner public key.
+     *
+     * @returns {TransactionInstruction} The transaction instruction.
+     */
     setOwner(owner: PublicKey, newOwner: PublicKey): TransactionInstruction;
+    /**
+     * Sets the admins.
+     *
+     * @param {PublicKey} owner - The owner public key.
+     * @param {PublicKey[]} admins - The admin public keys.
+     *
+     * @returns {TransactionInstruction} The transaction instruction.
+     */
     setAdmins(owner: PublicKey, admins: PublicKey[]): TransactionInstruction;
+    /**
+     * Sets the allow list.
+     *
+     * @param {PublicKey} owner - The owner public key.
+     * @param {PublicKey[]} allowlist - The allow list public keys.
+     *
+     * @returns {TransactionInstruction} The transaction instruction.
+     */
     setAllowList(owner: PublicKey, allowlist: PublicKey[]): TransactionInstruction;
+    /**
+     * Sets the deny list.
+     *
+     * @param {PublicKey} owner - The owner public key.
+     * @param {PublicKey[]} denylist - The deny list public keys.
+     *
+     * @returns {TransactionInstruction} The transaction instruction.
+     */
     setDenyList(owner: PublicKey, denylist: PublicKey[]): TransactionInstruction;
+    /**
+     * Sets the paused state.
+     *
+     * @param {PublicKey} owner - The owner public key.
+     * @param {boolean} paused - The paused state.
+     *
+     * @returns {TransactionInstruction} The transaction instruction.
+     */
     setPaused(owner: PublicKey, paused: boolean): TransactionInstruction;
+    /**
+     * Sets the executors.
+     *
+     * @param {PublicKey} owner - The owner public key.
+     * @param {PublicKey[]} executors - The executor public keys.
+     *
+     * @returns {TransactionInstruction} The transaction instruction.
+     */
     setExecutors(owner: PublicKey, executors: PublicKey[]): TransactionInstruction;
+    /**
+     * Sets the message libraries by programs.
+     *
+     * @param {PublicKey} owner - The owner public key.
+     * @param {PublicKey[]} msglibPrograms - The message library program public keys.
+     *
+     * @returns {TransactionInstruction} The transaction instruction.
+     */
     setMsglibByPrograms(owner: PublicKey, msglibPrograms: PublicKey[]): TransactionInstruction;
+    /**
+     * Sets the message libraries by PDAs.
+     *
+     * @param {PublicKey} owner - The owner public key.
+     * @param {PublicKey[]} msglibPDAs - The message library PDA public keys.
+     *
+     * @returns {TransactionInstruction} The transaction instruction.
+     */
     setMsglibByPDAs(owner: PublicKey, msglibPDAs: PublicKey[]): TransactionInstruction;
+    /**
+     * Sets the default multiplier BPS.
+     *
+     * @param {PublicKey} admin - The admin public key.
+     * @param {number} defaultMultiplierBps - The default multiplier BPS.
+     *
+     * @returns {TransactionInstruction} The transaction instruction.
+     */
     setDefaultMultiplierBps(admin: PublicKey, defaultMultiplierBps: number): TransactionInstruction;
+    /**
+     * Sets the destination configurations.
+     *
+     * @param {PublicKey} admin - The admin public key.
+     * @param {types.DstConfig[]} dstConfigs - The destination configurations.
+     *
+     * @returns {TransactionInstruction} The transaction instruction.
+     */
     setDstConfig(admin: PublicKey, dstConfigs: DstConfig[]): TransactionInstruction;
+    /**
+     * Sets the price feed.
+     *
+     * @param {PublicKey} admin - The admin public key.
+     * @param {PublicKey} priceFeedProgram - The price feed program public key.
+     *
+     * @returns {TransactionInstruction} The transaction instruction.
+     */
     setPriceFeed(admin: PublicKey, priceFeedProgram: PublicKey): TransactionInstruction;
+    /**
+     * Gets the executor configuration.
+     *
+     * @param {Connection} connection - The connection.
+     * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig] - The commitment or configuration.
+     *
+     * @returns {Promise<accounts.ExecutorConfig | null>} A promise that resolves to the executor configuration or null.
+     */
     getExecutorConfig(connection: Connection, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<ExecutorConfig$1 | null>;
+    /**
+     * Gets the quote instruction account meta for CPI.
+     *
+     * @param {PublicKey} priceFeedConfig - The price feed configuration public key.
+     * @param {PublicKey} priceFeedProgram - The price feed program public key.
+     * @param {boolean} payment - Whether payment is required.
+     *
+     * @returns {AccountMeta[]} The account meta array.
+     */
     getQuoteIXAccountMetaForCPI(priceFeedConfig: PublicKey, priceFeedProgram: PublicKey, payment: boolean): AccountMeta[];
+    /**
+     * Executes a transaction.
+     *
+     * @param {Connection} connection - The connection.
+     * @param {PublicKey} executor - The executor public key.
+     * @param {PublicKey} endpointProgram - The endpoint program public key.
+     * @param {Packet} packet - The packet.
+     * @param {Uint8Array} extraData - The extra data.
+     * @param {BN} [value] - The value.
+     * @param {number} [computeUnits] - The compute units.
+     * @param {Commitment} [commitmentOrConfig] - The commitment or configuration.
+     *
+     * @returns {Promise<TransactionInstruction>} A promise that resolves to the transaction instruction.
+     */
     execute(connection: Connection, executor: PublicKey, endpointProgram: PublicKey, packet: Packet$2, extraData: Uint8Array, value?: BN, computeUnits?: number, commitmentOrConfig?: Commitment): Promise<TransactionInstruction>;
+    /**
+     * Composes a transaction.
+     *
+     * @param {Connection} connection - The connection.
+     * @param {PublicKey} executor - The executor public key.
+     * @param {PublicKey} endpointProgram - The endpoint program public key.
+     * @param {ComposeSentEvent} event - The compose sent event.
+     * @param {Uint8Array} extraData - The extra data.
+     * @param {BN} [value] - The value.
+     * @param {number} [computeUnits] - The compute units.
+     * @param {Commitment} [commitmentOrConfig] - The commitment or configuration.
+     *
+     * @returns {Promise<TransactionInstruction>} A promise that resolves to the transaction instruction.
+     */
     compose(connection: Connection, executor: PublicKey, endpointProgram: PublicKey, event: ComposeSentEvent, extraData: Uint8Array, value?: BN, computeUnits?: number, commitmentOrConfig?: Commitment): Promise<TransactionInstruction>;
 }
 
@@ -12820,41 +13823,134 @@ declare const PROGRAM_ADDRESS$1 = "7a4WjyR8VZ7yZz5XJAKm39BUGn5iT9CKcv2pmG9tdXVH"
  */
 declare const PROGRAM_ID$2: PublicKey;
 
+/**
+ * Interface representing the maximum message size.
+ */
 interface MaxMessageSize {
+    /**
+     * The size of the message.
+     */
     size: number;
+    /**
+     * The kind of the message size.
+     */
     __kind: 'MaxMessageSize';
 }
+/**
+ * Interface representing the outbound confirmations.
+ */
 interface OutboundConfirmations {
+    /**
+     * The number of confirmations.
+     */
     confirmations: number;
+    /**
+     * The kind of the outbound confirmations.
+     */
     __kind: 'OutboundConfirmations';
 }
+/**
+ * Interface representing the inbound confirmations.
+ */
 interface InboundConfirmations {
+    /**
+     * The number of confirmations.
+     */
     confirmations: number;
+    /**
+     * The kind of the inbound confirmations.
+     */
     __kind: 'InboundConfirmations';
 }
+/**
+ * Interface representing the oracles.
+ */
 interface Oracles {
+    /**
+     * Indicates if custom oracles are used.
+     */
     useCustomOracles: boolean;
+    /**
+     * The array of oracle public keys.
+     */
     oracles: PublicKey[];
+    /**
+     * The kind of the oracles.
+     */
     __kind: 'Oracles';
 }
+/**
+ * Interface representing the optional oracles.
+ */
 interface OptionalOracles {
+    /**
+     * Indicates if custom optional oracles are used.
+     */
     useCustomOptionalOracles: boolean;
+    /**
+     * The array of optional oracle public keys.
+     */
     optionalOracles: PublicKey[];
+    /**
+     * The threshold for the optional oracles.
+     */
     threshold: number;
+    /**
+     * The kind of the optional oracles.
+     */
     __kind: 'OptionalOracles';
 }
+/**
+ * Class representing the ULN (Ultra Light Node).
+ * @see {@link MessageLibInterface}
+ */
 declare class Uln implements MessageLibInterface {
     program: PublicKey;
     deriver: UlnPDADeriver;
     eventAuthorityPDA: PublicKey;
+    /**
+     * Creates an instance of the Uln class.
+     *
+     * @param {PublicKey} program - The program public key.
+     */
     constructor(program: PublicKey);
+    /**
+     * Initializes the ULN.
+     *
+     * @param {PublicKey} endpointProgram - The endpoint program public key.
+     * @param {PublicKey} payer - The payer public key.
+     * @param {PublicKey} admin - The admin public key.
+     * @param {number} eid - The endpoint ID.
+     * @returns {TransactionInstruction} The transaction instruction.
+     */
     initUln(endpointProgram: PublicKey, payer: PublicKey, admin: PublicKey, eid: number): TransactionInstruction;
     /**
+     * Initializes or updates the default configuration.
      * before calling this function, you should call initUln to initialize the uln
+     *
+     * @param {Connection} connection - The connection to the Solana cluster.
+     * @param {PublicKey} admin - The admin public key.
+     * @param {number} eid - The endpoint ID.
+     * @param {types.UlnConfig} sendUlnConfig - The send ULN configuration.
+     * @param {types.UlnConfig} receiveUlnConfig - The receive ULN configuration.
+     * @param {types.ExecutorConfig} executorConfig - The executor configuration.
+     * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig] - The commitment level or account info configuration.
+     * @returns {Promise<TransactionInstruction>} A promise that resolves to the transaction instruction.
      */
     initOrUpdateDefaultConfig(connection: Connection, admin: PublicKey, eid: number, sendUlnConfig: UlnConfig, receiveUlnConfig: UlnConfig, executorConfig: ExecutorConfig, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<TransactionInstruction>;
     /**
+     * Sets the treasury.
      * before calling this function, you should call initUln to initialize the uln
+     *
+     * @param {PublicKey} admin - The admin public key.
+     * @param {object} treasury - The treasury object.
+     * @param {PublicKey} treasury.admin - The treasury admin public key.
+     * @param {PublicKey} treasury.nativeReceiver - The native receiver public key.
+     * @param {number} treasury.nativeFeeBps - The native fee basis points.
+     * @param {object} treasury.lzToken - The LZ token object.
+     * @param {PublicKey} treasury.lzToken.receiver - The LZ token receiver public key.
+     * @param {number} treasury.lzToken.fee - The LZ token fee.
+     * @returns {Promise<TransactionInstruction>} A promise that resolves to the transaction instruction.
      */
     setTreasury(admin: PublicKey, treasury: {
         admin: PublicKey;
@@ -12865,27 +13961,57 @@ declare class Uln implements MessageLibInterface {
             fee: number;
         } | null;
     } | null): Promise<TransactionInstruction>;
-    transferAdmin(connection: Connection, admin: PublicKey, newAdmin: PublicKey, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<TransactionInstruction>;
     /**
+     * Transfers the admin role to a new admin.
      *
-     * @param connection
+     * @param {Connection} connection - The connection to the Solana cluster.
+     * @param {PublicKey} admin - The current admin public key.
+     * @param {PublicKey} newAdmin - The new admin public key.
+     * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig] - The commitment level or account info configuration.
+     * @returns {Promise<TransactionInstruction>} A promise that resolves to the transaction instruction.
+     * @throws {Error} If the ULN is not initialized.
+     */
+    transferAdmin(connection: Connection, admin: PublicKey, newAdmin: PublicKey, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<TransactionInstruction>;
+    /**
+     * Gets the account metadata for the CPI (Cross-Program Invocation) of the quote instruction.
      *
-     * @param sender the oApp PDA
-     * @param sendLibraryAuthority
-     * @param dstEid
-     * @param payInLzToken
-     * @param commitment
-     * @returns
+     * @param {Connection} connection - The connection to the Solana cluster.
+     * @param {PublicKey} _payer - The payer public key.
+     * @param {PacketPath} path - The packet path.
+     * @param {Commitment} [commitment] - The commitment level.
+     * @returns {Promise<AccountMeta[]>} A promise that resolves to an array of account metadata.
      */
     getQuoteIXAccountMetaForCPI(connection: Connection, _payer: PublicKey, path: PacketPath, commitment?: Commitment): Promise<AccountMeta[]>;
-    /***
-     * Get the account meta of the send instruction for CPI(Cross-Program Invocation )
+    /**
+     * Gets the account metadata for the CPI (Cross-Program Invocation) of the send instruction.
+     *
+     * @param {Connection} connection - The connection to the Solana cluster.
+     * @param {PublicKey} payer - The payer public key.
+     * @param {PacketPath} path - The packet path.
+     * @param {Commitment} [commitment='confirmed'] - The commitment level.
+     * @returns {Promise<AccountMeta[]>} A promise that resolves to an array of account metadata.
      */
     getSendIXAccountMetaForCPI(connection: Connection, payer: PublicKey, path: PacketPath, commitment?: Commitment): Promise<AccountMeta[]>;
+    /**
+     * Gets the remaining accounts for the send instruction.
+     *
+     * @param {Connection} connection - The connection to the Solana cluster.
+     * @param {PublicKey} sender - The sender public key.
+     * @param {number} dstEid - The destination endpoint ID.
+     * @param {boolean} payment - Indicates if payment is required.
+     * @param {Commitment | GetAccountInfoConfig} [commitment='confirmed'] - The commitment level or account info configuration.
+     * @returns {Promise<AccountMeta[]>} A promise that resolves to an array of account metadata.
+     */
     getSendIxRemainingAccounts(connection: Connection, sender: PublicKey, dstEid: number, payment: boolean, commitment?: Commitment | GetAccountInfoConfig): Promise<AccountMeta[]>;
-    /***
-     * Get all workers(executor&DVN)
+    /**
+     * Gets all workers (executor and DVN).
      * 2 RPC requests
+     *
+     * @param {Connection} connection - The connection to the Solana cluster.
+     * @param {PublicKey} sender - The sender public key.
+     * @param {number} eid - The endpoint ID.
+     * @param {Commitment | GetAccountInfoConfig} [commitment='confirmed'] - The commitment level or account info configuration.
+     * @returns {Promise<{ executor: { config: ExecutorAccounts.ExecutorConfig; owner: PublicKey }; dvns: { config: DvnAccounts.DvnConfig; owner: PublicKey }[] }>} A promise that resolves to an object containing the executor and DVN configurations.
      */
     getWorkers(connection: Connection, sender: PublicKey, eid: number, commitment?: Commitment | GetAccountInfoConfig): Promise<{
         executor: {
@@ -12897,26 +14023,138 @@ declare class Uln implements MessageLibInterface {
             owner: PublicKey;
         }[];
     }>;
+    /**
+     * Initializes the verification process.
+     *
+     * @param {Connection} connection - The connection to the Solana cluster.
+     * @param {PublicKey} payer - The payer public key.
+     * @param {PublicKey} dvn - The DVN public key.
+     * @param {Uint8Array} packetBytes - The packet bytes.
+     * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig] - The commitment level or account info configuration.
+     * @returns {Promise<TransactionInstruction | null>} A promise that resolves to the transaction instruction or null if not needed.
+     */
     initVerify(connection: Connection, payer: PublicKey, dvn: PublicKey, packetBytes: Uint8Array, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<TransactionInstruction | null>;
+    /**
+     * Verifies the packet.
+     *
+     * @param {PublicKey} dvn - The DVN public key.
+     * @param {Uint8Array} packetBytes - The packet bytes.
+     * @param {number | string} confirmations - The number of confirmations.
+     * @returns {TransactionInstruction} The transaction instruction.
+     */
     verify(dvn: PublicKey, packetBytes: Uint8Array, confirmations: number | string): TransactionInstruction;
+    /**
+     * Closes the verification process.
+     *
+     * @param {PublicKey} dvn - The DVN public key.
+     * @param {PublicKey} receiver - The receiver public key.
+     * @param {Uint8Array} packetBytes - The packet bytes.
+     * @returns {TransactionInstruction} The transaction instruction.
+     */
     closeVerify(dvn: PublicKey, receiver: PublicKey, packetBytes: Uint8Array): TransactionInstruction;
+    /**
+     * Checks if the DVN is verified.
+     *
+     * @param {Connection} connection - The connection to the Solana cluster.
+     * @param {PublicKey} endpointProgram - The endpoint program public key.
+     * @param {PublicKey} dvn - The DVN public key.
+     * @param {Uint8Array} packetBytes - The packet bytes.
+     * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig='confirmed'] - The commitment level or account info configuration.
+     * @returns {Promise<boolean>} A promise that resolves to true if the DVN is verified, false otherwise.
+     */
     isDvnVerified(connection: Connection, endpointProgram: PublicKey, dvn: PublicKey, packetBytes: Uint8Array, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<boolean>;
+    /**
+     * Commits the verification process.
+     *
+     * @param {Connection} connection - The connection to the Solana cluster.
+     * @param {PublicKey} endpointProgram - The endpoint program public key.
+     * @param {Uint8Array} packetBytes - The packet bytes.
+     * @returns {Promise<TransactionInstruction>} A promise that resolves to the transaction instruction.
+     */
     commitVerification(connection: Connection, endpointProgram: PublicKey, packetBytes: Uint8Array): Promise<TransactionInstruction>;
-    /***
-     * Get the account meta of the send instruction for CPI(Cross-Program Invocation )
+    /**
+     * Gets the account metadata for the CPI (Cross-Program Invocation) of the init config instruction.
+     *
+     * @param {PublicKey} payer - The payer public key.
+     * @param {PublicKey} oappID - The OApp ID public key.
+     * @param {number} eid - The endpoint ID.
+     * @returns {AccountMeta[]} An array of account metadata.
      */
     getInitConfigIXAccountMetaForCPI(payer: PublicKey, oappID: PublicKey, eid: number): AccountMeta[];
+    /**
+     * Constructs the set config data.
+     *
+     * @param {SetConfigType} configType - The configuration type.
+     * @param {types.ExecutorConfig | types.UlnConfig} configData - The configuration data.
+     * @returns {Uint8Array} The constructed set config data.
+     * @throws {Error} If the configuration type is invalid.
+     */
     static constructSetConfigData(configType: SetConfigType, configData: ExecutorConfig | UlnConfig): Uint8Array;
     /**
-     * @param oappID the oApp PDA
+     * Gets the account metadata for the CPI (Cross-Program Invocation) of the set config instruction.
      *
+     * @param {PublicKey} endpointProgram - The endpoint program public key.
+     * @param {PublicKey} oappID - The OApp ID public key.
+     * @param {number} eid - The endpoint ID.
+     * @returns {Promise<AccountMeta[]>} A promise that resolves to an array of account metadata.
      */
     getSetConfigIXAccountMetaForCPI(endpointProgram: PublicKey, oappID: PublicKey, eid: number): Promise<AccountMeta[]>;
+    /**
+     * Gets the ULN settings.
+     *
+     * @param {Connection} connection - The connection to the Solana cluster.
+     * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig] - The commitment level or account info configuration.
+     * @returns {Promise<accounts.UlnSettings | null>} A promise that resolves to the ULN settings or null if not found.
+     */
     getSetting(connection: Connection, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<UlnSettings | null>;
+    /**
+     * Gets the default send configuration state.
+     *
+     * @param {Connection} connection - The connection to the Solana cluster.
+     * @param {number} eid - The endpoint ID.
+     * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig] - The commitment level or account info configuration.
+     * @returns {Promise<accounts.SendConfig | null>} A promise that resolves to the default send configuration state or null if not found.
+     */
     getDefaultSendConfigState(connection: Connection, eid: number, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<SendConfig | null>;
+    /**
+     * Gets the send configuration state.
+     *
+     * @param {Connection} connection - The connection to the Solana cluster.
+     * @param {PublicKey} sender - The sender public key.
+     * @param {number} eid - The endpoint ID.
+     * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig] - The commitment level or account info configuration.
+     * @returns {Promise<accounts.SendConfig | null>} A promise that resolves to the send configuration state or null if not found.
+     */
     getSendConfigState(connection: Connection, sender: PublicKey, eid: number, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<SendConfig | null>;
+    /**
+     * Gets the default receive configuration state.
+     *
+     * @param {Connection} connection - The connection to the Solana cluster.
+     * @param {number} eid - The endpoint ID.
+     * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig] - The commitment level or account info configuration.
+     * @returns {Promise<accounts.ReceiveConfig | null>} A promise that resolves to the default receive configuration state or null if not found.
+     */
     getDefaultReceiveConfigState(connection: Connection, eid: number, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<ReceiveConfig | null>;
+    /**
+     * Gets the receive configuration state.
+     *
+     * @param {Connection} connection - The connection to the Solana cluster.
+     * @param {PublicKey} receiver - The receiver public key.
+     * @param {number} eid - The endpoint ID.
+     * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig] - The commitment level or account info configuration.
+     * @returns {Promise<accounts.ReceiveConfig | null>} A promise that resolves to the receive configuration state or null if not found.
+     */
     getReceiveConfigState(connection: Connection, receiver: PublicKey, eid: number, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<ReceiveConfig | null>;
+    /**
+     * Gets the final receive configuration state.
+     *
+     * @param {Connection} connection - The connection to the Solana cluster.
+     * @param {PublicKey} receiver - The receiver public key.
+     * @param {number} eid - The endpoint ID.
+     * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig='confirmed'] - The commitment level or account info configuration.
+     * @returns {Promise<accounts.ReceiveConfig>} A promise that resolves to the final receive configuration state.
+     * @throws {Error} If no DVN is found.
+     */
     getFinalReceiveConfigState(connection: Connection, receiver: PublicKey, eid: number, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<ReceiveConfig>;
 }
 
@@ -13908,15 +15146,80 @@ declare namespace index$1 {
  */
 declare const PROGRAM_ID$1: PublicKey;
 
+/**
+ * Class representing the PriceFeed.
+ */
 declare class PriceFeed {
     readonly program: PublicKey;
     deriver: PriceFeedPDADeriver;
+    /**
+     * Creates an instance of the PriceFeed class.
+     *
+     * @param {PublicKey} program - The public key of the program.
+     */
     constructor(program: PublicKey);
+    /**
+     * Initializes the price feed.
+     *
+     * @param {Connection} connection - The Solana connection object.
+     * @param {PublicKey} payer - The public key of the payer.
+     * @param {PublicKey} admin - The public key of the admin.
+     * @param {PublicKey[]} updaters - The list of public keys of the updaters.
+     * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig] - Optional commitment or configuration.
+     *
+     * @returns {Promise<TransactionInstruction>} The transaction instruction.
+     */
     initPriceFeed(connection: Connection, payer: PublicKey, admin: PublicKey, updaters: PublicKey[], commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<TransactionInstruction>;
+    /**
+     * Sets the price feed.
+     *
+     * @param {PublicKey} admin - The public key of the admin.
+     * @param {PublicKey[]} updaters - The list of public keys of the updaters.
+     * @param {bignum} priceRatioDenominator - The price ratio denominator.
+     * @param {number} arbitrumCompressionPercent - The Arbitrum compression percentage.
+     *
+     * @returns {TransactionInstruction} The transaction instruction.
+     */
     setPriceFeed(admin: PublicKey, updaters: PublicKey[], priceRatioDenominator: bignum, arbitrumCompressionPercent: number): TransactionInstruction;
+    /**
+     * Sets the price.
+     *
+     * @param {PublicKey} updater - The public key of the updater.
+     * @param {number} dstEid - The destination EID.
+     * @param {bignum} priceRatio - The price ratio.
+     * @param {bignum} gasPriceInUnit - The gas price in unit.
+     * @param {number} gasPerByte - The gas per byte.
+     * @param {types.ModelType | null} modelType - The model type.
+     *
+     * @returns {TransactionInstruction} The transaction instruction.
+     */
     setPrice(updater: PublicKey, dstEid: number, priceRatio: bignum, gasPriceInUnit: bignum, gasPerByte: number, modelType: ModelType | null): TransactionInstruction;
+    /**
+     * Sets the SOL price.
+     *
+     * @param {PublicKey} updater - The public key of the updater.
+     * @param {bignum | null} nativeTokenPriceUsd - The native token price in USD.
+     *
+     * @returns {TransactionInstruction} The transaction instruction.
+     */
     setSolPrice(updater: PublicKey, nativeTokenPriceUsd: bignum | null): TransactionInstruction;
+    /**
+     * Transfers the admin role.
+     *
+     * @param {PublicKey} admin - The public key of the current admin.
+     * @param {PublicKey} newAdmin - The public key of the new admin.
+     *
+     * @returns {TransactionInstruction} The transaction instruction.
+     */
     transferAdmin(admin: PublicKey, newAdmin: PublicKey): TransactionInstruction;
+    /**
+     * Retrieves the price feed account.
+     *
+     * @param {Connection} connection - The Solana connection object.
+     * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig] - Optional commitment or configuration.
+     *
+     * @returns {Promise<accounts.PriceFeed | null>} The price feed account or null if not found.
+     */
     getPriceFeed(connection: Connection, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<PriceFeed$1 | null>;
 }
 
@@ -13926,75 +15229,361 @@ declare namespace pricefeed {
   export { PROGRAM_ID$1 as PROGRAM_ID, pricefeed_PriceFeed as PriceFeed, index$3 as accounts, index$2 as instructions, index$1 as types };
 }
 
+/**
+ * Derives the OApp ID PDA.
+ *
+ * @param {PublicKey} program - The program public key.
+ * @param {string} [seed=COUNT_SEED] - The seed.
+ * @param {number} [id] - The ID.
+ * @returns {[PublicKey, number]} The derived PDA and bump.
+ */
 declare function oappIDPDA(program: PublicKey, seed?: string, id?: number): [PublicKey, number];
+/**
+ * Derives the LZ receive types accounts PDA.
+ *
+ * @param {PublicKey} program - The program public key.
+ * @param {PublicKey} [oappId] - The OApp ID.
+ * @returns {[PublicKey, number]} The derived PDA and bump.
+ */
 declare function deriveLzReceiveTypesAccountsPDA(program: PublicKey, oappId?: PublicKey): [PublicKey, number];
+/**
+ * Derives the LZ compose types accounts PDA.
+ *
+ * @param {PublicKey} program - The program public key.
+ * @param {PublicKey} [oappId] - The OApp ID.
+ * @returns {[PublicKey, number]} The derived PDA and bump.
+ */
 declare function deriveLzComposeTypesAccountsPDA(program: PublicKey, oappId?: PublicKey): [PublicKey, number];
+/**
+ * Abstract class representing a base OApp.
+ */
 declare abstract class BaseOApp {
     program: PublicKey;
     oappBaseDeriver: OAppBasePDADeriver;
+    /**
+     * Creates an instance of the BaseOApp class.
+     *
+     * @param {PublicKey} program - The program public key.
+     */
     constructor(program: PublicKey);
+    /**
+     * Gets the endpoint.
+     *
+     * @param {Connection} connection - The connection.
+     * @returns {Promise<EndpointProgram.Endpoint>} The endpoint.
+     */
     abstract getEndpoint(connection: Connection): Promise<Endpoint>;
+    /**
+     * Gets the send library program.
+     *
+     * @param {Connection} connection - The connection.
+     * @param {PublicKey} payer - The payer public key.
+     * @param {number} dstEid - The destination endpoint ID.
+     * @param {EndpointProgram.Endpoint} [endpoint] - The endpoint.
+     * @returns {Promise<SimpleMessageLibProgram.SimpleMessageLib | UlnProgram.Uln>} The send library program.
+     */
     abstract getSendLibraryProgram(connection: Connection, payer: PublicKey, dstEid: number, endpoint?: Endpoint): Promise<SimpleMessageLib | Uln>;
+    /**
+     * Queries the ID PDA info.
+     *
+     * @param {Connection} connection - The connection.
+     * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig] - The commitment or config.
+     * @returns {Promise<AccountInfo<Buffer> | null>} The account info.
+     */
     queryIDPDAInfo(connection: Connection, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<AccountInfo<Buffer> | null>;
+    /**
+     * Queries the PDA info.
+     *
+     * @param {Connection} connection - The connection.
+     * @param {PublicKey} pda - The PDA public key.
+     * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig] - The commitment or config.
+     * @returns {Promise<AccountInfo<Buffer> | null>} The account info.
+     */
     queryPDAInfo(connection: Connection, pda: PublicKey, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<AccountInfo<Buffer> | null>;
+    /**
+     * Gets the ID PDA.
+     *
+     * @returns {[PublicKey, number]} The ID PDA and bump.
+     */
     idPDA(): [PublicKey, number];
+    /**
+     * Gets the remote.
+     *
+     * @param {Connection} connection - The connection.
+     * @param {number} dstEid - The destination endpoint ID.
+     * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig] - The commitment or config.
+     * @returns {Promise<Uint8Array | null>} The remote data.
+     */
     getRemote(connection: Connection, dstEid: number, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<Uint8Array | null>;
 }
 
+/**
+ * Extracts the sent packet event by transaction hash.
+ *
+ * @param {Connection} connection - The connection to the Solana cluster.
+ * @param {PublicKey} program - The program public key.
+ * @param {TransactionSignature | Awaited<ReturnType<typeof connection.getParsedTransaction>>} signature - The transaction signature or parsed transaction.
+ * @param {Finality | GetVersionedTransactionConfig} [commitment] - The commitment level.
+ * @param {boolean} [unsafeParseErr=false] - Whether to parse the event even if the transaction failed.
+ * @returns {Promise<PacketSentEvent[] | null>} A promise that resolves to an array of sent packet events or null if not found.
+ */
 declare function extractSentPacketEventByTxHash(connection: Connection, program: PublicKey, signature: TransactionSignature | Awaited<ReturnType<typeof connection.getParsedTransaction>>, commitment?: Finality | GetVersionedTransactionConfig, unsafeParseErr?: boolean): Promise<PacketSentEvent[] | null>;
+/**
+ * Extracts the verified packet event by transaction hash.
+ *
+ * @param {Connection} connection - The connection to the Solana cluster.
+ * @param {PublicKey} program - The program public key.
+ * @param {TransactionSignature | Awaited<ReturnType<typeof connection.getParsedTransaction>>} signature - The transaction signature or parsed transaction.
+ * @param {Finality | GetVersionedTransactionConfig} [commitment] - The commitment level.
+ * @param {boolean} [unsafeParseErr=false] - Whether to parse the event even if the transaction failed.
+ * @returns {Promise<PacketVerifiedEvent[] | null>} A promise that resolves to an array of verified packet events or null if not found.
+ */
 declare function extractVerifiedPacketEventByTxHash(connection: Connection, program: PublicKey, signature: TransactionSignature | Awaited<ReturnType<typeof connection.getParsedTransaction>>, commitment?: Finality | GetVersionedTransactionConfig, unsafeParseErr?: boolean): Promise<PacketVerifiedEvent[] | null>;
+/**
+ * Extracts the received packet event by transaction hash.
+ *
+ * @param {Connection} connection - The connection to the Solana cluster.
+ * @param {PublicKey} program - The program public key.
+ * @param {TransactionSignature | Awaited<ReturnType<typeof connection.getParsedTransaction>>} signature - The transaction signature or parsed transaction.
+ * @param {Finality | GetVersionedTransactionConfig} [commitment] - The commitment level.
+ * @param {boolean} [unsafeParseErr=false] - Whether to parse the event even if the transaction failed.
+ * @returns {Promise<PacketDeliveredEvent[] | null>} A promise that resolves to an array of received packet events or null if not found.
+ */
 declare function extractReceivedPacketEventByTxHash(connection: Connection, program: PublicKey, signature: TransactionSignature | Awaited<ReturnType<typeof connection.getParsedTransaction>>, commitment?: Finality | GetVersionedTransactionConfig, unsafeParseErr?: boolean): Promise<PacketDeliveredEvent[] | null>;
+/**
+ * Extracts the compose sent event by transaction hash.
+ *
+ * @param {Connection} connection - The connection to the Solana cluster.
+ * @param {PublicKey} program - The program public key.
+ * @param {TransactionSignature | Awaited<ReturnType<typeof connection.getParsedTransaction>>} signature - The transaction signature or parsed transaction.
+ * @param {Finality | GetVersionedTransactionConfig} [commitment] - The commitment level.
+ * @param {boolean} [unsafeParseErr=false] - Whether to parse the event even if the transaction failed.
+ * @returns {Promise<ComposeSentEvent[] | null>} A promise that resolves to an array of compose sent events or null if not found.
+ */
 declare function extractComposeSentEventByTxHash(connection: Connection, program: PublicKey, signature: TransactionSignature | Awaited<ReturnType<typeof connection.getParsedTransaction>>, commitment?: Finality | GetVersionedTransactionConfig, unsafeParseErr?: boolean): Promise<ComposeSentEvent[] | null>;
+/**
+ * Extracts the compose delivered event by transaction hash.
+ *
+ * @param {Connection} connection - The connection to the Solana cluster.
+ * @param {PublicKey} program - The program public key.
+ * @param {TransactionSignature | Awaited<ReturnType<typeof connection.getParsedTransaction>>} signature - The transaction signature or parsed transaction.
+ * @param {Finality | GetVersionedTransactionConfig} [commitment] - The commitment level.
+ * @param {boolean} [unsafeParseErr=false] - Whether to parse the event even if the transaction failed.
+ * @returns {Promise<ComposeDeliveredEvent[] | null>} A promise that resolves to an array of compose delivered events or null if not found.
+ */
 declare function extractComposeDeliveredEventByTxHash(connection: Connection, program: PublicKey, signature: TransactionSignature | Awaited<ReturnType<typeof connection.getParsedTransaction>>, commitment?: Finality | GetVersionedTransactionConfig, unsafeParseErr?: boolean): Promise<ComposeDeliveredEvent[] | null>;
+/**
+ * Extracts the worker fee paid event by transaction hash.
+ *
+ * @param {Connection} connection - The connection to the Solana cluster.
+ * @param {PublicKey} program - The program public key.
+ * @param {TransactionSignature | Awaited<ReturnType<typeof connection.getParsedTransaction>>} signature - The transaction signature or parsed transaction.
+ * @param {Finality | GetVersionedTransactionConfig} [commitment] - The commitment level.
+ * @param {boolean} [unsafeParseErr=false] - Whether to parse the event even if the transaction failed.
+ * @returns {Promise<FeesPaidEvent[] | null>} A promise that resolves to an array of worker fee paid events or null if not found.
+ */
 declare function extractWorkerFeePaidEventByTxHash(connection: Connection, program: PublicKey, signature: TransactionSignature | Awaited<ReturnType<typeof connection.getParsedTransaction>>, commitment?: Finality | GetVersionedTransactionConfig, unsafeParseErr?: boolean): Promise<FeesPaidEvent[] | null>;
 /**
- * @param connection
- * @param program extract event from specific program id
- * @signature transaction signature(tx hash) or parsed transaction
- * @eventBeet beet struct for event
- * @commitment commitment level
- * @unsafeParseErr Default is false, only parse event if transaction succeeded. if true, will parse event even if transaction failed. Please set this to false if you want to ignore failed transaction and set `true` with caution as it may lead to unexpected behavior.
- * @returns array of events or null if no event found
+ * Extracts events from a transaction signature.
+ *
+ * @param {Connection} connection - The connection to the Solana cluster.
+ * @param {PublicKey} program - The program public key, extract event from specific program id
+ * @param {TransactionSignature | Awaited<ReturnType<typeof connection.getParsedTransaction>>} signature - The transaction signature(tx hash) or parsed transaction.
+ * @param {beet.FixableBeetArgsStruct<E> | beet.BeetArgsStruct<E>} eventBeet - The beet struct for the event.
+ * @param {Finality | GetVersionedTransactionConfig} [commitment] - The commitment level.
+ * @param {boolean} [unsafeParseErr=false] - Whether to parse the event even if the transaction failed. Default is false, only parse event if transaction succeeded. if true, will parse event even if transaction failed. Please set this to false if you want to ignore failed transaction and set `true` with caution as it may lead to unexpected behavior.
+ * @returns {Promise<E[] | null>} A promise that resolves to an array of events or null if not found.
  */
 declare function extractEventFromTransactionSignature<E>(connection: Connection, program: PublicKey, signature: TransactionSignature | Awaited<ReturnType<typeof connection.getParsedTransaction>>, eventBeet: beet.FixableBeetArgsStruct<E> | beet.BeetArgsStruct<E>, commitment?: Finality | GetVersionedTransactionConfig, unsafeParseErr?: boolean): Promise<E[] | null>;
+/**
+ * Generates an address lookup table.
+ *
+ * @param {Connection} connection - The connection to the Solana cluster.
+ * @param {PublicKey} payer - The payer public key.
+ * @param {PublicKey} authority - The authority public key.
+ * @param {PublicKey[]} addresses - The addresses to include in the lookup table.
+ * @returns {Promise<{ instructions: TransactionInstruction[]; address: PublicKey }>} A promise that resolves to the instructions and lookup table address.
+ */
 declare function generateAddressLookupTable(connection: Connection, payer: PublicKey, authority: PublicKey, addresses: PublicKey[]): Promise<{
     instructions: TransactionInstruction[];
     address: PublicKey;
 }>;
+/**
+ * Deactivates an address lookup table.
+ * To properly terminate the lookup table, it is advisable to initially invoke `deactivateLookupTable`,
+ * pause for a duration of 500 blocks, and subsequently invoke `closeLookupTable`.
+ *
+ * @param {PublicKey} authority - The authority public key.
+ * @param {PublicKey} lookupTable - The lookup table public key.
+ * @returns {TransactionInstruction} The transaction instruction.
+ */
 declare function deactivateLookupTable(authority: PublicKey, lookupTable: PublicKey): TransactionInstruction;
+/**
+ * Closes an address lookup table.
+ * To properly terminate the lookup table, it is advisable to initially invoke `deactivateLookupTable`,
+ * pause for a duration of 500 blocks, and subsequently invoke `closeLookupTable`.
+ *
+ * @param {PublicKey} recipient - The recipient public key.
+ * @param {PublicKey} authority - The authority public key.
+ * @param {PublicKey} lookupTable - The lookup table public key.
+ * @returns {TransactionInstruction} The transaction instruction.
+ */
 declare function closeLookupTable(recipient: PublicKey, authority: PublicKey, lookupTable: PublicKey): TransactionInstruction;
+/**
+ * Creates a versioned transaction with an address lookup table.
+ *
+ * @param {Connection} connection - The connection to the Solana cluster.
+ * @param {PublicKey} payer - The payer public key.
+ * @param {TransactionInstruction[]} instructions - The transaction instructions.
+ * @param {Blockhash} [recentBlockHash] - The recent block hash.
+ * @param {PublicKey} [tableAddr] - The address lookup table public key.
+ * @returns {Promise<VersionedTransaction>} A promise that resolves to the versioned transaction.
+ */
 declare function txWithAddressLookupTable(connection: Connection, payer: PublicKey, instructions: TransactionInstruction[], recentBlockHash?: Blockhash, tableAddr?: PublicKey): Promise<VersionedTransaction>;
+/**
+ * Creates a nonce account transaction.
+ *
+ * @param {Connection} connection - The connection to the Solana cluster.
+ * @param {PublicKey} auth - The authorized public key.
+ * @param {number} [lamportsForRent] - The lamports for rent.
+ * @returns {Promise<{ tx: Transaction; nonceAccount: Keypair }>} A promise that resolves to the transaction and nonce account.
+ */
 declare function createNonceAccountTX(connection: Connection, auth: PublicKey, lamportsForRent?: number): Promise<{
     tx: Transaction;
     nonceAccount: Keypair;
 }>;
+/**
+ * Creates a transaction with a nonce.
+ *
+ * @param {Connection} connection - The connection to the Solana cluster.
+ * @param {PublicKey} noncePubkey - The nonce public key.
+ * @param {TransactionInstruction[]} instructions - The transaction instructions.
+ * @param {NonceAccount} [nonceInfo] - The nonce account information.
+ * @returns {Promise<Transaction | null>} A promise that resolves to the transaction or null if not found.
+ */
 declare function txWithNonce(connection: Connection, noncePubkey: PublicKey, instructions: TransactionInstruction[], nonceInfo?: NonceAccount): Promise<Transaction | null>;
+/**
+ * Checks if an account is initialized.
+ *
+ * @param {Connection} connection - The connection to the Solana cluster.
+ * @param {PublicKey} account - The account public key.
+ * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig] - The commitment level or account info configuration.
+ * @returns {Promise<boolean>} A promise that resolves to true if the account is initialized, false otherwise.
+ */
 declare function isAccountInitialized(connection: Connection, account: PublicKey, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<boolean>;
+/**
+ * Builds a version 0 message.
+ *
+ * @param {Connection} connection - The connection to the Solana cluster.
+ * @param {PublicKey} payerKey - The payer public key.
+ * @param {TransactionInstruction[]} instructions - The transaction instructions.
+ * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig='confirmed'] - The commitment level or account info configuration.
+ * @param {Blockhash} [blockhash] - The blockhash.
+ * @returns {Promise<MessageV0>} A promise that resolves to the version 0 message.
+ */
 declare function buildMessageV0(connection: Connection, payerKey: PublicKey, instructions: TransactionInstruction[], commitmentOrConfig?: Commitment | GetAccountInfoConfig, blockhash?: Blockhash): Promise<MessageV0>;
+/**
+ * Builds a versioned transaction.
+ *
+ * @param {Connection} connection - The connection to the Solana cluster.
+ * @param {PublicKey} payerKey - The payer public key.
+ * @param {TransactionInstruction[]} instructions - The transaction instructions.
+ * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig='confirmed'] - The commitment level or account info configuration.
+ * @param {Blockhash} [blockhash] - The blockhash.
+ * @param {PublicKey} [lookupTableAddress] - The lookup table address.
+ * @returns {Promise<VersionedTransaction>} A promise that resolves to the versioned transaction.
+ */
 declare function buildVersionedTransaction(connection: Connection, payerKey: PublicKey, instructions: TransactionInstruction[], commitmentOrConfig?: Commitment | GetAccountInfoConfig, blockhash?: Blockhash, lookupTableAddress?: PublicKey): Promise<VersionedTransaction>;
+/**
+ * Generates an instruction discriminator.
+ *
+ * @param {string} method - The method name.
+ * @returns {Buffer} The instruction discriminator.
+ */
 declare function instructionDiscriminator(method: string): Buffer;
+/**
+ * Simulates a transaction.
+ *
+ * @param {Connection} connection - The connection to the Solana cluster.
+ * @param {TransactionInstruction[]} instructions - The transaction instructions.
+ * @param {PublicKey} programId - The program public key.
+ * @param {PublicKey} payer - The payer public key.
+ * @param {Commitment} [commitment='confirmed'] - The commitment level.
+ * @param {Blockhash} [blockhash] - The blockhash.
+ * @param {PublicKey} [lookupTableAddress] - The lookup table address.
+ * @returns {Promise<Buffer>} A promise that resolves to the simulation result.
+ * @throws {Error} If the simulation fails.
+ */
 declare function simulateTransaction(connection: Connection, instructions: TransactionInstruction[], programId: PublicKey, payer: PublicKey, commitment?: Commitment, blockhash?: Blockhash, lookupTableAddress?: PublicKey): Promise<Buffer>;
 
+/**
+ * Array of IDL types.
+ */
 declare const idlTypes: string[];
+/**
+ * Array of message libraries.
+ */
 declare const messageLibs: string[];
+/**
+ * Faucet URLs for different environments.
+ */
 declare const FAUCET_URL: {
     [env in Environment]: string;
 };
 
+/**
+ * Represents the address type as a fixed-size array of 32 bytes.
+ */
 declare const AddressType: beet.ElementCollectionBeet & beet.BeetBase & beet.BeetReadWrite<number[], number[]>;
+/**
+ * Offset for message type.
+ */
 declare const MSG_TYPE_OFFSET = 0;
+/**
+ * Enum representing different message types.
+ */
 declare enum MessageType {
+    /**
+     * Vanilla message type.
+     */
     VANILLA = 1,
+    /**
+     * Composed message type.
+     */
     COMPOSED_TYPE = 2
 }
+/**
+ * Interface representing the parameters for LzReceive.
+ */
 interface LzReceiveParams {
+    /**
+     * Source EID.
+     */
     srcEid: number;
+    /**
+     * Sender address (size: 32).
+     */
     sender: number[];
+    /**
+     * Nonce value.
+     */
     nonce: bignum;
+    /**
+     * GUID (size: 32).
+     */
     guid: number[];
+    /**
+     * Message content.
+     */
     message: Uint8Array;
+    /**
+     * Caller parameters.
+     */
     callerParams: Uint8Array;
 }
+/**
+ * Struct for serializing and deserializing LzReceiveParams.
+ */
 declare const LzReceiveParamsBeet: FixableBeetArgsStruct<LzReceiveParams>;
 /**
  *
@@ -14005,61 +15594,232 @@ pub index: u16,
 pub message: Vec<u8>,
 pub extra_data: Vec<u8>,
 **/
+/**
+ * Interface representing the parameters for LzCompose.
+ */
 interface LzComposeParams {
+    /**
+     * Sender public key.
+     */
     from: PublicKey;
+    /**
+     * Recipient public key.
+     */
     to: PublicKey;
+    /**
+     * GUID (size: 32).
+     */
     guid: number[];
+    /**
+     * Index value.
+     */
     index: number;
+    /**
+     * Message content.
+     */
     message: Uint8Array;
+    /**
+     * Extra data.
+     */
     extraData: Uint8Array;
 }
 /**
+ * Struct for serializing and deserializing LzComposeParams.
+ *
  * @category userTypes
  * @category generated
  */
 declare const LzComposeParamsBeet: FixableBeetArgsStruct<LzComposeParams>;
+/**
+ * Interface representing an LzReceive account.
+ */
 interface LzReceiveAccount {
+    /**
+     * Public key of the account.
+     */
     pubkey: PublicKey;
+    /**
+     * Indicates if the account is a signer.
+     */
     isSigner: boolean;
+    /**
+     * Indicates if the account is writable.
+     */
     isWritable: boolean;
 }
 /**
+ * Struct for serializing and deserializing LzReceiveAccount.
+ *
  * @category userTypes
  * @category generated
  */
 declare const LzReceiveAccountBeet: BeetArgsStruct<LzReceiveAccount>;
+/**
+ * Enum representing different executor option types.
+ */
 declare enum ExecutorOptionType {
+    /**
+     * Placeholder option type.
+     */
     PlaceHolder = 0,
+    /**
+     * LzReceive option type.
+     */
     LzReceive = 1,
+    /**
+     * NativeDrop option type.
+     */
     NativeDrop = 2,
+    /**
+     * LzCompose option type.
+     */
     LzCompose = 3,
+    /**
+     * OrderExecution option type.
+     */
     OrderExecution = 4
 }
+/**
+ * Maximum length for executor option types.
+ */
 declare const MaxExecutorOptionTypeLength = 10;
 
 /**
- * @param payer. If the msgType is COMPOSED_TYPE, then the payer is required to pay for initializing the account.
+ * Receives a LayerZero message.
+ *
+ * @param {Connection} connection - The Solana connection object.
+ * @param {PublicKey} payer - The public key of the payer.
+ * @param {Packet} packet - The packet containing the message.
+ * @param {Uint8Array} [callerParams] - Optional caller parameters.
+ * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig] - Optional commitment or configuration.
+ *
+ * @returns {Promise<TransactionInstruction>} The transaction instruction.
  */
 declare function lzReceive(connection: Connection, payer: PublicKey, packet: Packet$2, callerParams?: Uint8Array, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<TransactionInstruction>;
+/**
+ * Composes a LayerZero message.
+ *
+ * @param {Connection} connection - The Solana connection object.
+ * @param {PublicKey} payer - The public key of the payer.
+ * @param {ComposeSentEvent} event - The event containing the message details.
+ * @param {Uint8Array} [extraData] - Optional extra data.
+ * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig] - Optional commitment or configuration.
+ *
+ * @returns {Promise<TransactionInstruction>} The transaction instruction.
+ */
 declare function lzCompose(connection: Connection, payer: PublicKey, event: ComposeSentEvent, extraData?: Uint8Array, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<TransactionInstruction>;
+/**
+ * Retrieves the accounts required for the LzReceive instruction.
+ *
+ * @param {Connection} connection - The Solana connection object.
+ * @param {PublicKey} payer - The public key of the payer.
+ * @param {PublicKey} receiver - The public key of the receiver.
+ * @param {PublicKey} receiverProgram - The public key of the receiver program.
+ * @param {LzReceiveParams} params - The parameters for the LzReceive instruction.
+ * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig] - Optional commitment or configuration.
+ *
+ * @returns {Promise<AccountMeta[]>} The list of account metadata.
+ */
 declare function getLzReceiveAccounts(connection: Connection, payer: PublicKey, receiver: PublicKey, receiverProgram: PublicKey, params: LzReceiveParams, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<AccountMeta[]>;
+/**
+ * Retrieves the accounts required for the LzCompose instruction.
+ *
+ * @param {Connection} connection - The Solana connection object.
+ * @param {PublicKey} payer - The public key of the payer.
+ * @param {PublicKey} to - The public key of the recipient.
+ * @param {PublicKey} composerProgram - The public key of the composer program.
+ * @param {LzComposeParams} params - The parameters for the LzCompose instruction.
+ * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig] - Optional commitment or configuration.
+ *
+ * @returns {Promise<AccountMeta[]>} The list of account metadata.
+ */
 declare function getLzComposeAccountMeta(connection: Connection, payer: PublicKey, to: PublicKey, composerProgram: PublicKey, params: LzComposeParams, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<AccountMeta[]>;
 
+/**
+ * Supported programs.
+ */
 type SupportedPrograms = 'endpoint' | 'simple_messagelib' | 'uln' | 'blocked_messagelib' | 'executor' | 'pricefeed' | 'dvn';
+/**
+ * Interface representing a deployment.
+ */
 interface Deployment {
+    /**
+     * The name of the supported program.
+     */
     name: SupportedPrograms;
+    /**
+     * The network of the deployment.
+     */
     network: Network;
+    /**
+     * The address of the deployment.
+     */
     address: string;
+    /**
+     * Compatible versions of the deployment.
+     */
     compatibleVersions: string[];
+    /**
+     * The deployer of the deployment.
+     */
     deployer: string;
 }
+/**
+ * Gets the program keypair.
+ *
+ * @param {Network | 'default'} network - The network.
+ * @param {SupportedPrograms} program - The supported program.
+ * @returns {PublicKey} The public key of the program.
+ */
 declare function getProgramKeypair(network: Network | 'default', program: SupportedPrograms): PublicKey;
+/**
+ * Gets the endpoint program ID.
+ *
+ * @param {Network | 'default'} network - The network.
+ * @returns {PublicKey} The public key of the endpoint program.
+ */
 declare function getEndpointProgramId(network: Network | 'default'): PublicKey;
+/**
+ * Gets the simple message library program ID.
+ *
+ * @param {Network | 'default'} network - The network.
+ * @returns {PublicKey} The public key of the simple message library program.
+ */
 declare function getSimpleMessageLibProgramId(network: Network | 'default'): PublicKey;
+/**
+ * Gets the ULN program ID.
+ *
+ * @param {Network | 'default'} network - The network.
+ * @returns {PublicKey} The public key of the ULN program.
+ */
 declare function getULNProgramId(network: Network | 'default'): PublicKey;
+/**
+ * Gets the DVN program ID.
+ *
+ * @param {Network | 'default'} network - The network.
+ * @returns {PublicKey} The public key of the DVN program.
+ */
 declare function getDVNProgramId(network: Network | 'default'): PublicKey;
+/**
+ * Gets the blocked message library program ID.
+ *
+ * @param {Network | 'default'} network - The network.
+ * @returns {PublicKey} The public key of the blocked message library program.
+ */
 declare function getBlockedMessageLibProgramId(network: Network | 'default'): PublicKey;
+/**
+ * Gets the executor program ID.
+ *
+ * @param {Network | 'default'} network - The network.
+ * @returns {PublicKey} The public key of the executor program.
+ */
 declare function getExecutorProgramId(network: Network | 'default'): PublicKey;
+/**
+ * Gets the pricefeed program ID.
+ *
+ * @param {Network | 'default'} network - The network.
+ * @returns {PublicKey} The public key of the pricefeed program.
+ */
 declare function getPricefeedProgramId(network: Network | 'default'): PublicKey;
 
 /**
@@ -14120,6 +15880,9 @@ declare namespace index {
   export { index_PROGRAM_ADDRESS as PROGRAM_ADDRESS, index_PROGRAM_ID as PROGRAM_ID, index_createVersionInstruction as createVersionInstruction, index_createVersionInstructionAccounts as createVersionInstructionAccounts, index_versionInstructionDiscriminator as versionInstructionDiscriminator, index_versionStruct as versionStruct };
 }
 
+/**
+ * Class representing a helper for sending transactions.
+ */
 declare class SendHelper {
     readonly endpointProgram: PublicKey;
     readonly ulnProgram: PublicKey;
@@ -14128,25 +15891,89 @@ declare class SendHelper {
     private uln;
     private simpleMsgLib;
     private accounts;
+    /**
+     * Creates an instance of the SendHelper class.
+     *
+     * @param {PublicKey} [endpointProgram=EndpointProgram.PROGRAM_ID] - The endpoint program public key.
+     * @param {PublicKey} [ulnProgram=UlnProgram.PROGRAM_ID] - The ULN program public key.
+     * @param {PublicKey} [simpleMsgLibProgram=SimpleMessageLibProgram.PROGRAM_ID] - The simple message library program public key.
+     */
     constructor(endpointProgram?: PublicKey, ulnProgram?: PublicKey, simpleMsgLibProgram?: PublicKey);
+    /**
+     * Fetches multiple account information.
+     *
+     * @param {Connection} connection - The connection to the Solana cluster.
+     * @param {PublicKey[]} keys - The public keys of the accounts.
+     * @param {Commitment | GetAccountInfoConfig} [commitment] - The commitment level or account info configuration.
+     * @returns {Promise<(AccountInfo<Buffer> | null)[]>} A promise that resolves to an array of account information.
+     */
     private getMultipleAccountsInfo;
+    /**
+     * Gets the account metadata for the quote instruction.
+     *
+     * @param {Connection} connection - The connection to the Solana cluster.
+     * @param {PublicKey} payer - The payer public key.
+     * @param {PublicKey} sender - The sender public key.
+     * @param {number} dstEid - The destination endpoint ID.
+     * @param {string} receiver - The receiver address.
+     * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig='confirmed'] - The commitment level or account info configuration.
+     * @returns {Promise<AccountMeta[]>} A promise that resolves to an array of account metadata.
+     */
     getQuoteAccounts(connection: Connection, payer: PublicKey, sender: PublicKey, dstEid: number, receiver: string, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<AccountMeta[]>;
     /**
-     * @param connection
-     * @param payer
-     * @param sender the PDA of the oApp
-     * @param dstEid the destination endpoint id
-     * @param receiver the remote peer's address
-     * @param commitmentOrConfig
-     * 1 or 3(1+2) RPC calls
-     * */
+     * Gets the account metadata for the send instruction.
+     *
+     * @param {Connection} connection - The connection to the Solana cluster.
+     * @param {PublicKey} payer - The payer public key.
+     * @param {PublicKey} sender - The sender public key.
+     * @param {number} dstEid - The destination endpoint ID.
+     * @param {string} receiver - The receiver address.
+     * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig='confirmed'] - The commitment level or account info configuration.
+     * @returns {Promise<AccountMeta[]>} A promise that resolves to an array of account metadata.
+     */
     getSendAccounts(connection: Connection, payer: PublicKey, sender: PublicKey, dstEid: number, receiver: string, commitmentOrConfig?: Commitment | GetAccountInfoConfig): Promise<AccountMeta[]>;
+    /**
+     * Gets the account metadata for the endpoint.
+     *
+     * @param {PublicKey} msgLibProgram - The message library program public key.
+     * @param {PublicKey} msgLib - The message library public key.
+     * @param {PublicKey} sender - The sender public key.
+     * @param {number} dstEid - The destination endpoint ID.
+     * @param {string} receiver - The receiver address.
+     * @param {QuoteOrSend} quoteOrSend - The quote or send action.
+     * @returns {AccountMeta[]} An array of account metadata.
+     */
     private getEndpointAccounts;
+    /**
+     * Gets the account metadata for the simple message library.
+     *
+     * @param {PublicKey} payer - The payer public key.
+     * @param {QuoteOrSend} quoteOrSend - The quote or send action.
+     * @returns {AccountMeta[]} An array of account metadata.
+     */
     private getSimpleMsgLibAccounts;
+    /**
+     * Gets the account metadata for the ULN.
+     *
+     * @param {Connection} connection - The connection to the Solana cluster.
+     * @param {PublicKey} payer - The payer public key.
+     * @param {KeyedAccountInfo} ulnInfo - The ULN account information.
+     * @param {KeyedAccountInfo} ulnDefaultSendConfigInfo - The ULN default send configuration account information.
+     * @param {KeyedAccountInfo} ulnSendConfigInfo - The ULN send configuration account information.
+     * @param {QuoteOrSend} quoteOrSend - The quote or send action.
+     * @param {Commitment | GetAccountInfoConfig} [commitment] - The commitment level or account info configuration.
+     * @returns {Promise<AccountMeta[]>} A promise that resolves to an array of account metadata.
+     */
     private getUlnAccounts;
 }
 
+/**
+ * Object representing the IDL (Interface Definition Language) types.
+ */
 declare const IdlTypes: {
+    /**
+     * The endpoint types.
+     */
     endpoint: ({
         name: string;
         type: {
@@ -14241,16 +16068,67 @@ declare const IdlTypes: {
         };
     })[];
 };
+/**
+ * Enum representing different configuration types.
+ */
 declare enum SetConfigType {
+    /**
+     * Executor configuration type.
+     */
     EXECUTOR = 1,
+    /**
+     * Send ULN configuration type.
+     */
     SEND_ULN = 2,
+    /**
+     * Receive ULN configuration type.
+     */
     RECEIVE_ULN = 3
 }
+/**
+ * Interface representing the Message Library.
+ */
 interface MessageLibInterface {
+    /**
+     * The program public key.
+     */
     program: PublicKey;
+    /**
+     * Gets the account metadata for a quote instruction.
+     *
+     * @param {Connection} connection - The Solana connection.
+     * @param {PublicKey} payer - The payer public key.
+     * @param {PacketPath} path - The packet path.
+     * @param {Commitment} [commitment] - The commitment level.
+     * @returns {Promise<AccountMeta[]>} A promise that resolves to an array of account metadata.
+     */
     getQuoteIXAccountMetaForCPI(connection: Connection, payer: PublicKey, path: PacketPath, commitment?: Commitment): Promise<AccountMeta[]>;
+    /**
+     * Gets the account metadata for a send instruction.
+     *
+     * @param {Connection} connection - The Solana connection.
+     * @param {PublicKey} payer - The payer public key.
+     * @param {PacketPath} path - The packet path.
+     * @returns {Promise<AccountMeta[]>} A promise that resolves to an array of account metadata.
+     */
     getSendIXAccountMetaForCPI(connection: Connection, payer: PublicKey, path: PacketPath): Promise<AccountMeta[]>;
+    /**
+     * Gets the account metadata for an init config instruction.
+     *
+     * @param {PublicKey} payer - The payer public key.
+     * @param {PublicKey} oappID - The OAPP ID.
+     * @param {number} eid - The endpoint ID.
+     * @returns {AccountMeta[]} An array of account metadata.
+     */
     getInitConfigIXAccountMetaForCPI(payer: PublicKey, oappID: PublicKey, eid: number): AccountMeta[];
+    /**
+     * Gets the account metadata for a set config instruction.
+     *
+     * @param {PublicKey} endpointProgram - The endpoint program public key.
+     * @param {PublicKey} oappID - The OAPP ID.
+     * @param {number} eid - The endpoint ID.
+     * @returns {Promise<AccountMeta[]>} A promise that resolves to an array of account metadata.
+     */
     getSetConfigIXAccountMetaForCPI(endpointProgram: PublicKey, oappID: PublicKey, eid: number): Promise<AccountMeta[]>;
 }