@xlink-network/xlink-sdk/src/stacksUtils/stxContractAddresses.ts

XLINK js SDK

import { KnownRoute_FromStacks_ToEVM } from "../utils/buildSupportedRoutes"
import { assertExclude, checkNever } from "../utils/typeHelpers"
import { KnownChainId, KnownTokenId } from "../utils/types/knownIds"
import {
  isStacksContractAddressEqual,
  StacksContractAddress,
} from "../xlinkSdkUtils/types"

export const xlinkContractsDeployerMainnet =
  "SP2XD7417HGPRTREMKF748VNEQPDRR0RMANB7X1NK"
export const xlinkContractsDeployerTestnet =
  "ST2QXSK64YQX3CQPC530K79XWQ98XFAM9W3XKEH3N"

export const xlinkContractsMultisigMainnet =
  "SP673Z4BPB4R73359K9HE55F2X91V5BJTN5SXZ5T"
export const xlinkContractsMultisigTestnet =
  "ST2QXSK64YQX3CQPC530K79XWQ98XFAM9W3XKEH3N"

export const alexContractDeployerMainnet =
  "SP102V8P0F7JX67ARQ77WEA3D3CFB5XW39REDT0AM"
export const alexContractDeployerTestnet =
  "ST1J4G6RR643BCG8G8SR6M2D9Z9KXT2NJDRK3FBTK"

export const legacyAlexContractDeployerMainnet =
  "SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9"
export const legacyAlexContractDeployerTestnet =
  "ST1J2JTYXGRMZYNKE40GM87ZCACSPSSEEQVSNB7DC"

const stxAlternativeTokenContractAddresses = {
  wbtc: {
    [KnownChainId.Stacks.Mainnet]: {
      deployerAddress: xlinkContractsMultisigMainnet,
      contractName: "token-wbtc",
    },
    [KnownChainId.Stacks.Testnet]: {
      deployerAddress: xlinkContractsDeployerTestnet,
      contractName: "token-wbtc",
    },
  },
  btcb: {
    [KnownChainId.Stacks.Mainnet]: {
      deployerAddress: xlinkContractsMultisigMainnet,
      contractName: "token-wbtc",
    },
    [KnownChainId.Stacks.Testnet]: {
      deployerAddress: xlinkContractsDeployerTestnet,
      contractName: "token-btcb",
    },
  },
  cbBTC: {
    [KnownChainId.Stacks.Mainnet]: {
      deployerAddress: xlinkContractsMultisigMainnet,
      contractName: "token-wbtc",
    },
    [KnownChainId.Stacks.Testnet]: {
      deployerAddress: xlinkContractsDeployerTestnet,
      contractName: "token-wbtc",
    },
  },
  usdt: {
    [KnownChainId.Stacks.Mainnet]: {
      deployerAddress: xlinkContractsMultisigMainnet,
      contractName: "token-usdt",
    },
    [KnownChainId.Stacks.Testnet]: {
      deployerAddress: xlinkContractsDeployerTestnet,
      contractName: "token-usdt",
    },
  },
  usdc: {
    [KnownChainId.Stacks.Mainnet]: {
      deployerAddress: xlinkContractsMultisigMainnet,
      contractName: "token-usdt",
    },
    [KnownChainId.Stacks.Testnet]: {
      deployerAddress: xlinkContractsDeployerTestnet,
      contractName: "token-usdt",
    },
  },
} satisfies Record<
  string,
  Record<KnownChainId.StacksChain, StacksContractAddress>
>
export const getTerminatingStacksTokenContractAddress = (
  route: KnownRoute_FromStacks_ToEVM,
): undefined | StacksContractAddress => {
  const { fromToken, toChain, toToken } = route
  if (fromToken === KnownTokenId.Stacks.aBTC) {
    const restChains = assertExclude.i<ChainsHaveAlternativeBTC>()

    if (
      (toChain === KnownChainId.EVM.Ethereum ||
        toChain === KnownChainId.EVM.Sepolia) &&
      toToken === KnownTokenId.EVM.WBTC
    ) {
      return stxAlternativeTokenContractAddresses.wbtc[route.fromChain]
    }
    assertExclude(restChains, KnownChainId.EVM.Ethereum)
    assertExclude(restChains, KnownChainId.EVM.Sepolia)

    if (
      (toChain === KnownChainId.EVM.BSC ||
        toChain === KnownChainId.EVM.BSCTestnet) &&
      toToken === KnownTokenId.EVM.BTCB
    ) {
      return stxAlternativeTokenContractAddresses.btcb[route.fromChain]
    }
    assertExclude(restChains, KnownChainId.EVM.BSC)
    assertExclude(restChains, KnownChainId.EVM.BSCTestnet)

    if (
      toChain === KnownChainId.EVM.Base &&
      toToken === KnownTokenId.EVM.cbBTC
    ) {
      return stxAlternativeTokenContractAddresses.cbBTC[route.fromChain]
    }
    assertExclude(restChains, KnownChainId.EVM.Base)

    checkNever(restChains)
  }

  if (fromToken === KnownTokenId.Stacks.sUSDT) {
    const restChains = assertExclude.i<ChainsHaveAlternativeStableUSD>()

    if (
      (toChain === KnownChainId.EVM.Ethereum ||
        toChain === KnownChainId.EVM.Sepolia ||
        toChain === KnownChainId.EVM.BSC ||
        toChain === KnownChainId.EVM.BSCTestnet) &&
      toToken === KnownTokenId.EVM.USDT
    ) {
      return stxAlternativeTokenContractAddresses.usdt[route.fromChain]
    }
    assertExclude(restChains, KnownChainId.EVM.Ethereum)
    assertExclude(restChains, KnownChainId.EVM.Sepolia)
    assertExclude(restChains, KnownChainId.EVM.BSC)
    assertExclude(restChains, KnownChainId.EVM.BSCTestnet)

    if (
      toChain === KnownChainId.EVM.Base &&
      toToken === KnownTokenId.EVM.USDC
    ) {
      return stxAlternativeTokenContractAddresses.usdt[route.fromChain]
    }
    assertExclude(restChains, KnownChainId.EVM.Base)

    checkNever(restChains)
  }
  return undefined
}
export const getEVMTokenIdFromTerminatingStacksTokenContractAddress = (route: {
  evmChain: KnownChainId.EVMChain
  stacksChain: KnownChainId.StacksChain
  stacksTokenAddress: StacksContractAddress
}): undefined | KnownTokenId.EVMToken => {
  const restStableUSDChains = assertExclude.i<ChainsHaveAlternativeStableUSD>()
  const restBTCChains = assertExclude.i<ChainsHaveAlternativeBTC>()

  if (
    (route.evmChain === KnownChainId.EVM.Ethereum ||
      route.evmChain === KnownChainId.EVM.Sepolia) &&
    isStacksContractAddressEqual(
      route.stacksTokenAddress,
      stxAlternativeTokenContractAddresses.wbtc[route.stacksChain],
    )
  ) {
    return KnownTokenId.EVM.WBTC
  }
  assertExclude(restBTCChains, KnownChainId.EVM.Ethereum)
  assertExclude(restBTCChains, KnownChainId.EVM.Sepolia)

  if (
    (route.evmChain === KnownChainId.EVM.BSC ||
      route.evmChain === KnownChainId.EVM.BSCTestnet) &&
    isStacksContractAddressEqual(
      route.stacksTokenAddress,
      stxAlternativeTokenContractAddresses.btcb[route.stacksChain],
    )
  ) {
    return KnownTokenId.EVM.BTCB
  }
  assertExclude(restBTCChains, KnownChainId.EVM.BSC)
  assertExclude(restBTCChains, KnownChainId.EVM.BSCTestnet)

  if (
    route.evmChain === KnownChainId.EVM.Base &&
    isStacksContractAddressEqual(
      route.stacksTokenAddress,
      stxAlternativeTokenContractAddresses.cbBTC[route.stacksChain],
    )
  ) {
    return KnownTokenId.EVM.cbBTC
  }
  assertExclude(restBTCChains, KnownChainId.EVM.Base)

  if (
    (route.evmChain === KnownChainId.EVM.Ethereum ||
      route.evmChain === KnownChainId.EVM.Sepolia ||
      route.evmChain === KnownChainId.EVM.BSC ||
      route.evmChain === KnownChainId.EVM.BSCTestnet) &&
    isStacksContractAddressEqual(
      route.stacksTokenAddress,
      stxAlternativeTokenContractAddresses.usdt[route.stacksChain],
    )
  ) {
    return KnownTokenId.EVM.USDT
  }
  assertExclude(restStableUSDChains, KnownChainId.EVM.Ethereum)
  assertExclude(restStableUSDChains, KnownChainId.EVM.Sepolia)
  assertExclude(restStableUSDChains, KnownChainId.EVM.BSC)
  assertExclude(restStableUSDChains, KnownChainId.EVM.BSCTestnet)

  if (
    route.evmChain === KnownChainId.EVM.Base &&
    isStacksContractAddressEqual(
      route.stacksTokenAddress,
      stxAlternativeTokenContractAddresses.usdc[route.stacksChain],
    )
  ) {
    return KnownTokenId.EVM.USDC
  }
  assertExclude(restStableUSDChains, KnownChainId.EVM.Base)

  checkNever(restStableUSDChains)
  checkNever(restBTCChains)
  return undefined
}
type ChainsHaveAlternativeStableUSD =
  | typeof KnownChainId.EVM.Ethereum
  | typeof KnownChainId.EVM.Sepolia
  | typeof KnownChainId.EVM.BSC
  | typeof KnownChainId.EVM.BSCTestnet
  | typeof KnownChainId.EVM.Base
type ChainsHaveAlternativeBTC =
  | typeof KnownChainId.EVM.Ethereum
  | typeof KnownChainId.EVM.Sepolia
  | typeof KnownChainId.EVM.BSC
  | typeof KnownChainId.EVM.BSCTestnet
  | typeof KnownChainId.EVM.Base

export const stxContractDeployers = {
  "btc-peg-in-endpoint-v2-05": {
    [KnownChainId.Stacks.Mainnet]: {
      deployerAddress: xlinkContractsMultisigMainnet,
    },
    [KnownChainId.Stacks.Testnet]: {
      deployerAddress: xlinkContractsMultisigTestnet,
    },
  },
  "btc-peg-out-endpoint-v2-01": {
    [KnownChainId.Stacks.Mainnet]: {
      deployerAddress: xlinkContractsDeployerMainnet,
    },
    [KnownChainId.Stacks.Testnet]: {
      deployerAddress: xlinkContractsDeployerTestnet,
    },
  },
  "cross-peg-in-endpoint-v2-04": {
    [KnownChainId.Stacks.Mainnet]: {
      deployerAddress: xlinkContractsMultisigMainnet,
    },
    [KnownChainId.Stacks.Testnet]: {
      deployerAddress: xlinkContractsMultisigTestnet,
    },
  },
  "cross-peg-out-endpoint-v2-01": {
    [KnownChainId.Stacks.Mainnet]: {
      deployerAddress: xlinkContractsDeployerMainnet,
    },
    [KnownChainId.Stacks.Testnet]: {
      deployerAddress: xlinkContractsDeployerTestnet,
    },
  },
  "meta-peg-in-endpoint-v2-04": {
    [KnownChainId.Stacks.Mainnet]: {
      deployerAddress: xlinkContractsMultisigMainnet,
    },
    [KnownChainId.Stacks.Testnet]: {
      deployerAddress: xlinkContractsMultisigTestnet,
    },
  },
  "meta-peg-out-endpoint-v2-04": {
    [KnownChainId.Stacks.Mainnet]: {
      deployerAddress: xlinkContractsMultisigMainnet,
    },
    [KnownChainId.Stacks.Testnet]: {
      deployerAddress: xlinkContractsMultisigTestnet,
    },
  },
} satisfies Record<
  string,
  Record<KnownChainId.StacksChain, { deployerAddress: string }>
>

export const stxTokenContractAddresses: Record<
  KnownTokenId.StacksToken,
  Record<KnownChainId.StacksChain, StacksContractAddress>
> = {
  [KnownTokenId.Stacks.ALEX]: {
    [KnownChainId.Stacks.Mainnet]: {
      deployerAddress: alexContractDeployerMainnet,
      contractName: "token-alex",
    },
    [KnownChainId.Stacks.Testnet]: {
      deployerAddress: alexContractDeployerTestnet,
      contractName: "token-alex",
    },
  },
  [KnownTokenId.Stacks.aBTC]: {
    [KnownChainId.Stacks.Mainnet]: {
      deployerAddress: xlinkContractsDeployerMainnet,
      contractName: "token-abtc",
    },
    [KnownChainId.Stacks.Testnet]: {
      deployerAddress: xlinkContractsDeployerTestnet,
      contractName: "token-abtc",
    },
  },
  [KnownTokenId.Stacks.sUSDT]: {
    [KnownChainId.Stacks.Mainnet]: {
      deployerAddress: xlinkContractsDeployerMainnet,
      contractName: "token-susdt",
    },
    [KnownChainId.Stacks.Testnet]: {
      deployerAddress: xlinkContractsDeployerTestnet,
      contractName: "token-susdt",
    },
  },
  [KnownTokenId.Stacks.sLUNR]: {
    [KnownChainId.Stacks.Mainnet]: {
      deployerAddress: xlinkContractsDeployerMainnet,
      contractName: "token-slunr",
    },
    [KnownChainId.Stacks.Testnet]: {
      deployerAddress: xlinkContractsDeployerTestnet,
      contractName: "token-slunr",
    },
  },
  [KnownTokenId.Stacks.sSKO]: {
    [KnownChainId.Stacks.Mainnet]: {
      deployerAddress: xlinkContractsDeployerMainnet,
      contractName: "token-ssko",
    },
    [KnownChainId.Stacks.Testnet]: {
      deployerAddress: xlinkContractsDeployerTestnet,
      contractName: "token-ssko",
    },
  },
  [KnownTokenId.Stacks.vLiSTX]: {
    [KnownChainId.Stacks.Mainnet]: {
      deployerAddress: alexContractDeployerMainnet,
      contractName: "token-wvlqstx",
    },
    [KnownChainId.Stacks.Testnet]: {
      deployerAddress: alexContractDeployerTestnet,
      contractName: "token-wvlqstx",
    },
  },
  [KnownTokenId.Stacks.vLiALEX]: {
    [KnownChainId.Stacks.Mainnet]: {
      deployerAddress: alexContractDeployerMainnet,
      contractName: "token-wvlialex",
    },
    [KnownChainId.Stacks.Testnet]: {
      deployerAddress: alexContractDeployerTestnet,
      contractName: "token-wvlialex",
    },
  },
  [KnownTokenId.Stacks.uBTC]: {
    [KnownChainId.Stacks.Mainnet]: {
      deployerAddress: xlinkContractsMultisigMainnet,
      contractName: "token-ubtc",
    },
    [KnownChainId.Stacks.Testnet]: {
      deployerAddress: xlinkContractsDeployerTestnet,
      contractName: "token-ubtc",
    },
  },
  [KnownTokenId.Stacks.DB20]: {
    [KnownChainId.Stacks.Mainnet]: {
      deployerAddress: legacyAlexContractDeployerMainnet,
      contractName: "brc20-db20",
    },
    [KnownChainId.Stacks.Testnet]: {
      deployerAddress: legacyAlexContractDeployerTestnet,
      contractName: "brc20-db20",
    },
  },
  [KnownTokenId.Stacks.DOG]: {
    [KnownChainId.Stacks.Mainnet]: {
      deployerAddress: legacyAlexContractDeployerMainnet,
      contractName: "runes-dog",
    },
    [KnownChainId.Stacks.Testnet]: {
      deployerAddress: legacyAlexContractDeployerTestnet,
      contractName: "runes-dog",
    },
  },
}