@defisaver/automation-sdk 1.0.1

package/src/types/enums.ts

@@ -0,0 +1,108 @@
+export enum ChainId {
+  Ethereum = 1,
+  Optimism = 10,
+  Arbitrum = 42161,
+}
+
+export enum RatioState {
+  OVER = 0,
+  UNDER = 1,
+}
+
+export enum BundleProtocols {
+  MStable = 'mstable',
+  Yearn = 'yearn',
+  Rari = 'rari',
+}
+
+/**
+ * @dev Follow the naming convention:
+ *      - Enum name consists of two parts, name and version
+ *      - Name should be human-readable name of the protocol, it can include spaces or any characters needed
+ *      - Version should be separated from the name with double underscores `__` (If there is no version leave it out)
+ *      - Example `Name of ThePROTOCOL__v1` (Without version `Name of ThePROTOCOL`)
+ */
+export namespace ProtocolIdentifiers {
+  export enum StrategiesAutomation {
+    MakerDAO = 'MakerDAO__MCD',
+    Liquity = 'Liquity',
+    ChickenBonds = 'ChickenBonds',
+    CompoundV3 = 'Compound__V3',
+    AaveV3 = 'Aave__V3',
+  }
+
+  export enum LegacyAutomation {
+    MakerDAO = 'MakerDAO__MCD',
+    CompoundV2 = 'Compound__V2',
+    AaveV2 = 'Aave__V2',
+  }
+}
+
+export namespace Strategies {
+  export enum MainnetIds {
+    MAKER_CLOSE_ON_PRICE_TO_DAI = 7,
+    MAKER_CLOSE_ON_PRICE_TO_COLL = 9,
+    LIQUITY_CLOSE_ON_PRICE_TO_COLL_DEPRECATED = 10, // replaced with 14
+    MAKER_TRAILING_STOP_LOSS_TO_COLL = 11,
+    MAKER_TRAILING_STOP_LOSS_TO_DAI = 12,
+    LIQUITY_TRAILING_STOP_LOSS_TO_COLL = 13,
+    LIQUITY_CLOSE_ON_PRICE_TO_COLL = 14,
+    CHICKEN_BONDS_REBOND = 31,
+  }
+
+  export enum OptimismIds {}
+
+  export enum ArbitrumIds {}
+
+  export enum Identifiers {
+    SavingsLiqProtection = 'smart-savings-liquidation-protection',
+    Repay = 'repay',
+    EoaRepay = 'eoa-repay',
+    Boost = 'boost',
+    EoaBoost = 'eoa-boost',
+    CloseToDebt = 'close-to-debt',
+    CloseToCollateral = 'close-to-collateral',
+    CloseOnPriceToDebt = 'close-on-price-to-debt',
+    CloseOnPriceToColl = 'close-on-price-to-collateral',
+    TrailingStopToColl = 'trailing-stop-to-collateral',
+    TrailingStopToDebt = 'trailing-stop-to-debt',
+    Rebond = 'rebond',
+    BondProtection = 'bond-protection',
+  }
+  export enum IdOverrides {
+    TakeProfit = 'take-profit',
+    StopLoss = 'stop-loss',
+    TrailingStop = 'trailing-stop',
+    LeverageManagement = 'leverage-management',
+    EoaLeverageManagement = 'leverage-management-eoa',
+  }
+}
+
+export namespace Bundles {
+  export enum MainnetIds {
+    MAKER_REPAY_FROM_SMART_SAVINGS_YEARN = 0,
+    MAKER_REPAY_FROM_SMART_SAVINGS_MSTABLE = 1,
+    MAKER_REPAY_FROM_SMART_SAVINGS_RARI = 2,
+    COMP_V3_SW_REPAY_BUNDLE = 3,
+    COMP_V3_SW_BOOST_BUNDLE = 4,
+    COMP_V3_EOA_REPAY_BUNDLE = 5,
+    COMP_V3_EOA_BOOST_BUNDLE = 6,
+    LIQUITY_PAYBACK_USING_CHICKEN_BOND = 7,
+  }
+
+  export enum OptimismIds {
+    AAVE_V3_REPAY = 0,
+    AAVE_V3_BOOST = 1,
+    AAVE_V3_CLOSE_TO_DEBT = 2,
+    AAVE_V3_CLOSE_TO_COLLATERAL = 3,
+  }
+
+  export enum ArbitrumIds {
+    AAVE_V3_REPAY = 0,
+    AAVE_V3_BOOST = 1,
+    AAVE_V3_CLOSE_TO_DEBT = 2,
+    AAVE_V3_CLOSE_TO_COLLATERAL = 3,
+  }
+}
+
+

package/src/types/index.ts

@@ -0,0 +1,217 @@
+import type Web3 from 'web3';
+import type { AbiItem } from 'web3-utils';
+import type { BaseContract, BlockType } from './contracts/generated/types';
+import type { Subscribe, StrategyModel } from './contracts/generated/SubStorage';
+import type {
+  ChainId, Strategies, Bundles, ProtocolIdentifiers,
+  RatioState,
+} from './enums';
+
+export type PlaceholderType = any; // TODO - fix any types
+
+export type EthereumAddress = string;
+
+export type BlockNumber = BlockType;
+
+export declare namespace Utils {
+  type WithOptional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+
+  type WithRequired<T, K extends keyof T> = Partial<Omit<T, K>> & Required<Pick<T, K>>;
+
+  type ValuesOf<E> = E[keyof E];
+
+  type EnumUnion<T> = {
+    [k in keyof T]: ValuesOf<T[k]>;
+  }[keyof T];
+}
+
+export declare namespace Contract {
+  interface Json {
+    abi: AbiItem[],
+    networks?: {
+      [key in ChainId as string]: {
+        createdBlock?: number,
+        address: EthereumAddress,
+      }
+    }
+  }
+
+  interface WithMeta<T> {
+    abi: AbiItem[],
+    address: EthereumAddress,
+    createdBlock: BlockNumber,
+    contract: T,
+  }
+}
+
+export declare namespace Multicall {
+  interface Calls {
+    abiItem: AbiItem,
+    target: EthereumAddress,
+    gasLimit?: number,
+    params: any[],
+  }
+
+  interface FormattedCalls {
+    callData: string,
+    target: EthereumAddress,
+    gasLimit: number,
+  }
+
+  type Payload = any[];
+}
+
+export interface SubscriptionOptions {
+  toBlock: BlockNumber,
+  fromBlock: BlockNumber,
+  mergeWithSameId?: boolean,
+}
+
+export declare namespace Interfaces {
+  interface ProtocolBase {
+    id: ProtocolIdentifiers.StrategiesAutomation | ProtocolIdentifiers.LegacyAutomation,
+    name: string,
+    fullName: string,
+    version: string,
+  }
+
+  interface Protocol extends ProtocolBase {
+    id: ProtocolIdentifiers.StrategiesAutomation,
+  }
+
+  interface LegacyProtocol extends ProtocolBase {
+    id: ProtocolIdentifiers.LegacyAutomation,
+  }
+
+  interface Automation {
+    provider: Web3,
+  }
+  interface LegacyAutomation<T extends BaseContract> {
+    provider: Web3,
+    monitorAddress: EthereumAddress,
+    protocol: Interfaces.LegacyProtocol,
+    subscriptionsJson: Contract.WithMeta<T>,
+  }
+}
+
+export interface Strategy {
+  strategyId: Strategies.Identifiers | Strategies.IdOverrides,
+  protocol: Interfaces.Protocol,
+  isBundle?: boolean,
+}
+
+export interface BundleOrStrategy extends Strategy {
+  bundleId?: string,
+  bundleName?: string,
+}
+
+export type TriggerData = StrategyModel.StrategySubStructOutputStruct['triggerData'];
+export type SubData = StrategyModel.StrategySubStructOutputStruct['subData'];
+
+export declare namespace Position {
+  namespace Specific {
+    interface Base {
+      subId1?: number,
+      subId2?: number,
+      mergeWithSameId?: boolean
+    }
+    interface RatioProtection extends Base {
+      minRatio?: number,
+      minOptimalRatio?: number,
+      repayEnabled?: boolean,
+      maxRatio?: number,
+      maxOptimalRatio?: number,
+      boostEnabled?: boolean,
+    }
+    interface CloseOnPrice extends Base {
+      price: string,
+      closeToAssetAddr: EthereumAddress,
+    }
+    interface CloseOnPriceAave extends Base {
+      collAsset: EthereumAddress,
+      collAssetId: number,
+      debtAsset: EthereumAddress,
+      debtAssetId: number,
+      baseToken: EthereumAddress,
+      quoteToken: EthereumAddress,
+      price: string,
+      ratioState: RatioState,
+    }
+    interface TrailingStop extends Base {
+      roundId: number,
+      triggerPercentage: number,
+      closeToAssetAddr: EthereumAddress,
+    }
+  }
+
+  export interface Automated {
+    chainId: ChainId,
+    owner: EthereumAddress,
+    subId: number,
+    subIds?: number[],
+    isEnabled?: boolean,
+    protocol: Interfaces.Protocol,
+    strategy: BundleOrStrategy,
+    strategyData: {
+      encoded: {
+        triggerData: TriggerData,
+        subData: SubData,
+      },
+      decoded: { // TODO type this?
+        triggerData: PlaceholderType,
+        subData: PlaceholderType,
+      },
+    },
+    specific: Specific.CloseOnPrice | Specific.TrailingStop | Specific.RatioProtection | Specific.CloseOnPriceAave,
+  }
+
+  interface LegacyAutomated {
+    chainId: ChainId,
+    owner: EthereumAddress,
+    isEnabled: boolean,
+    protocol: Interfaces.LegacyProtocol,
+    specific: any,
+  }
+}
+
+
+type StrategyInfo<T extends number> = Record<T, Strategy>;
+export type MainnetStrategiesInfo = StrategyInfo<Strategies.MainnetIds>;
+export type OptimismStrategiesInfo = StrategyInfo<Strategies.OptimismIds>;
+export type ArbitrumStrategiesInfo = StrategyInfo<Strategies.ArbitrumIds>;
+
+type BundleInfo<T extends number> = Record<T, BundleOrStrategy>;
+export type MainnetBundleInfo = BundleInfo<Bundles.MainnetIds>;
+export type OptimismBundleInfo = BundleInfo<Bundles.OptimismIds>;
+export type ArbitrumBundleInfo = BundleInfo<Bundles.ArbitrumIds>;
+
+export interface StrategiesInfo {
+  [ChainId.Ethereum]: MainnetStrategiesInfo,
+  [ChainId.Optimism]: OptimismStrategiesInfo,
+  [ChainId.Arbitrum]: ArbitrumStrategiesInfo
+}
+
+export interface BundlesInfo {
+  [ChainId.Ethereum]: MainnetBundleInfo,
+  [ChainId.Optimism]: OptimismBundleInfo,
+  [ChainId.Arbitrum]: ArbitrumBundleInfo
+}
+
+export type StrategyOrBundleIds =
+  Strategies.MainnetIds & Strategies.OptimismIds & Strategies.ArbitrumIds
+  & Bundles.MainnetIds & Bundles.OptimismIds & Bundles.ArbitrumIds;
+
+
+export interface ParseData {
+  chainId: ChainId,
+  subscriptionEventData: Subscribe['returnValues']
+  strategiesSubsData: StrategyModel.StoredSubDataStructOutputStruct,
+}
+
+type MapToProtocolVersion<T> = {
+  [i in ProtocolIdentifiers.StrategiesAutomation]: {
+    [key in Strategies.Identifiers as string]: T
+  }
+};
+
+export type StrategiesToProtocolVersionMapping = MapToProtocolVersion<(position: Position.Automated, parseData: ParseData) => Position.Automated>;

package/src/types/typings/process.d.ts

@@ -0,0 +1,9 @@
+import type Web3 from 'web3';
+
+declare global {
+  module NodeJS {
+    interface Process {
+      mockedWeb3: Web3
+    }
+  }
+}

package/tsconfig.json

@@ -0,0 +1,79 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig.json to read more about this file */
+
+    /* Basic Options */
+    // "incremental": true,                   /* Enable incremental compilation */
+    "target": "ES2015",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
+    "module": "ESNext",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
+    // "lib": [],                             /* Specify library files to be included in the compilation. */
+    "allowJs": true,                       /* Allow javascript files to be compiled. */
+    // "checkJs": true,                       /* Report errors in .js files. */
+    // "jsx": "react",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
+    "declaration": true,                   /* Generates corresponding '.d.ts' file. */
+    // "emitDeclarationOnly": false,
+    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
+    // "sourceMap": true,                     /* Generates corresponding '.map' file. */
+    // "outFile": "./",                       /* Concatenate and emit output to single file. */
+    "outDir": "./esm/",                        /* Redirect output structure to the directory. */
+    // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+    // "composite": true,                     /* Enable project compilation */
+    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
+    // "removeComments": true,                /* Do not emit comments to output. */
+    // "noEmit": true,                        /* Do not emit outputs. */
+    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
+    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+
+    /* Strict Type-Checking Options */
+    "strict": true,                           /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,              /* Enable strict null checks. */
+    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
+    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
+    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
+    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
+    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
+    "resolveJsonModule": true,
+
+    /* Additional Checks */
+    // "noUnusedLocals": true,                /* Report errors on unused locals. */
+    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
+    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
+    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
+    // "noUncheckedIndexedAccess": true,      /* Include 'undefined' in index signature results */
+
+    /* Module Resolution Options */
+    "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
+    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
+    //"typeRoots": ["utils.ts"],                       /* List of folders to include type definitions from. */
+    //"types": ["./src/utils.ts"],                           /* Type declaration files to be included in compilation. */
+    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+    "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
+    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */
+
+    /* Source Map Options */
+    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
+    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+
+    /* Experimental Options */
+    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
+    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
+
+    /* Advanced Options */
+    "skipLibCheck": true,                     /* Skip type checking of declaration files. */
+    "forceConsistentCasingInFileNames": true  /* Disallow inconsistently-cased references to the same file. */
+  },
+  "include": [
+    "./src/**/*",
+  ],
+  "typedocOptions": {
+    "entryPoints": ["./src/index.ts"],
+    "out": "docs",
+  }
+}