@layerzerolabs/lz-solana-sdk-v2 3.0.47 → 3.0.48

package/src/generated/dvn/types/MultisigConfig.ts

@@ -0,0 +1,124 @@
+/**
+ * This code was GENERATED using the solita package.
+ * Please DO NOT EDIT THIS FILE, instead rerun solita to update it or write a wrapper to add functionality.
+ *
+ * See: https://github.com/metaplex-foundation/solita
+ */
+
+import * as web3 from '@solana/web3.js'
+import * as beet from '@metaplex-foundation/beet'
+import * as beetSolana from '@metaplex-foundation/beet-solana'
+/**
+ * This type is used to derive the {@link MultisigConfig} type as well as the de/serializer.
+ * However don't refer to it in your code but use the {@link MultisigConfig} type instead.
+ *
+ * @category userTypes
+ * @category enums
+ * @category generated
+ * @private
+ */
+export type MultisigConfigRecord = {
+  Admins: { fields: [web3.PublicKey[]] }
+  Allowlist: { fields: [web3.PublicKey[]] }
+  Denylist: { fields: [web3.PublicKey[]] }
+  Msglibs: { fields: [web3.PublicKey[]] }
+  Paused: { fields: [boolean] }
+  Quorum: { fields: [number] }
+  Signers: { fields: [number[] /* size: 64 */[]] }
+}
+
+/**
+ * Union type respresenting the MultisigConfig data enum defined in Rust.
+ *
+ * NOTE: that it includes a `__kind` property which allows to narrow types in
+ * switch/if statements.
+ * Additionally `isMultisigConfig*` type guards are exposed below to narrow to a specific variant.
+ *
+ * @category userTypes
+ * @category enums
+ * @category generated
+ */
+export type MultisigConfig = beet.DataEnumKeyAsKind<MultisigConfigRecord>
+
+export const isMultisigConfigAdmins = (
+  x: MultisigConfig
+): x is MultisigConfig & { __kind: 'Admins' } => x.__kind === 'Admins'
+export const isMultisigConfigAllowlist = (
+  x: MultisigConfig
+): x is MultisigConfig & { __kind: 'Allowlist' } => x.__kind === 'Allowlist'
+export const isMultisigConfigDenylist = (
+  x: MultisigConfig
+): x is MultisigConfig & { __kind: 'Denylist' } => x.__kind === 'Denylist'
+export const isMultisigConfigMsglibs = (
+  x: MultisigConfig
+): x is MultisigConfig & { __kind: 'Msglibs' } => x.__kind === 'Msglibs'
+export const isMultisigConfigPaused = (
+  x: MultisigConfig
+): x is MultisigConfig & { __kind: 'Paused' } => x.__kind === 'Paused'
+export const isMultisigConfigQuorum = (
+  x: MultisigConfig
+): x is MultisigConfig & { __kind: 'Quorum' } => x.__kind === 'Quorum'
+export const isMultisigConfigSigners = (
+  x: MultisigConfig
+): x is MultisigConfig & { __kind: 'Signers' } => x.__kind === 'Signers'
+
+/**
+ * @category userTypes
+ * @category generated
+ */
+export const multisigConfigBeet = beet.dataEnum<MultisigConfigRecord>([
+  [
+    'Admins',
+    new beet.FixableBeetArgsStruct<MultisigConfigRecord['Admins']>(
+      [['fields', beet.tuple([beet.array(beetSolana.publicKey)])]],
+      'MultisigConfigRecord["Admins"]'
+    ),
+  ],
+  [
+    'Allowlist',
+    new beet.FixableBeetArgsStruct<MultisigConfigRecord['Allowlist']>(
+      [['fields', beet.tuple([beet.array(beetSolana.publicKey)])]],
+      'MultisigConfigRecord["Allowlist"]'
+    ),
+  ],
+  [
+    'Denylist',
+    new beet.FixableBeetArgsStruct<MultisigConfigRecord['Denylist']>(
+      [['fields', beet.tuple([beet.array(beetSolana.publicKey)])]],
+      'MultisigConfigRecord["Denylist"]'
+    ),
+  ],
+  [
+    'Msglibs',
+    new beet.FixableBeetArgsStruct<MultisigConfigRecord['Msglibs']>(
+      [['fields', beet.tuple([beet.array(beetSolana.publicKey)])]],
+      'MultisigConfigRecord["Msglibs"]'
+    ),
+  ],
+  [
+    'Paused',
+    new beet.BeetArgsStruct<MultisigConfigRecord['Paused']>(
+      [['fields', beet.fixedSizeTuple([beet.bool])]],
+      'MultisigConfigRecord["Paused"]'
+    ),
+  ],
+  [
+    'Quorum',
+    new beet.BeetArgsStruct<MultisigConfigRecord['Quorum']>(
+      [['fields', beet.fixedSizeTuple([beet.u8])]],
+      'MultisigConfigRecord["Quorum"]'
+    ),
+  ],
+  [
+    'Signers',
+    new beet.FixableBeetArgsStruct<MultisigConfigRecord['Signers']>(
+      [
+        [
+          'fields',
+          beet.tuple([beet.array(beet.uniformFixedSizeArray(beet.u8, 64))]),
+        ],
+      ],
+      'MultisigConfigRecord["Signers"]'
+    ),
+  ],
+]) as beet.FixableBeet<MultisigConfig, MultisigConfig>

package/src/generated/dvn/types/QuoteDvnParams.ts

@@ -0,0 +1,38 @@
+/**
+ * This code was GENERATED using the solita package.
+ * Please DO NOT EDIT THIS FILE, instead rerun solita to update it or write a wrapper to add functionality.
+ *
+ * See: https://github.com/metaplex-foundation/solita
+ */
+
+import * as web3 from '@solana/web3.js'
+import * as beet from '@metaplex-foundation/beet'
+import * as beetSolana from '@metaplex-foundation/beet-solana'
+import { LzOption, lzOptionBeet } from './LzOption'
+export type QuoteDvnParams = {
+  msglib: web3.PublicKey
+  dstEid: number
+  sender: web3.PublicKey
+  packetHeader: Uint8Array
+  payloadHash: number[] /* size: 32 */
+  confirmations: beet.bignum
+  options: LzOption[]
+}
+
+/**
+ * @category userTypes
+ * @category generated
+ */
+export const quoteDvnParamsBeet =
+  new beet.FixableBeetArgsStruct<QuoteDvnParams>(
+    [
+      ['msglib', beetSolana.publicKey],
+      ['dstEid', beet.u32],
+      ['sender', beetSolana.publicKey],
+      ['packetHeader', beet.bytes],
+      ['payloadHash', beet.uniformFixedSizeArray(beet.u8, 32)],
+      ['confirmations', beet.u64],
+      ['options', beet.array(lzOptionBeet)],
+    ],
+    'QuoteDvnParams'
+  )

package/src/generated/dvn/types/SetConfigParams.ts

@@ -0,0 +1,22 @@
+/**
+ * This code was GENERATED using the solita package.
+ * Please DO NOT EDIT THIS FILE, instead rerun solita to update it or write a wrapper to add functionality.
+ *
+ * See: https://github.com/metaplex-foundation/solita
+ */
+
+import * as beet from '@metaplex-foundation/beet'
+import { AdminConfig, adminConfigBeet } from './AdminConfig'
+export type SetConfigParams = {
+  config: AdminConfig
+}
+
+/**
+ * @category userTypes
+ * @category generated
+ */
+export const setConfigParamsBeet =
+  new beet.FixableBeetArgsStruct<SetConfigParams>(
+    [['config', adminConfigBeet]],
+    'SetConfigParams'
+  )

package/src/generated/dvn/types/TransactionAccount.ts

@@ -0,0 +1,29 @@
+/**
+ * This code was GENERATED using the solita package.
+ * Please DO NOT EDIT THIS FILE, instead rerun solita to update it or write a wrapper to add functionality.
+ *
+ * See: https://github.com/metaplex-foundation/solita
+ */
+
+import * as web3 from '@solana/web3.js'
+import * as beetSolana from '@metaplex-foundation/beet-solana'
+import * as beet from '@metaplex-foundation/beet'
+export type TransactionAccount = {
+  pubkey: web3.PublicKey
+  isSigner: boolean
+  isWritable: boolean
+}
+
+/**
+ * @category userTypes
+ * @category generated
+ */
+export const transactionAccountBeet =
+  new beet.BeetArgsStruct<TransactionAccount>(
+    [
+      ['pubkey', beetSolana.publicKey],
+      ['isSigner', beet.bool],
+      ['isWritable', beet.bool],
+    ],
+    'TransactionAccount'
+  )

package/src/generated/dvn/types/UlnConfig.ts

@@ -0,0 +1,34 @@
+/**
+ * This code was GENERATED using the solita package.
+ * Please DO NOT EDIT THIS FILE, instead rerun solita to update it or write a wrapper to add functionality.
+ *
+ * See: https://github.com/metaplex-foundation/solita
+ */
+
+import * as beet from '@metaplex-foundation/beet'
+import * as web3 from '@solana/web3.js'
+import * as beetSolana from '@metaplex-foundation/beet-solana'
+export type UlnConfig = {
+  confirmations: beet.bignum
+  requiredDvnCount: number
+  optionalDvnCount: number
+  optionalDvnThreshold: number
+  requiredDvns: web3.PublicKey[]
+  optionalDvns: web3.PublicKey[]
+}
+
+/**
+ * @category userTypes
+ * @category generated
+ */
+export const ulnConfigBeet = new beet.FixableBeetArgsStruct<UlnConfig>(
+  [
+    ['confirmations', beet.u64],
+    ['requiredDvnCount', beet.u8],
+    ['optionalDvnCount', beet.u8],
+    ['optionalDvnThreshold', beet.u8],
+    ['requiredDvns', beet.array(beetSolana.publicKey)],
+    ['optionalDvns', beet.array(beetSolana.publicKey)],
+  ],
+  'UlnConfig'
+)

package/src/generated/dvn/types/VerifiableParams.ts

@@ -0,0 +1,24 @@
+/**
+ * This code was GENERATED using the solita package.
+ * Please DO NOT EDIT THIS FILE, instead rerun solita to update it or write a wrapper to add functionality.
+ *
+ * See: https://github.com/metaplex-foundation/solita
+ */
+
+import * as beet from '@metaplex-foundation/beet'
+export type VerifiableParams = {
+  packetHeader: number[] /* size: 81 */
+  payloadHash: number[] /* size: 32 */
+}
+
+/**
+ * @category userTypes
+ * @category generated
+ */
+export const verifiableParamsBeet = new beet.BeetArgsStruct<VerifiableParams>(
+  [
+    ['packetHeader', beet.uniformFixedSizeArray(beet.u8, 81)],
+    ['payloadHash', beet.uniformFixedSizeArray(beet.u8, 32)],
+  ],
+  'VerifiableParams'
+)

package/src/generated/dvn/types/VerificationState.ts

@@ -0,0 +1,27 @@
+/**
+ * This code was GENERATED using the solita package.
+ * Please DO NOT EDIT THIS FILE, instead rerun solita to update it or write a wrapper to add functionality.
+ *
+ * See: https://github.com/metaplex-foundation/solita
+ */
+
+import * as beet from '@metaplex-foundation/beet'
+/**
+ * @category enums
+ * @category generated
+ */
+export enum VerificationState {
+  Verifying,
+  Verifiable,
+  Verified,
+  NotInitializable,
+  VerifiableButCapExceeded,
+}
+
+/**
+ * @category userTypes
+ * @category generated
+ */
+export const verificationStateBeet = beet.fixedScalarEnum(
+  VerificationState
+) as beet.FixedSizeBeet<VerificationState, VerificationState>

package/src/generated/dvn/types/WithdrawFeeParams.ts

@@ -0,0 +1,20 @@
+/**
+ * This code was GENERATED using the solita package.
+ * Please DO NOT EDIT THIS FILE, instead rerun solita to update it or write a wrapper to add functionality.
+ *
+ * See: https://github.com/metaplex-foundation/solita
+ */
+
+import * as beet from '@metaplex-foundation/beet'
+export type WithdrawFeeParams = {
+  amount: beet.bignum
+}
+
+/**
+ * @category userTypes
+ * @category generated
+ */
+export const withdrawFeeParamsBeet = new beet.BeetArgsStruct<WithdrawFeeParams>(
+  [['amount', beet.u64]],
+  'WithdrawFeeParams'
+)

package/src/generated/dvn/types/index.ts

@@ -0,0 +1,17 @@
+export * from './Acl'
+export * from './AdminConfig'
+export * from './CloseExecuteParams'
+export * from './DstConfig'
+export * from './ExecuteTransactionDigest'
+export * from './InitDvnParams'
+export * from './InvokeParams'
+export * from './LzOption'
+export * from './Multisig'
+export * from './MultisigConfig'
+export * from './QuoteDvnParams'
+export * from './SetConfigParams'
+export * from './TransactionAccount'
+export * from './UlnConfig'
+export * from './VerifiableParams'
+export * from './VerificationState'
+export * from './WithdrawFeeParams'

package/src/generated/endpoint/accounts/ComposeMessageState.ts

@@ -0,0 +1,170 @@
+/**
+ * This code was GENERATED using the solita package.
+ * Please DO NOT EDIT THIS FILE, instead rerun solita to update it or write a wrapper to add functionality.
+ *
+ * See: https://github.com/metaplex-foundation/solita
+ */
+
+import * as beet from '@metaplex-foundation/beet'
+import * as web3 from '@solana/web3.js'
+import * as beetSolana from '@metaplex-foundation/beet-solana'
+
+/**
+ * Arguments used to create {@link ComposeMessageState}
+ * @category Accounts
+ * @category generated
+ */
+export type ComposeMessageStateArgs = {
+  received: boolean
+  bump: number
+}
+
+export const composeMessageStateDiscriminator = [
+  55, 107, 79, 254, 243, 22, 172, 240,
+]
+/**
+ * Holds the data for the {@link ComposeMessageState} Account and provides de/serialization
+ * functionality for that data
+ *
+ * @category Accounts
+ * @category generated
+ */
+export class ComposeMessageState implements ComposeMessageStateArgs {
+  private constructor(readonly received: boolean, readonly bump: number) {}
+
+  /**
+   * Creates a {@link ComposeMessageState} instance from the provided args.
+   */
+  static fromArgs(args: ComposeMessageStateArgs) {
+    return new ComposeMessageState(args.received, args.bump)
+  }
+
+  /**
+   * Deserializes the {@link ComposeMessageState} from the data of the provided {@link web3.AccountInfo}.
+   * @returns a tuple of the account data and the offset up to which the buffer was read to obtain it.
+   */
+  static fromAccountInfo(
+    accountInfo: web3.AccountInfo<Buffer>,
+    offset = 0
+  ): [ComposeMessageState, number] {
+    return ComposeMessageState.deserialize(accountInfo.data, offset)
+  }
+
+  /**
+   * Retrieves the account info from the provided address and deserializes
+   * the {@link ComposeMessageState} from its data.
+   *
+   * @throws Error if no account info is found at the address or if deserialization fails
+   */
+  static async fromAccountAddress(
+    connection: web3.Connection,
+    address: web3.PublicKey,
+    commitmentOrConfig?: web3.Commitment | web3.GetAccountInfoConfig
+  ): Promise<ComposeMessageState> {
+    const accountInfo = await connection.getAccountInfo(
+      address,
+      commitmentOrConfig
+    )
+    if (accountInfo == null) {
+      throw new Error(
+        `Unable to find ComposeMessageState account at ${address}`
+      )
+    }
+    return ComposeMessageState.fromAccountInfo(accountInfo, 0)[0]
+  }
+
+  /**
+   * Provides a {@link web3.Connection.getProgramAccounts} config builder,
+   * to fetch accounts matching filters that can be specified via that builder.
+   *
+   * @param programId - the program that owns the accounts we are filtering
+   */
+  static gpaBuilder(
+    programId: web3.PublicKey = new web3.PublicKey(
+      '76y77prsiCMvXMjuoZ5VRrhG5qYBrUMYTE5WgHqgjEn6'
+    )
+  ) {
+    return beetSolana.GpaBuilder.fromStruct(programId, composeMessageStateBeet)
+  }
+
+  /**
+   * Deserializes the {@link ComposeMessageState} from the provided data Buffer.
+   * @returns a tuple of the account data and the offset up to which the buffer was read to obtain it.
+   */
+  static deserialize(buf: Buffer, offset = 0): [ComposeMessageState, number] {
+    return composeMessageStateBeet.deserialize(buf, offset)
+  }
+
+  /**
+   * Serializes the {@link ComposeMessageState} into a Buffer.
+   * @returns a tuple of the created Buffer and the offset up to which the buffer was written to store it.
+   */
+  serialize(): [Buffer, number] {
+    return composeMessageStateBeet.serialize({
+      accountDiscriminator: composeMessageStateDiscriminator,
+      ...this,
+    })
+  }
+
+  /**
+   * Returns the byteSize of a {@link Buffer} holding the serialized data of
+   * {@link ComposeMessageState}
+   */
+  static get byteSize() {
+    return composeMessageStateBeet.byteSize
+  }
+
+  /**
+   * Fetches the minimum balance needed to exempt an account holding
+   * {@link ComposeMessageState} data from rent
+   *
+   * @param connection used to retrieve the rent exemption information
+   */
+  static async getMinimumBalanceForRentExemption(
+    connection: web3.Connection,
+    commitment?: web3.Commitment
+  ): Promise<number> {
+    return connection.getMinimumBalanceForRentExemption(
+      ComposeMessageState.byteSize,
+      commitment
+    )
+  }
+
+  /**
+   * Determines if the provided {@link Buffer} has the correct byte size to
+   * hold {@link ComposeMessageState} data.
+   */
+  static hasCorrectByteSize(buf: Buffer, offset = 0) {
+    return buf.byteLength - offset === ComposeMessageState.byteSize
+  }
+
+  /**
+   * Returns a readable version of {@link ComposeMessageState} properties
+   * and can be used to convert to JSON and/or logging
+   */
+  pretty() {
+    return {
+      received: this.received,
+      bump: this.bump,
+    }
+  }
+}
+
+/**
+ * @category Accounts
+ * @category generated
+ */
+export const composeMessageStateBeet = new beet.BeetStruct<
+  ComposeMessageState,
+  ComposeMessageStateArgs & {
+    accountDiscriminator: number[] /* size: 8 */
+  }
+>(
+  [
+    ['accountDiscriminator', beet.uniformFixedSizeArray(beet.u8, 8)],
+    ['received', beet.bool],
+    ['bump', beet.u8],
+  ],
+  ComposeMessageState.fromArgs,
+  'ComposeMessageState'
+)

package/src/generated/endpoint/accounts/EndpointSettings.ts

@@ -0,0 +1,184 @@
+/**
+ * This code was GENERATED using the solita package.
+ * Please DO NOT EDIT THIS FILE, instead rerun solita to update it or write a wrapper to add functionality.
+ *
+ * See: https://github.com/metaplex-foundation/solita
+ */
+
+import * as web3 from '@solana/web3.js'
+import * as beet from '@metaplex-foundation/beet'
+import * as beetSolana from '@metaplex-foundation/beet-solana'
+
+/**
+ * Arguments used to create {@link EndpointSettings}
+ * @category Accounts
+ * @category generated
+ */
+export type EndpointSettingsArgs = {
+  eid: number
+  bump: number
+  admin: web3.PublicKey
+  lzTokenMint: beet.COption<web3.PublicKey>
+}
+
+export const endpointSettingsDiscriminator = [221, 232, 73, 56, 10, 66, 72, 14]
+/**
+ * Holds the data for the {@link EndpointSettings} Account and provides de/serialization
+ * functionality for that data
+ *
+ * @category Accounts
+ * @category generated
+ */
+export class EndpointSettings implements EndpointSettingsArgs {
+  private constructor(
+    readonly eid: number,
+    readonly bump: number,
+    readonly admin: web3.PublicKey,
+    readonly lzTokenMint: beet.COption<web3.PublicKey>
+  ) {}
+
+  /**
+   * Creates a {@link EndpointSettings} instance from the provided args.
+   */
+  static fromArgs(args: EndpointSettingsArgs) {
+    return new EndpointSettings(
+      args.eid,
+      args.bump,
+      args.admin,
+      args.lzTokenMint
+    )
+  }
+
+  /**
+   * Deserializes the {@link EndpointSettings} from the data of the provided {@link web3.AccountInfo}.
+   * @returns a tuple of the account data and the offset up to which the buffer was read to obtain it.
+   */
+  static fromAccountInfo(
+    accountInfo: web3.AccountInfo<Buffer>,
+    offset = 0
+  ): [EndpointSettings, number] {
+    return EndpointSettings.deserialize(accountInfo.data, offset)
+  }
+
+  /**
+   * Retrieves the account info from the provided address and deserializes
+   * the {@link EndpointSettings} from its data.
+   *
+   * @throws Error if no account info is found at the address or if deserialization fails
+   */
+  static async fromAccountAddress(
+    connection: web3.Connection,
+    address: web3.PublicKey,
+    commitmentOrConfig?: web3.Commitment | web3.GetAccountInfoConfig
+  ): Promise<EndpointSettings> {
+    const accountInfo = await connection.getAccountInfo(
+      address,
+      commitmentOrConfig
+    )
+    if (accountInfo == null) {
+      throw new Error(`Unable to find EndpointSettings account at ${address}`)
+    }
+    return EndpointSettings.fromAccountInfo(accountInfo, 0)[0]
+  }
+
+  /**
+   * Provides a {@link web3.Connection.getProgramAccounts} config builder,
+   * to fetch accounts matching filters that can be specified via that builder.
+   *
+   * @param programId - the program that owns the accounts we are filtering
+   */
+  static gpaBuilder(
+    programId: web3.PublicKey = new web3.PublicKey(
+      '76y77prsiCMvXMjuoZ5VRrhG5qYBrUMYTE5WgHqgjEn6'
+    )
+  ) {
+    return beetSolana.GpaBuilder.fromStruct(programId, endpointSettingsBeet)
+  }
+
+  /**
+   * Deserializes the {@link EndpointSettings} from the provided data Buffer.
+   * @returns a tuple of the account data and the offset up to which the buffer was read to obtain it.
+   */
+  static deserialize(buf: Buffer, offset = 0): [EndpointSettings, number] {
+    return endpointSettingsBeet.deserialize(buf, offset)
+  }
+
+  /**
+   * Serializes the {@link EndpointSettings} into a Buffer.
+   * @returns a tuple of the created Buffer and the offset up to which the buffer was written to store it.
+   */
+  serialize(): [Buffer, number] {
+    return endpointSettingsBeet.serialize({
+      accountDiscriminator: endpointSettingsDiscriminator,
+      ...this,
+    })
+  }
+
+  /**
+   * Returns the byteSize of a {@link Buffer} holding the serialized data of
+   * {@link EndpointSettings} for the provided args.
+   *
+   * @param args need to be provided since the byte size for this account
+   * depends on them
+   */
+  static byteSize(args: EndpointSettingsArgs) {
+    const instance = EndpointSettings.fromArgs(args)
+    return endpointSettingsBeet.toFixedFromValue({
+      accountDiscriminator: endpointSettingsDiscriminator,
+      ...instance,
+    }).byteSize
+  }
+
+  /**
+   * Fetches the minimum balance needed to exempt an account holding
+   * {@link EndpointSettings} data from rent
+   *
+   * @param args need to be provided since the byte size for this account
+   * depends on them
+   * @param connection used to retrieve the rent exemption information
+   */
+  static async getMinimumBalanceForRentExemption(
+    args: EndpointSettingsArgs,
+    connection: web3.Connection,
+    commitment?: web3.Commitment
+  ): Promise<number> {
+    return connection.getMinimumBalanceForRentExemption(
+      EndpointSettings.byteSize(args),
+      commitment
+    )
+  }
+
+  /**
+   * Returns a readable version of {@link EndpointSettings} properties
+   * and can be used to convert to JSON and/or logging
+   */
+  pretty() {
+    return {
+      eid: this.eid,
+      bump: this.bump,
+      admin: this.admin.toBase58(),
+      lzTokenMint: this.lzTokenMint,
+    }
+  }
+}
+
+/**
+ * @category Accounts
+ * @category generated
+ */
+export const endpointSettingsBeet = new beet.FixableBeetStruct<
+  EndpointSettings,
+  EndpointSettingsArgs & {
+    accountDiscriminator: number[] /* size: 8 */
+  }
+>(
+  [
+    ['accountDiscriminator', beet.uniformFixedSizeArray(beet.u8, 8)],
+    ['eid', beet.u32],
+    ['bump', beet.u8],
+    ['admin', beetSolana.publicKey],
+    ['lzTokenMint', beet.coption(beetSolana.publicKey)],
+  ],
+  EndpointSettings.fromArgs,
+  'EndpointSettings'
+)