Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: update to Neutron v5.0.0 #12

Open
wants to merge 34 commits into
base: main
Choose a base branch
from
Open

feat: update to Neutron v5.0.0 #12

Changes from 1 commit
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
5206fcd
docs: make it more clear that a MNEMONIC is required to run the script
dib542 Apr 22, 2024
02262a4
docs: explain the local demo mnemonics source twice
dib542 Apr 22, 2024
1c464bd
docs: move mnenomic option documentation to one section
dib542 Apr 25, 2024
935c700
docs: explain the behavior of using FAUCET_MNEMONIC at simulation end
dib542 Apr 25, 2024
e9aa736
docs: shorten line lengths to under 120 characters
dib542 Apr 25, 2024
15d9165
docs: move TOKEN_CONFIG and PAIR_CONFIG docs to README file
dib542 Apr 25, 2024
40a1fa0
docs: make TOKEN_CONFIG option header larger
dib542 Apr 25, 2024
414fe0c
style: make whitespace more consistent
dib542 Apr 25, 2024
7625658
feat: move most env vars to an .env file
dib542 May 6, 2024
ecd55bd
feat: move TOKEN_CONFIG_DEFAULT to local TOKEN_CONFIG example
dib542 May 6, 2024
e0390c7
docs: note default TRADE_FREQUENCY_SECONDS value
dib542 May 6, 2024
1b33b8d
feat: set default BOT_RAMPING_DELAY outside of docker compose env
dib542 May 6, 2024
a80ebb4
feat: make DOCKER_ENV var optional when run outside of docker-compose
dib542 May 6, 2024
40a19c9
feat: add SKIP_DEPOSIT option
dib542 May 6, 2024
89e1cea
fix: ensure to fetch up to date tags of the Neutron git repo
dib542 Jul 3, 2024
ffabb03
fix: new (SDK50) setup doesn't support setting GRPCWEB address
dib542 Jul 3, 2024
1c7b983
fix: ensure local DOCKER_ENV can still be read if HOSTNAME is set
dib542 Jul 3, 2024
3a341a5
feat: allow tokens of different decimal exponent to have correct price
dib542 Jul 3, 2024
484f6d5
fix: spelling
dib542 Jul 3, 2024
cfaeeca
docs: add more detail to placed trade logs
dib542 Jul 3, 2024
2f88553
fix: allow trade amount to be increased to required minimum amount
dib542 Jul 3, 2024
c16963e
fix: bc needs a herestring to read a string
dib542 Jul 3, 2024
3d1631b
fix: spaces
dib542 Jul 3, 2024
93d2003
fix: price direction to be consistent with pair_display_price direction
dib542 Jul 3, 2024
eaa8df7
feat: tag neutron-node with current version
dib542 Oct 17, 2024
0e7a35d
fix: allow Docker compose service to be built without heighliner image
dib542 Oct 18, 2024
47f6a5f
chore: update Docker CLI version
dib542 Oct 18, 2024
92b7e8b
refactor: use recommended CMD syntax
dib542 Oct 18, 2024
8541114
feat: add more checking delay: startup is a bit slower now
dib542 Oct 18, 2024
b301e38
feat: update to most current production release
dib542 Oct 18, 2024
db52a2b
feat: update to Neutron v5 API
dib542 Oct 18, 2024
71a660e
feat: only delay loops after the first loop
dib542 Oct 18, 2024
2429d21
fix: increment loop properly
dib542 Nov 19, 2024
71a945c
fix: the closest piece of liquidity may be a pool or a limit order
dib542 Nov 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs: move mnenomic option documentation to one section
  • Loading branch information
@dib542
dib542 committed Apr 25, 2024
commit 1c464bdfbbaa1f983ed32a93630108a9e8d2ad78
23 changes: 15 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,9 @@ To run the bot, you will first need a chain to run the bot against,
locally this should be a single dockerized neutron node
- `make build-neutron`

To run the default setup of a single neutron-node chain and a single trading bot:
To run the default setup of a single neutron-node chain and a single trading bot with a single wallet:
- `make start-trade-bot MNEMONIC=...`
- at least a single mnenomic must be specified from the mnenomics listed in the options section below
- `MNEMONIC`
- `MNEMONICS`
- `BOT_MNEMONIC`
- `BOT_MNEMONICS`
- `FAUCET_MNEMONIC`
- if running a local chain you can use DEMO_MNEMONICs from the neutron repo [networks/init.sh](https://github.com/neutron-org/neutron/blob/v3.0.0/network/init.sh#L19-L21) file
- the available `MNENOMIC` options are explained in the [Options section](#mnemonic-options)

This composed neutron chain and trading bot network will persist until you call:
- `make stop-trade-bot`
Expand All @@ -38,6 +32,19 @@ then `make start-trade-bot` should be used instead.

## Available options

### Mnemonic options
A single mnenomic option must be specified to run `make start-trade-bot` or `make test-trade-bot` this may be in the form of:
- a list of mnemonics to be used (delimited with any `\r\n,;` characters) where one mnemonic is given to each bot (in series). An error will be thrown if not enough mnemonics are provided for the number of `BOTS` requested.
- `MNEMONIC`
- `MNEMONICS`
- `BOT_MNEMONIC`
- `BOT_MNEMONICS`
- a single mnenomic which will be used to like a faucet to fund a separate randomly generated wallet for each bot requested (so you may easily run more than one bot with one wallet).
- `FAUCET_MNEMONIC`
- if you are running a local chain you can use the DEMO_MNEMONICs from the neutron repo [networks/init.sh](https://github.com/neutron-org/neutron/blob/v3.0.0/network/init.sh#L19-L21) file for these settings.

### Optional options

All docker-compose env vars are able to be set in both `make start-trade-bot` and `make test-trade-bot`
- Chain variables
- `CHAIN_ID`: the chain ID
Expand Down