This is the "lightwallet" version of the defichain-maxi script. It has the same functionality but uses the ocean-api. Therefore no own server or full-node is needed. Best way to run it is as a lambda function on AWS. There you can define trigger to execute it every 10 minutes for example.
In general the script checks the provided vault, if the collateral ratio is above the threshold it takes loans in DUSD and the defined dToken so that the collateral ratio comes into the range. The minted tokens will be put into the LM pool to produce rewards. If the collateral ratio falls below the defined threshold, LM-tokens are removed from the pool and loans in the vault are payed back to get the ratio back within the wanted range. With this the vault produces optimized rewards on the collateral.
Script works only with bech32 adresses, but you can use Mnemonic seed (24 words) or privateKey (from fullnode)
Do not use this tool if you don't understand vaults on defichain. If you set the wrong parameter, you risk liquidating your vault and losing the whole collateral.
Of course, this is not financial advice! We do not take any responsibility for lost funds. Only invest money that you are willing to lose.
We are developing this thing in our free time. Noone is paying us for it. If you benefit from our work, it would be a nice gesture to give something back. Here are our DFI donation addresses:
@kuegi : df1qqtlz4uw9w5s4pupwgucv4shl6atqw7xlz2wn07
@Krysh90 : df1qw2yusvjqctn6p4esyfm5ajgsu5ek8zddvhv8jm
@DeFiPages : df1qa26988rj9xamw4tkanu7pthqshw6677vkasdg7
@RobertM81 : df1q9qhhlwg3qqetg2n9dnflh567me29ndyzmxwxh2
We recommend running it as a lambda on AWS. with reasonable settings (trigger every 10 minutes) you will even stay within the free tier of AWS.
to build it run in folder ocean-client:
npm i
npm run build --file=vault-maxi
Upload the file dist/vault-maxi.zip to AWS.
To run, the script needs parameters set in the AWS ParameterStore:
/defichain-maxi/wallet/address
/defichain-maxi/wallet/vault
/defichain-maxi/settings/min-collateral-ratio
/defichain-maxi/settings/max-collateral-ratio
/defichain-maxi/settings/lm-pair
/defichain-maxi/settings/main-collateral-asset
/defichain-maxi/settings/stable-arb-batch-size (if > 0 -> search for stable-coin arbitrage and do batches of max this size)
/defichain-maxi/settings/reinvest
/defichain-maxi/settings/reinvest-pattern
/defichain-maxi/settings/auto-donation-percent-of-reinvest (if > 0 this percentage of your reinvested amount will be donated to the devs on every reinvest. highly appreciated.)
/defichain-maxi/state (written by the bot itself)
/defichain-maxi/skip (set to "true" to skip the next execution)
saved as a SecureString:
/defichain-maxi/wallet/seed
optional parameters for extra settings:
/defichain-maxi/settings/heartbeat-url (if defined, a GET request is send to this url on every invocation)
/defichain-maxi/settings/log-id (added to every telegram message for unique identification)
/defichain-maxi/settings/keep-wallet-clean (default true: means vaultMaxi uses dust and commission to payback loans etc.)
/defichain-maxi/settings/ocean-urls (comma separated list of alternative ocean-urls that you want to use)
/defichain-maxi/settings/log-level (one of error, warn, info, verbose)
optional parameters (if you want telegram notifications)
/defichain-maxi/telegram/notifications/chat-id
/defichain-maxi/telegram/notifications/token
/defichain-maxi/telegram/logs/chat-id
/defichain-maxi/telegram/logs/token
the parameter for the loglevel decides which messages are send to the notifications channel and which to the logs channel. Everything below the defined log-level goes to log-channel. log-level and above goes to notifications.
f.e. if log-level is on info all info, warn and error messages go to notifications, verbose messages will go to logs.
The levels:
- error: either an error in the setup or something unexpected from ocean. -> immediate action is required
- warn: something the user should take care of, but no immediate action required
- info: VM did something (change exposure, reinvest etc.) no action required
- verbose: sent on every execution with basic info
in the reinvest pattern, you can define how the DFI should be used in the reinvest. You can define a space or comma seperated list of targets. each target has the pattern token:percent:targetAddressVault if there is no targetAddress/Vault given, collateral tokens get deposited to the vault while normal tokens (including LM-Token) stay in your wallet.
the given percent is the part of the reinvest amount that should be used in this target. the sum of all percent-values must not be greater than 100.
If the sum of all given percent numbers is below 100, the remaining percent are equally distributed among all targets without defined percent.
If the token is a LP token, the DFI get swapped 50:50 to the two needed tokens and added to the pool. resulting LP tokens can be send to a targetAddress.
For collateralTokens the targetAddressVault can be a vault-id. Then the tokens are deposited to this vault.
For easier usage you can use wallet or vault as shortcut for your own address and vault.
examples:
DFI: full reinvest as DFI into the vaultDFI DUSD: half of the amount gets swapped to DUSD, DFI and DUSD get deposited to the vaultDFI DUSD::wallet: half of the amount gets swapped to DUSD, DFI get deposited to the vault, DUSD stay in the walletBTC:10:df1address1 TSLA:15 BTC-DFI:8 SPY-DUSD:20:otheraddress DFI USDT::someVault: 10% swapped to BTC and sent to df1address1, 15% swapped to TSLA and kept in wallet, 8% swapped half to BTC and put into BTC-DFI pool, 20% swapped to SPY and DUSD and the LP-token send to otheraddress, rest (47%) split in DFI (deposited to own vault) and USDT (deposited tosomeVault)
Besides having parameters in the AWS ParameterStore, there is the possibility to set environment variables on a AWS Lambda execution.
Currently following keys are respected with a small description on how they alter execution functionality
value: number
With default behaviour, a reinvest only happens if the accumulated DFI is less then twice the threshold. Anything above that is assumed to be a transfer of funds and therefore no action is taken (no processing according to reinvest pattern, no auto donation). Setting this environment variable, increases the threshold. With this you can force VaultMaxi to process even larger amounts as reinvests.
(overrides the parameter /defichain-maxi/settings/log-id but same functionality)
value: string
will be shown in the prefix of every telegram message. Meant to easily distinguish log messages of different bots
value: string
Extends name of following ParameterStore parameters with your value:
/defichain-maxi/wallet/address
/defichain-maxi/wallet/vault
/defichain-maxi/settings/min-collateral-ratio
/defichain-maxi/settings/max-collateral-ratio
/defichain-maxi/settings/lm-token
/defichain-maxi/settings/reinvest
/defichain-maxi/state
Example for value = -second
/defichain-maxi-second/wallet/address
/defichain-maxi-second/wallet/vault
/defichain-maxi-second/settings/min-collateral-ratio
/defichain-maxi-second/settings/max-collateral-ratio
/defichain-maxi-second/settings/lm-token
/defichain-maxi-second/settings/reinvest
/defichain-maxi-second/state
This will allow you to create a second lambda, with the code you built to run on a second address + vault
value: string
This value overwrites the default seed key parameter to another SecureString parameter, which is further used to initialise your wallet.
value: number default: 1
Defines the minimum $ value of a token in the address to be considered during a cleanup. IF a cleanup is needed, but the $-value of one tokenamount in the address is less than this value, this token is ignored during the cleanup. This is here to prevent micro tx on dust.
(overrides parameter /defichain-maxi/settings/keep-wallet-clean but same functionality)
value: string
possible values: "true", "false"
default: true
Enabled: keeps your address clean by using commissions (dust) to payback loans and adding liquidity to your pool-pair
Disabled: will not touch commissions (dust), only what is needed by default calculations
DEPRECATED since the new reinvest-pattern
value: string
possible values: "true", "false"
default: true
Enabled: rewards will be swapped to your main collateral asset ("DUSD" if not DFI) before reinvesting
Disabled: rewards will be directly reinvested as DFI
(will be added internally to the list of /defichain-maxi/settings/ocean-urls)
value: string
If provided, this overrides the url to be used as the ocean endpoint. default is "https://ocean.defichain.com" , but you could use custom providers like mydefichain: "https://ocean.mydefichain.com"
value: number
possible values: loanScheme.minColRatio < x < loanSchemen.minColRatio * 2
DISCLAIMER - only use this variable if you really know what you do, as this might risk your vault getting liquidated without a proper warning message
There is a warning if too less LM tokens of configured token is available to safeguard your vault. This might be because of having other loans within the very same vault.
To avoid getting spammed, because this is a calculated risk from you, you can change this safety warning to a lower ratio.
Example: Vault with MIN150 => minColRatio = 150 Safety warning will be raised if paying back all configured LM tokens will result in a collateral ratio of below 300. Setting this value to 250, will raise this warning to below 250.
The script check the environment variable AWS_EXECUTION_ENV, which is set inside AWS. If AWS_EXECUTION_ENV does not exist, local settings are used in the folder .vault-maxi in $HOME (linux) or %USERPROFILE% (Windows).
The last execution state is used from and written to state.txt or state%VAULTMAXI_STORE_POSTIX%.txt.
The settings are read from the file settings.json or settings%VAULTMAXI_STORE_POSTIX%.json.
If the file not exist, a new empty is created and the program stop with the error message
"new empty config created: ... Enter your values before the next start. Set seedfile to an encrypted folder."
The only difference to the AWS parameter is
"seedfile": "V:/store/vault-maxi-seed.txt",
which is the full path to a text file in an encrypted storage which contains the seed words in the first line.
If the environment variable VAULTMAXI_LOGID is not set, the app will set it to the hostname of the computer, which will be shown in the prefix of every telegram message.
The debugging configuration is set in .vscode/launch.json:
{
"version": "0.2.0",
"configurations": [
{
"type": "pwa-node",
"request": "launch",
"name": "Launch Program",
"skipFiles": [
"<node_internals>/**"
],
"program": "${workspaceFolder}\\src\\app.ts",
"args": ["if not 'run', event argument with checkSetup: true is used "],
"preLaunchTask": "tsc: build - tsconfig.json",
"outFiles": ["${workspaceFolder}/out/**/*.js"],
}
]
}
If "args" is not ["run"], vault-maxi.main() is called with checkSetup: true for security reason.
The tsconfig.json is also used to compile with tsc to the output folder 'out'.
Set a breakpoint in app.ts with F9 and start debugging with F5.
The function fs.rmSync in the build script need at least node version 14. However, all tests were performed with node version 16.
Download the windows installer (.msi) 64 bit from https://nodejs.org/en/download/.
In the debian 11 packet manager is inluded version 12.
First install the necessary repository:
curl -sL https://deb.nodesource.com/setup_16.x | sudo bash -
Install nodejs
sudo apt install nodejs
and check version.
node --version
To build one minified javascript file, run in folder ocean-client:
npm i
npm run build-app
which create index.js in folder 'dist.app'.
Start the script with checkSetup:
node index.js
Start the script with normal run:
node index.js run
As an alternative, the individual files in folder 'out' can be used:
node app.js