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
  • 1. Modify the model file as needed
  • 2. Modify the keeper run file
  • 3. Start the keeper and enter your keystore file password
  • Surplus Auction Output

Was this helpful?

  1. Keepers
  2. Surplus Auction Keeper

Running in Docker

Running a surplus auction keeper in a Docker container

PreviousSurplus Auction KeeperNextRunning on a Host

Last updated 3 years ago

Was this helpful?

In order to participate in surplus auctions you need to bid with protocol tokens

1. Modify the model file as needed

A basic surplus auction bidding model can be found in models/surplus_model.py. This model retrieves the latest FLX/USD price from Coingecko and will automatically place bids in an auction.

You probably want to modify the following variables in models/surplus_model.py:

  • STARTING_FLX_MULTIPLIER: the maximum acceptable FLX price to use when bidding. This value will be used when bidding on a new auction with no previous bids. Default: 1.50 meaning the maximum price to accept for FLX (in RAI terms) is 150% of the current FLX/USD market price

  • MINIMUM_FLX_MULTIPLIER: the minimum acceptable FLX price to use when bidding. Default: 1.10 meaning the minimum price to accept for FLX (in RAI terms) is 110% of the current FLX/USD market price

MY_BID_INCREASE: The amount of bid increase(in FLX) to make when outbidding another bidder. If value is less than the auction house' bidIncrease, then it will use the auction house setting. Example: A value of 1.10 will create bid increases of 10%. Note: Current bidIncrease on mainnet is 1.03. Default: 1.03

Then, use chmod +x surplus_model.py.

For more information about bidding models, see .

2. Modify the keeper run file

Modify the following variables in run_surplus_keeper.sh:

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

  • ETH_RPC_URL - the URL of your Ethereum RPC connection

  • KEYSTORE_DIR - the full path of the directory where your keystore file is

  • MODEL_DIR - the full path of directory where your surplus_model.py file is

  • KEYSTORE_FILE - your Ethereum UTC JSON keystore filename

  • GAS_MAXIMUM -maximum gas price, in GWEI

For more information about the keystore format and how to generate it:

Finally, to run the keeper, use chmod +x run_surplus_keeper.sh.

3. Start the keeper and enter your keystore file password

./run_surplus_keeper.sh

$ ./run_auction_keeper.sh
Pulling from reflexer/auction-keeper
Digest: sha256:7e55ec9b0a136fc903d9f7f2690538bcbde9029d957e0e6f84d0282790f9666a
Status: Downloaded newer image for reflexer/auction-keeper
docker.io/reflexer/auction-keeper
Password for /keystore/key.json:

Surplus Auction Output

Sample

Bidding Models
Ethereum UTC / JSON Wallet Encryption
keythereum
surplus auction output