@lombard.finance/sdk 2.5.2 → 3.2.0

package/src/tokens/lbtc-addresses.ts

@@ -0,0 +1,55 @@
+import { Address } from 'viem';
+import { ChainId } from '../common/chains';
+import { Env, DEFAULT_ENV } from '@lombard.finance/sdk-common';
+
+type LbtcContractAddresses = Partial<Record<ChainId, Address>>;
+
+const STAGE_LBTC_CONTRACTS = {
+  [ChainId.baseSepoliaTestnet]: '0x731eFa688F3679688cf60A3993b8658138953ED6',
+  [ChainId.berachainBartioTestnet]:
+    '0xc47e4b3124597FDF8DD07843D4a7052F2eE80C30',
+  [ChainId.binanceSmartChainTestnet]:
+    '0x731eFa688F3679688cf60A3993b8658138953ED6',
+  [ChainId.holesky]: '0xED7bfd5C1790576105Af4649817f6d35A75CD818',
+  [ChainId.sepolia]: '0xc47e4b3124597fdf8dd07843d4a7052f2ee80c30',
+  [ChainId.sonicBlazeTestnet]: '0x731eFa688F3679688cf60A3993b8658138953ED6',
+} as const;
+
+const TESTNET_LBTC_CONTRACTS = {
+  [ChainId.berachainBartioTestnet]:
+    '0xc47e4b3124597FDF8DD07843D4a7052F2eE80C30',
+  [ChainId.binanceSmartChainTestnet]:
+    '0x107Fc7d90484534704dD2A9e24c7BD45DB4dD1B5',
+  [ChainId.holesky]: '0x38A13AB20D15ffbE5A7312d2336EF1552580a4E2',
+  [ChainId.sepolia]: '0xc47e4b3124597fdf8dd07843d4a7052f2ee80c30',
+  [ChainId.sonicBlazeTestnet]: '0x107Fc7d90484534704dD2A9e24c7BD45DB4dD1B5',
+} as const;
+
+const LBTC_CONTRACTS = {
+  [ChainId.ethereum]: '0x8236a87084f8b84306f72007f36f2618a5634494',
+  [ChainId.base]: '0xecAc9C5F704e954931349Da37F60E39f515c11c1',
+  [ChainId.berachain]: '0xecAc9C5F704e954931349Da37F60E39f515c11c1',
+  [ChainId.binanceSmartChain]: '0xecAc9C5F704e954931349Da37F60E39f515c11c1',
+  [ChainId.corn]: '0xecAc9C5F704e954931349Da37F60E39f515c11c1',
+  [ChainId.morph]: '0xecAc9C5F704e954931349Da37F60E39f515c11c1',
+  [ChainId.sonic]: '0xecAc9C5F704e954931349Da37F60E39f515c11c1',
+  [ChainId.swell]: '0xecAc9C5F704e954931349Da37F60E39f515c11c1',
+} as const;
+
+/**
+ * Gets the collection of LBTC contract addresses based on the provided
+ * environment.
+ */
+export function getLbtcContractAddresses(
+  env: Env = DEFAULT_ENV,
+): LbtcContractAddresses {
+  switch (env) {
+    case Env.testnet:
+      return TESTNET_LBTC_CONTRACTS;
+    case Env.dev:
+    case Env.stage:
+      return STAGE_LBTC_CONTRACTS;
+    case Env.prod:
+      return LBTC_CONTRACTS;
+  }
+}

package/src/tokens/token-addresses.ts

@@ -0,0 +1,32 @@
+import { Address } from 'viem';
+import { ChainId } from '../common/chains';
+
+export enum Token {
+  LBTC = 'LBTC',
+  BTCB = 'BTCB',
+  cbBTC = 'cbBTC',
+  eBTC = 'eBTC',
+  wBTC = 'wBTC',
+  wBTCN = 'wBTCN',
+}
+
+export const TOKEN_ADDRESSES: Partial<
+  Record<Token, Partial<Record<ChainId, Address>>>
+> = {
+  [Token.BTCB]: {
+    [ChainId.binanceSmartChain]: '0x7130d2a12b9bcbfae4f2634d864a1ee1ce3ead9c',
+  },
+  [Token.cbBTC]: {
+    [ChainId.ethereum]: '0xcbb7c0000ab88b473b1f5afd9ef808440eed33bf',
+    [ChainId.base]: '0xcbb7c0000ab88b473b1f5afd9ef808440eed33bf',
+  },
+  [Token.eBTC]: {
+    [ChainId.ethereum]: '0x657e8c867d8b37dcc18fa4caead9c45eb088c642',
+  },
+  [Token.wBTC]: {
+    [ChainId.ethereum]: '0x2260fac5e5542a773aa44fbcfedf7c193bc2c599',
+  },
+  [Token.wBTCN]: {
+    [ChainId.corn]: '0xda5dDd7270381A7C2717aD10D1c0ecB19e3CDFb2',
+  },
+};

package/src/tokens/tokens.ts

@@ -0,0 +1,120 @@
+import { Env } from '@lombard.finance/sdk-common';
+import { ChainId } from '../common/chains';
+import { makePublicClient } from '../clients/public-client';
+import BigNumber from 'bignumber.js';
+import { Abi, Address, erc20Abi, PublicClient } from 'viem';
+import { TOKEN_ADDRESSES, Token } from './token-addresses';
+import { getLbtcContractAddresses } from './lbtc-addresses';
+import { LBTC_ABI } from './abi/LBTC_ABI';
+
+export type TokenInfo = {
+  address: Address;
+  abi: Abi;
+  symbol: string;
+  decimals: number;
+};
+
+export function getTokenContractInfo(
+  token: Token,
+  chainId: ChainId,
+  env?: Env,
+) {
+  if (token === Token.LBTC) {
+    const addresses = getLbtcContractAddresses(env);
+    const contractAddress = addresses[chainId];
+    if (!contractAddress) {
+      throw new Error(
+        `Could not determine the LBTC contract address for given chain id: ${chainId} (env: ${env})`,
+      );
+    }
+    return { abi: LBTC_ABI, address: contractAddress, chainId };
+  }
+
+  const address = TOKEN_ADDRESSES[token]?.[chainId];
+  if (!address) {
+    throw new Error(
+      `Could not determine the ${token} contract address for given chain id: ${chainId}`,
+    );
+  }
+
+  return {
+    abi: erc20Abi,
+    address,
+    chainId,
+  };
+}
+
+export const retrieveTokenProperties = async (
+  publicClient: PublicClient,
+  tokenContractInfo: { abi: Abi; address: Address; chainId: ChainId },
+) => {
+  const [symbolResult, decimalsResult] = await publicClient.multicall({
+    contracts: [
+      {
+        ...tokenContractInfo,
+        functionName: 'symbol',
+      },
+      {
+        ...tokenContractInfo,
+        functionName: 'decimals',
+      },
+    ],
+  });
+
+  if (
+    symbolResult.status === 'success' &&
+    decimalsResult.status === 'success'
+  ) {
+    return {
+      address: tokenContractInfo.address,
+      abi: tokenContractInfo.abi as Abi,
+      symbol: String(symbolResult.result),
+      decimals: Number(decimalsResult.result),
+    };
+  }
+};
+
+export async function getTokenInfo(
+  token: Token,
+  chainId: ChainId,
+  env?: Env,
+  rpcUrl?: string,
+): Promise<TokenInfo | undefined> {
+  const tokenContractInfo = getTokenContractInfo(token, chainId, env);
+  if (!tokenContractInfo) return;
+
+  const publicClient = makePublicClient({ chainId, rpcUrl });
+  return retrieveTokenProperties(publicClient, tokenContractInfo);
+}
+
+export async function getAssetInfo(
+  address: Address,
+  chainId: ChainId,
+  rpcUrl?: string,
+): Promise<TokenInfo | undefined> {
+  const publicClient = makePublicClient({ chainId, rpcUrl });
+  return retrieveTokenProperties(publicClient, {
+    abi: erc20Abi,
+    address,
+    chainId,
+  });
+}
+
+// Utils:
+// TODO: Move to utils
+
+export function toBaseDenomination(
+  input: BigNumber.Value,
+  decimalPlaces: number,
+) {
+  return BigNumber(input)
+    .multipliedBy(BigNumber(10).pow(decimalPlaces))
+    .decimalPlaces(0, BigNumber.ROUND_HALF_UP);
+}
+
+export function fromBaseDenomination(
+  input: BigNumber.Value,
+  decimalPlaces: number,
+) {
+  return BigNumber(input).dividedBy(BigNumber(10).pow(decimalPlaces));
+}

package/src/utils/env.ts

@@ -0,0 +1,12 @@
+import { ChainId } from '../common/chains';
+import { Env } from '@lombard.finance/sdk-common';
+
+const PROD_NATIVE_MINT_CHAINS = [
+  ChainId.ethereum,
+  ChainId.base,
+  ChainId.binanceSmartChain,
+] as ChainId[];
+
+export const determineEnv = (chainId: ChainId): Env => {
+  return PROD_NATIVE_MINT_CHAINS.includes(chainId) ? Env.prod : Env.stage;
+};

package/src/utils/hex.ts

@@ -1,7 +1,7 @@
-type Hex = `0x${string}`;
+import { Hex } from 'viem';
 
 export function isHex(input: string): input is Hex {
-  return input.startsWith("0x");
+  return input.startsWith('0x');
 }
 
 export function ensureHex(input: string): Hex {

package/src/utils/numbers.ts

@@ -0,0 +1,8 @@
+import BigNumber from 'bignumber.js';
+
+export const ZERO = BigNumber(0);
+export const ONE = BigNumber(1);
+
+export default function toBigInt(input: BigNumber.Value) {
+  return BigInt(BigNumber(input).toFixed());
+}

package/src/{common/utils/convertSatoshi.ts → utils/satoshi.ts}

@@ -1,6 +1,6 @@
 import BigNumber from 'bignumber.js';
 
-const BTC_DECIMALS = 8;
+export const BTC_DECIMALS = 8;
 export const SATOSHI_SCALE = BigNumber(10).pow(BTC_DECIMALS);
 
 /**
@@ -8,7 +8,7 @@ export const SATOSHI_SCALE = BigNumber(10).pow(BTC_DECIMALS);
  * @param amount - Satoshi amount
  * @returns BTC amount
  */
-export function fromSatoshi(amount: number | string | BigNumber) {
+export function fromSatoshi(amount: BigNumber.Value) {
   return BigNumber(amount).dividedBy(SATOSHI_SCALE);
 }
 
@@ -18,7 +18,7 @@ export function fromSatoshi(amount: number | string | BigNumber) {
  * @param amount - BTC amount
  * @returns Satoshi amount
  */
-export function toSatoshi(amount: number | string | BigNumber) {
+export function toSatoshi(amount: BigNumber.Value) {
   return BigNumber(amount)
     .multipliedBy(SATOSHI_SCALE)
     .decimalPlaces(0, BigNumber.ROUND_HALF_UP);

package/src/utils/time.ts

@@ -0,0 +1,12 @@
+export const SECOND = 1000;
+export const MINUTE = 60 * SECOND;
+export const HOUR = 60 * MINUTE;
+export const DAY = 24 * HOUR;
+
+export function now() {
+  return Date.now();
+}
+
+export function toUnix(ms: number) {
+  return Math.round(ms / 1000);
+}

package/src/vaults/abi/VEDA_VAULT_BASE_ASSET_ABI.json

@@ -0,0 +1,296 @@
+[
+  {
+    "constant": true,
+    "inputs": [],
+    "name": "mintingFinished",
+    "outputs": [{ "name": "", "type": "bool" }],
+    "payable": false,
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "constant": true,
+    "inputs": [],
+    "name": "name",
+    "outputs": [{ "name": "", "type": "string" }],
+    "payable": false,
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "constant": false,
+    "inputs": [
+      { "name": "_spender", "type": "address" },
+      { "name": "_value", "type": "uint256" }
+    ],
+    "name": "approve",
+    "outputs": [{ "name": "", "type": "bool" }],
+    "payable": false,
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "constant": false,
+    "inputs": [{ "name": "_token", "type": "address" }],
+    "name": "reclaimToken",
+    "outputs": [],
+    "payable": false,
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "constant": true,
+    "inputs": [],
+    "name": "totalSupply",
+    "outputs": [{ "name": "", "type": "uint256" }],
+    "payable": false,
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "constant": false,
+    "inputs": [
+      { "name": "_from", "type": "address" },
+      { "name": "_to", "type": "address" },
+      { "name": "_value", "type": "uint256" }
+    ],
+    "name": "transferFrom",
+    "outputs": [{ "name": "", "type": "bool" }],
+    "payable": false,
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "constant": true,
+    "inputs": [],
+    "name": "decimals",
+    "outputs": [{ "name": "", "type": "uint8" }],
+    "payable": false,
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "constant": false,
+    "inputs": [],
+    "name": "unpause",
+    "outputs": [],
+    "payable": false,
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "constant": false,
+    "inputs": [
+      { "name": "_to", "type": "address" },
+      { "name": "_amount", "type": "uint256" }
+    ],
+    "name": "mint",
+    "outputs": [{ "name": "", "type": "bool" }],
+    "payable": false,
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "constant": false,
+    "inputs": [{ "name": "value", "type": "uint256" }],
+    "name": "burn",
+    "outputs": [],
+    "payable": false,
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "constant": false,
+    "inputs": [],
+    "name": "claimOwnership",
+    "outputs": [],
+    "payable": false,
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "constant": true,
+    "inputs": [],
+    "name": "paused",
+    "outputs": [{ "name": "", "type": "bool" }],
+    "payable": false,
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "constant": false,
+    "inputs": [
+      { "name": "_spender", "type": "address" },
+      { "name": "_subtractedValue", "type": "uint256" }
+    ],
+    "name": "decreaseApproval",
+    "outputs": [{ "name": "success", "type": "bool" }],
+    "payable": false,
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "constant": true,
+    "inputs": [{ "name": "_owner", "type": "address" }],
+    "name": "balanceOf",
+    "outputs": [{ "name": "", "type": "uint256" }],
+    "payable": false,
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "constant": false,
+    "inputs": [],
+    "name": "renounceOwnership",
+    "outputs": [],
+    "payable": false,
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "constant": false,
+    "inputs": [],
+    "name": "finishMinting",
+    "outputs": [{ "name": "", "type": "bool" }],
+    "payable": false,
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "constant": false,
+    "inputs": [],
+    "name": "pause",
+    "outputs": [],
+    "payable": false,
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "constant": true,
+    "inputs": [],
+    "name": "owner",
+    "outputs": [{ "name": "", "type": "address" }],
+    "payable": false,
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "constant": true,
+    "inputs": [],
+    "name": "symbol",
+    "outputs": [{ "name": "", "type": "string" }],
+    "payable": false,
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "constant": false,
+    "inputs": [
+      { "name": "_to", "type": "address" },
+      { "name": "_value", "type": "uint256" }
+    ],
+    "name": "transfer",
+    "outputs": [{ "name": "", "type": "bool" }],
+    "payable": false,
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "constant": false,
+    "inputs": [
+      { "name": "_spender", "type": "address" },
+      { "name": "_addedValue", "type": "uint256" }
+    ],
+    "name": "increaseApproval",
+    "outputs": [{ "name": "success", "type": "bool" }],
+    "payable": false,
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "constant": true,
+    "inputs": [
+      { "name": "_owner", "type": "address" },
+      { "name": "_spender", "type": "address" }
+    ],
+    "name": "allowance",
+    "outputs": [{ "name": "", "type": "uint256" }],
+    "payable": false,
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "constant": true,
+    "inputs": [],
+    "name": "pendingOwner",
+    "outputs": [{ "name": "", "type": "address" }],
+    "payable": false,
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "constant": false,
+    "inputs": [{ "name": "newOwner", "type": "address" }],
+    "name": "transferOwnership",
+    "outputs": [],
+    "payable": false,
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  { "anonymous": false, "inputs": [], "name": "Pause", "type": "event" },
+  { "anonymous": false, "inputs": [], "name": "Unpause", "type": "event" },
+  {
+    "anonymous": false,
+    "inputs": [
+      { "indexed": true, "name": "burner", "type": "address" },
+      { "indexed": false, "name": "value", "type": "uint256" }
+    ],
+    "name": "Burn",
+    "type": "event"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      { "indexed": true, "name": "to", "type": "address" },
+      { "indexed": false, "name": "amount", "type": "uint256" }
+    ],
+    "name": "Mint",
+    "type": "event"
+  },
+  { "anonymous": false, "inputs": [], "name": "MintFinished", "type": "event" },
+  {
+    "anonymous": false,
+    "inputs": [{ "indexed": true, "name": "previousOwner", "type": "address" }],
+    "name": "OwnershipRenounced",
+    "type": "event"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      { "indexed": true, "name": "previousOwner", "type": "address" },
+      { "indexed": true, "name": "newOwner", "type": "address" }
+    ],
+    "name": "OwnershipTransferred",
+    "type": "event"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      { "indexed": true, "name": "owner", "type": "address" },
+      { "indexed": true, "name": "spender", "type": "address" },
+      { "indexed": false, "name": "value", "type": "uint256" }
+    ],
+    "name": "Approval",
+    "type": "event"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      { "indexed": true, "name": "from", "type": "address" },
+      { "indexed": true, "name": "to", "type": "address" },
+      { "indexed": false, "name": "value", "type": "uint256" }
+    ],
+    "name": "Transfer",
+    "type": "event"
+  }
+]