feat(cct-sdk): Add get token info op solana

ccip-sdk/src/cct/solana/index.test.ts

@@ -197,6 +197,7 @@ describe('SolanaTokenManager (cct/solana)', () => {
         getTokenAdminRegistryFor: async (address: string) =>
           address === reader ? pool : address === overrideAddress ? overrideRouter : account,
         getSupportedTokens: async () => [mint],
+        getTokenInfo: async () => ({ symbol: 'TKN', decimals: 6 }),
         getTokenPoolRemotes: async () => ({}),
         getRegistryTokenConfig: async (router: string) =>
           router === overrideRouter
@@ -779,6 +780,7 @@ describe('SolanaTokenManager (cct/solana)', () => {
               remoteChainSelector,
             }),
         ],
+        ['getTokenInfo', () => cct.getTokenInfo({ tokenAddress: mint })],
         [
           'getTokenPoolState',
           () =>

ccip-sdk/src/cct/solana/index.ts

@@ -177,8 +177,11 @@ import {
   type GenerateSetTokenAuthorityResult,
   type GenerateUpdateMetadataAuthorityParams,
   type GenerateUpdateMetadataAuthorityResult,
+  type GetTokenInfoParams,
+  type GetTokenInfoResult,
   ApproveToken,
   CreateTokenAccount,
+  GetTokenInfo,
   MintTokens,
   SetTokenAuthority,
   UpdateMetadataAuthority,
@@ -190,6 +193,7 @@ export class SolanaTokenManager extends TokenManager<typeof ChainFamily.Solana>
   // Token operations
   readonly #approveToken = new ApproveToken()
   readonly #createTokenAccount = new CreateTokenAccount()
+  readonly #getTokenInfo = new GetTokenInfo()
   readonly #mintTokens = new MintTokens()
   readonly #setTokenAuthority = new SetTokenAuthority()
   readonly #updateMetadataAuthority = new UpdateMetadataAuthority()
@@ -2230,6 +2234,36 @@ export class SolanaTokenManager extends TokenManager<typeof ChainFamily.Solana>
     return this.#transferAdmin.execute(this.chain, opts)
   }
 
+  /**
+   * Reads an SPL token mint's metadata, program, supply, initialization state, and mint/freeze
+   * authorities.
+   *
+   * @remarks Metadata comes from {@link SolanaChain.getTokenInfo}; mint state comes directly from
+   * the SPL Token or Token-2022 mint account. Supply is in base units. Solana-only; no EVM CCT
+   * equivalent exists.
+   *
+   * @see {@link setTokenAuthority} Sets the mint or freeze authorities returned here.
+   * @see {@link updateMetadataAuthority} Updates the Metaplex metadata associated with this mint.
+   * @see {@link getTokenPoolState} Reads pool configuration rather than mint state.
+   * @see {@link SolanaChain.getTokenInfo} Reads the underlying token metadata.
+   *
+   * @throws {@link CCTParamsInvalidError} If `tokenAddress` is not a valid Solana public key.
+   * @throws {@link CCIPSplTokenInvalidError} If the token metadata is not a valid SPL token.
+   * @throws {@link CCIPTokenMintNotFoundError} If the mint account does not exist.
+   * @throws {@link CCIPTokenMintInvalidError} If the mint is not owned by an SPL Token program.
+   * @throws {@link CCIPTokenDataParseError} If the mint data cannot be parsed.
+   *
+   * @example
+   * ```ts
+   * const cct = SolanaTokenManager.fromChain(chain)
+   * const info = await cct.getTokenInfo({ tokenAddress: mint })
+   * console.log(`${info.symbol}: ${info.decimals} decimals`)
+   * ```
+   */
+  getTokenInfo(opts: GetTokenInfoParams): Promise<GetTokenInfoResult> {
+    return this.#getTokenInfo.query(this.chain, opts)
+  }
+
   /**
    * Reads all, or one selected, Solana token pool remote-chain configurations.
    *

ccip-sdk/src/cct/solana/token/operations/get-token-info.test.ts

@@ -0,0 +1,86 @@
+import assert from 'node:assert/strict'
+import { describe, it } from 'node:test'
+
+import { MINT_SIZE, MintLayout, TOKEN_PROGRAM_ID } from '@solana/spl-token'
+import { Keypair, PublicKey } from '@solana/web3.js'
+
+import { CCIPTokenDataParseError } from '../../../../errors/index.ts'
+import type { SolanaChain } from '../../../../solana/index.ts'
+import { GetTokenInfo } from './get-token-info.ts'
+
+const tokenAddress = Keypair.generate().publicKey.toBase58()
+const mintAuthority = Keypair.generate().publicKey
+
+function mintData(): Buffer {
+  const data = Buffer.alloc(MINT_SIZE)
+  MintLayout.encode(
+    {
+      mintAuthorityOption: 1,
+      mintAuthority,
+      supply: 1_000_000n,
+      decimals: 6,
+      isInitialized: true,
+      freezeAuthorityOption: 0,
+      freezeAuthority: PublicKey.default,
+    },
+    data,
+  )
+  return data
+}
+
+describe('GetTokenInfo (cct/solana)', () => {
+  describe('query', () => {
+    it('delegates metadata to SolanaChain.getTokenInfo and reads mint state', async () => {
+      const metadata = { symbol: 'TKN', decimals: 6, name: 'Token' }
+      let received: string | undefined
+      const chain = {
+        connection: {
+          getAccountInfo: async () => ({ owner: TOKEN_PROGRAM_ID, data: mintData() }),
+        },
+        getTokenInfo: async (token: string) => {
+          received = token
+          return metadata
+        },
+      } as unknown as SolanaChain
+
+      assert.deepEqual(await new GetTokenInfo().query(chain, { tokenAddress }), {
+        ...metadata,
+        tokenProgram: TOKEN_PROGRAM_ID.toBase58(),
+        supply: 1_000_000n,
+        isInitialized: true,
+        mintAuthority: mintAuthority.toBase58(),
+        freezeAuthority: null,
+      })
+      assert.equal(received, tokenAddress)
+    })
+
+    it('rejects non-mint SPL accounts before fetching metadata', async () => {
+      let metadataCalls = 0
+      const chain = {
+        connection: {
+          getAccountInfo: async () => ({ owner: TOKEN_PROGRAM_ID, data: Buffer.alloc(1) }),
+        },
+        getTokenInfo: async () => {
+          metadataCalls++
+          return { symbol: 'TKN', decimals: 6 }
+        },
+      } as unknown as SolanaChain
+
+      await assert.rejects(new GetTokenInfo().query(chain, { tokenAddress }), (error: unknown) => {
+        assert.ok(error instanceof CCIPTokenDataParseError)
+        assert.equal(error.context.token, tokenAddress)
+        assert.ok(error.cause instanceof Error)
+        return true
+      })
+      assert.equal(metadataCalls, 0)
+    })
+  })
+
+  describe('validation', () => {
+    it('validates the mint address before querying', async () => {
+      await assert.rejects(
+        new GetTokenInfo().query({} as SolanaChain, { tokenAddress: 'not-a-public-key' }),
+      )
+    })
+  })
+})

ccip-sdk/src/cct/solana/token/operations/get-token-info.ts

@@ -0,0 +1,84 @@
+import { unpackMint } from '@solana/spl-token'
+import type { PublicKey } from '@solana/web3.js'
+
+import type { TokenInfo } from '../../../../chain.ts'
+import { CCIPTokenDataParseError } from '../../../../errors/index.ts'
+import type { SolanaChain } from '../../../../solana/index.ts'
+import { resolveTokenMint } from '../../../../solana/utils.ts'
+import { SolanaQuery } from '../../query.ts'
+import { parsePublicKey } from '../../validate.ts'
+
+/** Parameters for reading an SPL token mint's metadata. */
+export type GetTokenInfoParams = {
+  /** SPL token mint address. */
+  tokenAddress: string
+}
+
+/** SPL token metadata and mint state. */
+export type GetTokenInfoResult = TokenInfo & {
+  /** SPL Token or Token-2022 program that owns the mint. */
+  tokenProgram: string
+  /** Total minted supply in base units. */
+  supply: bigint
+  /** Whether the mint account has been initialized. */
+  isInitialized: boolean
+  /** Authority allowed to mint new tokens, or null for fixed-supply tokens. */
+  mintAuthority: string | null
+  /** Authority allowed to freeze token accounts, or null when freezing is disabled. */
+  freezeAuthority: string | null
+}
+
+type ParsedGetTokenInfoParams = GetTokenInfoParams & { mint: PublicKey }
+
+/**
+ * Reads an SPL token mint's metadata and state.
+ *
+ * @throws {@link CCTParamsInvalidError} If `tokenAddress` is not a valid Solana public key.
+ * @throws {@link CCIPSplTokenInvalidError} If the token metadata is not a valid SPL token.
+ * @throws {@link CCIPTokenMintNotFoundError} If the mint account does not exist.
+ * @throws {@link CCIPTokenMintInvalidError} If the mint is not owned by an SPL Token program.
+ * @throws {@link CCIPTokenDataParseError} If the mint data cannot be parsed.
+ */
+export class GetTokenInfo extends SolanaQuery<
+  GetTokenInfoParams,
+  GetTokenInfoResult,
+  ParsedGetTokenInfoParams
+> {
+  readonly name = 'getTokenInfo'
+
+  /** Converts and validates the mint address. */
+  protected prepare(params: GetTokenInfoParams): ParsedGetTokenInfoParams {
+    return {
+      ...params,
+      mint: parsePublicKey(this.name, 'tokenAddress', params.tokenAddress),
+    }
+  }
+
+  /** Delegates metadata lookup and reads the mint's SPL state. */
+  protected async read(
+    chain: SolanaChain,
+    { mint, tokenAddress }: ParsedGetTokenInfoParams,
+  ): Promise<GetTokenInfoResult> {
+    const account = await resolveTokenMint(chain.connection, mint)
+
+    let state
+    try {
+      state = unpackMint(mint, account, account.owner)
+    } catch (cause) {
+      throw new CCIPTokenDataParseError(tokenAddress, {
+        cause: cause instanceof Error ? cause : undefined,
+      })
+    }
+
+    const info = await chain.getTokenInfo(tokenAddress)
+
+    return {
+      ...info,
+      tokenProgram: account.owner.toBase58(),
+      supply: state.supply,
+      isInitialized: state.isInitialized,
+      mintAuthority: state.mintAuthority?.toBase58() ?? null,
+      freezeAuthority: state.freezeAuthority?.toBase58() ?? null,
+    }
+  }
+}

ccip-sdk/src/cct/solana/token/operations/index.ts

@@ -1,6 +1,7 @@
 export * from './approve-token.ts'
 export * from './create-token-account.ts'
 export * from './deploy-token.ts'
+export * from './get-token-info.ts'
 export * from './mint-tokens.ts'
 export * from './set-token-authority.ts'
 export * from './update-metadata-authority.ts'

ccip-sdk/src/gas.ts

@@ -196,7 +196,8 @@ export async function getDestTokenAmount({
   let sourceTokenAddress, sourcePoolAddress, destTokenAddress
   if ('destTokenAddress' in tokenAmount) {
     ;({ destTokenAddress, sourcePoolAddress, sourceTokenAddress } = tokenAmount)
-  } else if (!source) return tokenAmount // if we don't have a source, assume we were already given a dest `{token, amount}`
+  } else if (!source)
+    return tokenAmount // if we don't have a source, assume we were already given a dest `{token, amount}`
   else {
     ;({ destTokenAddress, sourceTokenAddress, sourcePoolAddress } =
       await sourceToDestTokenAddresses({