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

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @layerzerolabs/lz-solana-sdk-v2
 
+## 3.0.48
+
+### Patch Changes
+
+- 06754c6: monad testnet
+- Updated dependencies [06754c6]
+  - @layerzerolabs/lz-corekit-solana@3.0.48
+  - @layerzerolabs/lz-definitions@3.0.48
+  - @layerzerolabs/lz-foundation@3.0.48
+  - @layerzerolabs/lz-serdes@3.0.48
+  - @layerzerolabs/lz-utilities@3.0.48
+  - @layerzerolabs/lz-v2-utilities@3.0.48
+
 ## 3.0.47
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@layerzerolabs/lz-solana-sdk-v2",
-  "version": "3.0.47",
+  "version": "3.0.48",
   "license": "BUSL-1.1",
   "exports": {
     ".": {
@@ -15,7 +15,8 @@
   "types": "./dist/index.d.ts",
   "files": [
     "deployments/**/*",
-    "dist/**/*"
+    "dist/**/*",
+    "src/**/*"
   ],
   "scripts": {
     "api-gen": "$npm_execpath gen-idl && $npm_execpath ts-node scripts/generate.ts",
@@ -32,12 +33,12 @@
     "test-uln": "TEST_SCOPES=uln anchor test --skip-build"
   },
   "dependencies": {
-    "@layerzerolabs/lz-corekit-solana": "^3.0.47",
-    "@layerzerolabs/lz-definitions": "^3.0.47",
-    "@layerzerolabs/lz-foundation": "^3.0.47",
-    "@layerzerolabs/lz-serdes": "^3.0.47",
-    "@layerzerolabs/lz-utilities": "^3.0.47",
-    "@layerzerolabs/lz-v2-utilities": "^3.0.47",
+    "@layerzerolabs/lz-corekit-solana": "^3.0.48",
+    "@layerzerolabs/lz-definitions": "^3.0.48",
+    "@layerzerolabs/lz-foundation": "^3.0.48",
+    "@layerzerolabs/lz-serdes": "^3.0.48",
+    "@layerzerolabs/lz-utilities": "^3.0.48",
+    "@layerzerolabs/lz-v2-utilities": "^3.0.48",
     "@metaplex-foundation/beet": "^0.7.1",
     "@metaplex-foundation/beet-solana": "^0.4.0",
     "@metaplex-foundation/solita": "^0.20.1",
@@ -50,8 +51,8 @@
   "devDependencies": {
     "@coral-xyz/anchor": "^0.29.0",
     "@layerzerolabs/layerzero-v2-solana": "^0.0.0",
-    "@layerzerolabs/tsup-config-next": "^3.0.47",
-    "@layerzerolabs/typescript-config-next": "^3.0.47",
+    "@layerzerolabs/tsup-config-next": "^3.0.48",
+    "@layerzerolabs/typescript-config-next": "^3.0.48",
     "@types/bn.js": "^5.1.5",
     "@types/chai": "^4.3.11",
     "@types/chai-as-promised": "^7.1.0",

package/src/base-oapp.ts

@@ -0,0 +1,159 @@
+import { AccountInfo, Commitment, Connection, GetAccountInfoConfig, PublicKey } from '@solana/web3.js'
+import BN from 'bn.js'
+
+import * as EndpointProgram from './endpoint'
+import { COUNT_SEED, LZ_COMPOSE_TYPES_SEED, LZ_RECEIVE_TYPES_SEED, OAppBasePDADeriver } from './pda-deriver'
+import { AddressType } from './types'
+
+import { SimpleMessageLibProgram, UlnProgram } from '.'
+
+// TODO - replace default seed to a convention ID Seed
+
+/**
+ * Derives the OApp ID PDA.
+ *
+ * @param {PublicKey} program - The program public key.
+ * @param {string} [seed=COUNT_SEED] - The seed.
+ * @param {number} [id] - The ID.
+ * @returns {[PublicKey, number]} The derived PDA and bump.
+ */
+export function oappIDPDA(program: PublicKey, seed = COUNT_SEED, id?: number): [PublicKey, number] {
+    if (id != undefined) {
+        return PublicKey.findProgramAddressSync(
+            [Buffer.from(seed, 'utf8'), new BN(id).toArrayLike(Buffer, 'be', 1)],
+            program
+        )
+    } else {
+        return PublicKey.findProgramAddressSync([Buffer.from(seed, 'utf8')], program)
+    }
+}
+
+/**
+ * Derives the LZ receive types accounts PDA.
+ *
+ * @param {PublicKey} program - The program public key.
+ * @param {PublicKey} [oappId] - The OApp ID.
+ * @returns {[PublicKey, number]} The derived PDA and bump.
+ */
+export function deriveLzReceiveTypesAccountsPDA(program: PublicKey, oappId?: PublicKey): [PublicKey, number] {
+    if (oappId != undefined) {
+        return PublicKey.findProgramAddressSync([Buffer.from(LZ_RECEIVE_TYPES_SEED, 'utf8'), oappId.toBytes()], program)
+    }
+    return PublicKey.findProgramAddressSync([Buffer.from(LZ_RECEIVE_TYPES_SEED, 'utf8')], program)
+}
+
+/**
+ * Derives the LZ compose types accounts PDA.
+ *
+ * @param {PublicKey} program - The program public key.
+ * @param {PublicKey} [oappId] - The OApp ID.
+ * @returns {[PublicKey, number]} The derived PDA and bump.
+ */
+export function deriveLzComposeTypesAccountsPDA(program: PublicKey, oappId?: PublicKey): [PublicKey, number] {
+    if (oappId != undefined) {
+        return PublicKey.findProgramAddressSync([Buffer.from(LZ_COMPOSE_TYPES_SEED, 'utf8'), oappId.toBytes()], program)
+    }
+    return PublicKey.findProgramAddressSync([Buffer.from(LZ_COMPOSE_TYPES_SEED, 'utf8')], program)
+}
+
+/**
+ * Abstract class representing a base OApp.
+ */
+export abstract class BaseOApp {
+    oappBaseDeriver: OAppBasePDADeriver
+
+    /**
+     * Creates an instance of the BaseOApp class.
+     *
+     * @param {PublicKey} program - The program public key.
+     */
+    constructor(public program: PublicKey) {
+        this.oappBaseDeriver = new OAppBasePDADeriver(program)
+    }
+
+    /**
+     * Gets the endpoint.
+     *
+     * @param {Connection} connection - The connection.
+     * @returns {Promise<EndpointProgram.Endpoint>} The endpoint.
+     */
+    abstract getEndpoint(connection: Connection): Promise<EndpointProgram.Endpoint>
+
+    /**
+     * Gets the send library program.
+     *
+     * @param {Connection} connection - The connection.
+     * @param {PublicKey} payer - The payer public key.
+     * @param {number} dstEid - The destination endpoint ID.
+     * @param {EndpointProgram.Endpoint} [endpoint] - The endpoint.
+     * @returns {Promise<SimpleMessageLibProgram.SimpleMessageLib | UlnProgram.Uln>} The send library program.
+     */
+    abstract getSendLibraryProgram(
+        connection: Connection,
+        payer: PublicKey,
+        dstEid: number,
+        endpoint?: EndpointProgram.Endpoint
+    ): Promise<SimpleMessageLibProgram.SimpleMessageLib | UlnProgram.Uln>
+
+    /**
+     * Queries the ID PDA info.
+     *
+     * @param {Connection} connection - The connection.
+     * @param {Commitment | GetAccountInfoConfig} [commitmentOrConfig] - The commitment or config.
+     * @returns {Promise<AccountInfo<Buffer> | null>} The account info.
+     */
+    async queryIDPDAInfo(
+        connection: Connection,
+        commitmentOrConfig?: Commitment | GetAccountInfoConfig
+    ): Promise<AccountInfo<Buffer> | null> {
+        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: Connection,
+        pda: PublicKey,
+        commitmentOrConfig?: Commitment | GetAccountInfoConfig
+    ): Promise<AccountInfo<Buffer> | null> {
+        return connection.getAccountInfo(pda, commitmentOrConfig)
+    }
+
+    /**
+     * Gets the ID PDA.
+     *
+     * @returns {[PublicKey, number]} The ID PDA and bump.
+     */
+    idPDA(): [PublicKey, number] {
+        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: Connection,
+        dstEid: number,
+        commitmentOrConfig?: Commitment | GetAccountInfoConfig
+    ): Promise<Uint8Array | null> {
+        const [remotePDA] = this.oappBaseDeriver.remote(dstEid)
+        const info = await this.queryPDAInfo(connection, remotePDA, commitmentOrConfig)
+        if (info) {
+            // the first 8 bytes is account discriminator, so skip it. After that, the next 32 bytes is the address.
+            const result = AddressType.read(info.data, 8)
+            return Uint8Array.from(result)
+        }
+        return null
+    }
+}

package/src/config.ts

@@ -0,0 +1,32 @@
+import { Environment } from '@layerzerolabs/lz-definitions'
+
+/**
+ * Array of IDL types.
+ */
+export const idlTypes = [
+    'MessageLibQuoteParams',
+    'MessageLibSendParams',
+    'MessagingFee',
+    'MessagingReceipt',
+    'PacketForQuote',
+    'Packet',
+    'InitConfigParams',
+    'MessageLibSetConfigParams',
+    'MessageLibSnapshotConfigParams',
+    'MessageLibResetConfigParams',
+]
+
+/**
+ * Array of message libraries.
+ */
+export const messageLibs = ['uln', 'simple_messagelib']
+
+/**
+ * Faucet URLs for different environments.
+ */
+export const FAUCET_URL: { [env in Environment]: string } = {
+    [Environment.MAINNET]: '',
+    [Environment.TESTNET]: '',
+    [Environment.DEVNET]: '',
+    [Environment.LOCAL]: 'http://127.0.0.1:9900',
+}

package/src/deployment.test.ts

@@ -0,0 +1,11 @@
+import { assert } from 'chai'
+
+import 'mocha'
+import { getEndpointProgramId } from './deployment'
+
+describe('deployment', () => {
+    it('getEndpointProgramId', () => {
+        const programId = getEndpointProgramId('solana-sandbox-local')
+        assert.strictEqual(programId.toBase58(), '76y77prsiCMvXMjuoZ5VRrhG5qYBrUMYTE5WgHqgjEn6')
+    })
+})

package/src/deployment.ts

@@ -0,0 +1,128 @@
+import { PublicKey } from '@solana/web3.js'
+
+import { Network } from '@layerzerolabs/lz-definitions'
+
+/**
+ * Supported programs.
+ */
+export type SupportedPrograms =
+    | 'endpoint'
+    | 'simple_messagelib'
+    | 'uln'
+    | 'blocked_messagelib'
+    | 'executor'
+    | 'pricefeed'
+    | 'dvn'
+
+/**
+ * Interface representing a deployment.
+ */
+export interface Deployment {
+    /**
+     * The name of the supported program.
+     */
+    name: SupportedPrograms
+
+    /**
+     * The network of the deployment.
+     */
+    network: Network
+
+    /**
+     * The address of the deployment.
+     */
+    address: string
+
+    /**
+     * Compatible versions of the deployment.
+     */
+    compatibleVersions: string[]
+
+    /**
+     * The deployer of the deployment.
+     */
+    deployer: string
+}
+
+/**
+ * Gets the program keypair.
+ *
+ * @param {Network | 'default'} network - The network.
+ * @param {SupportedPrograms} program - The supported program.
+ * @returns {PublicKey} The public key of the program.
+ */
+export function getProgramKeypair(network: Network | 'default', program: SupportedPrograms): PublicKey {
+    network = network === 'default' ? 'solana-sandbox-local' : network
+    const deployment = require(`@layerzerolabs/lz-solana-sdk-v2/deployments/${network}/${program}.json`) as Deployment
+    return new PublicKey(deployment.address)
+}
+
+/**
+ * Gets the endpoint program ID.
+ *
+ * @param {Network | 'default'} network - The network.
+ * @returns {PublicKey} The public key of the endpoint program.
+ */
+export function getEndpointProgramId(network: Network | 'default'): PublicKey {
+    return getProgramKeypair(network, 'endpoint')
+}
+
+/**
+ * Gets the simple message library program ID.
+ *
+ * @param {Network | 'default'} network - The network.
+ * @returns {PublicKey} The public key of the simple message library program.
+ */
+export function getSimpleMessageLibProgramId(network: Network | 'default'): PublicKey {
+    return getProgramKeypair(network, 'simple_messagelib')
+}
+
+/**
+ * Gets the ULN program ID.
+ *
+ * @param {Network | 'default'} network - The network.
+ * @returns {PublicKey} The public key of the ULN program.
+ */
+export function getULNProgramId(network: Network | 'default'): PublicKey {
+    return getProgramKeypair(network, 'uln')
+}
+
+/**
+ * Gets the DVN program ID.
+ *
+ * @param {Network | 'default'} network - The network.
+ * @returns {PublicKey} The public key of the DVN program.
+ */
+export function getDVNProgramId(network: Network | 'default'): PublicKey {
+    return getProgramKeypair(network, 'dvn')
+}
+
+/**
+ * Gets the blocked message library program ID.
+ *
+ * @param {Network | 'default'} network - The network.
+ * @returns {PublicKey} The public key of the blocked message library program.
+ */
+export function getBlockedMessageLibProgramId(network: Network | 'default'): PublicKey {
+    return getProgramKeypair(network, 'blocked_messagelib')
+}
+
+/**
+ * Gets the executor program ID.
+ *
+ * @param {Network | 'default'} network - The network.
+ * @returns {PublicKey} The public key of the executor program.
+ */
+export function getExecutorProgramId(network: Network | 'default'): PublicKey {
+    return getProgramKeypair(network, 'executor')
+}
+
+/**
+ * Gets the pricefeed program ID.
+ *
+ * @param {Network | 'default'} network - The network.
+ * @returns {PublicKey} The public key of the pricefeed program.
+ */
+export function getPricefeedProgramId(network: Network | 'default'): PublicKey {
+    return getProgramKeypair(network, 'pricefeed')
+}