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

package/dist/index.mjs

@@ -1,39 +1,29 @@
 import * as web314 from '@solana/web3.js';
 import { PublicKey, TransactionInstruction, AddressLookupTableProgram, VersionedTransaction, TransactionMessage, Keypair, NONCE_ACCOUNT_LENGTH, Transaction, SystemProgram, NonceAccount } from '@solana/web3.js';
 import BN from 'bn.js';
-import { arrayify, hexZeroPad, hexlify } from '@ethersproject/bytes';
-import { keccak256 } from '@ethersproject/keccak256';
-import invariant4 from 'tiny-invariant';
-import { getAddress } from '@ethersproject/address';
-import base58 from 'bs58';
-import '@ethersproject/abi';
-import { BigNumber } from '@ethersproject/bignumber';
-import '@ethersproject/solidity';
+import invariant3 from 'tiny-invariant';
+import { keccak_256, sha2_256 } from '@layerzerolabs/lz-foundation';
+import { arrayify } from '@layerzerolabs/lz-utilities';
+import { addressToBytes32, PacketV1Codec } from '@layerzerolabs/lz-v2-utilities';
 import * as beet159 from '@metaplex-foundation/beet';
 import { uniformFixedSizeArray, u8, FixableBeetArgsStruct, u32, u64, bytes, u16, BeetArgsStruct, bool, array } from '@metaplex-foundation/beet';
 import * as beetSolana85 from '@metaplex-foundation/beet-solana';
 import * as splToken from '@solana/spl-token';
 import { Environment, EndpointId } from '@layerzerolabs/lz-definitions';
 import crypto from 'crypto';
-import { sha256 } from '@ethersproject/sha2';
+import base58 from 'bs58';
 
 var __defProp = Object.defineProperty;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
 var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
   get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
 }) : x)(function(x) {
-  if (typeof require !== "undefined")
-    return require.apply(this, arguments);
+  if (typeof require !== "undefined") return require.apply(this, arguments);
   throw Error('Dynamic require of "' + x + '" is not supported');
 });
 var __export = (target, all) => {
   for (var name in all)
     __defProp(target, name, { get: all[name], enumerable: true });
 };
-var __publicField = (obj, key, value) => {
-  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
-  return value;
-};
 var ENDPOINT_SEED = "Endpoint";
 var MESSAGE_LIB_SEED = "MessageLib";
 var SEND_LIBRARY_CONFIG_SEED = "SendLibraryConfig";
@@ -62,12 +52,28 @@ var PEER_SEED = "Peer";
 var MINT_SEED = "Mint";
 var ENFORCED_OPTIONS_SEED = "EnforcedOptions";
 var EndpointPDADeriver = class {
+  /**
+   * Creates an instance of the EndpointPDADeriver class.
+   *
+   * @param {PublicKey} program - The program public key.
+   */
   constructor(program) {
     this.program = program;
   }
+  /**
+   * Derives the setting address.
+   *
+   * @returns {[PublicKey, number]} The derived address and bump seed.
+   */
   setting() {
     return PublicKey.findProgramAddressSync([Buffer.from(ENDPOINT_SEED, "utf8")], this.program);
   }
+  /**
+   * 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) {
     return PublicKey.findProgramAddressSync(
       [
@@ -78,6 +84,13 @@ var EndpointPDADeriver = class {
       this.program
     );
   }
+  /**
+   * 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, dstEndpointId) {
     return PublicKey.findProgramAddressSync(
       [
@@ -90,7 +103,10 @@ var EndpointPDADeriver = class {
     );
   }
   /**
-   * @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) {
     return PublicKey.findProgramAddressSync(
@@ -98,6 +114,12 @@ var EndpointPDADeriver = class {
       this.program
     );
   }
+  /**
+   * 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) {
     return PublicKey.findProgramAddressSync(
       [
@@ -108,6 +130,13 @@ var EndpointPDADeriver = class {
       this.program
     );
   }
+  /**
+   * 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, srcEndpointId) {
     return PublicKey.findProgramAddressSync(
       [
@@ -132,9 +161,12 @@ var EndpointPDADeriver = class {
     );
   }
   /**
-   * @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, remoteChainId, remoteOapp) {
     return PublicKey.findProgramAddressSync(
@@ -148,6 +180,14 @@ var EndpointPDADeriver = class {
       this.program
     );
   }
+  /**
+   * 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, remoteChainId, remoteOapp) {
     return PublicKey.findProgramAddressSync(
       [
@@ -159,19 +199,23 @@ var EndpointPDADeriver = class {
       this.program
     );
   }
+  /**
+   * Derives the OApp registry address.
+   *
+   * @param {PublicKey} localOapp - The local OApp public key.
+   * @returns {[PublicKey, number]} The derived address and bump seed.
+   */
   oappRegistry(localOapp) {
     return PublicKey.findProgramAddressSync([Buffer.from(OAPP_SEED, "utf8"), localOapp.toBytes()], this.program);
   }
-  /***
-   * @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, srcEid, sender, nonce) {
     return PublicKey.findProgramAddressSync(
@@ -185,6 +229,16 @@ var EndpointPDADeriver = class {
       this.program
     );
   }
+  /**
+   * 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, guid, index, to, messageHash) {
     return PublicKey.findProgramAddressSync(
       [
@@ -200,18 +254,42 @@ var EndpointPDADeriver = class {
   }
 };
 var MessageLibPDADeriver = class {
+  /**
+   * Creates an instance of the MessageLibPDADeriver class.
+   *
+   * @param {PublicKey} program - The program public key.
+   */
   constructor(program) {
     this.program = program;
   }
+  /**
+   * Derives the message library address.
+   *
+   * @returns {[PublicKey, number]} The derived address and bump seed.
+   */
   messageLib() {
     return PublicKey.findProgramAddressSync([Buffer.from(MESSAGE_LIB_SEED, "utf8")], this.program);
   }
+  /**
+   * 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, oapp) {
     return PublicKey.findProgramAddressSync(
       [Buffer.from(SEND_CONFIG_SEED, "utf8"), new BN(eid).toArrayLike(Buffer, "be", 4), oapp.toBuffer()],
       this.program
     );
   }
+  /**
+   * 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, oapp) {
     return PublicKey.findProgramAddressSync(
       [Buffer.from(RECEIVE_CONFIG_SEED, "utf8"), new BN(eid).toArrayLike(Buffer, "be", 4), oapp.toBuffer()],
@@ -220,36 +298,79 @@ var MessageLibPDADeriver = class {
   }
 };
 var UlnPDADeriver = class extends MessageLibPDADeriver {
+  /**
+   * Derives the setting address.
+   *
+   * @returns {[PublicKey, number]} The derived address and bump seed.
+   */
   setting() {
     return PublicKey.findProgramAddressSync([Buffer.from(ULN_SEED, "utf8")], this.program);
   }
+  /**
+   * Derives the configuration address.
+   *
+   * @param {number} eid - The endpoint ID.
+   * @returns {[PublicKey, number]} The derived address and bump seed.
+   */
   config(eid) {
     return PublicKey.findProgramAddressSync(
       [Buffer.from(ULN_CONFIG_SEED, "utf8"), new BN(eid).toArrayLike(Buffer, "be", 4)],
       this.program
     );
   }
+  /**
+   * Derives the default send configuration address.
+   *
+   * @param {number} eid - The endpoint ID.
+   * @returns {[PublicKey, number]} The derived address and bump seed.
+   */
   defaultSendConfig(eid) {
     return PublicKey.findProgramAddressSync(
       [Buffer.from(SEND_CONFIG_SEED, "utf8"), new BN(eid).toArrayLike(Buffer, "be", 4)],
       this.program
     );
   }
+  /**
+   * Derives the default receive configuration address.
+   *
+   * @param {number} eid - The endpoint ID.
+   * @returns {[PublicKey, number]} The derived address and bump seed.
+   */
   defaultReceiveConfig(eid) {
     return PublicKey.findProgramAddressSync(
       [Buffer.from(RECEIVE_CONFIG_SEED, "utf8"), new BN(eid).toArrayLike(Buffer, "be", 4)],
       this.program
     );
   }
+  /**
+   * Derives the options address.
+   *
+   * @param {number} eit - The endpoint ID.
+   * @returns {[PublicKey, number]} The derived address and bump seed.
+   */
   options(eit) {
     return PublicKey.findProgramAddressSync(
       [Buffer.from(OPTIONS_SEED, "utf8"), new BN(eit).toArrayLike(Buffer, "be", 4)],
       this.program
     );
   }
+  /**
+   * Derives the worker configuration address.
+   *
+   * @param {PublicKey} worker - The worker public key.
+   * @returns {[PublicKey, number]} The derived address and bump seed.
+   */
   workerConfig(worker) {
     return PublicKey.findProgramAddressSync([Buffer.from(WORKER_SEED, "utf8"), worker.toBuffer()], this.program);
   }
+  /**
+   * 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, payloadHash, dvn) {
     return PublicKey.findProgramAddressSync(
       [Buffer.from(CONFIRMATIONS_SEED, "utf8"), headerHash, payloadHash, dvn.toBytes()],
@@ -258,18 +379,39 @@ var UlnPDADeriver = class extends MessageLibPDADeriver {
   }
 };
 var OAppBasePDADeriver = class {
+  /**
+   * Creates an instance of the OAppBasePDADeriver class.
+   *
+   * @param {PublicKey} program - The program public key.
+   */
   constructor(program) {
     this.program = program;
   }
+  /**
+   * Derives the remote address.
+   *
+   * @param {number} dstChainId - The destination chain ID.
+   * @returns {[PublicKey, number]} The derived address and bump seed.
+   */
   remote(dstChainId) {
     return PublicKey.findProgramAddressSync(
       [Buffer.from(REMOTE_SEED), new BN(dstChainId).toArrayLike(Buffer, "be", 4)],
       this.program
     );
   }
+  /**
+   * Derives the LzReceive types accounts address.
+   *
+   * @returns {[PublicKey, number]} The derived address and bump seed.
+   */
   lzReceiveTypesAccounts() {
     return PublicKey.findProgramAddressSync([Buffer.from(LZ_RECEIVE_TYPES_SEED, "utf8")], this.program);
   }
+  /**
+   * Derives the LzCompose types accounts address.
+   *
+   * @returns {[PublicKey, number]} The derived address and bump seed.
+   */
   lzComposeTypesAccounts() {
     return PublicKey.findProgramAddressSync([Buffer.from(LZ_COMPOSE_TYPES_SEED, "utf8")], this.program);
   }
@@ -278,36 +420,82 @@ var DVNDeriver = class {
   constructor(program) {
     this.program = program;
   }
+  /**
+   * Derives the authority address.
+   *
+   * @returns {[PublicKey, number]} The derived address and bump seed.
+   */
   authority() {
     return PublicKey.findProgramAddressSync([Buffer.from("dvn", "utf8")], this.program);
   }
+  /**
+   * Derives the configuration address.
+   *
+   * @returns {[PublicKey, number]} The derived address and bump seed.
+   */
   config() {
     return PublicKey.findProgramAddressSync([Buffer.from(DVN_CONFIG_SEED, "utf8")], this.program);
   }
+  /**
+   * Derives the execute hash address.
+   *
+   * @param {Buffer} digestHash - The digest hash.
+   * @returns {[PublicKey, number]} The derived address and bump seed.
+   */
   executeHash(digestHash) {
     return PublicKey.findProgramAddressSync([Buffer.from("ExecuteHash", "utf8"), digestHash], this.program);
   }
 };
 var EventPDADeriver = class {
+  /**
+   * Creates an instance of the EventPDADeriver class.
+   *
+   * @param {PublicKey} program - The program public key.
+   */
   constructor(program) {
     this.program = program;
   }
+  /**
+   * Derives the event authority PDA.
+   *
+   * @returns {[PublicKey, number]} The event authority PDA and bump seed.
+   */
   eventAuthority() {
     return PublicKey.findProgramAddressSync([Buffer.from(EVENT_SEED, "utf8")], this.program);
   }
 };
 var ExecutorPDADeriver = class {
+  /**
+   * Creates an instance of the ExecutorPDADeriver class.
+   *
+   * @param {PublicKey} program - The program public key.
+   */
   constructor(program) {
     this.program = program;
   }
+  /**
+   * Derives the executor configuration PDA.
+   *
+   * @returns {[PublicKey, number]} The executor configuration PDA and bump seed.
+   */
   config() {
     return PublicKey.findProgramAddressSync([Buffer.from(EXECUTOR_CONFIG_SEED, "utf8")], this.program);
   }
 };
 var PriceFeedPDADeriver = class {
+  /**
+   * Creates an instance of the PriceFeedPDADeriver class.
+   *
+   * @param {PublicKey} program - The program public key.
+   */
   constructor(program) {
     this.program = program;
   }
+  /**
+   * Derives the price feed PDA.
+   *
+   * @returns {[PublicKey, number]} The price feed PDA and bump seed.
+   */
   priceFeed() {
     return PublicKey.findProgramAddressSync([Buffer.from(PRICE_FEED_SEED, "utf8")], this.program);
   }
@@ -326,138 +514,6 @@ __export(endpoint_exports, {
   instructions: () => instructions_exports,
   types: () => types_exports
 });
-function hexZeroPadTo32(addr) {
-  return hexZeroPad(addr, 32);
-}
-function bytes32ToEthAddress(bytes322) {
-  if (bytes322 instanceof Uint8Array) {
-    bytes322 = hexlify(bytes322);
-  }
-  return getAddress(bytes322.slice(-40));
-}
-function trim0x(str) {
-  return str.replace(/^0x/, "");
-}
-function addressToBytes32(address) {
-  if (isSolanaAddress(address)) {
-    return base58.decode(address);
-  } else if (address.startsWith("0x") && address.length <= 66) {
-    return arrayify(hexZeroPadTo32(address));
-  }
-  throw new Error("Invalid address");
-}
-var solanaAddressRegex = /^([1-9A-HJ-NP-Za-km-z]{32,44})$/;
-function isSolanaAddress(address) {
-  return solanaAddressRegex.test(address);
-}
-BigNumber.from("0xffffffffffffffffffffffffffffffff");
-var PACKET_VERSION_OFFSET = 0;
-var NONCE_OFFSET = 1;
-var SRC_CHAIN_OFFSET = 9;
-var SRC_ADDRESS_OFFSET = 13;
-var DST_CHAIN_OFFSET = 45;
-var DST_ADDRESS_OFFSET = 49;
-var GUID_OFFSET = 81;
-var MESSAGE_OFFSET = 113;
-var PacketV1Codec = class _PacketV1Codec {
-  constructor(payloadEncoded) {
-    __publicField(this, "buffer");
-    this.buffer = Buffer.from(trim0x(payloadEncoded), "hex");
-  }
-  static from(payloadEncoded) {
-    return new _PacketV1Codec(payloadEncoded);
-  }
-  static fromBytes(payload) {
-    return new _PacketV1Codec("0x" + Buffer.from(payload).toString("hex"));
-  }
-  /**
-   * encode packet to hex string
-   */
-  static encode(packet) {
-    const buff = this.encodeBytes(packet);
-    return "0x" + Buffer.from(buff).toString("hex");
-  }
-  /**
-   * encode packet to Uint8Array
-   * @param packet
-   */
-  static encodeBytes(packet) {
-    const message = trim0x(packet.message);
-    const buffer = Buffer.alloc(MESSAGE_OFFSET + message.length / 2);
-    buffer.writeUInt8(packet.version, PACKET_VERSION_OFFSET);
-    buffer.writeBigUInt64BE(BigInt(packet.nonce), NONCE_OFFSET);
-    buffer.writeUInt32BE(packet.srcEid, SRC_CHAIN_OFFSET);
-    buffer.write(Buffer.from(addressToBytes32(packet.sender)).toString("hex"), SRC_ADDRESS_OFFSET, 32, "hex");
-    buffer.writeUInt32BE(packet.dstEid, DST_CHAIN_OFFSET);
-    buffer.write(Buffer.from(addressToBytes32(packet.receiver)).toString("hex"), DST_ADDRESS_OFFSET, 32, "hex");
-    buffer.write(trim0x(packet.guid), GUID_OFFSET, 32, "hex");
-    buffer.write(message, MESSAGE_OFFSET, message.length / 2, "hex");
-    return new Uint8Array(buffer);
-  }
-  version() {
-    return this.buffer.readUInt8(PACKET_VERSION_OFFSET);
-  }
-  nonce() {
-    return this.buffer.readBigUint64BE(NONCE_OFFSET).toString();
-  }
-  srcEid() {
-    return this.buffer.readUint32BE(SRC_CHAIN_OFFSET);
-  }
-  sender() {
-    return "0x" + this.buffer.slice(SRC_ADDRESS_OFFSET, DST_CHAIN_OFFSET).toString("hex");
-  }
-  senderAddressB20() {
-    return bytes32ToEthAddress(this.sender());
-  }
-  dstEid() {
-    return this.buffer.readUint32BE(DST_CHAIN_OFFSET);
-  }
-  receiver() {
-    return "0x" + this.buffer.slice(DST_ADDRESS_OFFSET, GUID_OFFSET).toString("hex");
-  }
-  receiverAddressB20() {
-    return bytes32ToEthAddress(this.receiver());
-  }
-  guid() {
-    return "0x" + this.buffer.slice(GUID_OFFSET, MESSAGE_OFFSET).toString("hex");
-  }
-  message() {
-    return "0x" + this.buffer.slice(MESSAGE_OFFSET).toString("hex");
-  }
-  payloadHash() {
-    return keccak256(this.payload());
-  }
-  payload() {
-    return "0x" + this.buffer.slice(GUID_OFFSET).toString("hex");
-  }
-  header() {
-    return "0x" + this.buffer.slice(0, GUID_OFFSET).toString("hex");
-  }
-  headerHash() {
-    return keccak256(this.header());
-  }
-  /**
-   * deserialize packet from hex string
-   * @deprecated use toPacket instead
-   */
-  decode() {
-    return this.toPacket();
-  }
-  toPacket() {
-    return {
-      version: this.version(),
-      nonce: this.nonce(),
-      srcEid: this.srcEid(),
-      sender: this.sender(),
-      dstEid: this.dstEid(),
-      receiver: this.receiver(),
-      guid: this.guid(),
-      message: this.message(),
-      // derived
-      payload: this.payload()
-    };
-  }
-};
 
 // src/generated/endpoint/accounts/index.ts
 var accounts_exports = {};
@@ -5836,6 +5892,11 @@ var sendLibrarySetEventBeet = new beet159.BeetArgsStruct(
 var EventEmitDiscriminator = "e445a52e51cb9a1d";
 var DefaultMessageLib = PublicKey.default;
 var Endpoint = class {
+  /**
+   * Creates an instance of the Endpoint class.
+   *
+   * @param {PublicKey} program - The program public key.
+   */
   constructor(program) {
     this.program = program;
     this.deriver = new EndpointPDADeriver(program);
@@ -5843,7 +5904,12 @@ var Endpoint = class {
     this.eventAuthorityPDA = eventAuthorityPDA;
   }
   /**
-   * 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, payer, admin) {
     const [settingPDA] = this.deriver.setting();
@@ -5862,8 +5928,14 @@ var Endpoint = class {
     );
   }
   // async initOrUpdateConfig(connection:Connection,)
-  /***
+  /**
+   * 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, messageLibProgram, libType = 2 /* SendAndReceive */) {
     const [msgLibPda] = new MessageLibPDADeriver(messageLibProgram).messageLib();
@@ -5886,6 +5958,16 @@ var Endpoint = class {
       this.program
     );
   }
+  /**
+   * 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.
+   */
   async setDefaultSendLibrary(connection, admin, messageLibProgram, dstEid, commitmentOrConfig) {
     const [msgLib] = new MessageLibPDADeriver(messageLibProgram).messageLib();
     const [defaultSendLibConfig] = this.deriver.defaultSendLibraryConfig(dstEid);
@@ -5938,6 +6020,16 @@ var Endpoint = class {
       );
     }
   }
+  /**
+   * 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.
+   */
   async setDefaultReceiveLibrary(connection, admin, messageLibProgram, srcEid, commitmentOrConfig) {
     const [msgLib] = new MessageLibPDADeriver(messageLibProgram).messageLib();
     const [defaultReceiveLibConfig] = this.deriver.defaultReceiveLibraryConfig(srcEid);
@@ -5992,6 +6084,16 @@ var Endpoint = class {
       );
     }
   }
+  /**
+   * 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, msgLibSDK, payer, oappID, eid) {
     const [msgLib] = new MessageLibPDADeriver(msgLibSDK.program).messageLib();
     const [oappRegistry] = this.deriver.oappRegistry(oappID);
@@ -6014,6 +6116,15 @@ var Endpoint = class {
       this.program
     );
   }
+  /**
+   * 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, dstEid, oappIDPDA2, remoteOappAddr) {
     const [nonce] = this.deriver.nonce(oappIDPDA2, dstEid, remoteOappAddr);
     const [pendingNonce] = this.deriver.pendingNonce(oappIDPDA2, dstEid, remoteOappAddr);
@@ -6035,6 +6146,14 @@ var Endpoint = class {
       this.program
     );
   }
+  /**
+   * 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, sender, dstEid) {
     const [oappRegistry] = this.deriver.oappRegistry(sender);
     const [sendLibraryConfig] = this.deriver.sendLibraryConfig(sender, dstEid);
@@ -6053,6 +6172,15 @@ var Endpoint = class {
       this.program
     );
   }
+  /**
+   * 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, oappIDPDA2, newSendLibProgram, dstEid) {
     const [newSendLib] = new MessageLibPDADeriver(newSendLibProgram).messageLib();
     const [sendLibraryConfig] = this.deriver.sendLibraryConfig(oappIDPDA2, dstEid);
@@ -6078,6 +6206,14 @@ var Endpoint = class {
     );
     return ix;
   }
+  /**
+   * 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, receiver, srcEid) {
     const [oappRegistry] = this.deriver.oappRegistry(receiver);
     const [receiveLibraryConfig] = this.deriver.receiveLibraryConfig(receiver, srcEid);
@@ -6096,6 +6232,16 @@ var Endpoint = class {
       this.program
     );
   }
+  /**
+   * 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, oappIDPDA2, newReceiveLibProgram, srcEid, gracePeriod) {
     const [newReceiveLib] = new MessageLibPDADeriver(newReceiveLibProgram).messageLib();
     const [receiveLibraryConfig] = this.deriver.receiveLibraryConfig(oappIDPDA2, srcEid);
@@ -6122,6 +6268,21 @@ var Endpoint = class {
     );
     return ix;
   }
+  /**
+   * 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.
+   */
   async setOappConfig(connection, oappDelegate, oappID, msgLibProgram, eid, config, commitment = "confirmed") {
     const [msgLib] = new MessageLibPDADeriver(msgLibProgram).messageLib();
     const [msgLibInfo] = this.deriver.messageLibraryInfo(msgLib);
@@ -6159,7 +6320,9 @@ var Endpoint = class {
     return ix;
   }
   /// send a simulated transaction to the endpoint to get the fee for sending a message
-  /***
+  /**
+   *
+   * 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
@@ -6170,6 +6333,13 @@ var Endpoint = class {
    *
    *  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.
    */
   async getQuoteIXAccountMetaForCPI(connection, payer, path, msgLibProgram) {
     const { sender: sender_, dstEid, receiver: receiver_ } = path;
@@ -6208,8 +6378,16 @@ var Endpoint = class {
       ].concat(accounts)
     );
   }
-  /***
-   * 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.
    */
   async getSendIXAccountMetaForCPI(connection, payer, path, msgLibProgram, commitmentOrConfig) {
     const { sender: sender_, dstEid, receiver: receiver_ } = path;
@@ -6253,6 +6431,16 @@ var Endpoint = class {
       }
     ].concat(accounts);
   }
+  /**
+   * 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.
+   */
   async skip(payer, sender, receiver, srcEid, nonce) {
     const [nonceAccount] = this.deriver.nonce(receiver, srcEid, addressToBytes32(sender.toBase58()));
     const [payloadHash] = this.deriver.payloadHash(receiver, srcEid, sender.toBytes(), parseInt(nonce));
@@ -6284,6 +6472,18 @@ var Endpoint = class {
     );
     return Promise.resolve(ix);
   }
+  /**
+   * 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.
+   */
   async initVerify(connection, payer, sender, receiver, srcEid, nonce, commitmentOrConfig) {
     const [nonceAccount] = this.deriver.nonce(receiver, srcEid, addressToBytes32(sender.toBase58()));
     const [payloadHash] = this.deriver.payloadHash(receiver, srcEid, sender.toBytes(), parseInt(nonce));
@@ -6308,6 +6508,13 @@ var Endpoint = class {
       this.program
     );
   }
+  /**
+   * 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, receiveLibrary) {
     const receiver = new PublicKey(Buffer.from(packet.receiver().slice(2), "hex"));
     const srcEid = packet.srcEid();
@@ -6503,6 +6710,13 @@ var Endpoint = class {
   //         } as AccountMeta,
   //     ].concat(ix.keys)
   // }
+  /**
+   * 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, oapp) {
     const [oappRegistry] = this.deriver.oappRegistry(oapp);
     const eventAuthority = this.eventAuthorityPDA;
@@ -6527,6 +6741,15 @@ var Endpoint = class {
       }
     ].concat(keys);
   }
+  /**
+   * 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, sender, srcEid, nonce) {
     const [noncePDA] = this.deriver.nonce(receiver, srcEid, sender);
     const [pendingNonce] = this.deriver.pendingNonce(receiver, srcEid, sender);
@@ -6556,6 +6779,15 @@ var Endpoint = class {
       }
     ].concat(keys);
   }
+  /**
+   * 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.
+   */
   async isDefaultSendLibrary(connection, messageLibProgram, dstEid, commitmentOrConfig) {
     const [msgLib] = new MessageLibPDADeriver(messageLibProgram).messageLib();
     const info = await this.getDefaultSendLibrary(connection, dstEid, commitmentOrConfig);
@@ -6564,6 +6796,15 @@ var Endpoint = class {
     }
     return false;
   }
+  /**
+   * 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.
+   */
   async isDefaultReceiveLibrary(connection, messageLibProgram, srcEid, commitmentOrConfig) {
     const [msgLib] = new MessageLibPDADeriver(messageLibProgram).messageLib();
     const info = await this.getDefaultReceiveLibrary(connection, srcEid, commitmentOrConfig);
@@ -6573,6 +6814,13 @@ var Endpoint = class {
     return false;
   }
   // all of below functions are retrieving accounts state
+  /**
+   * 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.
+   */
   async getSetting(connection, commitmentOrConfig) {
     const [setting] = this.deriver.setting();
     try {
@@ -6582,8 +6830,12 @@ var Endpoint = class {
     }
   }
   /**
+   * 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.
    */
   async getMessageLibInfo(connection, messageLibProgram, commitmentOrConfig) {
     const [msgLib] = new MessageLibPDADeriver(messageLibProgram).messageLib();
@@ -6594,6 +6846,14 @@ var Endpoint = class {
       return 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.
+   */
   async getDefaultReceiveLibrary(connection, srcEid, commitmentOrConfig) {
     const [defaultReceiveLibConfig] = this.deriver.defaultReceiveLibraryConfig(srcEid);
     try {
@@ -6616,6 +6876,14 @@ var Endpoint = class {
       return 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.
+   */
   async getDefaultSendLibrary(connection, dstEid, commitmentOrConfig) {
     const [defaultSendLibConfig] = this.deriver.defaultSendLibraryConfig(dstEid);
     try {
@@ -6639,8 +6907,13 @@ var Endpoint = class {
     }
   }
   /**
-   * 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.
    */
   async getSendLibrary(connection, oappPda, dstEid, commitmentOrConfig = "confirmed") {
     const [sendLibConfig] = this.deriver.sendLibraryConfig(oappPda, dstEid);
@@ -6673,7 +6946,13 @@ var Endpoint = class {
     }
   }
   /**
-   * 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.
    */
   async getReceiveLibrary(connection, oappPda, srcEid, commitmentOrConfig) {
     const [receiveLibConfig] = this.deriver.receiveLibraryConfig(oappPda, srcEid);
@@ -6709,7 +6988,7 @@ var Endpoint = class {
       };
     }
     const messageLibInfo = await connection.getAccountInfo(info.messageLib, commitmentOrConfig);
-    invariant4(messageLibInfo, "messageLibInfo should not be null");
+    invariant3(messageLibInfo, "messageLibInfo should not be null");
     const { timeout } = info;
     if (timeout) {
       return {
@@ -6722,6 +7001,18 @@ var Endpoint = class {
     return { programId: messageLibInfo.owner, msgLib: info.messageLib, isDefault: false, timeout: null };
   }
   // rename to a more generic name
+  /**
+   * 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.
+   */
   async getInboundPayloadHash(connection, receiver, srcEid, sender, nonce, _payloadHash, commitmentOrConfig) {
     const [payloadHashPDA] = this.deriver.payloadHash(receiver, srcEid, sender, nonce);
     const accountInfo = await connection.getAccountInfo(payloadHashPDA, commitmentOrConfig);
@@ -6730,8 +7021,17 @@ var Endpoint = class {
     }
     return PayloadHash.fromAccountInfo(accountInfo, 0)[0];
   }
+  /**
+   * 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.
+   */
   async getComposedMessageState(connection, from, params, commitmentOrConfig) {
-    const message = arrayify(keccak256(params.message));
+    const message = keccak_256(params.message);
     const [composedMessagePDA] = this.deriver.composedMessage(
       from,
       Uint8Array.from(params.guid),
@@ -6745,6 +7045,16 @@ var Endpoint = class {
     }
     return ComposeMessageState.fromAccountInfo(accountInfo, 0)[0];
   }
+  /**
+   * 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.
+   */
   async getNonce(connection, oappIDPDA2, remoteEid, remoteOappAddr, commitmentOrConfig) {
     const [nonce] = this.deriver.nonce(oappIDPDA2, remoteEid, remoteOappAddr);
     try {
@@ -6753,6 +7063,16 @@ var Endpoint = class {
       return 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.
+   */
   async getPendingInboundNonce(connection, oappIDPDA2, remoteEid, remoteOappAddr, commitmentOrConfig) {
     const [nonce] = this.deriver.pendingNonce(oappIDPDA2, remoteEid, remoteOappAddr);
     try {
@@ -6761,12 +7081,30 @@ var Endpoint = class {
       return 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.
+   */
   async getMessageLibVersion(connection, payer, messageLibProgram, commitment = "confirmed") {
     const ix = simple_message_lib_exports.instructions.createVersionInstruction(messageLibProgram);
     const simulateResp = await simulateTransaction(connection, [ix], messageLibProgram, payer, commitment);
     const version = simple_message_lib_exports.types.versionBeet.read(simulateResp, 0);
     return version;
   }
+  /**
+   * 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.
+   */
   async transferAdmin(connection, admin, newAdmin, commitment = "confirmed") {
     const [settingPDA] = this.deriver.setting();
     const endpointSettings = await EndpointSettings.fromAccountAddress(connection, settingPDA, commitment);
@@ -8713,10 +9051,27 @@ var PROGRAM_ID2 = new PublicKey(PROGRAM_ADDRESS2);
 
 // src/simple-message-lib.ts
 var SimpleMessageLib = class {
+  /**
+   * Creates an instance of the SimpleMessageLib class.
+   *
+   * @param {PublicKey} program - The program public key.
+   */
   constructor(program) {
     this.program = program;
     this.deriver = new MessageLibPDADeriver(program);
   }
+  /**
+   * 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, payer, admin, eid, nativeFee, lzTokenFee = 0) {
     const [messageLibPda] = this.deriver.messageLib();
     const [endpointAuth] = new EndpointPDADeriver(endpointProgram).messageLibraryInfo(messageLibPda);
@@ -8738,6 +9093,14 @@ var SimpleMessageLib = class {
       this.program
     );
   }
+  /**
+   * 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, newCaller) {
     const [messageLibPDA] = this.deriver.messageLib();
     return createSetWlCallerInstruction(
@@ -8753,6 +9116,15 @@ var SimpleMessageLib = class {
       this.program
     );
   }
+  /**
+   * 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.
+   */
   async isWhiteListed(connection, caller, commitmentOrConfig) {
     try {
       const exceptedCaller = await this.getWhiteListCaller(connection, commitmentOrConfig);
@@ -8761,6 +9133,14 @@ var SimpleMessageLib = class {
       return false;
     }
   }
+  /**
+   * 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.
+   */
   async getWhiteListCaller(connection, commitmentOrConfig) {
     const [messageLibPDA] = this.deriver.messageLib();
     const messageLibInfo = await MessageLib.fromAccountAddress(
@@ -8770,6 +9150,16 @@ var SimpleMessageLib = class {
     );
     return messageLibInfo.wlCaller;
   }
+  /**
+   * 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, endpointProgram, payer, encodedPacket) {
     const packet = PacketV1Codec.fromBytes(encodedPacket);
     const [receiveLibrary] = this.deriver.messageLib();
@@ -8786,8 +9176,14 @@ var SimpleMessageLib = class {
       this.program
     );
   }
-  /***
-   * 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.
    */
   async getSendIXAccountMetaForCPI(_connection, payer, _path) {
     const [msgLib] = this.deriver.messageLib();
@@ -8807,6 +9203,16 @@ var SimpleMessageLib = class {
     });
     return Promise.resolve(cpiAccounts.slice(1));
   }
+  /**
+   * 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.
+   */
   async getQuoteIXAccountMetaForCPI(_connection, _payer, _path, _commitment) {
     const [msgLib] = this.deriver.messageLib();
     const keys = createQuoteInstructionAccounts2(
@@ -8819,8 +9225,14 @@ var SimpleMessageLib = class {
     );
     return Promise.resolve(keys.slice(1));
   }
-  /***
-   * 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, oappID, eid) {
     const [sendConfig] = this.deriver.sendConfig(eid, oappID);
@@ -8844,6 +9256,15 @@ var SimpleMessageLib = class {
     });
     return keys.slice(1);
   }
+  /**
+   * 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.
+   */
   async getSetConfigIXAccountMetaForCPI(endpointProgram, oappID, eid) {
     const [sendConfig] = this.deriver.sendConfig(eid, oappID);
     const [receiveConfig] = this.deriver.receiveConfig(eid, oappID);
@@ -10721,9 +11142,21 @@ var SolanaSignerExt = class _SolanaSignerExt {
   constructor(signers) {
     this.signers = signers;
   }
+  /**
+   * Creates an instance of the SolanaSignerExt class.
+   *
+   * @param {HashSigner[]} signers - The signers.
+   * @returns {SolanaSignerExt} The SolanaSignerExt instance.
+   */
   static from(signers) {
     return new _SolanaSignerExt(signers);
   }
+  /**
+   * 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.
+   */
   async sign(message) {
     return Promise.all(
       this.signers.map(async (s) => {
@@ -10734,12 +11167,27 @@ var SolanaSignerExt = class _SolanaSignerExt {
   }
 };
 var DVN = class {
+  /**
+   * 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, endpointId = EndpointId.SOLANA_V2_SANDBOX) {
     this.programId = programId;
     this.dvnDeriver = new DVNDeriver(programId);
     this.vid = endpointId % 3e4;
     this.eventAuthority = new EventPDADeriver(programId).eventAuthority()[0];
   }
+  /**
+   * 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.
+   */
   async initDVN(connection, payer, params) {
     const [config] = this.dvnDeriver.config();
     const info = await connection.getAccountInfo(config);
@@ -10757,6 +11205,14 @@ var DVN = class {
       this.programId
     );
   }
+  /**
+   * 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, instruction, expiration) {
     return {
       vid,
@@ -10772,15 +11228,39 @@ var DVN = class {
       expiration
     };
   }
+  /**
+   * Gets the execute hash for a given hash bytes.
+   *
+   * @param {Buffer} hashBytes - The hash bytes.
+   * @returns {PublicKey} The execute hash.
+   */
   getExecuteHash(hashBytes) {
     const [executeHash] = this.dvnDeriver.executeHash(hashBytes);
     return executeHash;
   }
+  /**
+   * Gets the hash bytes for a given digest.
+   *
+   * @param {types.ExecuteTransactionDigest} digest - The transaction digest.
+   * @returns {Buffer} The hash bytes.
+   */
   getHashBytes(digest) {
     const [digestBytes] = executeTransactionDigestBeet.serialize(digest);
-    const hash = keccak256(digestBytes);
-    return Buffer.from(hash.slice(2), "hex");
+    const hash = keccak_256(digestBytes);
+    return Buffer.from(hash);
   }
+  /**
+   * 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.
+   */
   async invoke(connection, vid, payer, instruction, expiration, sign) {
     const configState = await this.getConfigState(connection, "confirmed");
     if (!configState) {
@@ -10822,6 +11302,12 @@ var DVN = class {
       this.programId
     );
   }
+  /**
+   * Creates a transaction instruction to set the quorum.
+   *
+   * @param {number} quorum - The quorum.
+   * @returns {TransactionInstruction} The transaction instruction.
+   */
   createSetQuorumInstruction(quorum) {
     const params = {
       fields: [quorum],
@@ -10836,6 +11322,12 @@ var DVN = class {
       data: buffer
     });
   }
+  /**
+   * Creates a transaction instruction to set the admins.
+   *
+   * @param {PublicKey[]} admins - The admin public keys.
+   * @returns {TransactionInstruction} The transaction instruction.
+   */
   createSetAdminsInstruction(admins) {
     const params = {
       fields: [admins],
@@ -10850,6 +11342,12 @@ var DVN = class {
       data: buffer
     });
   }
+  /**
+   * Creates a transaction instruction to set the signers.
+   *
+   * @param {Uint8Array[]} signers - The signer public keys.
+   * @returns {TransactionInstruction} The transaction instruction.
+   */
   createSetSignersInstruction(signers) {
     const params = {
       fields: [signers.map((s) => Array.from(s))],
@@ -10864,6 +11362,12 @@ var DVN = class {
       data: buffer
     });
   }
+  /**
+   * Creates a transaction instruction to set the allowlist.
+   *
+   * @param {PublicKey[]} allowlist - The allowlist public keys.
+   * @returns {TransactionInstruction} The transaction instruction.
+   */
   createSetAllowlistInstruction(allowlist) {
     const params = {
       fields: [allowlist],
@@ -10878,6 +11382,12 @@ var DVN = class {
       data: buffer
     });
   }
+  /**
+   * Creates a transaction instruction to set the denylist.
+   *
+   * @param {PublicKey[]} denylist - The denylist public keys.
+   * @returns {TransactionInstruction} The transaction instruction.
+   */
   createSetDenylistInstruction(denylist) {
     const params = {
       fields: [denylist],
@@ -10892,6 +11402,12 @@ var DVN = class {
       data: buffer
     });
   }
+  /**
+   * Creates a transaction instruction to set the pause state.
+   *
+   * @param {boolean} pause - The pause state.
+   * @returns {TransactionInstruction} The transaction instruction.
+   */
   createSetPauseInstruction(pause) {
     const params = {
       fields: [pause],
@@ -10906,6 +11422,13 @@ var DVN = class {
       data: buffer
     });
   }
+  /**
+   * 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, defaultMultiplierBps) {
     const [configAccount] = this.dvnDeriver.config();
     return createSetConfigInstruction3(
@@ -10926,6 +11449,13 @@ var DVN = class {
       this.programId
     );
   }
+  /**
+   * 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, admins) {
     const [configAccount] = this.dvnDeriver.config();
     return createSetConfigInstruction3(
@@ -10946,6 +11476,13 @@ var DVN = class {
       this.programId
     );
   }
+  /**
+   * 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, dstConfigs) {
     const [configAccount] = this.dvnDeriver.config();
     return createSetConfigInstruction3(
@@ -10966,6 +11503,13 @@ var DVN = class {
       this.programId
     );
   }
+  /**
+   * 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, removeEids) {
     const [configAccount] = this.dvnDeriver.config();
     return createSetConfigInstruction3(
@@ -10986,6 +11530,12 @@ var DVN = class {
       this.programId
     );
   }
+  /**
+   * Creates a transaction instruction to set the message libraries.
+   *
+   * @param {PublicKey[]} msglibPrograms - The message library public keys.
+   * @returns {TransactionInstruction} The transaction instruction.
+   */
   createSetMsgLibsInstruction(msglibPrograms) {
     const params = {
       fields: [msglibPrograms],
@@ -11000,13 +11550,34 @@ var DVN = class {
       data: buffer
     });
   }
+  /**
+   * Gets the expiration time.
+   *
+   * @returns {number} The expiration time.
+   */
   _getExpiration() {
     return (/* @__PURE__ */ new Date()).getTime() / 1e3 + 120;
   }
+  /**
+   * 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.
+   */
   async setMsgLibs(connection, payer, msgLibs, sign) {
     const expiration = this._getExpiration();
     return this.invoke(connection, this.vid, payer, this.createSetMsgLibsInstruction(msgLibs), expiration, sign);
   }
+  /**
+   * 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, priceFeedProgram) {
     const [configAccount] = this.dvnDeriver.config();
     const [priceFeedPda] = new PriceFeedPDADeriver(priceFeedProgram).priceFeed();
@@ -11028,6 +11599,14 @@ var DVN = class {
       this.programId
     );
   }
+  /**
+   * 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, priceFeedProgram, payment) {
     const [config] = this.dvnDeriver.config();
     const keys = createQuoteDvnInstructionAccounts(
@@ -11049,6 +11628,13 @@ var DVN = class {
       }
     ].concat(keys);
   }
+  /**
+   * 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.
+   */
   async getConfigState(connection, commitment = "confirmed") {
     const [config] = this.dvnDeriver.config();
     try {
@@ -12620,8 +13206,8 @@ var treasurySetEventBeet = new beet159.FixableBeetArgsStruct(
 function getEventDiscriminator(event) {
   const hash = crypto.createHash("sha256");
   hash.update(`event:${event}`);
-  const sha2562 = hash.digest("hex");
-  return sha2562.slice(0, 16);
+  const sha256 = hash.digest("hex");
+  return sha256.slice(0, 16);
 }
 async function extractSentPacketEventByTxHash(connection, program, signature, commitment, unsafeParseErr = false) {
   const events = await extractEventFromTransactionSignature(
@@ -12632,8 +13218,7 @@ async function extractSentPacketEventByTxHash(connection, program, signature, co
     commitment,
     unsafeParseErr
   );
-  if (!events)
-    return null;
+  if (!events) return null;
   return events;
 }
 async function extractVerifiedPacketEventByTxHash(connection, program, signature, commitment, unsafeParseErr = false) {
@@ -12645,8 +13230,7 @@ async function extractVerifiedPacketEventByTxHash(connection, program, signature
     commitment,
     unsafeParseErr
   );
-  if (!events)
-    return null;
+  if (!events) return null;
   return events;
 }
 async function extractReceivedPacketEventByTxHash(connection, program, signature, commitment, unsafeParseErr = false) {
@@ -12658,8 +13242,7 @@ async function extractReceivedPacketEventByTxHash(connection, program, signature
     commitment,
     unsafeParseErr
   );
-  if (!events)
-    return null;
+  if (!events) return null;
   return events;
 }
 async function extractComposeSentEventByTxHash(connection, program, signature, commitment, unsafeParseErr = false) {
@@ -12671,8 +13254,7 @@ async function extractComposeSentEventByTxHash(connection, program, signature, c
     commitment,
     unsafeParseErr
   );
-  if (!events)
-    return null;
+  if (!events) return null;
   return events;
 }
 async function extractComposeDeliveredEventByTxHash(connection, program, signature, commitment, unsafeParseErr = false) {
@@ -12684,8 +13266,7 @@ async function extractComposeDeliveredEventByTxHash(connection, program, signatu
     commitment,
     unsafeParseErr
   );
-  if (!events)
-    return null;
+  if (!events) return null;
   return events;
 }
 async function extractWorkerFeePaidEventByTxHash(connection, program, signature, commitment, unsafeParseErr = false) {
@@ -12697,14 +13278,12 @@ async function extractWorkerFeePaidEventByTxHash(connection, program, signature,
     commitment,
     unsafeParseErr
   );
-  if (!events)
-    return null;
+  if (!events) return null;
   return events;
 }
 async function extractEventFromTransactionSignature(connection, program, signature, eventBeet, commitment, unsafeParseErr = false) {
   const tx = typeof signature === "string" ? await connection.getParsedTransaction(signature, commitment) : signature;
-  if (tx == null)
-    return null;
+  if (tx == null) return null;
   const events = new Array();
   if (tx.meta?.err !== null && !unsafeParseErr) {
     return null;
@@ -12851,7 +13430,7 @@ async function buildVersionedTransaction(connection, payerKey, instructions, com
   );
 }
 function instructionDiscriminator(method) {
-  return Buffer.from(sha256(Buffer.from(`global:${method}`)).substring(2), "hex").subarray(0, 8);
+  return Buffer.from(sha2_256(Buffer.from(`global:${method}`))).subarray(0, 8);
 }
 async function simulateTransaction(connection, instructions, programId, payer, commitment = "confirmed", blockhash, lookupTableAddress) {
   const tx = await buildVersionedTransaction(
@@ -12999,8 +13578,7 @@ function retrieveAccountFromSimulatedResp(resp, payer) {
   const results = fixedBeet.read(resp, 0);
   return results.map((r) => {
     if (r.pubkey.toBase58() == PublicKey.default.toBase58() && r.isSigner) {
-      if (!payer)
-        throw new Error("payer is required");
+      if (!payer) throw new Error("payer is required");
       return {
         pubkey: payer,
         isSigner: true,
@@ -13292,11 +13870,28 @@ var PROGRAM_ID4 = new PublicKey(PROGRAM_ADDRESS4);
 
 // src/executor.ts
 var Executor = class {
+  /**
+   * Creates an instance of the Executor class.
+   *
+   * @param {PublicKey} program - The program public key.
+   */
   constructor(program) {
     this.program = program;
     this.deriver = new ExecutorPDADeriver(this.program);
   }
   // owner methods
+  /**
+   * 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, owner, admins, executors, msglibs, priceFeed) {
     const [configAccount] = this.deriver.config();
     return createInitExecutorInstruction(
@@ -13316,6 +13911,14 @@ var Executor = class {
       this.program
     );
   }
+  /**
+   * 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, newOwner) {
     const [configAccount] = this.deriver.config();
     return createOwnerSetConfigInstruction(
@@ -13332,6 +13935,14 @@ var Executor = class {
       this.program
     );
   }
+  /**
+   * Sets the admins.
+   *
+   * @param {PublicKey} owner - The owner public key.
+   * @param {PublicKey[]} admins - The admin public keys.
+   *
+   * @returns {TransactionInstruction} The transaction instruction.
+   */
   setAdmins(owner, admins) {
     const [configAccount] = this.deriver.config();
     return createOwnerSetConfigInstruction(
@@ -13348,6 +13959,14 @@ var Executor = class {
       this.program
     );
   }
+  /**
+   * 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, allowlist) {
     const [configAccount] = this.deriver.config();
     return createOwnerSetConfigInstruction(
@@ -13364,6 +13983,14 @@ var Executor = class {
       this.program
     );
   }
+  /**
+   * 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, denylist) {
     const [configAccount] = this.deriver.config();
     return createOwnerSetConfigInstruction(
@@ -13380,6 +14007,14 @@ var Executor = class {
       this.program
     );
   }
+  /**
+   * Sets the paused state.
+   *
+   * @param {PublicKey} owner - The owner public key.
+   * @param {boolean} paused - The paused state.
+   *
+   * @returns {TransactionInstruction} The transaction instruction.
+   */
   setPaused(owner, paused) {
     const [configAccount] = this.deriver.config();
     return createOwnerSetConfigInstruction(
@@ -13396,6 +14031,14 @@ var Executor = class {
       this.program
     );
   }
+  /**
+   * Sets the executors.
+   *
+   * @param {PublicKey} owner - The owner public key.
+   * @param {PublicKey[]} executors - The executor public keys.
+   *
+   * @returns {TransactionInstruction} The transaction instruction.
+   */
   setExecutors(owner, executors) {
     const [configAccount] = this.deriver.config();
     return createOwnerSetConfigInstruction(
@@ -13412,6 +14055,14 @@ var Executor = class {
       this.program
     );
   }
+  /**
+   * 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, msglibPrograms) {
     this.deriver.config();
     const msglibPdas = msglibPrograms.map((program) => {
@@ -13419,6 +14070,14 @@ var Executor = class {
     });
     return this.setMsglibByPDAs(owner, msglibPdas);
   }
+  /**
+   * 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, msglibPDAs) {
     const [configAccount] = this.deriver.config();
     return createOwnerSetConfigInstruction(
@@ -13436,6 +14095,14 @@ var Executor = class {
     );
   }
   // admin methods
+  /**
+   * 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, defaultMultiplierBps) {
     const [configAccount] = this.deriver.config();
     return createAdminSetConfigInstruction(
@@ -13452,6 +14119,14 @@ var Executor = class {
       this.program
     );
   }
+  /**
+   * 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, dstConfigs) {
     const [configAccount] = this.deriver.config();
     return createAdminSetConfigInstruction(
@@ -13468,6 +14143,14 @@ var Executor = class {
       this.program
     );
   }
+  /**
+   * 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, priceFeedProgram) {
     const [configAccount] = this.deriver.config();
     const [priceFeed] = new PriceFeedPDADeriver(priceFeedProgram).priceFeed();
@@ -13485,6 +14168,14 @@ var Executor = class {
       this.program
     );
   }
+  /**
+   * 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.
+   */
   async getExecutorConfig(connection, commitmentOrConfig) {
     const [configAccount] = this.deriver.config();
     try {
@@ -13498,6 +14189,15 @@ var Executor = class {
       return 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, priceFeedProgram, payment) {
     const [config] = this.deriver.config();
     const ixAccounts = createQuoteExecutorInstructionAccounts(
@@ -13519,6 +14219,20 @@ var Executor = class {
       }
     ].concat(ixAccounts);
   }
+  /**
+   * 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.
+   */
   async execute(connection, executor, endpointProgram, packet, extraData, value = new BN(0), computeUnits = 2e5, commitmentOrConfig) {
     const [config] = this.deriver.config();
     const endpointEventDeriver = new EventPDADeriver(endpointProgram);
@@ -13578,6 +14292,20 @@ var Executor = class {
       this.program
     );
   }
+  /**
+   * 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.
+   */
   async compose(connection, executor, endpointProgram, event, extraData, value = new BN(0), computeUnits = 4e5, commitmentOrConfig) {
     const [config] = this.deriver.config();
     const endpointEventDeriver = new EventPDADeriver(endpointProgram);
@@ -16440,12 +17168,26 @@ var PROGRAM_ID5 = new PublicKey(PROGRAM_ADDRESS5);
 
 // src/uln.ts
 var Uln = class {
+  /**
+   * Creates an instance of the Uln class.
+   *
+   * @param {PublicKey} program - The program public key.
+   */
   constructor(program) {
     this.program = program;
     this.deriver = new UlnPDADeriver(program);
     const [eventAuthorityPDA] = new EventPDADeriver(program).eventAuthority();
     this.eventAuthorityPDA = eventAuthorityPDA;
   }
+  /**
+   * 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, payer, admin, eid) {
     const [setting] = this.deriver.setting();
     const [msgLib] = this.deriver.messageLib();
@@ -16467,7 +17209,17 @@ var Uln = class {
     );
   }
   /**
+   * 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.
    */
   async initOrUpdateDefaultConfig(connection, admin, eid, sendUlnConfig, receiveUlnConfig, executorConfig, commitmentOrConfig) {
     const [setting] = this.deriver.setting();
@@ -16518,7 +17270,18 @@ var Uln = class {
   }
   // msg_lib -> msg_lib_program ->
   /**
+   * 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.
    */
   async setTreasury(admin, treasury) {
     const [setting] = this.deriver.setting();
@@ -16538,6 +17301,16 @@ var Uln = class {
     );
     return Promise.resolve(ix);
   }
+  /**
+   * 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 | 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.
+   */
   async transferAdmin(connection, admin, newAdmin, commitmentOrConfig) {
     const [setting] = this.deriver.setting();
     const info = await connection.getAccountInfo(setting, commitmentOrConfig);
@@ -16560,15 +17333,13 @@ var Uln = class {
     );
   }
   /**
+   * Gets the account metadata for the CPI (Cross-Program Invocation) of the quote instruction.
    *
-   * @param connection
-   *
-   * @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.
    */
   async getQuoteIXAccountMetaForCPI(connection, _payer, path, commitment) {
     const { sender: sender_, dstEid } = path;
@@ -16590,8 +17361,14 @@ var Uln = class {
     );
     return accounts.slice(1);
   }
-  /***
-   * 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.
    */
   async getSendIXAccountMetaForCPI(connection, payer, path, commitment = "confirmed") {
     const { sender: sender_, dstEid } = path;
@@ -16629,6 +17406,16 @@ var Uln = class {
     return accounts.slice(1);
   }
   // 3 RPC requests
+  /**
+   * 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.
+   */
   async getSendIxRemainingAccounts(connection, sender, dstEid, payment, commitment = "confirmed") {
     const { executor, dvns } = await this.getWorkers(connection, sender, dstEid, commitment);
     const priceFeeds = new Array();
@@ -16639,7 +17426,7 @@ var Uln = class {
     });
     const priceFeedInfos = await connection.getMultipleAccountsInfo(priceFeeds, commitment);
     const priceFeedDict = priceFeedInfos.reduce((acc, info, i) => {
-      invariant4(info, `priceFeed:${priceFeeds[i].toBase58()} not initialized`);
+      invariant3(info, `priceFeed:${priceFeeds[i].toBase58()} not initialized`);
       acc.set(priceFeeds[i].toBase58(), info.owner);
       return acc;
     }, /* @__PURE__ */ new Map());
@@ -16659,9 +17446,15 @@ var Uln = class {
     });
     return executorAccounts.concat(dvnAccounts.flat());
   }
-  /***
-   * 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.
    */
   async getWorkers(connection, sender, eid, commitment = "confirmed") {
     const [defaultSendConfig] = this.deriver.defaultSendConfig(eid);
@@ -16670,7 +17463,7 @@ var Uln = class {
       [defaultSendConfig, sendConfig],
       commitment
     );
-    invariant4(defaultSendConfigBuf, "defaultSendConfig not initialized");
+    invariant3(defaultSendConfigBuf, "defaultSendConfig not initialized");
     const [defaultSendConfigState] = SendConfig.fromAccountInfo(defaultSendConfigBuf);
     let {
       executor,
@@ -16695,14 +17488,14 @@ var Uln = class {
       [executor.executor, ...dvns],
       commitment
     );
-    invariant4(executorBuf, `executor:${executor.executor.toBase58()} not initialized`);
+    invariant3(executorBuf, `executor:${executor.executor.toBase58()} not initialized`);
     return {
       executor: {
         config: accounts_exports4.ExecutorConfig.fromAccountInfo(executorBuf)[0],
         owner: executorBuf.owner
       },
       dvns: dvnBuf.map((dvn, i) => {
-        invariant4(dvn, `dvn:${dvns[i].toBase58()} not initialized`);
+        invariant3(dvn, `dvn:${dvns[i].toBase58()} not initialized`);
         return {
           config: accounts_exports3.DvnConfig.fromAccountInfo(dvn)[0],
           owner: dvn.owner
@@ -16710,6 +17503,16 @@ var Uln = class {
       })
     };
   }
+  /**
+   * 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.
+   */
   async initVerify(connection, payer, dvn, packetBytes, commitmentOrConfig) {
     const packet = PacketV1Codec.fromBytes(packetBytes);
     const headerHash = packet.headerHash();
@@ -16736,6 +17539,14 @@ var Uln = class {
       this.program
     );
   }
+  /**
+   * 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, packetBytes, confirmations) {
     const packet = PacketV1Codec.fromBytes(packetBytes);
     const headerHash = packet.headerHash();
@@ -16760,6 +17571,14 @@ var Uln = class {
       this.program
     );
   }
+  /**
+   * 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, receiver, packetBytes) {
     const packet = PacketV1Codec.fromBytes(packetBytes);
     const headerHash = packet.headerHash();
@@ -16782,6 +17601,16 @@ var Uln = class {
       this.program
     );
   }
+  /**
+   * 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.
+   */
   async isDvnVerified(connection, endpointProgram, dvn, packetBytes, commitmentOrConfig = "confirmed") {
     const packet = PacketV1Codec.fromBytes(packetBytes);
     const headerHash = packet.headerHash();
@@ -16824,6 +17653,14 @@ var Uln = class {
       return false;
     }
   }
+  /**
+   * 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.
+   */
   async commitVerification(connection, endpointProgram, packetBytes) {
     const packet = PacketV1Codec.fromBytes(packetBytes);
     const payloadHash = packet.payloadHash();
@@ -16863,8 +17700,13 @@ var Uln = class {
       this.program
     );
   }
-  /***
-   * 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, oappID, eid) {
     const [sendConfig] = this.deriver.sendConfig(eid, oappID);
@@ -16888,6 +17730,14 @@ var Uln = class {
     });
     return accounts.slice(1);
   }
+  /**
+   * 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, configData) {
     switch (configType) {
       case 1 /* EXECUTOR */: {
@@ -16904,8 +17754,12 @@ var Uln = class {
     }
   }
   /**
-   * @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.
    */
   async getSetConfigIXAccountMetaForCPI(endpointProgram, oappID, eid) {
     const [sendConfig] = this.deriver.sendConfig(eid, oappID);
@@ -16932,6 +17786,13 @@ var Uln = class {
   }
   //
   // all of below functions are retrieving accounts state
+  /**
+   * 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.
+   */
   async getSetting(connection, commitmentOrConfig) {
     const [setting] = this.deriver.setting();
     try {
@@ -16940,6 +17801,14 @@ var Uln = class {
       return 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.
+   */
   async getDefaultSendConfigState(connection, eid, commitmentOrConfig) {
     const [config] = this.deriver.defaultSendConfig(eid);
     try {
@@ -16948,6 +17817,15 @@ var Uln = class {
       return 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.
+   */
   async getSendConfigState(connection, sender, eid, commitmentOrConfig) {
     const [config] = this.deriver.sendConfig(eid, sender);
     try {
@@ -16956,6 +17834,14 @@ var Uln = class {
       return 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.
+   */
   async getDefaultReceiveConfigState(connection, eid, commitmentOrConfig) {
     const [config] = this.deriver.defaultReceiveConfig(eid);
     try {
@@ -16964,6 +17850,15 @@ var Uln = class {
       return 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.
+   */
   async getReceiveConfigState(connection, receiver, eid, commitmentOrConfig) {
     const [config] = this.deriver.receiveConfig(eid, receiver);
     try {
@@ -16972,6 +17867,16 @@ var Uln = class {
       return 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.
+   */
   async getFinalReceiveConfigState(connection, receiver, eid, commitmentOrConfig = "confirmed") {
     const NIL_CONFIRMATIONS = "18446744073709551615";
     const NIL_DVN_COUNT = "255";
@@ -17803,10 +18708,26 @@ var PROGRAM_ID6 = new PublicKey(PROGRAM_ADDRESS6);
 
 // src/pricefeed.ts
 var PriceFeed2 = class {
+  /**
+   * Creates an instance of the PriceFeed class.
+   *
+   * @param {PublicKey} program - The public key of the program.
+   */
   constructor(program) {
     this.program = program;
     this.deriver = new PriceFeedPDADeriver(this.program);
   }
+  /**
+   * 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.
+   */
   async initPriceFeed(connection, payer, admin, updaters, commitmentOrConfig) {
     const [priceFeed] = this.deriver.priceFeed();
     const info = await connection.getAccountInfo(priceFeed, commitmentOrConfig);
@@ -17827,6 +18748,16 @@ var PriceFeed2 = class {
       this.program
     );
   }
+  /**
+   * 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, updaters, priceRatioDenominator, arbitrumCompressionPercent) {
     const [priceFeed] = this.deriver.priceFeed();
     return createSetPriceFeedInstruction(
@@ -17844,6 +18775,18 @@ var PriceFeed2 = class {
       this.program
     );
   }
+  /**
+   * 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, dstEid, priceRatio, gasPriceInUnit, gasPerByte, modelType) {
     const EID_MODULUS = 3e4;
     dstEid = dstEid % EID_MODULUS;
@@ -17867,6 +18810,14 @@ var PriceFeed2 = class {
       this.program
     );
   }
+  /**
+   * 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, nativeTokenPriceUsd) {
     const [priceFeed] = this.deriver.priceFeed();
     return createSetSolPriceInstruction(
@@ -17882,6 +18833,14 @@ var PriceFeed2 = class {
       this.program
     );
   }
+  /**
+   * 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, newAdmin) {
     const [priceFeed] = this.deriver.priceFeed();
     return createTransferAdminInstruction4(
@@ -17897,6 +18856,14 @@ var PriceFeed2 = class {
       this.program
     );
   }
+  /**
+   * 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.
+   */
   async getPriceFeed(connection, commitmentOrConfig) {
     const [priceFeed] = this.deriver.priceFeed();
     try {
@@ -17929,19 +18896,52 @@ function deriveLzComposeTypesAccountsPDA(program, oappId) {
   return PublicKey.findProgramAddressSync([Buffer.from(LZ_COMPOSE_TYPES_SEED, "utf8")], program);
 }
 var BaseOApp = class {
+  /**
+   * Creates an instance of the BaseOApp class.
+   *
+   * @param {PublicKey} program - The program public key.
+   */
   constructor(program) {
     this.program = program;
     this.oappBaseDeriver = new OAppBasePDADeriver(program);
   }
+  /**
+   * 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.
+   */
   async queryIDPDAInfo(connection, commitmentOrConfig) {
     return this.queryPDAInfo(connection, this.idPDA()[0], commitmentOrConfig);
   }
+  /**
+   * 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.
+   */
   async queryPDAInfo(connection, pda, commitmentOrConfig) {
     return connection.getAccountInfo(pda, commitmentOrConfig);
   }
+  /**
+   * Gets the ID PDA.
+   *
+   * @returns {[PublicKey, number]} The ID PDA and bump.
+   */
   idPDA() {
     return oappIDPDA(this.program);
   }
+  /**
+   * 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.
+   */
   async getRemote(connection, dstEid, commitmentOrConfig) {
     const [remotePDA] = this.oappBaseDeriver.remote(dstEid);
     const info = await this.queryPDAInfo(connection, remotePDA, commitmentOrConfig);
@@ -18043,6 +19043,13 @@ function createVersionInstructionAccounts3(programId) {
 var PROGRAM_ADDRESS7 = "2XrYqmhBMPJgDsb4SVbjV1PnJBprurd5bzRCkHwiFCJB";
 var PROGRAM_ID7 = new PublicKey(PROGRAM_ADDRESS7);
 var SendHelper = class {
+  /**
+   * 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 = endpoint_exports.PROGRAM_ID, ulnProgram = uln_exports.PROGRAM_ID, simpleMsgLibProgram = simple_message_lib_exports.PROGRAM_ID) {
     this.endpointProgram = endpointProgram;
     this.ulnProgram = ulnProgram;
@@ -18052,6 +19059,14 @@ var SendHelper = class {
     this.uln = new uln_exports.Uln(ulnProgram);
     this.simpleMsgLib = new simple_message_lib_exports.SimpleMessageLib(simpleMsgLibProgram);
   }
+  /**
+   * 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.
+   */
   async getMultipleAccountsInfo(connection, keys, commitment) {
     const missingKeys = keys.filter((key) => !this.accounts.has(key.toBase58()));
     if (missingKeys.length > 0) {
@@ -18062,6 +19077,17 @@ var SendHelper = class {
     }
     return keys.map((key) => this.accounts.get(key.toBase58()));
   }
+  /**
+   * 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.
+   */
   async getQuoteAccounts(connection, payer, sender, dstEid, receiver, commitmentOrConfig = "confirmed") {
     const [sendLibConfig] = this.endpoint.deriver.sendLibraryConfig(sender, dstEid);
     const [defaultSendLibConfig] = this.endpoint.deriver.defaultSendLibraryConfig(dstEid);
@@ -18081,7 +19107,7 @@ var SendHelper = class {
       [sendLibConfig, defaultSendLibConfig, simpleMsgLib, uln, ulnDefaultSendConfig, ulnSendConfig],
       commitmentOrConfig
     );
-    invariant4(defaultSendLibConfigBuf && sendLibConfigBuf, "endpoint send library not initialized");
+    invariant3(defaultSendLibConfigBuf && sendLibConfigBuf, "endpoint send library not initialized");
     const [sendLibConfigInfo] = endpoint_exports.accounts.SendLibraryConfig.fromAccountInfo(sendLibConfigBuf, 0);
     const [defaultSendLibConfigInfo] = endpoint_exports.accounts.SendLibraryConfig.fromAccountInfo(
       defaultSendLibConfigBuf,
@@ -18120,14 +19146,16 @@ var SendHelper = class {
     );
   }
   /**
-   * @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.
+   */
   async getSendAccounts(connection, payer, sender, dstEid, receiver, commitmentOrConfig = "confirmed") {
     const [sendLibConfig] = this.endpoint.deriver.sendLibraryConfig(sender, dstEid);
     const [defaultSendLibConfig] = this.endpoint.deriver.defaultSendLibraryConfig(dstEid);
@@ -18147,7 +19175,7 @@ var SendHelper = class {
       [sendLibConfig, defaultSendLibConfig, simpleMsgLib, uln, ulnDefaultSendConfig, ulnSendConfig],
       commitmentOrConfig
     );
-    invariant4(defaultSendLibConfigBuf && sendLibConfigBuf, "endpoint send library not initialized");
+    invariant3(defaultSendLibConfigBuf && sendLibConfigBuf, "endpoint send library not initialized");
     const [sendLibConfigInfo] = endpoint_exports.accounts.SendLibraryConfig.fromAccountInfo(sendLibConfigBuf, 0);
     const [defaultSendLibConfigInfo] = endpoint_exports.accounts.SendLibraryConfig.fromAccountInfo(
       defaultSendLibConfigBuf,
@@ -18185,6 +19213,17 @@ var SendHelper = class {
       )
     );
   }
+  /**
+   * 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.
+   */
   getEndpointAccounts(msgLibProgram, msgLib, sender, dstEid, receiver, quoteOrSend) {
     const [sendLibraryConfig] = this.endpoint.deriver.sendLibraryConfig(sender, dstEid);
     const [defaultSendLibraryConfig] = this.endpoint.deriver.defaultSendLibraryConfig(dstEid);
@@ -18231,6 +19270,13 @@ var SendHelper = class {
       }
     ].concat(accounts);
   }
+  /**
+   * 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.
+   */
   getSimpleMsgLibAccounts(payer, quoteOrSend) {
     const [msgLib] = this.simpleMsgLib.deriver.messageLib();
     let accounts;
@@ -18261,9 +19307,20 @@ var SendHelper = class {
     });
     return accounts.slice(1);
   }
-  // 2 RPC calls
+  /**
+   * 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.
+   */
   async getUlnAccounts(connection, payer, ulnInfo, ulnDefaultSendConfigInfo, ulnSendConfigInfo, quoteOrSend, commitment) {
-    invariant4(ulnInfo.accountInfo && ulnDefaultSendConfigInfo.accountInfo, "uln send library not initialized");
+    invariant3(ulnInfo.accountInfo && ulnDefaultSendConfigInfo.accountInfo, "uln send library not initialized");
     const [ulnState] = uln_exports.accounts.UlnSettings.fromAccountInfo(ulnInfo.accountInfo, 0);
     const [defaultSendConfigState] = uln_exports.accounts.SendConfig.fromAccountInfo(
       ulnDefaultSendConfigInfo.accountInfo,
@@ -18293,7 +19350,7 @@ var SendHelper = class {
       [executor.executor, ...dvnsKey],
       commitment
     );
-    invariant4(executorBuf, `executor:${executor.executor.toBase58()} not initialized`);
+    invariant3(executorBuf, `executor:${executor.executor.toBase58()} not initialized`);
     let executorAccounts, dvnAccounts;
     {
       const executor2 = {
@@ -18301,7 +19358,7 @@ var SendHelper = class {
         owner: executorBuf.owner
       };
       const dvns = dvnBuf.map((dvn, i) => {
-        invariant4(dvn, `dvn:${dvnsKey[i].toBase58()} not initialized`);
+        invariant3(dvn, `dvn:${dvnsKey[i].toBase58()} not initialized`);
         return {
           config: accounts_exports3.DvnConfig.fromAccountInfo(dvn)[0],
           owner: dvn.owner
@@ -18313,7 +19370,7 @@ var SendHelper = class {
       });
       const priceFeedInfos = await this.getMultipleAccountsInfo(connection, priceFeeds, commitment);
       priceFeedInfos.forEach((info, i) => {
-        invariant4(info, `priceFeed:${priceFeeds[i].toBase58()} not initialized`);
+        invariant3(info, `priceFeed:${priceFeeds[i].toBase58()} not initialized`);
       });
       executorAccounts = new Executor(executor2.owner).getQuoteIXAccountMetaForCPI(
         executor2.config.priceFeed,
@@ -19911,6 +20968,9 @@ var types = [
 
 // src/index.ts
 var IdlTypes = {
+  /**
+   * The endpoint types.
+   */
   endpoint: types
 };
 var SetConfigType2 = /* @__PURE__ */ ((SetConfigType3) => {
@@ -19921,5 +20981,5 @@ var SetConfigType2 = /* @__PURE__ */ ((SetConfigType3) => {
 })(SetConfigType2 || {});
 
 export { AddressType, BaseOApp, blocked_messagelib_exports as BlockedMessageLibProgram, COMPOSED_MESSAGE_HASH_SEED, CONFIRMATIONS_SEED, COUNT_SEED, DVNDeriver, dvn_exports2 as DVNProgram, DVN_CONFIG_SEED, dvn_exports as DvnProgram, ENDPOINT_SEED, ENFORCED_OPTIONS_SEED, EVENT_SEED, EXECUTOR_CONFIG_SEED, EndpointPDADeriver, endpoint_exports as EndpointProgram, EventPDADeriver, ExecutorOptionType, ExecutorPDADeriver, executor_exports as ExecutorProgram, FAUCET_URL, IdlTypes, LZ_COMPOSE_TYPES_SEED, LZ_RECEIVE_TYPES_SEED, LzComposeParamsBeet, LzReceiveAccountBeet, LzReceiveParamsBeet, MESSAGE_LIB_SEED, MINT_SEED, MSG_TYPE_OFFSET, MaxExecutorOptionTypeLength, MessageLibPDADeriver, MessageType, NONCE_SEED, OAPP_SEED, OAppBasePDADeriver, OPTIONS_SEED, PAYLOAD_HASH_SEED, PEER_SEED, PENDING_NONCE_SEED, PRICE_FEED_SEED, PriceFeedPDADeriver, pricefeed_exports as PriceFeedProgram, RECEIVE_CONFIG_SEED, RECEIVE_LIBRARY_CONFIG_SEED, REMOTE_SEED, SEND_CONFIG_SEED, SEND_LIBRARY_CONFIG_SEED, SendHelper, SetConfigType2 as SetConfigType, simple_message_lib_exports as SimpleMessageLibProgram, ULN_CONFIG_SEED, ULN_SEED, UlnPDADeriver, uln_exports as UlnProgram, WORKER_SEED, buildMessageV0, buildVersionedTransaction, closeLookupTable, createNonceAccountTX, deactivateLookupTable, deriveLzComposeTypesAccountsPDA, deriveLzReceiveTypesAccountsPDA, extractComposeDeliveredEventByTxHash, extractComposeSentEventByTxHash, extractEventFromTransactionSignature, extractReceivedPacketEventByTxHash, extractSentPacketEventByTxHash, extractVerifiedPacketEventByTxHash, extractWorkerFeePaidEventByTxHash, generateAddressLookupTable, getBlockedMessageLibProgramId, getDVNProgramId, getEndpointProgramId, getExecutorProgramId, getLzComposeAccountMeta, getLzReceiveAccounts, getPricefeedProgramId, getProgramKeypair, getSimpleMessageLibProgramId, getULNProgramId, idlTypes, instructionDiscriminator, isAccountInitialized, lzCompose, lzReceive, messageLibs, oappIDPDA, simulateTransaction, txWithAddressLookupTable, txWithNonce };
-//# sourceMappingURL=out.js.map
+//# sourceMappingURL=index.mjs.map
 //# sourceMappingURL=index.mjs.map