Global Settlement Guide

The following are examples of how you can use geb.js to facilitate the Global Settlement process and redeem your collateral which is locked in your own Safes or directly exchange system coins with collateral.
Example Flow for Global Settlement Using GEB.js
These scripts can help you go throught the steps described on the Global Settlement page. 
We first need to setup geb.js and ethers.js:
1
import { ethers } from 'ethers'
2
import { Geb, utils } from 'geb.js'
3
​
4
const provider = new ethers.providers.JsonRpcProvider(
5
    'http://kovan.infura.io/v3/<API KEY>'
6
)
7
const wallet = new ethers.Wallet('0xdefiisawesome...', provider)
8
const geb = new Geb('kovan', provider)
Copied!
Before continuing, we need to make sure that Global Settlement was triggered by checking the shutdown timestamp: 
1
const shutdownTime = await geb.contracts.globalSettlement.shutdownTime()
2
const hasGlobalSettlementStarted = shutdownTime.gt(0)
Copied!
Withdraw Excess Collateral
After settlement starts, each collateral needs to be frozen (Step 2). This needs to be done only once for every collateral type. 
1
const tx = geb.contracts.globalSettlement.freezeCollateralType(utils.ETH_A)
2
await wallet.sendTransaction(tx)
Copied!
Since a SAFE is supposed to be over-collateralized, its owner can already withdraw excess collateral. The following script assumes that the SAFE is owned by a proxy contract. It also uses the Global Settlement Proxy Actions to pack and atomically execute multiple transactions at once.
1
const proxy = await geb.getProxyAction(wallet.address)
2
const wethJoinAddress = geb.contracts.joinETH_A.address
3
// Withdraw excess collateral from the Safe with ID #3
4
const tx = proxy.freeTokenCollateralGlobalSettlement(wethJoinAddress, 3)
5
await wallet.sendTransaction(tx)
Copied!
This fulfills step 3 and step 5 from the Global Settlement process.
Set the Final COL/COIN Exchange Rates 
This part of the process consists in determining an exchange rate between the system coins that are still in circulation and each individual collateral type accepted by the system. The system needs to account for all Safes (I), terminate all ongoing collateral auctions (II) and remove all system surplus (III).
This needs to be done only once for the whole system. These steps can be taken care of by the settlement keeper bot or by anyone who is willing to pay the gas costs associated with these transactions.
1
// For (I) the function `processSAFE` needs to be called for all SAFEs,
2
// particularly for under-collateralized ones since their owners are not 
3
// incentivised to call it themselves
4
const safes = [] // Gather some Safe handlers 
5
safes.push((await geb.getSafe(2)).handler)
6
safes.push((await geb.getSafe(3)).handler)
7
safes.push((await geb.getSafe(4)).handler)
8
​
9
// Prepare the transactions
10
const txs = safes.map(handler => 
11
    geb.contracts.globalSettlement.processSAFE(utils.ETH_A, handler)
12
)
13
​
14
// Send all transactions
15
txs.map(tx => await wallet.sendTransaction(tx))
16
​
17
// For (II) we have 2 possibilities: wait for all auctions to finish
18
const cooldown = await geb.contracts.globalSettlement.shutdownCooldown()
19
const now = BigNumber.from(Date.now()).div(1000)
20
const isCooldownPassed = now.gt(shutdownTime.add(cooldown))
21
​
22
// Or prematurely terminate each auction
23
const auctionId = 6
24
const tx = geb.contracts.globalSettlement.fastTrackAuction(utils.ETH_A, auctionId)
25
await wallet.sendTransaction(tx)
26
​
27
// (III) We need to get rid of the system surplus
28
const accountingEngineAddress = geb.contracts.accountingEngine.address
29
const coin = await  geb.contracts.safeEngine.coinBalance(accountingEngineAddress)
30
const debt = await geb.contracts.safeEngine.debtBalance(accountingEngineAddress)
31
const amountToSettle = coin.gte(debt) ? debt : coin
32
const tx = geb.contracts.accountingEngine.settleDebt(amountToSettle)
33
await wallet.sendTransaction(tx)
34
​
35
// In case there is a bug in the system's accounting that 
36
// created more surplus than debt, there is a backup function called
37
// transferPostSettlementSurplus() which gets rid of that extra surplus
38
// and allows GlobalSettlement.setOutstandingCoinSupply() to execute successfuly
39
const tx = geb.contracts.accountingEngine.transferPostSettlementSurplus()
40
await wallet.sendTransaction(tx)
Copied!
Finally, the cash price for each collateral can be set with the following steps:
1
const tx = geb.contracts.globalSettlement.setOutstandingCoinSupply()
2
await wallet.sendTransaction(tx)
3
​
4
// To be called once for each collateral type
5
const tx = geb.contracts.globalSettlement.calculateCashPrice(utils.ETH_A)
6
await wallet.sendTransaction(tx)
Copied!
Redeem Collateral Against System Coins
At this stage, any system coin holder can exchange their coins against a fixed basket of collateral. This is a 2 step process that consists in locking and preparing system coins and then claiming a share of a specific collateral type.
1
// Prepare the system coins
2
const systemCoinBalance = await geb.contracts.coin.balanceOf(wallet.address)
3
const tx = proxy.prepareCoinsForRedeemingGlobalSettlement(systemCoinBalance)
4
await wallet.sendTransaction(tx)
5
​
6
// Redeem any collateral type you want
7
const tx = proxy.redeemTokenCollateralGlobalSettlement(wethJoinAddress, utils.ETH_A, systemCoinBalance)
8
await wallet.sendTransaction(tx)
Copied!

GEB.js - Previous

Getting Started

Next - GEB.js

API Reference

Last modified 9mo ago

Copy link

Contents

Example Flow for Global Settlement Using GEB.js

Withdraw Excess Collateral

Set the Final COL/COIN Exchange Rates

Redeem Collateral Against System Coins