@0xsquid/squid-types 0.1.1

package/dist/chains/index.d.ts

@@ -0,0 +1,127 @@
+import { StringOrNumber } from "../index";
+export declare enum ChainType {
+    EVM = "evm",
+    COSMOS = "cosmos"
+}
+export type BaseChain = {
+    chainId: StringOrNumber;
+    chainType: ChainType;
+    chainName: ChainName;
+    networkName: string;
+    rpc: string;
+    internalRpc: string;
+    chainIconURI: string;
+    blockExplorerUrls: string[];
+    estimatedRouteDuration: number;
+    swapAmountForGas: string;
+    nativeCurrency: {
+        name: string;
+        symbol: string;
+        decimals: number;
+        icon: string;
+    };
+    squidContracts: {
+        defaultCrosschainToken: string;
+        squidRouter?: string;
+        squidMulticall?: string;
+    };
+    axelarContracts: {
+        gateway: string;
+        forecallable?: string;
+    };
+};
+export type EvmChain = BaseChain & {
+    chainNativeContracts: {
+        wrappedNativeToken: string;
+        ensRegistry: string;
+        multicall: string;
+        usdcToken: string;
+    };
+    gas?: {
+        lastBaseFeePerGas: string;
+        maxFeePerGas: string;
+        maxPriorityFeePerGas: string;
+        gasPrice: string;
+    };
+};
+export type CosmosChain = BaseChain & {
+    rest: string;
+    stakeCurrency: CosmosCurrency;
+    walletUrl?: string;
+    walletUrlForStaking?: string;
+    bip44: BIP44;
+    alternativeBIP44s?: BIP44[];
+    bech32Config: Bech32Config;
+    currencies: CosmosCurrency[];
+    feeCurrencies: CosmosCurrency[];
+    coinType?: number;
+    features?: string[];
+    gasPriceStep?: CosmosGasType;
+    chainToAxelarChannelId: string;
+};
+export type CosmosCurrency = {
+    coinDenom: string;
+    coinMinimalDenom: string;
+    coinDecimals: number;
+    coingeckoId?: string;
+    gasPriceStep?: CosmosGasType;
+};
+export type BIP44 = {
+    coinType: number;
+};
+export type Bech32Config = {
+    bech32PrefixAccAddr: string;
+    bech32PrefixAccPub: string;
+    bech32PrefixValAddr: string;
+    bech32PrefixValPub: string;
+    bech32PrefixConsAddr: string;
+    bech32PrefixConsPub: string;
+};
+export type CosmosGasType = {
+    low: number;
+    average: number;
+    high: number;
+};
+export type ChainData = EvmChain | CosmosChain;
+export declare enum ChainName {
+    ARBITRUM = "Arbitrum",
+    ARBITRUM2 = "arbitrum",
+    AURORA = "aurora",
+    AVALANCHE = "Avalanche",
+    BASE = "base",
+    BINANCE = "binance",
+    CELO = "celo",
+    ETHEREUM = "Ethereum",
+    ETHEREUM2 = "Ethereum-2",
+    FANTOM = "Fantom",
+    FILECOIN = "filecoin",
+    KAVA = "kava",
+    MOONBEAM = "Moonbeam",
+    OPTIMISM = "optimism",
+    POLYGON = "Polygon",
+    AGORIC = "agoric",
+    ASSETMANTLE = "assetmantle",
+    AURA = "aura",
+    AXELARNET = "axelarnet",
+    CARBON = "carbon",
+    COMDEX = "comdex",
+    COSMOS = "cosmoshub",
+    CRESCENT = "crescent",
+    EMONEY = "e-money",
+    EVMOS = "evmos",
+    FETCH = "fetch",
+    INJECTIVE = "injective",
+    JUNO = "juno",
+    KI = "ki",
+    KUJIRA = "kujira",
+    OSMOSIS = "osmosis",
+    OSMOSIS5 = "osmosis-5",
+    REGEN = "regen",
+    SEI = "sei",
+    SECRET = "secret",
+    SECRETSNIP = "secret-snip",
+    STARGAZE = "stargaze",
+    STRIDE = "stride",
+    TERRA2 = "terra-2",
+    UMEE = "umee"
+}

package/dist/chains/index.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChainName = exports.ChainType = void 0;
+var ChainType;
+(function (ChainType) {
+    ChainType["EVM"] = "evm";
+    ChainType["COSMOS"] = "cosmos";
+})(ChainType = exports.ChainType || (exports.ChainType = {}));
+var ChainName;
+(function (ChainName) {
+    ChainName["ARBITRUM"] = "Arbitrum";
+    ChainName["ARBITRUM2"] = "arbitrum";
+    ChainName["AURORA"] = "aurora";
+    ChainName["AVALANCHE"] = "Avalanche";
+    ChainName["BASE"] = "base";
+    ChainName["BINANCE"] = "binance";
+    ChainName["CELO"] = "celo";
+    ChainName["ETHEREUM"] = "Ethereum";
+    ChainName["ETHEREUM2"] = "Ethereum-2";
+    ChainName["FANTOM"] = "Fantom";
+    ChainName["FILECOIN"] = "filecoin";
+    ChainName["KAVA"] = "kava";
+    ChainName["MOONBEAM"] = "Moonbeam";
+    ChainName["OPTIMISM"] = "optimism";
+    ChainName["POLYGON"] = "Polygon";
+    // Cosmos
+    ChainName["AGORIC"] = "agoric";
+    ChainName["ASSETMANTLE"] = "assetmantle";
+    ChainName["AURA"] = "aura";
+    ChainName["AXELARNET"] = "axelarnet";
+    ChainName["CARBON"] = "carbon";
+    ChainName["COMDEX"] = "comdex";
+    ChainName["COSMOS"] = "cosmoshub";
+    ChainName["CRESCENT"] = "crescent";
+    ChainName["EMONEY"] = "e-money";
+    ChainName["EVMOS"] = "evmos";
+    ChainName["FETCH"] = "fetch";
+    ChainName["INJECTIVE"] = "injective";
+    ChainName["JUNO"] = "juno";
+    ChainName["KI"] = "ki";
+    ChainName["KUJIRA"] = "kujira";
+    ChainName["OSMOSIS"] = "osmosis";
+    ChainName["OSMOSIS5"] = "osmosis-5";
+    ChainName["REGEN"] = "regen";
+    ChainName["SEI"] = "sei";
+    ChainName["SECRET"] = "secret";
+    ChainName["SECRETSNIP"] = "secret-snip";
+    ChainName["STARGAZE"] = "stargaze";
+    ChainName["STRIDE"] = "stride";
+    ChainName["TERRA2"] = "terra-2";
+    ChainName["UMEE"] = "umee";
+})(ChainName = exports.ChainName || (exports.ChainName = {}));
+//# sourceMappingURL=index.js.map

package/dist/chains/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/chains/index.ts"],"names":[],"mappings":";;;AAEA,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,8BAAiB,CAAA;AACnB,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB;AA0FD,IAAY,SA2CX;AA3CD,WAAY,SAAS;IACnB,kCAAqB,CAAA;IACrB,mCAAsB,CAAA;IACtB,8BAAiB,CAAA;IACjB,oCAAuB,CAAA;IACvB,0BAAa,CAAA;IACb,gCAAmB,CAAA;IACnB,0BAAa,CAAA;IACb,kCAAqB,CAAA;IACrB,qCAAwB,CAAA;IACxB,8BAAiB,CAAA;IACjB,kCAAqB,CAAA;IACrB,0BAAa,CAAA;IACb,kCAAqB,CAAA;IACrB,kCAAqB,CAAA;IACrB,gCAAmB,CAAA;IAEnB,SAAS;IACT,8BAAiB,CAAA;IACjB,wCAA2B,CAAA;IAC3B,0BAAa,CAAA;IACb,oCAAuB,CAAA;IACvB,8BAAiB,CAAA;IACjB,8BAAiB,CAAA;IACjB,iCAAoB,CAAA;IACpB,kCAAqB,CAAA;IACrB,+BAAkB,CAAA;IAClB,4BAAe,CAAA;IACf,4BAAe,CAAA;IACf,oCAAuB,CAAA;IACvB,0BAAa,CAAA;IACb,sBAAS,CAAA;IACT,8BAAiB,CAAA;IACjB,gCAAmB,CAAA;IACnB,mCAAsB,CAAA;IACtB,4BAAe,CAAA;IACf,wBAAW,CAAA;IACX,8BAAiB,CAAA;IACjB,uCAA0B,CAAA;IAC1B,kCAAqB,CAAA;IACrB,8BAAiB,CAAA;IACjB,+BAAkB,CAAA;IAClB,0BAAa,CAAA;AACf,CAAC,EA3CW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QA2CpB"}

package/dist/dexes/index.d.ts

@@ -0,0 +1,31 @@
+export declare enum DexName {
+    APESWAP = "apeswap",
+    APESWAP_V3 = "apeswap-v3",
+    CURVE = "curve",
+    KYBERSWAP_ELASTIC = "kyberswap-elastic",
+    PANCAKESWAP = "pancakeswap",
+    PANCAKESWAP_V3 = "pancakeswap-v3",
+    PANGOLIN = "pangolin",
+    QUICKSWAP = "quickswap",
+    QUICKSWAP_V3 = "quickswap-v3",
+    SPOOKYSWAP = "spookyswap",
+    STELLASWAP = "stellaswap",
+    SUSHISWAP = "sushiswap",
+    TRIDENT = "trident",
+    TRADERJOE = "traderjoe",
+    UBESWAP = "ubeswap",
+    UNISWAP_V2 = "uniswap-v2",
+    UNISWAP_V3 = "uniswap-v3",
+    ZYBERSWAP = "zyberswap"
+}
+export declare enum DexType {
+    UNISWAP_V2 = "uniswap-v2",
+    UNISWAP_V3 = "uniswap-v3",
+    CURVE_POOL = "curve",
+    ALGEBRA = "algebra",
+    TRIDENT = "trident",
+    KYBERSWAP_ELASTIC = "kyberswap-elastic",
+    SADDLE = "saddle",
+    WOMBAT = "wombat",
+    PLATYPUS = "Platypus"
+}

package/dist/dexes/index.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DexType = exports.DexName = void 0;
+// identifiers for dexes
+var DexName;
+(function (DexName) {
+    DexName["APESWAP"] = "apeswap";
+    DexName["APESWAP_V3"] = "apeswap-v3";
+    DexName["CURVE"] = "curve";
+    DexName["KYBERSWAP_ELASTIC"] = "kyberswap-elastic";
+    DexName["PANCAKESWAP"] = "pancakeswap";
+    DexName["PANCAKESWAP_V3"] = "pancakeswap-v3";
+    DexName["PANGOLIN"] = "pangolin";
+    DexName["QUICKSWAP"] = "quickswap";
+    DexName["QUICKSWAP_V3"] = "quickswap-v3";
+    DexName["SPOOKYSWAP"] = "spookyswap";
+    DexName["STELLASWAP"] = "stellaswap";
+    DexName["SUSHISWAP"] = "sushiswap";
+    DexName["TRIDENT"] = "trident";
+    DexName["TRADERJOE"] = "traderjoe";
+    DexName["UBESWAP"] = "ubeswap";
+    DexName["UNISWAP_V2"] = "uniswap-v2";
+    DexName["UNISWAP_V3"] = "uniswap-v3";
+    DexName["ZYBERSWAP"] = "zyberswap";
+    // ONCE WE START ADDING DEXES WE WILL BE MOVING THEM ABOVE
+    /*
+    CURVE_V2_CELO = "Curve_v2_celo",
+    ELLIPSIS = "Ellipsis",
+    STELLASWAP_SADDLE = "Stellaswap_Saddle",
+    PANCAKESWAP_STABLE = "Pancakeswap_stable",
+    PLATYPUS = "Platypus",
+    WOMBAT = "Wombat",
+    GMX = "GMX",
+    OSMOSIS = "Osmosis",
+    DUALITY = "Duality",
+    ONE_INCH = "1inch",
+    */
+})(DexName = exports.DexName || (exports.DexName = {}));
+// identifiers dex adapters
+var DexType;
+(function (DexType) {
+    DexType["UNISWAP_V2"] = "uniswap-v2";
+    DexType["UNISWAP_V3"] = "uniswap-v3";
+    DexType["CURVE_POOL"] = "curve";
+    DexType["ALGEBRA"] = "algebra";
+    DexType["TRIDENT"] = "trident";
+    DexType["KYBERSWAP_ELASTIC"] = "kyberswap-elastic";
+    DexType["SADDLE"] = "saddle";
+    DexType["WOMBAT"] = "wombat";
+    DexType["PLATYPUS"] = "Platypus";
+    // ONCE WE START ADDING DEXES WE WILL BE MOVING THEM ABOVE
+    /*
+    OSMOSIS = "Osmosis",
+    DUALITY = "Duality",
+    */
+})(DexType = exports.DexType || (exports.DexType = {}));
+//# sourceMappingURL=index.js.map

package/dist/dexes/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/dexes/index.ts"],"names":[],"mappings":";;;AAAA,wBAAwB;AACxB,IAAY,OAiCX;AAjCD,WAAY,OAAO;IACjB,8BAAmB,CAAA;IACnB,oCAAyB,CAAA;IACzB,0BAAe,CAAA;IACf,kDAAuC,CAAA;IACvC,sCAA2B,CAAA;IAC3B,4CAAiC,CAAA;IACjC,gCAAqB,CAAA;IACrB,kCAAuB,CAAA;IACvB,wCAA6B,CAAA;IAC7B,oCAAyB,CAAA;IACzB,oCAAyB,CAAA;IACzB,kCAAuB,CAAA;IACvB,8BAAmB,CAAA;IACnB,kCAAuB,CAAA;IACvB,8BAAmB,CAAA;IACnB,oCAAyB,CAAA;IACzB,oCAAyB,CAAA;IACzB,kCAAuB,CAAA;IAEvB,0DAA0D;IAC1D;;;;;;;;;;;MAWE;AACJ,CAAC,EAjCW,OAAO,GAAP,eAAO,KAAP,eAAO,QAiClB;AAED,2BAA2B;AAC3B,IAAY,OAgBX;AAhBD,WAAY,OAAO;IACjB,oCAAyB,CAAA;IACzB,oCAAyB,CAAA;IACzB,+BAAoB,CAAA;IACpB,8BAAmB,CAAA;IACnB,8BAAmB,CAAA;IACnB,kDAAuC,CAAA;IACvC,4BAAiB,CAAA;IACjB,4BAAiB,CAAA;IACjB,gCAAqB,CAAA;IAErB,0DAA0D;IAC1D;;;MAGE;AACJ,CAAC,EAhBW,OAAO,GAAP,eAAO,KAAP,eAAO,QAgBlB"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./chains";
+export * from "./dexes";
+export * from "./tokens";
+export type StringOrNumber = string | number;

package/dist/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./chains"), exports);
+__exportStar(require("./dexes"), exports);
+__exportStar(require("./tokens"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,0CAAwB;AACxB,2CAAyB"}

package/dist/tokens/index.d.ts

@@ -0,0 +1,28 @@
+import { ChainType, StringOrNumber } from "../index";
+export interface Token {
+    type: ChainType;
+    chainId: StringOrNumber;
+    name: string;
+    address: string;
+    symbol: string;
+    decimals: number;
+    logoURI?: string;
+    coingeckoId?: string;
+    redstoneId?: string;
+    commonKey?: string;
+    usdPrice?: number;
+    ibcDenom?: string;
+}
+export interface CosmosToken extends Token {
+    denom: string;
+    base_denom: string;
+    base_type: string;
+    dp_denom: string;
+    origin_chain: string;
+    decimal: number;
+    description: string;
+    image: string;
+}
+export interface EvmToken extends Token {
+    address: string;
+}

package/dist/tokens/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/tokens/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/tokens/index.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@0xsquid/squid-types",
+  "version": "0.1.1",
+  "description": "JS and TS types relating to 0xsquid related projects.",
+  "main": "dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "format": "prettier --write --loglevel warn \"./src/**/*.ts\"",
+    "clean": "rimraf dist tsconfig.tsbuildinfo",
+    "clean:all": "rimraf dist tsconfig.tsbuildinfo node_modules",
+    "prepare": "yarn build",
+    "build": "yarn clean && tsc"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/0xsquid/squid-core.git"
+  },
+  "publishConfig": {
+    "access": "restricted"
+  },
+  "keywords": [
+    "typescript",
+    "types",
+    "0xsquid",
+    "squidrouter"
+  ],
+  "author": "0xsquid",
+  "license": "Apache-2.0",
+  "devDependencies": {
+    "@typescript-eslint/eslint-plugin": "^5.59.8",
+    "typescript": "^4.9.5",
+    "eslint": "^8.41.0",
+    "eslint-config-prettier": "^8.8.0"
+  },
+  "peerDependencies": {
+    "typescript": ">=4.0.0"
+  },
+  "release-it": {
+    "plugins": {
+      "@release-it/conventional-changelog": {
+        "preset": "conventionalcommits",
+        "infile": "CHANGELOG.md"
+      }
+    },
+    "github": {
+      "release": true,
+      "tokenRef": "GITHUB_AUTH"
+    },
+    "git": {
+      "tagName": "squid-types-v${version}",
+      "pushRepo": "https://github.com/0xsquid/squid-core.git",
+      "commitMessage": "chore: branch cut release for squid-types v${version}"
+    },
+    "npm": {
+      "publish": false
+    }
+  }
+}