GEB Docs
  • Introduction to GEB
  • Community Resources
  • FLX Mechanics
  • FAQ
  • RAI
    • RAI Use-Cases
    • Multi-chain RAI
    • RAI Integrations
  • The Money God League
    • Intro to The League
  • Ungovernance
    • Governance Minimization Guide
  • Risk
    • GEB Risks
    • PID Failure Modes & Responses
  • Incentives
    • RAI Uniswap V2 Mint + LP Incentives Program
    • RAI Uniswap V3 Mint + LP Incentives Program (Inactive)
    • FLX Staking
    • RAI / ETH Uniswap V3 Oracle LP Incentives Program
  • Contract Variables Translation
    • Core Contracts Naming Transition
    • Governance Contracts Naming Transition
    • SAFE Management Contract Naming Transition
  • System Contracts
    • Core Module
      • SAFE Engine
      • Liquidation Engine
      • Accounting Engine
    • Auction Module
      • English Collateral Auction House
      • Fixed Discount Collateral Auction House
      • Increasing Discount Collateral Auction House
      • Debt Auction House
      • Surplus Auction House
    • Oracle Module
      • Oracle Relayer
      • Medianizer
        • DSValue
        • Governance Led Median
        • Chainlink Median
        • Uniswap V2 Median
      • FSM
        • Oracle Security Module
        • Dampened Security Module
        • FSM Governance Interface
    • Token Module
      • Token Adapters
      • System Coin
      • Protocol Token
      • Protocol Token Authority
      • Protocol Token Printing Permissions
    • Money Market Module
      • Tax Collector
    • Sustainability Module
      • Stability Fee Treasury
      • FSM Wrapper
      • Increasing Treasury Reimbursement
      • Mandatory Fixed Treasury Reimbursement
      • Increasing Reward Relayer
    • Automation Module
      • Collateral Auction Throttler
      • Single Spot Debt Ceiling Setter
      • ESM Threshold Setter
    • Governance Module
      • DSPause
    • Shutdown Module
      • Global Settlement
      • ESM
  • Proxy Infrastructure
    • DSProxy
    • Proxy Registry
  • Helper Contracts
    • SAFE Manager
  • GEB.js
    • Getting Started
    • Global Settlement Guide
    • API Reference
      • Geb
      • Safe
      • Proxy Actions
      • Geb Admin
  • APIs
    • API Endpoints
  • Pyflex
    • Getting Started
      • Configuration
      • GEB Basics
    • SAFE Management
      • Opening a SAFE
      • Closing a SAFE
    • Numerics
  • Keepers
    • Keeper Overview
    • Collateral Auction Keeper
      • Running in Docker
      • Running on a Host
      • Liquidations & Collateral Auctions
      • Collateral Auction Flash Swaps
    • Debt Auction Keeper
      • Running in Docker
      • Running on a Host
    • Staked Token Auction Keeper
      • Running in Docker
      • Running on a Host
    • Surplus Auction Keeper
      • Running in Docker
      • Running on a Host
    • Bidding Models
  • Liquidation Protection
    • SAFE Protection
    • Liquidation Protection Guide
    • Uni-V2 RAI/ETH Savior Details
    • Curve V1 Savior Details
Powered by GitBook
On this page
  • Prerequisties
  • Get RAI:
  • Clone:
  • Install:
  • 1) Start virtualenv
  • 2) Create a model file
  • 3) Create the keeper run file
  • Then, substitute the following variables:
  • Finally:
  • 4) Start the keeper and enter your keystore file password

Was this helpful?

  1. Keepers
  2. Collateral Auction Keeper

Running on a Host

Running a collateral auction keeper directly on a host

PreviousRunning in DockerNextLiquidations & Collateral Auctions

Last updated 4 years ago

Was this helpful?

Prerequisties

Python 3.6+

Get RAI:

Buy RAI from Uniswap v2 or and generate it.

Clone:

git clone https://github.com/reflexer-labs/auction-keeper.git
cd auction-keeper
git submodule update --init --recursive

Install:

This creates a virtual environment and installs requirements.

./install.sh

1) Start virtualenv

source _virtualenv/bin/activate

2) Create a model file

Paste the following code into collateral_model.sh:

#!/usr/bin/env bash
while true; do
  echo "{}"
  sleep 120                   
done

NOTE: Currently, collateral auctions sell collateral at a fixed discount and so the keeper doesn't use a bidding model. This empty bidding model is simply a placeholder.

3) Create the keeper run file

Create a file called run_auction_keeper.sh and paste the following code in it:

#!/bin/bash
bin/auction-keeper \
     --model ./collateral_model.sh \
     --rpc-uri <ETH_RPC_URL> \
     --eth-from <KEEPER_ADDRESS> \
     --eth-key key_file=<KEYSTORE_FILE>

Then, substitute the following variables:

ETH_RPC_URL - the URL of the ethereum RPC connection

KEEPER_ADDRESS - the keeper's address. It should be in checksummed format(not lowercase).

KEYSTORE_FILE - your Ethereum UTC JSON keystore filename

For more information about this keystore format and how to generate them:

Finally:

chmod +x run_auction_keeper.sh

4) Start the keeper and enter your keystore file password

./run_auction_keeper.sh

$ ./run_auction_keeper.sh
Password for /keystore/key.json:

open a SAFE
Ethereum UTC / JSON Wallet Encryption
keythereum