@defisaver/automation-sdk 3.1.1 → 3.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.babelrc +3 -3
- package/.editorconfig +9 -9
- package/.env.dev +4 -4
- package/.eslintignore +6 -6
- package/.eslintrc.js +39 -39
- package/.mocharc.json +4 -4
- package/.nvmrc +1 -1
- package/README.md +46 -46
- package/cjs/abis/Erc20.json +223 -223
- package/cjs/abis/SubStorage.json +21 -21
- package/cjs/abis/UniMulticall.json +17 -17
- package/cjs/abis/index.d.ts +9 -9
- package/cjs/abis/index.js +30 -30
- package/cjs/abis/legacy_AaveV2Subscriptions.json +8 -8
- package/cjs/abis/legacy_AuthCheck.json +8 -8
- package/cjs/abis/legacy_CompoundV2Subscriptions.json +9 -9
- package/cjs/abis/legacy_MakerSubscriptions.json +9 -9
- package/cjs/automation/private/Automation.d.ts +12 -12
- package/cjs/automation/private/Automation.js +42 -42
- package/cjs/automation/private/LegacyAutomation.d.ts +25 -25
- package/cjs/automation/private/LegacyAutomation.js +118 -118
- package/cjs/automation/private/LegacyProtocol.d.ts +22 -22
- package/cjs/automation/private/LegacyProtocol.js +41 -41
- package/cjs/automation/private/LegacyProtocol.test.d.ts +1 -1
- package/cjs/automation/private/LegacyProtocol.test.js +25 -25
- package/cjs/automation/private/Protocol.d.ts +22 -22
- package/cjs/automation/private/Protocol.js +41 -41
- package/cjs/automation/private/Protocol.test.d.ts +1 -1
- package/cjs/automation/private/Protocol.test.js +25 -25
- package/cjs/automation/private/StrategiesAutomation.d.ts +33 -33
- package/cjs/automation/private/StrategiesAutomation.js +181 -181
- package/cjs/automation/private/StrategiesAutomation.test.d.ts +1 -1
- package/cjs/automation/private/StrategiesAutomation.test.js +671 -671
- package/cjs/automation/public/ArbitrumStrategies.d.ts +5 -5
- package/cjs/automation/public/ArbitrumStrategies.js +13 -13
- package/cjs/automation/public/BaseStrategies.d.ts +5 -5
- package/cjs/automation/public/BaseStrategies.js +13 -13
- package/cjs/automation/public/EthereumStrategies.d.ts +5 -5
- package/cjs/automation/public/EthereumStrategies.js +13 -13
- package/cjs/automation/public/OptimismStrategies.d.ts +5 -5
- package/cjs/automation/public/OptimismStrategies.js +13 -13
- package/cjs/automation/public/legacy/LegacyAaveAutomation.d.ts +6 -6
- package/cjs/automation/public/legacy/LegacyAaveAutomation.js +20 -20
- package/cjs/automation/public/legacy/LegacyCompoundAutomation.d.ts +6 -6
- package/cjs/automation/public/legacy/LegacyCompoundAutomation.js +20 -20
- package/cjs/automation/public/legacy/LegacyMakerAutomation.d.ts +6 -6
- package/cjs/automation/public/legacy/LegacyMakerAutomation.js +20 -20
- package/cjs/configuration.d.ts +1 -1
- package/cjs/configuration.js +12 -12
- package/cjs/constants/index.d.ts +28 -28
- package/cjs/constants/index.js +489 -474
- package/cjs/index.d.ts +23 -23
- package/cjs/index.js +65 -65
- package/cjs/services/contractService.d.ts +12 -12
- package/cjs/services/contractService.js +54 -54
- package/cjs/services/ethereumService.d.ts +7 -7
- package/cjs/services/ethereumService.js +49 -49
- package/cjs/services/ethereumService.test.d.ts +1 -1
- package/cjs/services/ethereumService.test.js +242 -242
- package/cjs/services/strategiesService.d.ts +2 -2
- package/cjs/services/strategiesService.js +723 -723
- package/cjs/services/strategiesService.test.d.ts +1 -1
- package/cjs/services/strategiesService.test.js +110 -110
- package/cjs/services/strategySubService.d.ts +100 -100
- package/cjs/services/strategySubService.js +267 -264
- package/cjs/services/strategySubService.test.d.ts +1 -1
- package/cjs/services/strategySubService.test.js +936 -934
- package/cjs/services/subDataService.d.ts +192 -192
- package/cjs/services/subDataService.js +475 -475
- package/cjs/services/subDataService.test.d.ts +1 -1
- package/cjs/services/subDataService.test.js +1282 -1282
- package/cjs/services/triggerService.d.ts +191 -191
- package/cjs/services/triggerService.js +367 -367
- package/cjs/services/triggerService.test.d.ts +1 -1
- package/cjs/services/triggerService.test.js +926 -926
- package/cjs/services/utils.d.ts +25 -25
- package/cjs/services/utils.js +131 -131
- package/cjs/services/utils.test.d.ts +1 -1
- package/cjs/services/utils.test.js +376 -376
- package/cjs/types/contracts/generated/Erc20.d.ts +53 -53
- package/cjs/types/contracts/generated/Erc20.js +5 -5
- package/cjs/types/contracts/generated/Legacy_AaveV2Subscriptions.d.ts +129 -129
- package/cjs/types/contracts/generated/Legacy_AaveV2Subscriptions.js +5 -5
- package/cjs/types/contracts/generated/Legacy_AuthCheck.d.ts +20 -20
- package/cjs/types/contracts/generated/Legacy_AuthCheck.js +5 -5
- package/cjs/types/contracts/generated/Legacy_CompoundV2Subscriptions.d.ts +128 -128
- package/cjs/types/contracts/generated/Legacy_CompoundV2Subscriptions.js +5 -5
- package/cjs/types/contracts/generated/Legacy_MakerSubscriptions.d.ts +246 -246
- package/cjs/types/contracts/generated/Legacy_MakerSubscriptions.js +5 -5
- package/cjs/types/contracts/generated/SubStorage.d.ts +114 -114
- package/cjs/types/contracts/generated/SubStorage.js +5 -5
- package/cjs/types/contracts/generated/UniMulticall.d.ts +55 -55
- package/cjs/types/contracts/generated/UniMulticall.js +5 -5
- package/cjs/types/contracts/generated/index.d.ts +7 -7
- package/cjs/types/contracts/generated/index.js +2 -2
- package/cjs/types/contracts/generated/types.d.ts +54 -54
- package/cjs/types/contracts/generated/types.js +2 -2
- package/cjs/types/enums.d.ts +184 -181
- package/cjs/types/enums.js +206 -203
- package/cjs/types/index.d.ts +224 -224
- package/cjs/types/index.js +2 -2
- package/esm/abis/Erc20.json +223 -223
- package/esm/abis/SubStorage.json +21 -21
- package/esm/abis/UniMulticall.json +17 -17
- package/esm/abis/index.d.ts +9 -9
- package/esm/abis/index.js +18 -18
- package/esm/abis/legacy_AaveV2Subscriptions.json +8 -8
- package/esm/abis/legacy_AuthCheck.json +8 -8
- package/esm/abis/legacy_CompoundV2Subscriptions.json +9 -9
- package/esm/abis/legacy_MakerSubscriptions.json +9 -9
- package/esm/automation/private/Automation.d.ts +12 -12
- package/esm/automation/private/Automation.js +39 -39
- package/esm/automation/private/LegacyAutomation.d.ts +25 -25
- package/esm/automation/private/LegacyAutomation.js +112 -112
- package/esm/automation/private/LegacyProtocol.d.ts +22 -22
- package/esm/automation/private/LegacyProtocol.js +38 -38
- package/esm/automation/private/LegacyProtocol.test.d.ts +1 -1
- package/esm/automation/private/LegacyProtocol.test.js +20 -20
- package/esm/automation/private/Protocol.d.ts +22 -22
- package/esm/automation/private/Protocol.js +38 -38
- package/esm/automation/private/Protocol.test.d.ts +1 -1
- package/esm/automation/private/Protocol.test.js +20 -20
- package/esm/automation/private/StrategiesAutomation.d.ts +33 -33
- package/esm/automation/private/StrategiesAutomation.js +175 -175
- package/esm/automation/private/StrategiesAutomation.test.d.ts +1 -1
- package/esm/automation/private/StrategiesAutomation.test.js +666 -666
- package/esm/automation/public/ArbitrumStrategies.d.ts +5 -5
- package/esm/automation/public/ArbitrumStrategies.js +7 -7
- package/esm/automation/public/BaseStrategies.d.ts +5 -5
- package/esm/automation/public/BaseStrategies.js +7 -7
- package/esm/automation/public/EthereumStrategies.d.ts +5 -5
- package/esm/automation/public/EthereumStrategies.js +7 -7
- package/esm/automation/public/OptimismStrategies.d.ts +5 -5
- package/esm/automation/public/OptimismStrategies.js +7 -7
- package/esm/automation/public/legacy/LegacyAaveAutomation.d.ts +6 -6
- package/esm/automation/public/legacy/LegacyAaveAutomation.js +14 -14
- package/esm/automation/public/legacy/LegacyCompoundAutomation.d.ts +6 -6
- package/esm/automation/public/legacy/LegacyCompoundAutomation.js +14 -14
- package/esm/automation/public/legacy/LegacyMakerAutomation.d.ts +6 -6
- package/esm/automation/public/legacy/LegacyMakerAutomation.js +14 -14
- package/esm/configuration.d.ts +1 -1
- package/esm/configuration.js +7 -7
- package/esm/constants/index.d.ts +28 -28
- package/esm/constants/index.js +483 -468
- package/esm/index.d.ts +23 -23
- package/esm/index.js +23 -23
- package/esm/services/contractService.d.ts +12 -12
- package/esm/services/contractService.js +45 -45
- package/esm/services/ethereumService.d.ts +7 -7
- package/esm/services/ethereumService.js +41 -41
- package/esm/services/ethereumService.test.d.ts +1 -1
- package/esm/services/ethereumService.test.js +237 -237
- package/esm/services/strategiesService.d.ts +2 -2
- package/esm/services/strategiesService.js +696 -696
- package/esm/services/strategiesService.test.d.ts +1 -1
- package/esm/services/strategiesService.test.js +108 -108
- package/esm/services/strategySubService.d.ts +100 -100
- package/esm/services/strategySubService.js +238 -235
- package/esm/services/strategySubService.test.d.ts +1 -1
- package/esm/services/strategySubService.test.js +908 -906
- package/esm/services/subDataService.d.ts +192 -192
- package/esm/services/subDataService.js +469 -469
- package/esm/services/subDataService.test.d.ts +1 -1
- package/esm/services/subDataService.test.js +1254 -1254
- package/esm/services/triggerService.d.ts +191 -191
- package/esm/services/triggerService.js +338 -338
- package/esm/services/triggerService.test.d.ts +1 -1
- package/esm/services/triggerService.test.js +901 -901
- package/esm/services/utils.d.ts +25 -25
- package/esm/services/utils.js +82 -82
- package/esm/services/utils.test.d.ts +1 -1
- package/esm/services/utils.test.js +348 -348
- package/esm/types/contracts/generated/Erc20.d.ts +53 -53
- package/esm/types/contracts/generated/Erc20.js +4 -4
- package/esm/types/contracts/generated/Legacy_AaveV2Subscriptions.d.ts +129 -129
- package/esm/types/contracts/generated/Legacy_AaveV2Subscriptions.js +4 -4
- package/esm/types/contracts/generated/Legacy_AuthCheck.d.ts +20 -20
- package/esm/types/contracts/generated/Legacy_AuthCheck.js +4 -4
- package/esm/types/contracts/generated/Legacy_CompoundV2Subscriptions.d.ts +128 -128
- package/esm/types/contracts/generated/Legacy_CompoundV2Subscriptions.js +4 -4
- package/esm/types/contracts/generated/Legacy_MakerSubscriptions.d.ts +246 -246
- package/esm/types/contracts/generated/Legacy_MakerSubscriptions.js +4 -4
- package/esm/types/contracts/generated/SubStorage.d.ts +114 -114
- package/esm/types/contracts/generated/SubStorage.js +4 -4
- package/esm/types/contracts/generated/UniMulticall.d.ts +55 -55
- package/esm/types/contracts/generated/UniMulticall.js +4 -4
- package/esm/types/contracts/generated/index.d.ts +7 -7
- package/esm/types/contracts/generated/index.js +1 -1
- package/esm/types/contracts/generated/types.d.ts +54 -54
- package/esm/types/contracts/generated/types.js +1 -1
- package/esm/types/enums.d.ts +184 -181
- package/esm/types/enums.js +203 -200
- package/esm/types/index.d.ts +224 -224
- package/esm/types/index.js +1 -1
- package/package.json +61 -61
- package/scripts/generateContractTypes.js +39 -39
- package/src/abis/Erc20.json +222 -222
- package/src/abis/SubStorage.json +21 -21
- package/src/abis/UniMulticall.json +17 -17
- package/src/abis/index.ts +28 -28
- package/src/abis/legacy_AaveV2Subscriptions.json +7 -7
- package/src/abis/legacy_AuthCheck.json +7 -7
- package/src/abis/legacy_CompoundV2Subscriptions.json +8 -8
- package/src/abis/legacy_MakerSubscriptions.json +8 -8
- package/src/automation/private/Automation.ts +44 -44
- package/src/automation/private/LegacyAutomation.ts +135 -135
- package/src/automation/private/LegacyProtocol.test.ts +23 -23
- package/src/automation/private/LegacyProtocol.ts +51 -51
- package/src/automation/private/Protocol.test.ts +23 -23
- package/src/automation/private/Protocol.ts +51 -51
- package/src/automation/private/StrategiesAutomation.test.ts +663 -663
- package/src/automation/private/StrategiesAutomation.ts +242 -242
- package/src/automation/public/ArbitrumStrategies.ts +10 -10
- package/src/automation/public/BaseStrategies.ts +10 -10
- package/src/automation/public/EthereumStrategies.ts +10 -10
- package/src/automation/public/OptimismStrategies.ts +10 -10
- package/src/automation/public/legacy/LegacyAaveAutomation.ts +20 -20
- package/src/automation/public/legacy/LegacyCompoundAutomation.ts +20 -20
- package/src/automation/public/legacy/LegacyMakerAutomation.ts +20 -20
- package/src/configuration.ts +8 -8
- package/src/constants/index.ts +507 -492
- package/src/index.ts +39 -39
- package/src/services/contractService.ts +77 -77
- package/src/services/ethereumService.test.ts +257 -257
- package/src/services/ethereumService.ts +69 -69
- package/src/services/strategiesService.test.ts +105 -105
- package/src/services/strategiesService.ts +934 -934
- package/src/services/strategySubService.test.ts +1122 -1119
- package/src/services/strategySubService.ts +524 -518
- package/src/services/subDataService.test.ts +1387 -1387
- package/src/services/subDataService.ts +644 -644
- package/src/services/triggerService.test.ts +1004 -1004
- package/src/services/triggerService.ts +449 -449
- package/src/services/utils.test.ts +430 -430
- package/src/services/utils.ts +103 -103
- package/src/types/enums.ts +200 -197
- package/src/types/index.ts +279 -279
- package/tsconfig.esm.json +8 -8
- package/tsconfig.json +22 -22
- package/umd/index.js +0 -34103
package/.babelrc
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
{
|
|
2
|
-
"presets": []
|
|
3
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"presets": []
|
|
3
|
+
}
|
package/.editorconfig
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
root = true
|
|
2
|
-
|
|
3
|
-
[*]
|
|
4
|
-
charset = utf-8
|
|
5
|
-
indent_style = space
|
|
6
|
-
indent_size = 2
|
|
7
|
-
end_of_line = lf
|
|
8
|
-
insert_final_newline = true
|
|
9
|
-
trim_trailing_whitespace = true
|
|
1
|
+
root = true
|
|
2
|
+
|
|
3
|
+
[*]
|
|
4
|
+
charset = utf-8
|
|
5
|
+
indent_style = space
|
|
6
|
+
indent_size = 2
|
|
7
|
+
end_of_line = lf
|
|
8
|
+
insert_final_newline = true
|
|
9
|
+
trim_trailing_whitespace = true
|
package/.env.dev
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
# Used for testing
|
|
2
|
-
RPC_1=
|
|
3
|
-
RPC_10=
|
|
4
|
-
RPC_8453=
|
|
1
|
+
# Used for testing
|
|
2
|
+
RPC_1=
|
|
3
|
+
RPC_10=
|
|
4
|
+
RPC_8453=
|
|
5
5
|
RPC_42161=
|
package/.eslintignore
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
node_modules
|
|
2
|
-
esm
|
|
3
|
-
test
|
|
4
|
-
docs
|
|
5
|
-
cjs
|
|
6
|
-
src/types/contracts/generated/*
|
|
1
|
+
node_modules
|
|
2
|
+
esm
|
|
3
|
+
test
|
|
4
|
+
docs
|
|
5
|
+
cjs
|
|
6
|
+
src/types/contracts/generated/*
|
package/.eslintrc.js
CHANGED
|
@@ -1,39 +1,39 @@
|
|
|
1
|
-
|
|
2
|
-
module.exports = {
|
|
3
|
-
extends: ['@defisaver/eslint-config/base-config'],
|
|
4
|
-
env: {
|
|
5
|
-
es6: true,
|
|
6
|
-
mocha: true,
|
|
7
|
-
},
|
|
8
|
-
ignorePatterns: ['*.test.ts', 'esm/', 'cjs/'],
|
|
9
|
-
overrides: [{
|
|
10
|
-
files: ['*.ts'],
|
|
11
|
-
extends: ['@defisaver/eslint-config/base-config-typescript'],
|
|
12
|
-
parser: '@typescript-eslint/parser',
|
|
13
|
-
parserOptions: {
|
|
14
|
-
project: ['./tsconfig.json'],
|
|
15
|
-
tsconfigRootDir: './',
|
|
16
|
-
},
|
|
17
|
-
rules: {
|
|
18
|
-
'@typescript-eslint/consistent-type-imports': 2,
|
|
19
|
-
},
|
|
20
|
-
}],
|
|
21
|
-
parserOptions: {
|
|
22
|
-
ecmaVersion: 2018,
|
|
23
|
-
sourceType: 'module',
|
|
24
|
-
},
|
|
25
|
-
rules: {
|
|
26
|
-
'max-len': 0,
|
|
27
|
-
},
|
|
28
|
-
settings: {
|
|
29
|
-
'import/resolver': {
|
|
30
|
-
typescript: {
|
|
31
|
-
alwaysTryTypes: true,
|
|
32
|
-
project: ['./tsconfig.json'],
|
|
33
|
-
},
|
|
34
|
-
node: {
|
|
35
|
-
extensions: ['.js', '.ts'],
|
|
36
|
-
},
|
|
37
|
-
},
|
|
38
|
-
},
|
|
39
|
-
};
|
|
1
|
+
|
|
2
|
+
module.exports = {
|
|
3
|
+
extends: ['@defisaver/eslint-config/base-config'],
|
|
4
|
+
env: {
|
|
5
|
+
es6: true,
|
|
6
|
+
mocha: true,
|
|
7
|
+
},
|
|
8
|
+
ignorePatterns: ['*.test.ts', 'esm/', 'cjs/'],
|
|
9
|
+
overrides: [{
|
|
10
|
+
files: ['*.ts'],
|
|
11
|
+
extends: ['@defisaver/eslint-config/base-config-typescript'],
|
|
12
|
+
parser: '@typescript-eslint/parser',
|
|
13
|
+
parserOptions: {
|
|
14
|
+
project: ['./tsconfig.json'],
|
|
15
|
+
tsconfigRootDir: './',
|
|
16
|
+
},
|
|
17
|
+
rules: {
|
|
18
|
+
'@typescript-eslint/consistent-type-imports': 2,
|
|
19
|
+
},
|
|
20
|
+
}],
|
|
21
|
+
parserOptions: {
|
|
22
|
+
ecmaVersion: 2018,
|
|
23
|
+
sourceType: 'module',
|
|
24
|
+
},
|
|
25
|
+
rules: {
|
|
26
|
+
'max-len': 0,
|
|
27
|
+
},
|
|
28
|
+
settings: {
|
|
29
|
+
'import/resolver': {
|
|
30
|
+
typescript: {
|
|
31
|
+
alwaysTryTypes: true,
|
|
32
|
+
project: ['./tsconfig.json'],
|
|
33
|
+
},
|
|
34
|
+
node: {
|
|
35
|
+
extensions: ['.js', '.ts'],
|
|
36
|
+
},
|
|
37
|
+
},
|
|
38
|
+
},
|
|
39
|
+
};
|
package/.mocharc.json
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
{
|
|
2
|
-
"require": "ts-node/register",
|
|
3
|
-
"extension": ["ts"]
|
|
4
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"require": "ts-node/register",
|
|
3
|
+
"extension": ["ts"]
|
|
4
|
+
}
|
|
5
5
|
|
package/.nvmrc
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
v20.17.0
|
|
1
|
+
v20.17.0
|
package/README.md
CHANGED
|
@@ -1,47 +1,47 @@
|
|
|
1
|
-
# SDK for fetching DeFi Saver strategies data from the blockchain.
|
|
2
|
-
|
|
3
|
-
Fetch strategies data from the blockchain, and parse it into a readable format.
|
|
4
|
-
Use one of the following classes to fetch data for strategies: EthereumStrategies, OptimismStrategies, ArbitrumStrategies or BaseStrategies.
|
|
5
|
-
Use one of the following classes to fetch data for legacy automation: LegacyMakerAutomation, LegacyAaveAutomation, or LegacyCompoundAutomation.
|
|
6
|
-
Various services and constants also available for use.
|
|
7
|
-
|
|
8
|
-
## Usage
|
|
9
|
-
|
|
10
|
-
```js
|
|
11
|
-
const ethereumStrategies = new EthereumStrategies({
|
|
12
|
-
provider: WEB3_PROVIDER_HERE,
|
|
13
|
-
});
|
|
14
|
-
|
|
15
|
-
const subscriptions = await ethereumStrategies.getSubscriptionsFor(
|
|
16
|
-
// Pass one or multiple owner addresses, or use getSubscriptions method to fetch all subscriptions
|
|
17
|
-
['0x000000000000000000000000000000000000dEaD'],
|
|
18
|
-
{
|
|
19
|
-
fromBlock: 0,
|
|
20
|
-
toBlock: 'latest',
|
|
21
|
-
mergeSubs: true, // Used for merging subscriptions with same strategy ID (e.g. boost and repay)
|
|
22
|
-
enabledOnly: true,
|
|
23
|
-
unexpiredOnly: true, // Referring to exchange subscriptions
|
|
24
|
-
}
|
|
25
|
-
);
|
|
26
|
-
|
|
27
|
-
// Do what you would like with subscriptions
|
|
28
|
-
```
|
|
29
|
-
|
|
30
|
-
## Development - How to add new strategies?
|
|
31
|
-
|
|
32
|
-
- Add strategy/bundle ID to `./src/types/enums.ts`, and create `Identifiers` if needed
|
|
33
|
-
- Add strategy/bundle info to `./src/constants/index.ts`
|
|
34
|
-
- Add encoding/decoding to the following files:
|
|
35
|
-
- `./src/services/strategySubService.ts`
|
|
36
|
-
- `./src/services/subDataService.ts`
|
|
37
|
-
- `./src/services/triggerService.ts`
|
|
38
|
-
- Write parsing for the strategy in `./src/services/strategeiesService.ts` and add assign it to `const parsingMethodsMapping`
|
|
39
|
-
- Write tests for each method
|
|
40
|
-
- Run tests with `yarn test` or `yarn test fileName` for a specific file (e.g. `yarn test utils`)
|
|
41
|
-
- Congrats! 🥳
|
|
42
|
-
|
|
43
|
-
## Testing
|
|
44
|
-
|
|
45
|
-
`npm run test` - Run all tests
|
|
46
|
-
|
|
1
|
+
# SDK for fetching DeFi Saver strategies data from the blockchain.
|
|
2
|
+
|
|
3
|
+
Fetch strategies data from the blockchain, and parse it into a readable format.
|
|
4
|
+
Use one of the following classes to fetch data for strategies: EthereumStrategies, OptimismStrategies, ArbitrumStrategies or BaseStrategies.
|
|
5
|
+
Use one of the following classes to fetch data for legacy automation: LegacyMakerAutomation, LegacyAaveAutomation, or LegacyCompoundAutomation.
|
|
6
|
+
Various services and constants also available for use.
|
|
7
|
+
|
|
8
|
+
## Usage
|
|
9
|
+
|
|
10
|
+
```js
|
|
11
|
+
const ethereumStrategies = new EthereumStrategies({
|
|
12
|
+
provider: WEB3_PROVIDER_HERE,
|
|
13
|
+
});
|
|
14
|
+
|
|
15
|
+
const subscriptions = await ethereumStrategies.getSubscriptionsFor(
|
|
16
|
+
// Pass one or multiple owner addresses, or use getSubscriptions method to fetch all subscriptions
|
|
17
|
+
['0x000000000000000000000000000000000000dEaD'],
|
|
18
|
+
{
|
|
19
|
+
fromBlock: 0,
|
|
20
|
+
toBlock: 'latest',
|
|
21
|
+
mergeSubs: true, // Used for merging subscriptions with same strategy ID (e.g. boost and repay)
|
|
22
|
+
enabledOnly: true,
|
|
23
|
+
unexpiredOnly: true, // Referring to exchange subscriptions
|
|
24
|
+
}
|
|
25
|
+
);
|
|
26
|
+
|
|
27
|
+
// Do what you would like with subscriptions
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## Development - How to add new strategies?
|
|
31
|
+
|
|
32
|
+
- Add strategy/bundle ID to `./src/types/enums.ts`, and create `Identifiers` if needed
|
|
33
|
+
- Add strategy/bundle info to `./src/constants/index.ts`
|
|
34
|
+
- Add encoding/decoding to the following files:
|
|
35
|
+
- `./src/services/strategySubService.ts`
|
|
36
|
+
- `./src/services/subDataService.ts`
|
|
37
|
+
- `./src/services/triggerService.ts`
|
|
38
|
+
- Write parsing for the strategy in `./src/services/strategeiesService.ts` and add assign it to `const parsingMethodsMapping`
|
|
39
|
+
- Write tests for each method
|
|
40
|
+
- Run tests with `yarn test` or `yarn test fileName` for a specific file (e.g. `yarn test utils`)
|
|
41
|
+
- Congrats! 🥳
|
|
42
|
+
|
|
43
|
+
## Testing
|
|
44
|
+
|
|
45
|
+
`npm run test` - Run all tests
|
|
46
|
+
|
|
47
47
|
`npm run test-single --name=your_test_name` - Run single test for specified name e.g. for MyTest.test.ts test name is MyTest
|