@lombard.finance/sdk-solana 1.2.2 → 2.0.0

package/src/web3Sdk/claimLBTC/claimLBTC.ts

@@ -1,225 +0,0 @@
-import { AnchorProvider, Program, setProvider } from '@coral-xyz/anchor';
-import { getAssociatedTokenAddress, TOKEN_PROGRAM_ID } from '@solana/spl-token';
-import { PublicKey, SystemProgram } from '@solana/web3.js';
-
-import { MintPayload } from '../../common/mintPayload';
-import { getConfig, networkToEnv } from '../../const/getConfig';
-import { getConnection } from '../../const/rpcUrls';
-import { getLbtcIdl } from '../../idl/getLbtcIdl';
-import { ISolanaWalletProvider, SolanaNetwork } from '../../types';
-import { sendAndConfirmTransaction } from '../../utils';
-import { createDebugLogger } from '../../utils/createDebugLogger';
-import { verifyMatchingRecipient } from '../../utils/recipients';
-import { createOrGetAssociatedTokenAccount } from '../../utils/tokenAccount';
-import { checkPayloadStatus } from './utils';
-import { generateDepositId } from './utils/generateDepositId';
-import { postMintSignatures } from './utils/postMintSignatures';
-
-export const ALREADY_MINTED_TX_HASH = 'ALREADY_MINTED';
-
-/**
- * Parameters for claiming LBTC tokens on Solana
- */
-export interface ClaimLBTCParams {
-  /**
-   * Address to receive the LBTC tokens
-   */
-  recipientAddress: string;
-  /**
-   * Amount of LBTC to claim in base units
-   */
-  amount: string;
-  /**
-   * Network to use
-   */
-  network: SolanaNetwork;
-  /**
-   * Proof signature from the backend
-   */
-  proofSignature: string;
-  /**
-   * Raw payload data
-   */
-  rawPayload: string;
-  /**
-   * Optional RPC endpoint to use
-   */
-  rpcUrl?: string;
-  /**
-   * Enable verbose debug logging
-   * @default false
-   */
-  debug?: boolean;
-}
-
-/**
- * Claim LBTC tokens on Solana using a three-step process:
- * 1. Create mint payload
- * 2. Post mint signatures
- * 3. Mint from payload
- *
- * @param provider Solana wallet provider
- * @param params Claim parameters
- * @returns Transaction signature
- */
-export async function claimLBTC(
-  provider: ISolanaWalletProvider,
-  params: ClaimLBTCParams,
-): Promise<string> {
-  const {
-    recipientAddress,
-    network,
-    proofSignature,
-    rawPayload,
-    rpcUrl,
-    debug = false,
-  } = params;
-  const { debugLog, printLogs } = createDebugLogger({ debug });
-
-  try {
-    if (!provider.publicKey) {
-      throw new Error('Wallet not found');
-    }
-
-    const config = getConfig(networkToEnv[network]);
-    const connection = getConnection(network, rpcUrl);
-
-    const wallet = {
-      publicKey: new PublicKey(provider.publicKey),
-      signTransaction: provider.signTransaction,
-      signAllTransactions: provider.signAllTransactions,
-    };
-    const anchorProvider = new AnchorProvider(connection, wallet, {});
-    setProvider(anchorProvider);
-    const program = new Program(getLbtcIdl(network), anchorProvider);
-
-    const mint = new PublicKey(config.lbtcTokenMint);
-    const programId = new PublicKey(config.lbtcProgramId);
-    const lzMultisig = new PublicKey(config.lzMultisig);
-    const mintPayload = new MintPayload(rawPayload);
-    const [mintPayloadPDA] = PublicKey.findProgramAddressSync(
-      [mintPayload.hashAsBytes()],
-      programId,
-    );
-    const [configPDA] = PublicKey.findProgramAddressSync(
-      [Buffer.from('lbtc_config')],
-      programId,
-    );
-    const [tokenAuth] = PublicKey.findProgramAddressSync(
-      [Buffer.from('token_authority')],
-      programId,
-    );
-    const payloadHashArray = Array.from(mintPayload.hashAsBytes());
-
-    await verifyMatchingRecipient(mint, mintPayload, recipientAddress);
-
-    const payloadStatus = await checkPayloadStatus(
-      program,
-      mintPayloadPDA,
-      debugLog,
-    );
-
-    if (payloadStatus.isMinted) {
-      return ALREADY_MINTED_TX_HASH;
-    }
-
-    await createOrGetAssociatedTokenAccount({
-      provider,
-      connection,
-      ownerAddress: recipientAddress,
-      mintAddress: config.lbtcTokenMint,
-    });
-
-    // Step 1: Create Mint Payload (if it doesn't exist)
-    if (!payloadStatus.exists) {
-      debugLog('Adding Create Mint Payload instruction...');
-      const createPayloadIx = await program.methods
-        .createMintPayload(payloadHashArray, Array.from(mintPayload.bytes()))
-        .accounts({
-          payer: provider.publicKey,
-          config: configPDA,
-          // @ts-ignore -- type error from idl even though payload is required
-          payload: mintPayloadPDA,
-          systemProgram: SystemProgram.programId,
-        })
-        .transaction();
-      await sendAndConfirmTransaction({
-        instruction: createPayloadIx,
-        connection,
-        provider,
-        debugLabel: 'Create Mint Payload',
-      });
-    } else {
-      debugLog('Mint payload already exists, skipping create instruction.');
-    }
-
-    // Step 2: Post Mint Signatures (if not already signed)
-    if (!payloadStatus.isSigned) {
-      await postMintSignatures({
-        connection,
-        provider,
-        program,
-        configPDA,
-        mintPayloadPDA,
-        payloadHashArray,
-        proofSignature,
-      });
-    } else {
-      debugLog('Payload already signed, skipping post signatures instruction.');
-    }
-
-    // Extract necessary data from the payload
-    const recipient = new PublicKey(recipientAddress);
-    const recipientATA = await getAssociatedTokenAddress(mint, recipient);
-    const amount = mintPayload.amount.startsWith('0x')
-      ? BigInt(mintPayload.amount)
-      : BigInt(`0x${mintPayload.amount}`);
-    const depositId = generateDepositId(
-      recipientATA,
-      amount,
-      mintPayload.txId,
-      Number(mintPayload.vout),
-    );
-    const DEPOSIT_SEED = Buffer.from('deposit');
-    const [depositPDA] = config.bascule
-      ? PublicKey.findProgramAddressSync(
-          [DEPOSIT_SEED, depositId],
-          new PublicKey(config.bascule),
-        )
-      : [];
-
-    // Step 3: Mint From Payload (Always add if not already minted)
-    const mintTx = await program.methods
-      .mintFromPayload(payloadHashArray)
-      .accounts({
-        config: configPDA,
-        tokenProgram: TOKEN_PROGRAM_ID,
-        recipient: recipientATA,
-        mint,
-        mintAuthority: lzMultisig,
-        tokenAuthority: tokenAuth,
-        payload: mintPayloadPDA,
-        // @ts-ignore -- type error from idl even though payload is required
-        bascule: config.bascule,
-        basculeData: config.basculeData,
-        deposit: depositPDA,
-        systemProgram: SystemProgram.programId,
-        signer: provider.publicKey,
-      })
-      .transaction();
-
-    const { signature } = await sendAndConfirmTransaction({
-      instruction: mintTx,
-      connection,
-      provider,
-      debugLabel: 'Mint From Payload',
-    });
-
-    return signature;
-  } catch (error: unknown) {
-    if (error instanceof Error) {
-      error.message = `${error.message}\n\nDebug logs:\n${printLogs()}`;
-    }
-    throw error;
-  }
-}

package/src/web3Sdk/claimLBTC/index.ts

@@ -1 +0,0 @@
-export * from './claimLBTC';

package/src/web3Sdk/claimLBTC/utils/generateDepositId.ts

@@ -1,75 +0,0 @@
-import { Buffer } from 'node:buffer'; // Use buffer package for cross-platform compatibility
-
-import { PublicKey } from '@solana/web3.js';
-import { keccak256 } from 'js-sha3';
-
-/**
- * Represents the unique identifier for a deposit, derived from transaction details.
- * It's a 32-byte array, typically the result of a Keccak-256 hash.
- */
-export type DepositId = Uint8Array;
-
-/**
- * Generates a unique deposit ID (address) based on transaction details, mirroring
- * the logic used in the corresponding Solana smart contract.
- *
- * The ID is computed using the following formula:
- * keccak256(
- *   [0u8; 32]                   // 32-byte zero prefix
- *   || [0x03, 0x53, 0x4f, 0x4c] // 4-byte chain ID ("\x03SOL")
- *   || recipient (32 bytes)
- *   || amount (u64, 8 bytes, big-endian)
- *   || tx_id (32 bytes)
- *   || tx_vout (u32, 4 bytes, big-endian)
- * )
- *
- * Adapted from: https://github.com/lombard-finance/sol-contracts/blob/632491cb92fd2f206b0e563b1e72e4b2ae2eadf5/programs/bascule/src/instructions/validator.rs#L118-L138
- *
- * @param recipient - The recipient's Solana public key.
- * @param amount - The amount of the transaction (as a bigint, representing u64).
- * @param txId - The transaction ID (as a 32-byte Uint8Array or Buffer).
- * @param txVout - The transaction output index (as a number, representing u32).
- * @returns A 32-byte Uint8Array representing the calculated deposit ID.
- * @throws Error if txId is not 32 bytes long.
- */
-export function generateDepositId(
-  recipient: PublicKey,
-  amount: bigint,
-  txId: string,
-  txVout: number,
-): DepositId {
-  const txIdBuffer = Buffer.from(txId, 'hex');
-  const reversedTxIdBuffer = txIdBuffer.reverse();
-
-  if (reversedTxIdBuffer.length !== 32) {
-    throw new Error('txId must be a 32-byte array.');
-  }
-
-  const prefix = Buffer.alloc(32, 0);
-  const chainId = Buffer.from([0x03, 0x53, 0x4f, 0x4c]);
-  const recipientBuffer = recipient.toBuffer();
-  const amountBuffer = Buffer.alloc(8);
-  amountBuffer.writeBigUInt64BE(amount);
-
-  const txVoutBuffer = Buffer.alloc(4);
-  txVoutBuffer.writeUInt32BE(txVout);
-
-  const dataToHash = Buffer.concat([
-    new Uint8Array(prefix),
-    new Uint8Array(chainId),
-    new Uint8Array(recipientBuffer),
-    new Uint8Array(amountBuffer),
-    new Uint8Array(reversedTxIdBuffer),
-    new Uint8Array(txVoutBuffer),
-  ]);
-
-  const dataToHashUint8Array = new Uint8Array(
-    dataToHash.buffer,
-    dataToHash.byteOffset,
-    dataToHash.byteLength,
-  );
-  const hashString = keccak256(dataToHashUint8Array);
-  const hashBuffer = Buffer.from(hashString, 'hex');
-
-  return new Uint8Array(hashBuffer);
-}

package/src/web3Sdk/claimLBTC/utils/index.ts

@@ -1,2 +0,0 @@
-export * from './payloadUtils';
-export * from './signatureUtils';

package/src/web3Sdk/claimLBTC/utils/parseTransactionLogs.ts

@@ -1,44 +0,0 @@
-export const parseTransactionLogs = (
-  err: unknown,
-): { errorMessage: string; errorLogs: string[] } => {
-  console.error('Error claiming LBTC:', err);
-  let errorMessage =
-    typeof err === 'object' && err !== null && 'message' in err
-      ? (err.message as string)
-      : String(err);
-  let errorLogs: string[] = [];
-
-  if (typeof errorMessage === 'string') {
-    const logParts = errorMessage.split('Logs:');
-    if (logParts.length > 1) {
-      errorMessage = logParts[0].trim();
-      try {
-        let logsText = logParts[1].trim();
-
-        if (logsText.startsWith('[') && logsText.endsWith(']')) {
-          try {
-            errorLogs = JSON.parse(logsText);
-
-            return { errorMessage, errorLogs };
-          } catch {
-            logsText = logsText.replace(/^\[|\]$/g, '');
-            errorLogs = logsText
-              .split(/",?\s*"/)
-              .map(line => line.replace(/^"|"$/g, '')); // Remove quotes
-
-            return { errorMessage, errorLogs };
-          }
-        } else {
-          errorLogs = logsText.split('\n').filter(line => line.trim() !== '');
-          return { errorMessage, errorLogs };
-        }
-      } catch (parseError) {
-        console.error('Failed to parse logs:', parseError);
-        errorMessage = err instanceof Error ? err.message : String(err);
-        return { errorMessage, errorLogs: [] };
-      }
-    }
-  }
-
-  return { errorMessage, errorLogs };
-};

package/src/web3Sdk/claimLBTC/utils/payloadUtils.ts

@@ -1,58 +0,0 @@
-import { Program } from '@coral-xyz/anchor';
-import { PublicKey } from '@solana/web3.js';
-
-import type { Lbtc } from '../../../idl/lbtc';
-
-/**
- * Status of a mint payload on-chain
- */
-export interface PayloadStatus {
-  /**
-   * Whether the payload exists on-chain
-   */
-  exists: boolean;
-  /**
-   * Whether the payload has been signed (signatures posted)
-   */
-  isSigned: boolean;
-  /**
-   * Whether the LBTC tokens have been minted
-   */
-  isMinted: boolean;
-}
-
-/**
- * Checks the status of a mint payload on the Solana blockchain
- *
- * @param program Anchor program instance
- * @param mintPayloadPDA The PDA address where the mint payload is stored
- * @param debugLog Debug logging function
- * @returns The status of the payload
- */
-export async function checkPayloadStatus(
-  program: Program<Lbtc>,
-  mintPayloadPDA: PublicKey,
-  debugLog: (...args: unknown[]) => void,
-): Promise<PayloadStatus> {
-  try {
-    const payloadAccount =
-      await program.account.mintPayload.fetch(mintPayloadPDA);
-
-    if (!payloadAccount) {
-      return { exists: false, isSigned: false, isMinted: false };
-    }
-
-    const isSigned = Array.isArray(payloadAccount.signed)
-      ? payloadAccount.signed.every((signed: boolean) => signed === true)
-      : false;
-
-    return {
-      exists: true,
-      isSigned,
-      isMinted: !!payloadAccount.minted,
-    };
-  } catch (error) {
-    debugLog('Error checking payload status:', error);
-    return { exists: false, isSigned: false, isMinted: false };
-  }
-}

package/src/web3Sdk/claimLBTC/utils/postMintSignatures.ts

@@ -1,50 +0,0 @@
-import { Program } from '@coral-xyz/anchor';
-import { Connection, PublicKey } from '@solana/web3.js';
-
-import { Lbtc } from '../../../idl/lbtc';
-import { ISolanaWalletProvider } from '../../../types';
-import { sendAndConfirmTransaction } from '../../../utils';
-import { parseSignaturesFromProof } from './signatureUtils';
-
-export const postMintSignatures = async ({
-  connection,
-  provider,
-  program,
-  configPDA,
-  mintPayloadPDA,
-  payloadHashArray,
-  proofSignature,
-}: {
-  connection: Connection;
-  provider: ISolanaWalletProvider;
-  program: Program<Lbtc>;
-  configPDA: PublicKey;
-  mintPayloadPDA: PublicKey;
-  payloadHashArray: number[];
-  proofSignature: string;
-}) => {
-  const { signatures: parsedSignaturesUint8, indices } =
-    parseSignaturesFromProof(proofSignature);
-
-  if (parsedSignaturesUint8.length === 0 || indices.length === 0) {
-    throw new Error('No valid signatures found in the proof');
-  }
-
-  // Convert Uint8Array[] to number[][]
-  const signatures = parsedSignaturesUint8.map(sig => Array.from(sig));
-
-  const postSignaturesIx = await program.methods
-    .postMintSignatures(payloadHashArray, signatures, indices)
-    .accounts({
-      config: configPDA,
-      // @ts-ignore -- type error from idl even though payload is required
-      payload: mintPayloadPDA,
-    })
-    .transaction();
-  return await sendAndConfirmTransaction({
-    instruction: postSignaturesIx,
-    connection,
-    provider,
-    debugLabel: 'Post Mint Signatures',
-  });
-};

package/src/web3Sdk/unstakeLBTC/index.ts

@@ -1 +0,0 @@
-export * from './unstakeLBTC';

package/src/web3Sdk/unstakeLBTC/unstakeLBTC.stories.tsx

@@ -1,141 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-
-import {
-  Button,
-  ConnectButton,
-  ErrorDisplay,
-  ResultDisplay,
-} from '../../stories/components';
-import { functionType } from '../../stories/decorators/function-type';
-import { useConnect } from '../../stories/hooks/useConnect';
-import useQuery from '../../stories/hooks/useQuery';
-import { SolanaNetwork } from '../../types';
-import { unstakeLBTC } from './unstakeLBTC';
-
-interface UnstakeLbtcStoryArgs {
-  network: SolanaNetwork;
-  amountSats: string;
-  btcAddress: string;
-}
-
-const DEFAULT_AMOUNT_SATS = '22000';
-
-export const StoryView = ({
-  network,
-  amountSats,
-  btcAddress,
-}: UnstakeLbtcStoryArgs) => {
-  const {
-    data: connectionData,
-    error: connectError,
-    isLoading: isConnecting,
-    connect,
-    disconnect,
-  } = useConnect();
-  const isConnected = !!connectionData;
-  const address = connectionData?.address;
-  const provider = connectionData?.provider;
-
-  const request = async () => {
-    if (!provider || !address) throw new Error('Wallet not connected.');
-    if (!btcAddress)
-      throw new Error('Destination Bitcoin address is required (set in args).');
-    if (!amountSats || !/^[1-9]\d*$/.test(amountSats))
-      throw new Error(
-        'Amount must be a positive integer in satoshis (set in args).',
-      );
-
-    const result = await unstakeLBTC(provider, {
-      amount: amountSats,
-      btcAddress,
-      network: network,
-    });
-    return result;
-  };
-
-  const {
-    data: txHash,
-    error,
-    isLoading,
-    refetch: handleUnstake,
-  } = useQuery(
-    request,
-    [provider, address, amountSats, btcAddress, network],
-    false,
-  );
-
-  return (
-    <>
-      <ConnectButton
-        connect={connect}
-        disconnect={disconnect}
-        isConnected={isConnected}
-        isLoading={isConnecting}
-        error={connectError}
-        walletName={connectionData?.walletName}
-        address={connectionData?.address}
-        network={network}
-      />
-
-      {isConnected && (
-        <>
-          <div className="d-grid gap-2 my-4">
-            <Button
-              primary
-              size="large"
-              onClick={handleUnstake}
-              isLoading={isLoading}
-              actionName={unstakeLBTC.name}
-            />
-          </div>
-
-          {txHash && (
-            <ResultDisplay
-              result={txHash}
-              title="Unstake Transaction Hash"
-              successMessage="Success! Unstake transaction submitted."
-            />
-          )}
-          {(error || connectError) && (
-            <ErrorDisplay error={error || connectError} title="Unstake Error" />
-          )}
-        </>
-      )}
-    </>
-  );
-};
-
-const meta: Meta<typeof StoryView> = {
-  title: 'write/unstakeLBTC',
-  component: StoryView,
-  tags: ['autodocs'],
-  decorators: [functionType('write')],
-  parameters: {
-    docs: {
-      description: {
-        component:
-          'Demonstrates unstaking LBTC from Solana back to a Bitcoin address using the `unstakeLBTC` SDK function. Requires the amount in satoshis and the destination Bitcoin address.',
-      },
-    },
-  },
-  args: {
-    network: SolanaNetwork.devnet,
-    amountSats: DEFAULT_AMOUNT_SATS,
-    btcAddress: '',
-  },
-  argTypes: {
-    network: {
-      control: { type: 'select' },
-      options: Object.values(SolanaNetwork),
-    },
-    amountSats: {
-      control: { type: 'text' },
-    },
-    btcAddress: {
-      control: { type: 'text' },
-    },
-  },
-};
-
-export default meta;
-type Story = StoryObj<typeof meta>;