@lombard.finance/sdk 2.5.1 → 3.1.0

package/src/contract-functions/signStakeAndBake/signStakeAndBake.ts

@@ -0,0 +1,140 @@
+import { makeWalletClient } from '../../clients/wallet-client';
+import { CommonWriteParameters } from '../../common/parameters';
+import { isVedaVaultStakeAndBakeChain, Vault, VAULTS } from '../../vaults';
+import { getLBTCContractInfo } from '../../tokens/lbtc-contract';
+import { getPermitNonce } from '../getPermitNonce/getPermitNonce';
+import BigNumber from 'bignumber.js';
+import { DAY, now, toUnix } from '../../utils/time';
+
+export interface ISignStakeAndBakeParams extends CommonWriteParameters {
+  /**
+   * The approved value that will be automatically claimed and deposited
+   * to the chosen vault.
+   */
+  value: BigNumber.Value;
+  /**
+   * The expiration UNIX time of the signature.
+   * Defaults to 24 hours from the time of signing.
+   */
+  expiry?: number;
+  /**
+   * The chosen DeFi vault to which the funds will be deposited.
+   */
+  vaultKey?: Vault;
+}
+
+export interface ISignStakeAndBakeResult {
+  /**
+   * The signature.
+   */
+  signature: string;
+  /**
+   * The typed data used to generate the signature.
+   */
+  typedData: string;
+}
+
+/**
+ * Signs the "stake and bake" signature that allows Lombard to claim specified
+ * amount of BTC (LBTC) and deposit that amount directly to the specified DeFi
+ * vault.
+ *
+ * In order for the "stake and bake" process to work a user has to store the
+ * signature to the Lombard's system, see: `storeStakeAndBakeSignature`
+ *
+ * @param {ISignStakeAndBakeParams} parameters - The parameters.
+ * @param {BigNumber.Value} parameters.value - The amount of BTC that's going to be claimed and deposited to the DeFi vault.
+ * @param {number} parameters.expiry = The optional expiration UNIX time of the signature.
+ * @param {Vault} parameters.vaultKey - The optional DeFi vault identifier.
+ * @param {Address} parameters.account - The EVM account address.
+ * @param {ChainId} parameters.chainId - The chain id.
+ * @param {EIP1193Provider} parameters.provider - The EIP1193 provider.
+ * @param {string} parameters.rpcUrl - The optional rpc url.
+ *
+ * @returns {Promise<ISignStakeAndBakeResult>} - The signature and typed data.
+ */
+export async function signStakeAndBake({
+  account,
+  expiry = toUnix(now() + DAY),
+  value,
+  vaultKey = Vault.Veda,
+  chainId,
+  provider,
+  rpcUrl,
+  env,
+}: ISignStakeAndBakeParams): Promise<ISignStakeAndBakeResult> {
+  const vault = VAULTS[vaultKey];
+  if (!vault) {
+    throw new Error(`Unknown vault key: ${vaultKey}`);
+  }
+
+  if (!isVedaVaultStakeAndBakeChain(chainId)) {
+    throw new Error(
+      `Unsupported chain id: ${chainId}. Please switch to one of the supported chains: ${vault.stakeAndBakeChains.join(', ')}`,
+    );
+  }
+
+  const lbtcContract = getLBTCContractInfo(chainId, env);
+  const walletClient = makeWalletClient({ chainId, provider });
+  const spenderContract = vault.spenderContracts[chainId];
+
+  const nonce = await getPermitNonce({
+    owner: account,
+    chainId,
+    rpcUrl,
+  });
+
+  const typedData: Parameters<typeof walletClient.signTypedData>[0] = {
+    account,
+    domain: {
+      name: 'Lombard Staked Bitcoin',
+      version: '1',
+      chainId: BigInt(chainId),
+      verifyingContract: lbtcContract.address,
+    },
+    types: {
+      EIP712Domain: [
+        {
+          name: 'name',
+          type: 'string',
+        },
+        {
+          name: 'version',
+          type: 'string',
+        },
+        {
+          name: 'chainId',
+          type: 'uint256',
+        },
+        {
+          name: 'verifyingContract',
+          type: 'address',
+        },
+      ],
+      Permit: [
+        { name: 'owner', type: 'address' },
+        { name: 'spender', type: 'address' },
+        { name: 'value', type: 'uint256' },
+        { name: 'nonce', type: 'uint256' },
+        { name: 'deadline', type: 'uint256' },
+      ],
+    },
+    primaryType: 'Permit',
+    message: {
+      owner: account,
+      spender: spenderContract.address,
+      value: BigInt(BigNumber(value).toFixed()),
+      nonce: BigInt(nonce),
+      deadline: BigInt(expiry),
+    },
+  };
+
+  const signature = await walletClient.signTypedData(typedData);
+
+  return {
+    signature,
+    typedData: JSON.stringify(typedData, (_, v) =>
+      typeof v === 'bigint' ? v.toString() : v,
+    ),
+  };
+}

package/src/contract-functions/unstakeLBTC/unstakeLBTC.stories.tsx

@@ -0,0 +1,80 @@
+import type { Meta, StoryObj } from '@storybook/react';
+import { DEFAULT_ENV } from '@lombard.finance/sdk-common';
+import { Button } from '../../stories/components/Button';
+import { CodeBlock } from '../../stories/components/CodeBlock';
+import useQuery from '../../stories/hooks/useQuery';
+import { IUnstakeLBTCParams, unstakeLBTC } from './unstakeLBTC';
+import { ConnectButton } from '../../stories/components/ConnectButton';
+import {
+  canPerformAction,
+  useConnection,
+} from '../../stories/hooks/useConnection';
+import {
+  functionType,
+  wagmiDecorator,
+} from '../../stories/components/decorators';
+
+const meta = {
+  title: 'write/unstakeLBTC',
+  component: StoryView,
+  tags: ['autodocs'],
+  decorators: [wagmiDecorator, functionType('write')],
+} satisfies Meta<typeof StoryView>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const WithParams: Story = {
+  args: {
+    amount: 0.00001,
+    btcAddress: '',
+    env: DEFAULT_ENV,
+  },
+};
+
+type ClaimLBTCProps = Pick<IUnstakeLBTCParams, 'btcAddress' | 'env' | 'amount'>;
+
+export function StoryView(props: ClaimLBTCProps) {
+  const connection = useConnection();
+
+  const request = async () => {
+    if (!canPerformAction(connection)) {
+      alert('Not connected');
+      return;
+    }
+
+    return unstakeLBTC({
+      amount: props.amount,
+      btcAddress: props.btcAddress,
+
+      account: connection.account.address,
+      chainId: connection.account.chainId,
+      provider: connection.provider,
+    });
+  };
+
+  const { data, error, isLoading, refetch } = useQuery(request, [], false);
+
+  return (
+    <>
+      <p>
+        This function unstakes the specified amount of LBTC and transfers the
+        equivalent amount of BTC to the provided BTC address.
+      </p>
+
+      <div className="mb-4">
+        <ConnectButton />
+      </div>
+
+      <Button
+        onClick={refetch}
+        disabled={isLoading || !connection.account.address}
+        isLoading={isLoading}
+        actionName={unstakeLBTC.name}
+      />
+
+      <CodeBlock text={error || data} />
+    </>
+  );
+}

package/src/contract-functions/unstakeLBTC/unstakeLBTC.ts

@@ -0,0 +1,65 @@
+import { getOutputScript } from '@lombard.finance/sdk-common';
+import { CommonWriteParameters } from '../../common/parameters';
+import { toSatoshi } from '../../utils/satoshi';
+import { makeWalletClient } from '../../clients/wallet-client';
+import { makePublicClient } from '../../clients/public-client';
+import { getLBTCContractInfo } from '../../tokens/lbtc-contract';
+import { CHAIN_ID_TO_VIEM_CHAIN_MAP } from '../../common/chains';
+import { Hex } from 'viem';
+import BigNumber from 'bignumber.js';
+
+/**
+ * The unstake parameters.
+ */
+export interface IUnstakeLBTCParams extends CommonWriteParameters {
+  /**
+   * The BTC address to send the unstaked BTC to.
+   */
+  btcAddress: string;
+  /**
+   * The amount of LBTC to unstake.
+   */
+  amount: BigNumber.Value;
+}
+
+/**
+ * Unstakes (redeems) specified amount of LBTC and sends the equivalent amount
+ * of BTC to the provided BTC address.
+ * @param {IUnstakeLBTCParams} parameters - The unstake parameters.
+ * @param {string} parameters.btcAddress - The BTC address.
+ * @param {BigNumber.Value} parameters.amount - The amount of LBTC to unstake.
+ * @param {Address} parameters.account - The EVM address.
+ * @param {ChainId} parameters.chainId - The chain id.
+ * @param {EIP1193Provider} parameters.provider - The EIP1193 provider.
+ * @param {string} parameters.rpcUrl - The optional rpc url.
+ */
+export async function unstakeLBTC({
+  btcAddress,
+  amount,
+  account,
+  chainId,
+  provider,
+  rpcUrl,
+  env,
+}: IUnstakeLBTCParams): Promise<Hex> {
+  const outputScript = getOutputScript(btcAddress, env);
+  const amountSat = toSatoshi(amount).toNumber();
+
+  const lbtcContract = getLBTCContractInfo(chainId, env);
+
+  const publicClient = makePublicClient({ chainId, rpcUrl });
+  const walletClient = makeWalletClient({ provider, chainId });
+
+  const { request } = await publicClient.simulateContract({
+    address: lbtcContract.address,
+    account,
+    chain: CHAIN_ID_TO_VIEM_CHAIN_MAP[chainId],
+    abi: lbtcContract.abi,
+    functionName: 'redeem',
+    args: [outputScript, BigInt(amountSat)],
+  });
+
+  const txHash = await walletClient.writeContract(request);
+
+  return txHash;
+}

package/src/index.ts

@@ -1,23 +1,48 @@
-export * from "./sdk";
-export * from "./web3Sdk";
+// API functions:
+export * from './api-functions';
 
-export * from "./common/types/types";
-export * from "./common/utils/convertSatoshi";
-export * from "./common/utils/isValidChain";
-export type { Env as TEnv } from "@lombard.finance/sdk-common";
-export { Env as OEnv } from "@lombard.finance/sdk-common";
+// READ and WRITE functions:
+export * from './contract-functions';
+
+// Vault:
+export { Vault } from './vaults';
+export {
+  deposit,
+  type DepositParameters,
+} from './vaults/lib/deposit';
+
+export {
+  queueWithdraw,
+  type QueueWithdrawParameters,
+  cancelWithdraw,
+  type CancelWithdrawParameters,
+} from './vaults/lib/withdraw';
 
 export {
   getVaultDeposits,
   type GetVaultDepositsParameters,
-} from "./vaults/lib/get-vault-deposits";
+} from './vaults/lib/get-vault-deposits';
 
 export {
   getVaultWithdrawals,
   type GetVaultWithdrawalsParameters,
-} from "./vaults/lib/get-vault-withdrawals";
+} from './vaults/lib/get-vault-withdrawals';
 
 export {
   getVaultPoints,
   type GetVaultPointsParameters,
-} from "./vaults/lib/get-vault-points";
+} from './vaults/lib/get-vault-points';
+
+// Rewards:
+export * from './rewards';
+
+// Utils:
+export * from './common/api-config';
+export * from './common/blockchain-identifier';
+export * from './common/chains';
+export * from './utils/satoshi';
+export * from './tokens/lbtc-addresses';
+
+// Re-exports:
+export type { Address, EIP1193Provider } from 'viem';
+export { Env } from '@lombard.finance/sdk-common';

package/src/rewards/index.ts

@@ -0,0 +1,26 @@
+export { claimReward, type ClaimRewardParameters } from './lib/claim-reward';
+
+export {
+  getRewardBalances,
+  type GetRewardBalancesParameters,
+  RewardBlockchainType,
+} from './lib/get-reward-balances';
+
+export {
+  getRewardSigningData,
+  type GetRewardSigningDataParameters,
+} from './lib/get-reward-signing-data';
+
+export {
+  getRewardWithdrawalFee,
+  type GetRewardWithdrawalFeeParameters,
+} from './lib/get-reward-withdrawal-fee';
+
+export {
+  getRewardWithdrawals,
+  type GetRewardsWithdrawalsParameters,
+  type RewardWithdrawal,
+  RewardWithdrawalStatus,
+} from './lib/get-reward-withdrawals';
+
+export { isRewardTokenSupported, RewardToken } from './lib/reward-tokens';

package/src/rewards/lib/claim-reward.stories.tsx

@@ -0,0 +1,82 @@
+import type { Meta, StoryObj } from '@storybook/react';
+import {
+  functionType,
+  wagmiDecorator,
+} from '../../stories/components/decorators';
+import { Button } from '../../stories/components/Button';
+import { CodeBlock } from '../../stories/components/CodeBlock';
+import { ErrorBlock } from '../../stories/components/error-block';
+import useQuery from '../../stories/hooks/useQuery';
+import { RewardToken } from './reward-tokens';
+import { Env } from '@lombard.finance/sdk-common';
+import { claimReward, ClaimRewardParameters } from './claim-reward';
+import { ConnectButton } from '../../stories/components/ConnectButton';
+import {
+  canPerformAction,
+  useConnection,
+} from '../../stories/hooks/useConnection';
+import { ChainId } from '../../common/chains';
+import { EXAMPLE_BABYLON_ADDRESS } from '../../stories/constants';
+
+const meta = {
+  title: 'rewards/claimReward',
+  component: StoryView,
+  tags: ['autodocs'],
+  decorators: [wagmiDecorator, functionType('write')],
+} satisfies Meta<typeof StoryView>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const WithParams: Story = {
+  args: {
+    to: EXAMPLE_BABYLON_ADDRESS,
+    amount: '0.001',
+    rewardToken: RewardToken.BABY,
+    chainId: ChainId.ethereum,
+    env: Env.stage,
+  },
+};
+
+type Props = Omit<ClaimRewardParameters, 'account' | 'provider'>;
+
+export function StoryView(props: Props) {
+  const connection = useConnection();
+
+  const request = async () => {
+    if (!canPerformAction(connection)) {
+      alert('Please connect');
+      return;
+    }
+
+    return claimReward({
+      account: connection.account.address,
+      provider: connection.provider,
+      ...props,
+    });
+  };
+
+  const { data, error, isLoading, refetch } = useQuery(request, [], false);
+
+  return (
+    <>
+      <p>This function claims a reward earned by a user.</p>
+
+      <div className="mb-4">
+        <ConnectButton />
+      </div>
+
+      <Button
+        onClick={refetch}
+        disabled={isLoading || !canPerformAction(connection)}
+        isLoading={isLoading}
+        actionName={claimReward.name}
+      />
+
+      <ErrorBlock>{error}</ErrorBlock>
+
+      <CodeBlock text={data} />
+    </>
+  );
+}

package/src/rewards/lib/claim-reward.ts

@@ -0,0 +1,84 @@
+import BigNumber from 'bignumber.js';
+import { CommonWriteParameters } from '../../common/parameters';
+import axios from 'axios';
+import { getApiConfig } from '../../common/api-config';
+import { makeWalletClient } from '../../clients/wallet-client';
+import { getRewardWithdrawalFee } from './get-reward-withdrawal-fee';
+import { getRewardSigningData } from './get-reward-signing-data';
+import {
+  mapDataToRewardWithdrawal,
+  WithdrawalData,
+} from './get-reward-withdrawals';
+import { isRewardTokenSupported, RewardToken } from './reward-tokens';
+
+type Response = {
+  withdrawal: WithdrawalData;
+};
+
+export type ClaimRewardParameters = {
+  /** The reward token. */
+  rewardToken: RewardToken;
+  /** The amount of reward to be withdrawn (claimed). */
+  amount: BigNumber.Value;
+  /** The destination address. */
+  to: string;
+} & CommonWriteParameters;
+
+const REQUEST_WITHDRAW_URL =
+  '/api/v1/distribution/account/{from}/withdrawals/{to}';
+
+/** Claims a reward. */
+export async function claimReward({
+  account: from,
+  rewardToken,
+  amount,
+  to,
+  chainId,
+  provider,
+  env,
+}: ClaimRewardParameters) {
+  if (!isRewardTokenSupported(rewardToken)) {
+    throw new Error(`Unknown reward token: ${RewardToken}`);
+  }
+
+  const walletClient = makeWalletClient({
+    chainId,
+    provider,
+  });
+
+  const withdrawalFee = await getRewardWithdrawalFee({
+    address: from,
+    rewardToken,
+    env,
+  });
+  const signingData = await getRewardSigningData({
+    from,
+    to,
+    amount,
+    fee: withdrawalFee,
+    rewardToken,
+    env,
+  });
+
+  const signature = await walletClient.signMessage({
+    account: from,
+    message: signingData,
+  });
+
+  const payload = {
+    amount: BigNumber(amount).toFixed(),
+    fee: BigNumber(withdrawalFee).toFixed(),
+    signature,
+  };
+
+  const { baseApiUrl } = getApiConfig(env);
+  const { data: withdrawData } = await axios.post<Response>(
+    REQUEST_WITHDRAW_URL.replace('{from}', from).replace('{to}', to),
+    payload,
+    {
+      baseURL: baseApiUrl,
+    },
+  );
+
+  return mapDataToRewardWithdrawal(withdrawData.withdrawal);
+}

package/src/rewards/lib/get-reward-balances.stories.tsx

@@ -0,0 +1,64 @@
+import type { Meta, StoryObj } from '@storybook/react';
+import {
+  functionType,
+  wagmiDecorator,
+} from '../../stories/components/decorators';
+import { Button } from '../../stories/components/Button';
+import { CodeBlock } from '../../stories/components/CodeBlock';
+import { ErrorBlock } from '../../stories/components/error-block';
+import { EXAMPLE_EVM_ADDRESS } from '../../stories/constants';
+import useQuery from '../../stories/hooks/useQuery';
+import {
+  getRewardBalances,
+  GetRewardBalancesParameters,
+} from './get-reward-balances';
+import { RewardToken } from './reward-tokens';
+import { Env } from '@lombard.finance/sdk-common';
+
+const meta = {
+  title: 'rewards/getRewardBalances',
+  component: StoryView,
+  tags: ['autodocs'],
+  decorators: [wagmiDecorator, functionType('api-get')],
+} satisfies Meta<typeof StoryView>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const WithParams: Story = {
+  args: {
+    address: EXAMPLE_EVM_ADDRESS,
+    rewardToken: RewardToken.BABY,
+    env: Env.stage,
+  },
+};
+
+type Props = GetRewardBalancesParameters;
+
+export function StoryView(props: Props) {
+  const request = async () => {
+    return getRewardBalances({
+      ...props,
+    });
+  };
+
+  const { data, error, isLoading, refetch } = useQuery(request, [], false);
+
+  return (
+    <>
+      <p>This function gets the rewards earned by a user.</p>
+
+      <Button
+        onClick={refetch}
+        disabled={isLoading}
+        isLoading={isLoading}
+        actionName={getRewardBalances.name}
+      />
+
+      <ErrorBlock>{error}</ErrorBlock>
+
+      <CodeBlock text={data} />
+    </>
+  );
+}

package/src/rewards/lib/get-reward-balances.ts

@@ -0,0 +1,81 @@
+import { Address } from 'viem';
+import { IEnvParam } from '../../common/parameters';
+import { getApiConfig } from '../../common/api-config';
+import axios from 'axios';
+import { isRewardTokenSupported, RewardToken } from './reward-tokens';
+import BigNumber from 'bignumber.js';
+
+export enum RewardBlockchainType {
+  Undefined = 'BLOCKCHAIN_TYPE_UNDEFINED',
+  Evm = 'BLOCKCHAIN_TYPE_EVM',
+  Sui = 'BLOCKCHAIN_TYPE_SUI',
+  Solana = 'BLOCKCHAIN_TYPE_SOLANA',
+  Cosmos = 'BLOCKCHAIN_TYPE_COSMOS',
+}
+
+type Response = {
+  account: {
+    id: string;
+    address: string;
+    available_balance: string;
+    locked_balance: string;
+    pending_balance: string;
+    blockchain_type: RewardBlockchainType;
+    created_at: string;
+  };
+};
+
+const REWARDS_URL = '/api/v1/distribution/account/{address}';
+
+export type GetRewardBalancesParameters = {
+  /** The reward earner (claimer). */
+  address: Address;
+  /** The reward token. */
+  rewardToken?: RewardToken;
+} & IEnvParam;
+
+export type RewardBalances = {
+  /** The address of the reward earner (claimer). */
+  address: Address;
+  /** The available balance of the reward token (ready to be withdrawn). */
+  availableBalance: BigNumber;
+  /** The locked balance (in processing). */
+  lockedBalance: BigNumber;
+  /** The pending balance to be credited. */
+  pendingBalance: BigNumber;
+  /** The reward token. */
+  rewardToken: RewardToken;
+  /** The timestamp. */
+  timestamp: Date;
+};
+
+/**
+ * Gets the reward balances earned by the specified address.
+ */
+export async function getRewardBalances({
+  address,
+  rewardToken = RewardToken.BABY,
+  env,
+}: GetRewardBalancesParameters) {
+  if (!isRewardTokenSupported(rewardToken)) {
+    throw new Error(`Unknown reward token: ${RewardToken}`);
+  }
+
+  const { baseApiUrl } = getApiConfig(env);
+
+  const { data } = await axios.get<Response>(
+    REWARDS_URL.replace('{address}', address),
+    { baseURL: baseApiUrl },
+  );
+
+  const balances: RewardBalances = {
+    address,
+    availableBalance: BigNumber(data.account.available_balance),
+    lockedBalance: BigNumber(data.account.locked_balance),
+    pendingBalance: BigNumber(data.account.pending_balance),
+    rewardToken,
+    timestamp: new Date(data.account.created_at),
+  };
+
+  return balances;
+}