@underscore-finance/sdk 1.2.20-next.1 → 1.2.20-next.2

package/dapp.config.js

@@ -1,154 +0,0 @@
-import { createRequire } from 'module'
-
-const require = createRequire(import.meta.url)
-const Manifest = require('../underscore-protocol/migration_history/base-mainnet/v1.1/current-manifest.json')
-
-// These manifest-only entries are not part of the generated SDK surface.
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-const { LevgVaultHelper, '40Acres': FortyAcres, Yo, Tokemak, ...rest } = Manifest.contracts
-
-const PROTOCOL_ABI_ALIASES = {
-  ERC20: 'Erc20Token',
-  FortyAcres: '40Acres',
-}
-
-function protocolAbiPath(name) {
-  return `../underscore-protocol/scripts/abis/${name}.json`
-}
-
-function protocolAbi(name) {
-  return require(protocolAbiPath(name))
-}
-
-function protocolAbiNameFor(contractName) {
-  const protocolName = PROTOCOL_ABI_ALIASES[contractName] ?? contractName
-  try {
-    require.resolve(protocolAbiPath(protocolName))
-    return protocolName
-  } catch {
-    return undefined
-  }
-}
-
-function withProtocolAbi(contractName, baseContract = {}, protocolName = protocolAbiNameFor(contractName)) {
-  if (!protocolName) return baseContract
-  return {
-    ...baseContract,
-    abi: protocolAbi(protocolName),
-  }
-}
-
-function withCurrentProtocolAbis(contracts) {
-  return Object.fromEntries(
-    Object.entries(contracts).map(([contractName, contract]) => [
-      contractName,
-      withProtocolAbi(contractName, contract),
-    ]),
-  )
-}
-
-function protocolTemplate(name) {
-  return {
-    isTemplate: true,
-    abi: protocolAbi(name),
-  }
-}
-
-export default {
-  name: 'Underscore Finance',
-  description: 'Underscore Finance',
-  targetPath: './src/contracts',
-  chainId: 8453,
-  isModule: true,
-  isSdk: true,
-  package: {
-    source: './src',
-    protocol: {
-      name: 'Underscore Finance',
-      description: 'SDK for interacting with Underscore Finance smart contracts',
-      website: 'https://underscore.finance',
-      repo: 'https://github.com/underscore-finance/typescript-sdk',
-    },
-  },
-  contracts: {
-    ...withCurrentProtocolAbis(rest),
-    Addys: protocolTemplate('Addys'),
-    AgentSenderSpecialAdmin: protocolTemplate('AgentSenderSpecialAdmin'),
-    DefaultsLocal: protocolTemplate('DefaultsLocal'),
-    EarnVaultWallet: protocolTemplate('EarnVaultWallet'),
-    Erc20Token: protocolTemplate('Erc20Token'),
-    FortyAcres: withProtocolAbi('FortyAcres', FortyAcres),
-    LevgVaultWallet: protocolTemplate('LevgVaultWallet'),
-    LocalGov: protocolTemplate('LocalGov'),
-    Ownership: protocolTemplate('Ownership'),
-    UndyToken: protocolTemplate('UndyToken'),
-    VaultErc20Token: protocolTemplate('VaultErc20Token'),
-
-    // Keep the historical SDK export name while sourcing the current protocol ABI.
-    ERC20: protocolTemplate('Erc20Token'),
-
-    UserWallet: withProtocolAbi('UserWallet', {
-      isTemplate: true,
-      address: Manifest.contracts.UserWallet.address,
-    }),
-    UserWalletConfig: withProtocolAbi('UserWalletConfig', {
-      isTemplate: true,
-      address: Manifest.contracts.UserWalletConfig.address,
-    }),
-    ChequeBook: withProtocolAbi('ChequeBook', Manifest.contracts.ChequeBook),
-
-    UserWalletV1: {
-      isTemplate: true,
-      address: '0x880E453Ec494FB17bffba537BeaB4Cc6CD1B7C12',
-    },
-    UserWalletConfigV1: {
-      isTemplate: true,
-      address: '0x0E7064202c4F906Adc4D9F6D3C92470b62F624F1',
-    },
-    AgentWrapperV1: {
-      isTemplate: true,
-      address: '0x9d3F593380875860cC18F5736373ae4B084Ba2F9',
-    },
-    AgentWrapperV2: {
-      isTemplate: true,
-      address: '0x761fCDFfF8B187901eA11415237632A3F7E0203B',
-    },
-    AgentWrapper: withProtocolAbi('AgentWrapper', {
-      isTemplate: true,
-      ...Manifest.contracts.AgentWrapper,
-    }),
-    SignatureHelperV1: {
-      address: '0x7a938DEd840172e89ef3B90039959E51C1dC6893',
-      isTemplate: true,
-      ...Manifest.contracts.SignatureHelper,
-    },
-    UserWalletSignatureHelper: withProtocolAbi('UserWalletSignatureHelper', {
-      isTemplate: true,
-      ...Manifest.contracts.UserWalletSignatureHelper,
-    }),
-    AgentSenderSpecialSigHelper: withProtocolAbi('AgentSenderSpecialSigHelper', {
-      isTemplate: true,
-      ...Manifest.contracts.AgentSenderSpecialSigHelper,
-    }),
-    AgentSenderSpecial: withProtocolAbi('AgentSenderSpecial', {
-      isTemplate: true,
-      ...Manifest.contracts.AgentSenderSpecial,
-    }),
-    AgentSenderGeneric: withProtocolAbi('AgentSenderGeneric', {
-      isTemplate: true,
-      ...Manifest.contracts.AgentSenderGeneric,
-    }),
-    EarnVault: withProtocolAbi('EarnVault', {
-      isTemplate: true,
-      address: Manifest.contracts.UndyUsd.address,
-    }),
-    LevgVault: withProtocolAbi('LevgVault', {
-      isTemplate: true,
-      address: '0x936c3C493Dc45D0f4D2FA36C7640f3BCABd64B4B',
-    }),
-    LevgVaultHelper: withProtocolAbi('LevgVaultHelper', {
-      ...LevgVaultHelper,
-      isTemplate: true,
-    }),
-  },
-}

package/src/getSwapInstructions.ts

@@ -1,55 +0,0 @@
-import { AddressResolverFunction } from '@dappql/async'
-import { Address, PublicClient } from 'viem'
-
-import { LegoTools } from './contracts/index.js'
-
-type DeepMutable<T> = {
-  -readonly [P in keyof T]: T[P] extends object ? DeepMutable<T[P]> : T[P]
-}
-
-export async function getSwapInstructionsAmountOut(
-  publicClient: PublicClient,
-  payload: {
-    tokenIn: Address
-    tokenOut: Address
-    amountIn: bigint
-    slippage: bigint
-    includeLegoIds?: bigint[]
-  },
-  addressResolver?: AddressResolverFunction,
-) {
-  const { tokenIn, tokenOut, amountIn, slippage, includeLegoIds } = payload
-
-  const instructions = await publicClient.simulateContract({
-    address: addressResolver ? addressResolver('LegoTools') : LegoTools.deployAddress!,
-    abi: LegoTools.abi,
-    functionName: 'getRoutesAndSwapInstructionsAmountOut',
-    args: [tokenIn, tokenOut, amountIn, slippage, includeLegoIds ?? []],
-  })
-
-  return instructions.result as DeepMutable<typeof instructions.result>
-}
-
-export async function getSwapInstructionsAmountIn(
-  publicClient: PublicClient,
-  payload: {
-    tokenIn: Address
-    tokenOut: Address
-    amountOut: bigint
-    amountInAvailable: bigint
-    slippage: bigint
-    includeLegoIds?: bigint[]
-  },
-  addressResolver?: AddressResolverFunction,
-) {
-  const { tokenIn, tokenOut, amountOut, amountInAvailable, slippage, includeLegoIds } = payload
-
-  const instructions = await publicClient.simulateContract({
-    address: addressResolver ? addressResolver('LegoTools') : LegoTools.deployAddress!,
-    abi: LegoTools.abi,
-    functionName: 'getRoutesAndSwapInstructionsAmountIn',
-    args: [tokenIn, tokenOut, amountOut, amountInAvailable, slippage, includeLegoIds ?? []],
-  })
-
-  return instructions.result as DeepMutable<typeof instructions.result>
-}

package/src/index.ts

@@ -1,192 +0,0 @@
-import { GetItemCallFunction, iteratorQuery, query, RequestCollection } from '@dappql/async'
-import { Address, createPublicClient, http, PublicClient, WalletClient } from 'viem'
-import { base } from 'viem/chains'
-
-import * as CONTRACTS from './contracts/index.js'
-import createSdk, { SDK } from './contracts/sdk.js'
-import { getSwapInstructionsAmountIn, getSwapInstructionsAmountOut } from './getSwapInstructions.js'
-export * from './contracts/index.js'
-
-export type Contracts = SDK
-export type ContractsNames = keyof typeof CONTRACTS
-
-export const DEPARTMENT_IDS = {
-  LEDGER: 1n,
-  MISSION_CONTROL: 2n,
-  LEGO_BOOK: 3n,
-  SWITCHBOARD: 4n,
-  HATCHERY: 5n,
-  LOOT_DISTRIBUTOR: 6n,
-  APPRAISER: 7n,
-  WALLET_BACKPACK: 8n,
-  BILLING: 9n,
-  VAULT_REGISTRY: 10n,
-  HELPERS: 11n,
-}
-
-export const LEGOS_IDS = {
-  RIPE: 1n,
-  AAVE_V3: 2n,
-  COMPOUND_V3: 3n,
-  EULER: 4n,
-  FLUID: 5n,
-  MOONWELL: 6n,
-  MORPHO: 7n,
-  AERO_CLASSIC: 8n,
-  AERO_SLIPSTREAM: 9n,
-  CURVE: 10n,
-  UNISWAP_V2: 11n,
-  UNISWAP_V3: 12n,
-  UNDERSCORE: 13n,
-  FORTY_ACRES: 14n,
-  WASABI: 15n,
-  AVANTIS: 16n,
-  SKY_PSM: 17n,
-  EXTRA_FI: 18n,
-}
-
-export const HELPERS_IDS = {
-  LEGO_TOOLS: 1n,
-  LEVG_VAULT_TOOLS: 2n,
-}
-
-export type UnderscoreConfig = {
-  rpcUrl?: string
-  publicClient?: PublicClient
-  walletClient?: WalletClient
-}
-
-class Underscore {
-  public publicClient: PublicClient
-  public walletClient: WalletClient | undefined
-  public contracts: SDK
-  public addresses: Partial<Record<ContractsNames, `0x${string}`>>
-  constructor(config?: UnderscoreConfig) {
-    this.publicClient =
-      config?.publicClient ||
-      (createPublicClient({
-        chain: base,
-        transport: http(config?.rpcUrl),
-      }) as unknown as PublicClient)
-    this.addresses = {}
-    this.walletClient = config?.walletClient
-    this.contracts = createSdk(this.publicClient, this.walletClient, this.addressResolver)
-  }
-
-  async loadAddresses() {
-    const departments = await this.multicall((contracts) => {
-      return {
-        Ledger: contracts.UndyHq.call.getAddr(DEPARTMENT_IDS.LEDGER),
-        MissionControl: contracts.UndyHq.call.getAddr(DEPARTMENT_IDS.MISSION_CONTROL),
-        LegoBook: contracts.UndyHq.call.getAddr(DEPARTMENT_IDS.LEGO_BOOK),
-        Switchboard: contracts.UndyHq.call.getAddr(DEPARTMENT_IDS.SWITCHBOARD),
-        Hatchery: contracts.UndyHq.call.getAddr(DEPARTMENT_IDS.HATCHERY),
-        LootDistributor: contracts.UndyHq.call.getAddr(DEPARTMENT_IDS.LOOT_DISTRIBUTOR),
-        Appraiser: contracts.UndyHq.call.getAddr(DEPARTMENT_IDS.APPRAISER),
-        WalletBackpack: contracts.UndyHq.call.getAddr(DEPARTMENT_IDS.WALLET_BACKPACK),
-        Billing: contracts.UndyHq.call.getAddr(DEPARTMENT_IDS.BILLING),
-        VaultRegistry: contracts.UndyHq.call.getAddr(DEPARTMENT_IDS.VAULT_REGISTRY),
-        Helpers: contracts.UndyHq.call.getAddr(DEPARTMENT_IDS.HELPERS),
-      }
-    })
-    const children = await this.multicall((contracts) => {
-      return {
-        RipeLego: contracts.LegoBook.call.getAddr(LEGOS_IDS.RIPE).at(departments.LegoBook),
-        AaveV3: contracts.LegoBook.call.getAddr(LEGOS_IDS.AAVE_V3).at(departments.LegoBook),
-        CompoundV3: contracts.LegoBook.call.getAddr(LEGOS_IDS.COMPOUND_V3).at(departments.LegoBook),
-        Euler: contracts.LegoBook.call.getAddr(LEGOS_IDS.EULER).at(departments.LegoBook),
-        Fluid: contracts.LegoBook.call.getAddr(LEGOS_IDS.FLUID).at(departments.LegoBook),
-        Moonwell: contracts.LegoBook.call.getAddr(LEGOS_IDS.MOONWELL).at(departments.LegoBook),
-        Morpho: contracts.LegoBook.call.getAddr(LEGOS_IDS.MORPHO).at(departments.LegoBook),
-        AeroClassic: contracts.LegoBook.call.getAddr(LEGOS_IDS.AERO_CLASSIC).at(departments.LegoBook),
-        AeroSlipstream: contracts.LegoBook.call.getAddr(LEGOS_IDS.AERO_SLIPSTREAM).at(departments.LegoBook),
-        Curve: contracts.LegoBook.call.getAddr(LEGOS_IDS.CURVE).at(departments.LegoBook),
-        UniswapV2: contracts.LegoBook.call.getAddr(LEGOS_IDS.UNISWAP_V2).at(departments.LegoBook),
-        UniswapV3: contracts.LegoBook.call.getAddr(LEGOS_IDS.UNISWAP_V3).at(departments.LegoBook),
-        UnderscoreLego: contracts.LegoBook.call.getAddr(LEGOS_IDS.UNDERSCORE).at(departments.LegoBook),
-        FortyAcres: contracts.LegoBook.call.getAddr(LEGOS_IDS.FORTY_ACRES).at(departments.LegoBook),
-        Wasabi: contracts.LegoBook.call.getAddr(LEGOS_IDS.WASABI).at(departments.LegoBook),
-        Avantis: contracts.LegoBook.call.getAddr(LEGOS_IDS.AVANTIS).at(departments.LegoBook),
-        SkyPsm: contracts.LegoBook.call.getAddr(LEGOS_IDS.SKY_PSM).at(departments.LegoBook),
-        ExtraFi: contracts.LegoBook.call.getAddr(LEGOS_IDS.EXTRA_FI).at(departments.LegoBook),
-
-        SwitchboardAlpha: contracts.Switchboard.call.getAddr(1n).at(departments.Switchboard),
-        SwitchboardBravo: contracts.Switchboard.call.getAddr(2n).at(departments.Switchboard),
-        SwitchboardCharlie: contracts.Switchboard.call.getAddr(3n).at(departments.Switchboard),
-
-        LegoTools: contracts.Helpers.call.getAddr(1n).at(departments.Helpers),
-        LevgVaultTools: contracts.Helpers.call.getAddr(2n).at(departments.Helpers),
-      }
-    })
-
-    this.addresses = {
-      ...departments,
-      ...children,
-    }
-  }
-
-  addressResolver = (name: string) => {
-    return this.addresses[name as ContractsNames]!
-  }
-
-  setWalletClient(walletClient: WalletClient) {
-    this.walletClient = walletClient
-    this.contracts = createSdk(this.publicClient, this.walletClient)
-  }
-
-  setPublicClient(publicClient: PublicClient) {
-    this.publicClient = publicClient
-    this.contracts = createSdk(this.publicClient, this.walletClient)
-  }
-
-  async multicall<T extends RequestCollection>(
-    cb: (contracts: typeof CONTRACTS) => T,
-    options: { blockNumber?: bigint } = {},
-  ) {
-    const request = cb(CONTRACTS)
-    return (query as any)(this.publicClient, request, options, this.addressResolver) as ReturnType<typeof query<T>>
-  }
-
-  async iterate<T>(
-    cb: (contracts: typeof CONTRACTS) => {
-      total: bigint
-      getItem: GetItemCallFunction<T>
-    },
-    options: {
-      blockNumber?: bigint
-      firstIndex?: bigint
-    } = {},
-  ) {
-    const { total, getItem } = cb(CONTRACTS)
-    return (iteratorQuery as any)(this.publicClient, total, getItem, options, this.addressResolver) as ReturnType<
-      typeof iteratorQuery<T>
-    >
-  }
-
-  async getSwapInstructionsAmountOut(payload: {
-    tokenIn: Address
-    tokenOut: Address
-    amountIn: bigint
-    slippage: bigint
-    includeLegoIds?: bigint[]
-  }) {
-    return getSwapInstructionsAmountOut(this.publicClient, payload, this.addressResolver)
-  }
-
-  async getSwapInstructionsAmountIn(payload: {
-    tokenIn: Address
-    tokenOut: Address
-    amountOut: bigint
-    amountInAvailable: bigint
-    slippage: bigint
-    includeLegoIds?: bigint[]
-  }) {
-    return getSwapInstructionsAmountIn(this.publicClient, payload)
-  }
-
-  DEPARTMENT_IDS = DEPARTMENT_IDS
-
-  LEGOS_IDS = LEGOS_IDS
-}
-
-export default Underscore

package/tsconfig.json

@@ -1,18 +0,0 @@
-{
-  "compilerOptions": {
-    "jsx": "react-jsx",
-    "module": "NodeNext",
-    "moduleResolution": "NodeNext",
-    "target": "ES2021",
-    "strict": true,
-    "outDir": "dist",
-    "rootDir": "src",
-    "declaration": true,
-    "declarationMap": true,
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "resolveJsonModule": true
-  },
-  "include": ["src/**/*.ts", "src/**/*.tsx"],
-  "exclude": ["node_modules"]
-}