Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/makerdao/maker-keeper
https://github.com/makerdao/maker-keeper
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/makerdao/maker-keeper
- Owner: makerdao
- License: agpl-3.0
- Created: 2021-12-01T15:55:19.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-03T12:23:13.000Z (10 months ago)
- Last Synced: 2024-04-03T13:37:45.884Z (10 months ago)
- Language: Python
- Size: 77.1 KB
- Stars: 1
- Watchers: 3
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
# maker-keeper
This repository contains a Keeper that on each block mined checks if there's any debt ceiling change opportunity and executes the transaction to update.
Checking opportunities of debt ceiling change is done by calling the `getNextJob` function of `AutoLineJob` contract (https://etherscan.io/address/0xd3E01B079f0a787Fc2143a43E2Bdd799b2f34d9a).
## Installation
This project uses *Python 3.8* and requires *virtualenv* to be installed.
In order to clone the project and install required third-party packages please execute:
```
git clone https://github.com/makerdao/maker-keeper.git
cd maker-keeper
git submodule update --init --recursive
./install.sh
```
Can be also installed as a Docker image (makerdao/maker-keeper)
## Running
```
usage: maker-keeper [-h] --rpc-url RPC_URL [--rpc-timeout RPC_TIMEOUT]
--eth-from ETH_FROM --eth-private-key ETH_PRIVATE_KEY
[--autoline-address AUTOLINE_ADDRESS]
[--autoline-job-address AUTOLINE_JOB_ADDRESS]
[--max-errors MAX_ERRORS] --network-id NETWORK_ID
--blocknative-api-key BLOCKNATIVE_API_KEY
optional arguments:
-h, --help show this help message and exit
--rpc-url RPC_URL JSON-RPC host URL
--rpc-timeout RPC_TIMEOUT
JSON-RPC timeout (in seconds, default: 10)
--eth-from ETH_FROM Ethereum account from which to send transactions
--eth-private-key ETH_PRIVATE_KEY
Ethereum private key(s) to use
--autoline-address AUTOLINE_ADDRESS
Address of AutoLine contract (default: 0xC7Bdd1F2B16447dcf3dE045C4a039A60EC2f0ba3)
--autoline-job-address AUTOLINE_JOB_ADDRESS
Address of AutoLineJob contract (default: 0xd3E01B079f0a787Fc2143a43E2Bdd799b2f34d9a)
--max-errors MAX_ERRORS
Maximum number of allowed errors before the keeper
terminates (default: 100)
--network-id NETWORK_ID
Unique id of network running autoline keepers (hex encoded)
--blocknative-api-key BLOCKNATIVE_API_KEY
Blocknative key
```
## Sample startup script
```
#!/bin/bash
bin/maker-keeper \
--rpc-url https://localhost:8545 \
--eth-from 0x.... \
--eth-private-key 5210.... \
--network-id 0x.... \
--blocknative-api-key MY-KEY
```
## Build helm chart & deploy into kubernetes
```
# helm deploy dryrun
cd deploy && make dryrun
# helm deploy
cd deploy && make deploy
```