@shapeshiftoss/contracts 1.0.3 → 1.0.4

package/dist/esm/constants.js

@@ -0,0 +1,105 @@
+import { erc20Abi } from 'viem';
+import { EVERGREEN_FARMING_ABI } from './abis/evergreenFarming.js';
+import { FARMING_ABI } from './abis/farming.js';
+import { I_UNISWAP_V2_PAIR_ABI } from './abis/iUniswapV2Pair.js';
+import { THORCHAIN_ROUTER_ABI } from './abis/thorchainRouter.js';
+import { UNISWAP_V2_ROUTER_02_ABI } from './abis/uniswapV2Router02.js';
+import { ContractType } from './types.js';
+export const WETH_TOKEN_CONTRACT = '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2';
+export const FOX_TOKEN_CONTRACT = '0xc770EEfAd204B5180dF6a14Ee197D99d808ee52d';
+// Staking contract addresses as string literals
+export const ETH_FOX_STAKING_V1_CONTRACT = '0xdd80e21669a664bce83e3ad9a0d74f8dad5d9e72';
+export const ETH_FOX_STAKING_V2_CONTRACT = '0xc54b9f82c1c54e9d4d274d633c7523f2299c42a0';
+export const ETH_FOX_STAKING_V3_CONTRACT = '0x212ebf9fd3c10f371557b08e993eaab385c3932b';
+export const ETH_FOX_STAKING_V4_CONTRACT = '0x24fd7fb95dc742e23dc3829d3e656feeb5f67fa0';
+export const ETH_FOX_STAKING_V5_CONTRACT = '0xc14eaa8284feff79edc118e06cadbf3813a7e555';
+export const ETH_FOX_STAKING_V6_CONTRACT = '0xebb1761ad43034fd7faa64d84e5bbd8cb5c40b68';
+export const ETH_FOX_STAKING_V7_CONTRACT = '0x5939783dbf3e9f453a69bc9ddc1e492efac1fbcb';
+export const ETH_FOX_STAKING_V8_CONTRACT = '0x662da6c777a258382f08b979d9489c3fbbbd8ac3';
+export const ETH_FOX_STAKING_V9_CONTRACT = '0x721720784b76265aa3e34c1c7ba02a6027bcd3e5';
+export const ETH_FOX_STAKING_EVERGREEN_CONTRACT = '0xe7e16e2b05440c2e484c5c41ac3e5a4d15da2744';
+export const foxEthStakingContractAddresses = [
+    ETH_FOX_STAKING_V9_CONTRACT,
+    ETH_FOX_STAKING_V8_CONTRACT,
+    ETH_FOX_STAKING_V7_CONTRACT,
+    ETH_FOX_STAKING_V6_CONTRACT,
+    ETH_FOX_STAKING_V5_CONTRACT,
+    ETH_FOX_STAKING_V4_CONTRACT,
+    ETH_FOX_STAKING_V3_CONTRACT,
+    ETH_FOX_STAKING_V2_CONTRACT,
+    ETH_FOX_STAKING_V1_CONTRACT,
+    ETH_FOX_STAKING_EVERGREEN_CONTRACT,
+];
+// Exported as a string literal for contract address discrimination purposes
+export const ETH_FOX_POOL_CONTRACT = '0x470e8de2eBaef52014A47Cb5E6aF86884947F08c';
+// Uniswap V2
+export const UNISWAP_V2_ROUTER_02_CONTRACT_MAINNET = '0x7a250d5630B4cF539739dF2C5dAcb4c659F2488D';
+export const UNISWAP_V2_FACTORY_CONTRACT_MAINNET = '0x5C69bEe701ef814a2B6a3EDD4B1652CB9cc5aA6f';
+// Uniswap V3
+export const UNISWAP_V3_QUOTER_CONTRACT_MAINNET = '0xb27308f9F90D607463bb33eA1BeBb41C27CE5AB6';
+export const UNISWAP_V3_POOL_FACTORY_CONTRACT_MAINNET = '0x1F98431c8aD98523631AE4a59f267346ea31F984';
+// THORChain Contracts
+export const THOR_ROUTER_CONTRACT_MAINNET = '0xd37bbe5744d730a1d98d8dc97c42f0ca46ad7146';
+export const TS_AGGREGATOR_TOKEN_TRANSFER_PROXY_CONTRACT_MAINNET = '0xF892Fef9dA200d9E84c9b0647ecFF0F34633aBe8';
+// RFOX on Arbitrum ERC1967Proxy contract address
+// Uncomment me if you want to test RFOX with a shorter cooldown period
+// export const RFOX_PROXY_CONTRACT: Address = '0x1094c4a99fce60e69ffe75849309408f1262d304'
+// export const RFOX_UNI_V2_ETH_FOX_PROXY_CONTRACT: Address = '0x4843373F380aDf80C779cD4dEDC6452E414f7634'
+export const RFOX_PROXY_CONTRACT = '0xaC2a4fD70BCD8Bab0662960455c363735f0e2b56';
+export const RFOX_UNI_V2_ETH_FOX_PROXY_CONTRACT = '0x83B51B7605d2E277E03A7D6451B1efc0e5253A2F';
+export const RFOX_REWARD_RATE = 1n * 10n ** 27n;
+export const RFOX_WAD = 1n * 10n ** 18n;
+export const CONTRACT_ADDRESS_TO_ABI = {
+    [ETH_FOX_POOL_CONTRACT]: I_UNISWAP_V2_PAIR_ABI,
+    [ETH_FOX_STAKING_V1_CONTRACT]: FARMING_ABI,
+    [ETH_FOX_STAKING_V2_CONTRACT]: FARMING_ABI,
+    [ETH_FOX_STAKING_V3_CONTRACT]: FARMING_ABI,
+    [ETH_FOX_STAKING_V4_CONTRACT]: FARMING_ABI,
+    [ETH_FOX_STAKING_V5_CONTRACT]: FARMING_ABI,
+    [ETH_FOX_STAKING_V6_CONTRACT]: FARMING_ABI,
+    [ETH_FOX_STAKING_V7_CONTRACT]: FARMING_ABI,
+    [ETH_FOX_STAKING_V8_CONTRACT]: FARMING_ABI,
+    [ETH_FOX_STAKING_V9_CONTRACT]: FARMING_ABI,
+    [ETH_FOX_STAKING_EVERGREEN_CONTRACT]: EVERGREEN_FARMING_ABI,
+    [FOX_TOKEN_CONTRACT]: erc20Abi,
+    [UNISWAP_V2_ROUTER_02_CONTRACT_MAINNET]: UNISWAP_V2_ROUTER_02_ABI,
+    // THOR Router Mainnet
+    [THOR_ROUTER_CONTRACT_MAINNET]: THORCHAIN_ROUTER_ABI,
+};
+export const CONTRACT_TYPE_TO_ABI = {
+    [ContractType.UniV2Pair]: I_UNISWAP_V2_PAIR_ABI,
+    [ContractType.ERC20]: erc20Abi,
+    [ContractType.ThorRouter]: THORCHAIN_ROUTER_ABI,
+};
+// 0x proxy contracts - all EVM chains except Optimism have the same address
+export const ZRX_ETHEREUM_PROXY_CONTRACT = '0xDef1C0ded9bec7F1a1670819833240f027b25EfF';
+export const ZRX_OPTIMISM_PROXY_CONTRACT = '0xDEF1ABE32c034e558Cdd535791643C58a13aCC10';
+// Cowswap
+export const COWSWAP_SETTLEMENT_CONTRACT_MAINNET = '0x9008D19f58AAbD9eD0D60971565AA8510560ab41';
+// Arbitrum Bridge contracts
+export const ARB_OUTBOX_CONTRACT = '0x0B9857ae2D4A3DBe74ffE1d7DF045bb7F96E4840';
+export const ARB_SYS_CONTRACT = '0x0000000000000000000000000000000000000064';
+export const ARBITRUM_L2_ERC20_GATEWAY_PROXY_CONTRACT = '0x09e9222E96E7B4AE2a407B98d48e330053351EEe';
+export const ARB_RETRYABLE_TX_CONTRACT = '0x000000000000000000000000000000000000006e';
+export const L2_ARBITRUM_CUSTOM_GATEWAY_CONTRACT = '0x096760F208390250649E3e8763348E783AEF5562';
+export const L2_ARBITRUM_GATEWAY_CONTRACT = '0x5288c571Fd7aD117beA99bF60FE0846C4E84F933';
+export const L1_ARBITRUM_GATEWAY_CONTRACT = '0x72ce9c846789fdb6fc1f34ac4ad25dd9ef7031ef';
+export const L1_ORBIT_CUSTOM_GATEWAY_CONTRACT = '0x4Dbd4fc535Ac27206064B68FfCf827b0A60BAB3f';
+export const SHAPE_SHIFT_ROUTER_CONTRACT = '0x6a1e73f12018D8e5f966ce794aa2921941feB17E';
+export const FOXY_STAKING_CONTRACT = '0xee77aa3Fd23BbeBaf94386dD44b548e9a785ea4b';
+// Fox Staking Contracts
+export const UNI_V2_FOX_STAKING_REWARDS_V1_CONTRACT = '0xDd80E21669A664Bce83E3AD9a0d74f8Dad5D9E72';
+export const UNI_V2_FOX_STAKING_REWARDS_V2_CONTRACT = '0xc54B9F82C1c54E9D4d274d633c7523f2299c42A0';
+export const UNI_V2_FOX_STAKING_REWARDS_V3_CONTRACT = '0x212ebf9FD3c10F371557b08E993eAaB385c3932b';
+export const UNI_V2_FOX_STAKING_REWARDS_V4_CONTRACT = '0x24FD7FB95dc742e23Dc3829d3e656FEeb5f67fa0';
+export const UNI_V2_FOX_STAKING_REWARDS_V5_CONTRACT = '0xC14eaA8284feFF79EDc118E06caDBf3813a7e555';
+export const UNI_V2_FOX_STAKING_REWARDS_CONTRACTS = [
+    UNI_V2_FOX_STAKING_REWARDS_V1_CONTRACT,
+    UNI_V2_FOX_STAKING_REWARDS_V2_CONTRACT,
+    UNI_V2_FOX_STAKING_REWARDS_V3_CONTRACT,
+    UNI_V2_FOX_STAKING_REWARDS_V4_CONTRACT,
+    UNI_V2_FOX_STAKING_REWARDS_V5_CONTRACT,
+];
+// Permit2 is deployed here across all chains.
+// https://0x.org/docs/introduction/0x-cheat-sheet#permit2-contract
+export const PERMIT2_CONTRACT = '0x000000000022D473030F116dDEE9F6B43aC78BA3';

package/dist/esm/contractManager.d.ts

@@ -0,0 +1,11 @@
+import type { AssetId, ChainId } from '@shapeshiftoss/caip';
+import type { Address } from 'viem';
+import type { KnownContractAddress, KnownContractByAddress, KnownContractByType } from './types.js';
+import { ContractType } from './types.js';
+export declare const getOrCreateContractByAddress: <A extends KnownContractAddress>(address: A) => KnownContractByAddress<A>;
+export declare const getOrCreateContractByType: <A extends KnownContractAddress, T extends ContractType>({ address, type, chainId, }: {
+    address: string | Address;
+    type: T;
+    chainId: ChainId;
+}) => KnownContractByType<A, T>;
+export declare const fetchUniV2PairData: ((pairAssetId: AssetId) => Promise<import("@uniswap/sdk").Pair>) & import("lodash").MemoizedFunction;

package/dist/esm/contractManager.js

@@ -0,0 +1,69 @@
+import { fromAssetId, toAssetId } from '@shapeshiftoss/caip';
+import { KnownChainIds } from '@shapeshiftoss/types';
+import { Fetcher } from '@uniswap/sdk';
+import assert from 'assert';
+import memoize from 'lodash/memoize';
+import { getAddress, getContract } from 'viem';
+import { CONTRACT_ADDRESS_TO_ABI, CONTRACT_TYPE_TO_ABI } from './constants.js';
+import { getEthersV5Provider } from './ethersProviderSingleton.js';
+import { ContractType } from './types.js';
+import { viemClientByChainId, viemEthMainnetClient } from './viemClient.js';
+const definedContracts = {};
+export const getOrCreateContractByAddress = (address) => {
+    const checksumAddress = getAddress(address);
+    const definedContract = definedContracts[checksumAddress];
+    if (definedContract !== undefined) {
+        return definedContract;
+    }
+    const contractAbi = CONTRACT_ADDRESS_TO_ABI[address];
+    const contract = getContract({
+        abi: contractAbi,
+        address: checksumAddress,
+        client: viemEthMainnetClient,
+    });
+    definedContracts[checksumAddress] = contract;
+    return contract;
+};
+export const getOrCreateContractByType = ({ address, type, chainId, }) => {
+    const checksumAddress = getAddress(address);
+    const definedContract = definedContracts[checksumAddress];
+    if (definedContract !== undefined) {
+        return definedContract;
+    }
+    const publicClient = viemClientByChainId[chainId];
+    assert(publicClient !== undefined, `no public client found for chainId '${chainId}'`);
+    const contract = getContract({
+        abi: CONTRACT_TYPE_TO_ABI[type],
+        address: checksumAddress,
+        client: publicClient,
+    });
+    definedContracts[checksumAddress] = contract;
+    return contract;
+};
+export const fetchUniV2PairData = memoize(async (pairAssetId) => {
+    const { assetReference, chainId } = fromAssetId(pairAssetId);
+    const checksumAddress = getAddress(assetReference);
+    const pair = getOrCreateContractByType({
+        address: checksumAddress,
+        type: ContractType.UniV2Pair,
+        chainId: KnownChainIds.EthereumMainnet,
+    });
+    const ethersV5Provider = getEthersV5Provider();
+    const token0Address = await pair.read.token0();
+    const token1Address = await pair.read.token1();
+    const token0AssetId = toAssetId({
+        chainId,
+        assetNamespace: 'erc20',
+        assetReference: token0Address,
+    });
+    const token1AssetId = toAssetId({
+        chainId,
+        assetNamespace: 'erc20',
+        assetReference: token1Address,
+    });
+    const { chainReference: asset0EvmChainId, assetReference: asset0Address } = fromAssetId(token0AssetId);
+    const { chainReference: asset1EvmChainId, assetReference: asset1Address } = fromAssetId(token1AssetId);
+    const token0 = await Fetcher.fetchTokenData(Number(asset0EvmChainId), asset0Address, ethersV5Provider);
+    const token1 = await Fetcher.fetchTokenData(Number(asset1EvmChainId), asset1Address, ethersV5Provider);
+    return Fetcher.fetchPairData(token0, token1, ethersV5Provider);
+});

package/dist/esm/ethersProviderSingleton.d.ts

@@ -0,0 +1,6 @@
+import type { EvmChainId } from '@shapeshiftoss/types';
+import { JsonRpcProvider } from 'ethers';
+import { ethers as ethersV5 } from 'ethers5';
+export declare const rpcUrlByChainId: (chainId: EvmChainId) => string;
+export declare const getEthersProvider: (chainId: EvmChainId) => JsonRpcProvider;
+export declare const getEthersV5Provider: (chainId?: EvmChainId) => ethersV5.providers.JsonRpcProvider;

package/dist/esm/ethersProviderSingleton.js

@@ -0,0 +1,71 @@
+import { KnownChainIds } from '@shapeshiftoss/types';
+import { assertUnreachable } from '@shapeshiftoss/utils';
+import { JsonRpcProvider } from 'ethers';
+import { ethers as ethersV5 } from 'ethers5';
+export const rpcUrlByChainId = (chainId) => {
+    const url = (() => {
+        switch (chainId) {
+            case KnownChainIds.AvalancheMainnet:
+                return process.env.VITE_AVALANCHE_NODE_URL;
+            case KnownChainIds.OptimismMainnet:
+                return process.env.VITE_OPTIMISM_NODE_URL;
+            case KnownChainIds.BnbSmartChainMainnet:
+                return process.env.VITE_BNBSMARTCHAIN_NODE_URL;
+            case KnownChainIds.PolygonMainnet:
+                return process.env.VITE_POLYGON_NODE_URL;
+            case KnownChainIds.GnosisMainnet:
+                return process.env.VITE_GNOSIS_NODE_URL;
+            case KnownChainIds.EthereumMainnet:
+                return process.env.VITE_ETHEREUM_NODE_URL;
+            case KnownChainIds.ArbitrumMainnet:
+                return process.env.VITE_ARBITRUM_NODE_URL;
+            case KnownChainIds.ArbitrumNovaMainnet:
+                return process.env.VITE_ARBITRUM_NOVA_NODE_URL;
+            case KnownChainIds.BaseMainnet:
+                return process.env.VITE_BASE_NODE_URL;
+            case KnownChainIds.MonadMainnet:
+                return process.env.VITE_MONAD_NODE_URL;
+            default:
+                return assertUnreachable(chainId);
+        }
+    })();
+    if (!url) {
+        throw new Error(`No RPC URL found for chainId ${chainId}`);
+    }
+    return url;
+};
+const ethersProviders = new Map();
+const ethersV5Providers = new Map();
+export const getEthersProvider = (chainId) => {
+    if (!ethersProviders.has(chainId)) {
+        const provider = new JsonRpcProvider(rpcUrlByChainId(chainId), undefined, {
+            staticNetwork: true,
+        });
+        ethersProviders.set(chainId, provider);
+        return provider;
+    }
+    else {
+        // This really should be defined but I guess enough safety never hurts mang...
+        const provider = ethersProviders.get(chainId);
+        if (!provider) {
+            throw new Error(`No provider found for chainId ${chainId}`);
+        }
+        return provider;
+    }
+};
+// For backwards-compatibility for libraries still stuck in v5
+export const getEthersV5Provider = (chainId = KnownChainIds.EthereumMainnet) => {
+    if (!ethersV5Providers.has(chainId)) {
+        const provider = new ethersV5.providers.StaticJsonRpcProvider(rpcUrlByChainId(chainId));
+        ethersV5Providers.set(chainId, provider);
+        return provider;
+    }
+    else {
+        // This really should be defined but I guess enough safety never hurts mang...
+        const provider = ethersV5Providers.get(chainId);
+        if (!provider) {
+            throw new Error(`No provider found for chainId ${chainId}`);
+        }
+        return provider;
+    }
+};

package/dist/esm/index.d.ts

@@ -0,0 +1,6 @@
+export * from './constants.js';
+export * from './types.js';
+export * from './contractManager.js';
+export * from './ethersProviderSingleton.js';
+export * from './abis/index.js';
+export * from './viemClient.js';

package/dist/esm/index.js

@@ -0,0 +1,6 @@
+export * from './constants.js';
+export * from './types.js';
+export * from './contractManager.js';
+export * from './ethersProviderSingleton.js';
+export * from './abis/index.js';
+export * from './viemClient.js';

package/dist/esm/types.d.ts

@@ -0,0 +1,21 @@
+import type { Address, GetContractReturnType, PublicClient } from 'viem';
+import type { EVERGREEN_FARMING_ABI, FARMING_ABI } from './abis/index.js';
+import type { CONTRACT_ADDRESS_TO_ABI, CONTRACT_TYPE_TO_ABI, ETH_FOX_POOL_CONTRACT, FOX_TOKEN_CONTRACT, foxEthStakingContractAddresses, THOR_ROUTER_CONTRACT_MAINNET, UNISWAP_V2_ROUTER_02_CONTRACT_MAINNET } from './constants.js';
+export declare enum ContractType {
+    UniV2Pair = "UniV2Pair",
+    ERC20 = "ERC20",
+    ThorRouter = "ThorRouter"
+}
+export type KnownContractAbiByAddress<T extends KnownContractAddress> = (typeof CONTRACT_ADDRESS_TO_ABI)[T];
+export type KnownContractAbiByType<T extends ContractType> = (typeof CONTRACT_TYPE_TO_ABI)[T];
+export type KnownContractByAddress<T extends KnownContractAddress> = GetContractReturnType<KnownContractAbiByAddress<T>, PublicClient, T>;
+export type KnownContract = KnownContractByAddress<KnownContractAddress>;
+export type KnownContractByType<A extends KnownContractAddress, T extends ContractType> = GetContractReturnType<KnownContractAbiByType<T>, PublicClient, A>;
+export type KnownContractAddress = typeof ETH_FOX_POOL_CONTRACT | FoxEthStakingContractAddress | typeof FOX_TOKEN_CONTRACT | typeof UNISWAP_V2_ROUTER_02_CONTRACT_MAINNET | typeof THOR_ROUTER_CONTRACT_MAINNET;
+export type DefinedContract = {
+    contract: KnownContractByAddress<KnownContractAddress>;
+    address: KnownContractAddress;
+};
+export type FoxEthStakingContractAddress = (typeof foxEthStakingContractAddresses)[number];
+export type FoxEthStakingContractAbi = typeof FARMING_ABI | typeof EVERGREEN_FARMING_ABI;
+export type FoxEthStakingContract<T extends FoxEthStakingContractAbi> = T extends typeof FARMING_ABI ? GetContractReturnType<typeof FARMING_ABI, PublicClient, Address> : GetContractReturnType<typeof EVERGREEN_FARMING_ABI, PublicClient, Address>;

package/dist/esm/types.js

@@ -0,0 +1,6 @@
+export var ContractType;
+(function (ContractType) {
+    ContractType["UniV2Pair"] = "UniV2Pair";
+    ContractType["ERC20"] = "ERC20";
+    ContractType["ThorRouter"] = "ThorRouter";
+})(ContractType || (ContractType = {}));