@atomiqlabs/sdk 1.0.0-beta3 → 1.0.0-beta30

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atomiqlabs/sdk",
-  "version": "1.0.0-beta3",
+  "version": "1.0.0-beta30",
   "description": "atomiq labs SDK for cross-chain swaps between smart chains and bitcoin",
   "main": "./dist/index.js",
   "types:": "./dist/index.d.ts",
@@ -22,7 +22,7 @@
   "license": "ISC",
   "dependencies": {
     "crosslightning-base": "7.0.0-beta1",
-    "crosslightning-sdk-base": "10.0.5-beta8",
+    "crosslightning-sdk-base": "10.0.5-beta33",
     "crosslightning-solana": "7.0.0-beta4"
   },
   "devDependencies": {

package/src/MultichainSwapper.ts

@@ -1,127 +1,134 @@
-import {
-    BitcoinNetwork,
-    BtcToken, IndexedDBStorageManager,
-    MempoolApi,
-    MempoolBitcoinRpc,
-    RedundantSwapPrice,
-    RedundantSwapPriceAssets,
-    SCToken,
-    Swapper,
-    SwapperOptions
-} from "crosslightning-sdk-base";
-import {objectMap} from "crosslightning-sdk-base/dist/utils/Utils";
-import {SdkSolana, SdkSolanaType} from "./chains/solana/SolanaChainInitializer";
-import {SdkChain} from "./chains/ChainInitializer";
-import * as BN from "bn.js";
-import {SmartChainAssets} from "./SmartChainAssets";
-import {IStorageManager, StorageObject} from "crosslightning-base";
-
-type Chains = {
-    "SOLANA": SdkSolanaType
-};
-
-const Chains: {
-    [C in keyof Chains]: SdkChain<Chains[C]>
-} = {
-    "SOLANA": SdkSolana
-} as const;
-
-type SdkMultichain = { [C in keyof Chains]: Chains[C]["ChainType"] };
-
-export type MultichainSwapperOptions = SwapperOptions & {
-    chains: {
-        [C in keyof Chains]: Chains[C]["Options"]
-    }
-} & {
-    storageCtor?: <T extends StorageObject>(name: string) => IStorageManager<T>
-};
-
-export class MultichainSwapper extends Swapper<SdkMultichain> {
-
-    constructor(options: MultichainSwapperOptions) {
-        options.bitcoinNetwork ??= BitcoinNetwork.MAINNET;
-        options.storagePrefix ??= "atomiqsdk-"+options.bitcoinNetwork;
-        options.storageCtor ??= (name: string) => new IndexedDBStorageManager(name);
-
-        options.registryUrl ??= options.bitcoinNetwork===BitcoinNetwork.MAINNET ?
-            "https://api.github.com/repos/adambor/SolLightning-registry/contents/registry-mainnet.json?ref=main" :
-            "https://api.github.com/repos/adambor/SolLightning-registry/contents/registry.json?ref=main";
-
-        const mempoolApi = new MempoolApi(
-            options.bitcoinNetwork===BitcoinNetwork.TESTNET ?
-                "https://mempool.space/testnet/api/" :
-                "https://mempool.space/api/"
-        );
-        const bitcoinRpc = new MempoolBitcoinRpc(mempoolApi);
-
-        const pricingAssets: RedundantSwapPriceAssets<SdkMultichain> = [];
-        Object.keys(SmartChainAssets).forEach((ticker) => {
-            const chains: any = {};
-            for(let chainId in Chains) {
-                if(Chains[chainId].assets[ticker]!=null) chains[chainId] = Chains[chainId].assets[ticker];
-            }
-            pricingAssets.push({
-                ...SmartChainAssets[ticker].pricing,
-                chains
-            })
-        });
-
-        const ctorChainData = objectMap(Chains, (value, key) => {
-            return value.getCtorData(options, bitcoinRpc, options.bitcoinNetwork);
-        });
-
-        super(bitcoinRpc, ctorChainData, RedundantSwapPrice.createFromTokenMap<SdkMultichain>(new BN(10000), pricingAssets), options);
-    }
-
-}
-
-export const Tokens: {
-    [C in keyof Chains]: {
-        [T in keyof Chains[C]["Assets"]]: SCToken<Chains[C]["ChainType"]["ChainId"]> & {name: string, decimals: number}
-    }
-} & {
-    BITCOIN: {
-        BTC: BtcToken<false>,
-        BTCLN: BtcToken<true>
-    }
-} = {
-    ...objectMap(Chains, (value, key) => {
-        return objectMap(value.assets, (assetData, ticker) => {
-            return {
-                chain: "SC",
-                chainId: value.chainIdentifier,
-                address: assetData.address,
-                name: SmartChainAssets[ticker].name,
-                decimals: assetData.decimals
-            }
-        });
-    }),
-    BITCOIN: {
-        BTC: {
-            chain: "BTC",
-            lightning: false
-        },
-        BTCLN: {
-            chain: "BTC",
-            lightning: true
-        }
-    }
-};
-
-export const TokenResolver: {
-    [C in keyof Chains]: {
-        getToken(address: string): {ticker: string, name: string}
-    }
-} = objectMap(Chains, (value, key) => {
-    const addressMap: {[tokenAddress: string]: {ticker: string, name: string, decimals: number}} = {};
-    for(let ticker in value.assets) {
-        addressMap[value.assets[ticker].address] = {
-            ticker,
-            name: SmartChainAssets[ticker].name,
-            decimals: value.assets[ticker].decimals
-        }
-    }
-    return {
-        getToken: (address: string) => addressMap[address]
-    };
-});
+import {
+    BitcoinNetwork, BitcoinTokens,
+    BtcToken, IndexedDBStorageManager, isToken,
+    MempoolApi,
+    MempoolBitcoinRpc,
+    RedundantSwapPrice,
+    RedundantSwapPriceAssets,
+    SCToken,
+    Swapper,
+    SwapperOptions, Token
+} from "crosslightning-sdk-base";
+import {objectMap} from "crosslightning-sdk-base/dist/utils/Utils";
+import {SdkSolana, SdkSolanaType} from "./chains/solana/SolanaChainInitializer";
+import {SdkChain} from "./chains/ChainInitializer";
+import * as BN from "bn.js";
+import {SmartChainAssets} from "./SmartChainAssets";
+import {IStorageManager, StorageObject} from "crosslightning-base";
+
+type Chains = {
+    "SOLANA": SdkSolanaType
+};
+
+const Chains: {
+    [C in keyof Chains]: SdkChain<Chains[C]>
+} = {
+    "SOLANA": SdkSolana
+} as const;
+
+type SdkMultichain = { [C in keyof Chains]: Chains[C]["ChainType"] };
+
+export type MultichainSwapperOptions = SwapperOptions & {
+    chains: {
+        [C in keyof Chains]: Chains[C]["Options"]
+    }
+} & {
+    storageCtor?: <T extends StorageObject>(name: string) => IStorageManager<T>,
+    pricingFeeDifferencePPM?: BN
+};
+
+export class MultichainSwapper extends Swapper<SdkMultichain> {
+
+    constructor(options: MultichainSwapperOptions) {
+        options.bitcoinNetwork ??= BitcoinNetwork.MAINNET;
+        options.storagePrefix ??= "atomiqsdk-"+options.bitcoinNetwork;
+        options.storageCtor ??= (name: string) => new IndexedDBStorageManager(name);
+
+        options.registryUrl ??= options.bitcoinNetwork===BitcoinNetwork.MAINNET ?
+            "https://api.github.com/repos/adambor/SolLightning-registry/contents/registry-mainnet.json?ref=main" :
+            "https://api.github.com/repos/adambor/SolLightning-registry/contents/registry.json?ref=main";
+
+        const mempoolApi = new MempoolApi(
+            options.bitcoinNetwork===BitcoinNetwork.TESTNET ?
+                "https://mempool.space/testnet/api/" :
+                "https://mempool.space/api/"
+        );
+        const bitcoinRpc = new MempoolBitcoinRpc(mempoolApi);
+
+        const pricingAssets: (RedundantSwapPriceAssets<SdkMultichain>[number] & {ticker: string, name: string})[] = [];
+        Object.keys(SmartChainAssets).forEach((ticker) => {
+            const chains: any = {};
+            for(let chainId in Chains) {
+                if(Chains[chainId].assets[ticker]!=null) chains[chainId] = Chains[chainId].assets[ticker];
+            }
+            const assetData = SmartChainAssets[ticker];
+            pricingAssets.push({
+                ...assetData.pricing,
+                chains,
+                ticker,
+                name: assetData.name
+            })
+        });
+
+        const ctorChainData = objectMap(Chains, (value, key) => {
+            return value.getCtorData(options, bitcoinRpc, options.bitcoinNetwork);
+        });
+
+        super(
+            bitcoinRpc,
+            ctorChainData,
+            RedundantSwapPrice.createFromTokenMap<SdkMultichain>(options.pricingFeeDifferencePPM ?? new BN(10000), pricingAssets),
+            pricingAssets,
+            options
+        );
+    }
+
+}
+
+export const Tokens: {
+    [C in keyof Chains]: {
+        [T in keyof Chains[C]["Assets"]]: SCToken<C>
+    }
+} & {
+    BITCOIN: {
+        BTC: BtcToken<false>,
+        BTCLN: BtcToken<true>
+    }
+} = {
+    ...objectMap(Chains, (value, key) => {
+        return objectMap(value.assets, (assetData, ticker) => {
+            return {
+                chain: "SC",
+                chainId: value.chainIdentifier,
+                address: assetData.address,
+                name: SmartChainAssets[ticker].name,
+                decimals: assetData.decimals,
+                ticker
+            }
+        });
+    }),
+    BITCOIN: BitcoinTokens
+};
+
+export const TokenResolver: {
+    [C in keyof Chains]: {
+        getToken(address: string): SCToken<C>
+    }
+} = {
+    ...objectMap(Chains, (value, key) => {
+        const addressMap: {[tokenAddress: string]: SCToken} = {};
+        for(let ticker in value.assets) {
+            addressMap[value.assets[ticker].address] = {
+                chain: "SC",
+                chainId: value.chainIdentifier,
+                address: value.assets[ticker].address,
+                ticker,
+                name: SmartChainAssets[ticker].name,
+                decimals: value.assets[ticker].decimals
+            }
+        }
+        return {
+            getToken: (address: string) => addressMap[address]
+        };
+    })
+};

package/src/SmartChainAssets.ts

@@ -1,57 +1,57 @@
-
-export const SmartChainAssets = {
-    WBTC: {
-        pricing: {
-            binancePair: "WBTCBTC",
-            okxPair: "$fixed-1",
-            coinGeckoCoinId: "wrapped-bitcoin",
-            coinPaprikaCoinId: "wbtc-wrapped-bitcoin"
-        },
-        name: "Wrapped BTC"
-    },
-    USDC: {
-        pricing: {
-            binancePair: "!BTCUSDC",
-            okxPair: "!BTC-USDC",
-            coinGeckoCoinId: "usd-coin",
-            coinPaprikaCoinId: "usdc-usd-coin"
-        },
-        name: "USD Circle"
-    },
-    USDT: {
-        pricing: {
-            binancePair: "!BTCUSDT",
-            okxPair: "!BTC-USDT",
-            coinGeckoCoinId: "tether",
-            coinPaprikaCoinId: "usdt-tether"
-        },
-        name: "Tether USD"
-    },
-    SOL: {
-        pricing: {
-            binancePair: "SOLBTC",
-            okxPair: "SOL-BTC",
-            coinGeckoCoinId: "solana",
-            coinPaprikaCoinId: "sol-solana"
-        },
-        name: "Solana"
-    },
-    BONK: {
-        pricing: {
-            binancePair: "BONKUSDC;!BTCUSDC",
-            okxPair: null,
-            coinGeckoCoinId: "bonk",
-            coinPaprikaCoinId: "bonk-bonk"
-        },
-        name: "Bonk"
-    }
-} as const;
-
-export type SmartChainAssetTickers = keyof typeof SmartChainAssets;
-
-export type AssetData = {
-    [ticker in SmartChainAssetTickers]?: {
-        address: string,
-        decimals: number
-    }
-};
+
+export const SmartChainAssets = {
+    WBTC: {
+        pricing: {
+            binancePair: "WBTCBTC",
+            okxPair: "$fixed-1",
+            coinGeckoCoinId: "wrapped-bitcoin",
+            coinPaprikaCoinId: "wbtc-wrapped-bitcoin"
+        },
+        name: "Wrapped BTC"
+    },
+    USDC: {
+        pricing: {
+            binancePair: "!BTCUSDC",
+            okxPair: "!BTC-USDC",
+            coinGeckoCoinId: "usd-coin",
+            coinPaprikaCoinId: "usdc-usd-coin"
+        },
+        name: "USD Circle"
+    },
+    USDT: {
+        pricing: {
+            binancePair: "!BTCUSDT",
+            okxPair: "!BTC-USDT",
+            coinGeckoCoinId: "tether",
+            coinPaprikaCoinId: "usdt-tether"
+        },
+        name: "Tether USD"
+    },
+    SOL: {
+        pricing: {
+            binancePair: "SOLBTC",
+            okxPair: "SOL-BTC",
+            coinGeckoCoinId: "solana",
+            coinPaprikaCoinId: "sol-solana"
+        },
+        name: "Solana"
+    },
+    BONK: {
+        pricing: {
+            binancePair: "BONKUSDC;!BTCUSDC",
+            okxPair: null,
+            coinGeckoCoinId: "bonk",
+            coinPaprikaCoinId: "bonk-bonk"
+        },
+        name: "Bonk"
+    }
+} as const;
+
+export type SmartChainAssetTickers = keyof typeof SmartChainAssets;
+
+export type AssetData = {
+    [ticker in SmartChainAssetTickers]?: {
+        address: string,
+        decimals: number
+    }
+};

package/src/chains/ChainInitializer.ts

@@ -1,16 +1,16 @@
-import {BitcoinRpc, ChainType} from "crosslightning-base";
-import {BitcoinNetwork, CtorChainData, SwapperOptions} from "crosslightning-sdk-base";
-import {AssetData} from "../SmartChainAssets";
-
-
-export type SdkChainType = {
-    ChainType: ChainType,
-    Options: {},
-    Assets: AssetData
-}
-
-export type SdkChain<T extends SdkChainType> = {
-    getCtorData: (options: SwapperOptions, bitcoinRpc: BitcoinRpc<any>, network: BitcoinNetwork) => CtorChainData<T["ChainType"]>,
-    assets: AssetData,
-    chainIdentifier: string
-};
+import {BitcoinRpc, ChainType} from "crosslightning-base";
+import {BitcoinNetwork, CtorChainData, SwapperOptions} from "crosslightning-sdk-base";
+import {AssetData} from "../SmartChainAssets";
+
+
+export type SdkChainType = {
+    ChainType: ChainType,
+    Options: {},
+    Assets: AssetData
+}
+
+export type SdkChain<T extends SdkChainType> = {
+    getCtorData: (options: SwapperOptions, bitcoinRpc: BitcoinRpc<any>, network: BitcoinNetwork) => CtorChainData<T["ChainType"]>,
+    assets: AssetData,
+    chainIdentifier: string
+};

package/src/chains/solana/SolanaChainInitializer.ts

@@ -1,97 +1,101 @@
-import {
-    SolanaBtcRelay,
-    SolanaChainType, SolanaFees, SolanaRetryPolicy,
-    SolanaSwapData,
-    SolanaSwapProgram,
-    StoredDataAccount
-} from "crosslightning-solana";
-import {
-    BitcoinNetwork,
-    CtorChainData
-} from "crosslightning-sdk-base";
-import {BitcoinRpc, IStorageManager} from "crosslightning-base";
-import {Connection} from "@solana/web3.js";
-import {SolanaChains} from "./SolanaChains";
-import {SolanaChainEventsBrowser} from "crosslightning-solana/dist/solana/events/SolanaChainEventsBrowser";
-import {SdkChain} from "../ChainInitializer";
-import {MultichainSwapperOptions} from "../../MultichainSwapper";
-
-const chainId = "SOLANA" as const;
-
-type SolanaSwapperOptions = {
-    rpcUrl: string,
-    dataAccountStorage?: IStorageManager<StoredDataAccount>,
-    retryPolicy?: SolanaRetryPolicy,
-
-    btcRelayContract?: string,
-    swapContract?: string,
-
-    trustedIntermediary?: string
-};
-
-function getSolanaCtorData(options: MultichainSwapperOptions, bitcoinRpc: BitcoinRpc<any>, network: BitcoinNetwork): CtorChainData<SolanaChainType> {
-    const connection = new Connection(options.chains.SOLANA.rpcUrl);
-
-    const Fees = new SolanaFees(connection, 200000, 2, 100);
-    const btcRelay = new SolanaBtcRelay(connection, bitcoinRpc, options.chains.SOLANA.btcRelayContract ?? SolanaChains[network].addresses.btcRelayContract, Fees);
-    const swapContract = new SolanaSwapProgram(
-        connection,
-        btcRelay,
-        options.chains.SOLANA.dataAccountStorage || options.storageCtor("solAccounts"),
-        options.chains.SOLANA.swapContract ?? SolanaChains[network].addresses.swapContract,
-        options.chains.SOLANA.retryPolicy ?? {transactionResendInterval: 1000},
-        Fees
-    )
-    const chainEvents = new SolanaChainEventsBrowser(connection, swapContract);
-
-    return {
-        btcRelay,
-        swapContract,
-        chainEvents,
-        swapDataConstructor: SolanaSwapData,
-        defaultTrustedIntermediaryUrl: options.chains.SOLANA.trustedIntermediary ?? SolanaChains[network].trustedSwapForGasUrl,
-        //These are defined here to keep the data from old SolLightning-sdk, not needed for other chains
-        storage: {
-            toBtc: options.storageCtor("SOLv4-"+options.bitcoinNetwork+"-Swaps-ToBTC"),
-            toBtcLn: options.storageCtor("SOLv4-"+options.bitcoinNetwork+"-Swaps-ToBTCLN"),
-            fromBtc: options.storageCtor("SOLv4-"+options.bitcoinNetwork+"-Swaps-FromBTC"),
-            fromBtcLn: options.storageCtor("SOLv4-"+options.bitcoinNetwork+"-Swaps-FromBTCLN"),
-            lnForGas: options.storageCtor("SOLv4-"+options.bitcoinNetwork+"-Swaps-LnForGas")
-        }
-    }
-}
-
-const SolanaAssets = {
-    WBTC: {
-        address: "3NZ9JMVBmGAqocybic2c7LQCJScmgsAZ6vQqTDzcqmJh",
-        decimals: 8
-    },
-    USDC: {
-        address: "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
-        decimals: 6
-    },
-    USDT: {
-        address: "Es9vMFrzaCERmJfrF4H2FYD4KCoNkY11McCe8BenwNYB",
-        decimals: 6
-    },
-    SOL: {
-        address: "So11111111111111111111111111111111111111112",
-        decimals: 9
-    },
-    BONK: {
-        address: "DezXAZ8z7PnrnRJjz3wXBoRgixCa6xjnB7YaB1pPB263",
-        decimals: 5
-    }
-} as const;
-
-export type SdkSolanaType = {
-    ChainType: SolanaChainType,
-    Options: SolanaSwapperOptions,
-    Assets: typeof SolanaAssets
-};
-
-export const SdkSolana: SdkChain<SdkSolanaType> = {
-    getCtorData: getSolanaCtorData,
-    assets: SolanaAssets,
-    chainIdentifier: chainId
-} as const;
+import {
+    SolanaBtcRelay,
+    SolanaChainType, SolanaFees, SolanaRetryPolicy,
+    SolanaSwapData,
+    SolanaSwapProgram,
+    StoredDataAccount
+} from "crosslightning-solana";
+import {
+    BitcoinNetwork,
+    CtorChainData
+} from "crosslightning-sdk-base";
+import {BitcoinRpc, IStorageManager} from "crosslightning-base";
+import {Connection} from "@solana/web3.js";
+import {SolanaChains} from "./SolanaChains";
+import {SolanaChainEventsBrowser} from "crosslightning-solana/dist/solana/events/SolanaChainEventsBrowser";
+import {SdkChain} from "../ChainInitializer";
+import {MultichainSwapperOptions} from "../../MultichainSwapper";
+
+const chainId = "SOLANA" as const;
+
+type SolanaSwapperOptions = {
+    rpcUrl: string | Connection,
+    dataAccountStorage?: IStorageManager<StoredDataAccount>,
+    retryPolicy?: SolanaRetryPolicy,
+
+    btcRelayContract?: string,
+    swapContract?: string,
+
+    trustedIntermediary?: string,
+
+    fees?: SolanaFees
+};
+
+function getSolanaCtorData(options: MultichainSwapperOptions, bitcoinRpc: BitcoinRpc<any>, network: BitcoinNetwork): CtorChainData<SolanaChainType> {
+    const connection = typeof(options.chains.SOLANA.rpcUrl)==="string" ?
+        new Connection(options.chains.SOLANA.rpcUrl) :
+        options.chains.SOLANA.rpcUrl;
+
+    const Fees = options.chains.SOLANA.fees ?? new SolanaFees(connection, 200000, 4, 100);
+    const btcRelay = new SolanaBtcRelay(connection, bitcoinRpc, options.chains.SOLANA.btcRelayContract ?? SolanaChains[network].addresses.btcRelayContract, Fees);
+    const swapContract = new SolanaSwapProgram(
+        connection,
+        btcRelay,
+        options.chains.SOLANA.dataAccountStorage || options.storageCtor("solAccounts"),
+        options.chains.SOLANA.swapContract ?? SolanaChains[network].addresses.swapContract,
+        options.chains.SOLANA.retryPolicy ?? {transactionResendInterval: 1000},
+        Fees
+    )
+    const chainEvents = new SolanaChainEventsBrowser(connection, swapContract);
+
+    return {
+        btcRelay,
+        swapContract,
+        chainEvents,
+        swapDataConstructor: SolanaSwapData,
+        defaultTrustedIntermediaryUrl: options.chains.SOLANA.trustedIntermediary ?? SolanaChains[network].trustedSwapForGasUrl,
+        //These are defined here to keep the data from old SolLightning-sdk, not needed for other chains
+        storage: {
+            toBtc: options.storageCtor("SOLv4-"+options.bitcoinNetwork+"-Swaps-ToBTC"),
+            toBtcLn: options.storageCtor("SOLv4-"+options.bitcoinNetwork+"-Swaps-ToBTCLN"),
+            fromBtc: options.storageCtor("SOLv4-"+options.bitcoinNetwork+"-Swaps-FromBTC"),
+            fromBtcLn: options.storageCtor("SOLv4-"+options.bitcoinNetwork+"-Swaps-FromBTCLN"),
+            lnForGas: options.storageCtor("SOLv4-"+options.bitcoinNetwork+"-Swaps-LnForGas")
+        }
+    }
+}
+
+const SolanaAssets = {
+    WBTC: {
+        address: "3NZ9JMVBmGAqocybic2c7LQCJScmgsAZ6vQqTDzcqmJh",
+        decimals: 8
+    },
+    USDC: {
+        address: "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
+        decimals: 6
+    },
+    USDT: {
+        address: "Es9vMFrzaCERmJfrF4H2FYD4KCoNkY11McCe8BenwNYB",
+        decimals: 6
+    },
+    SOL: {
+        address: "So11111111111111111111111111111111111111112",
+        decimals: 9
+    },
+    BONK: {
+        address: "DezXAZ8z7PnrnRJjz3wXBoRgixCa6xjnB7YaB1pPB263",
+        decimals: 5
+    }
+} as const;
+
+export type SdkSolanaType = {
+    ChainType: SolanaChainType,
+    Options: SolanaSwapperOptions,
+    Assets: typeof SolanaAssets
+};
+
+export const SdkSolana: SdkChain<SdkSolanaType> = {
+    getCtorData: getSolanaCtorData,
+    assets: SolanaAssets,
+    chainIdentifier: chainId
+} as const;