Skip to content

Commit 9c284a1

Browse files
SeaSaltyFunkgitbook-bot
authored andcommitted
GitBook: [keep3r-network#4] No subject
1 parent ee16e5b commit 9c284a1

7 files changed

Lines changed: 143 additions & 5 deletions

File tree

SUMMARY.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@
1111
## $KP3R Token
1212

1313
* [Understanding $KP3R](usdkp3r-token/understanding-usdkp3r.md)
14-
* [$KP3R FAQ](usdkp3r-token/usdkp3r-faq.md)
1514
* [$KP3R Tokenomics](usdkp3r-token/usdkp3r-tokenomics.md)
15+
* [$KP3R FAQ](usdkp3r-token/usdkp3r-faq.md)
1616

1717
## Minting
1818

@@ -61,7 +61,7 @@
6161
## Appendix
6262

6363
* [Audits](appendix/audits.md)
64-
* [Security](appendix/security.md)
64+
* [Minting & Issuance Security](appendix/minting-and-issuance-security.md)
6565

6666
## Links
6767

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Minting & Issuance Security
2+
3+
## Iron Bank Role Explained
4+
5+
Iron Bank refers to the set of lending contracts that represent the Iron Bank money market. More on Iron Bank in their [main documentation](https://docs.ib.xyz/). Markets can be added or removed via the [Iron Bank Unittroller](https://etherscan.io/address/0xAB1c342C7bf5Ec5F02ADEA1c2270670bCa144CbB). The admin for Iron Bank is the [Iron Bank Timelock](https://etherscan.io/address/0x5b12f04e22384b01f42ed14da23eacd21f14ac17#code) which in turn is controlled by the [Iron Bank Multisig](https://etherscan.io/address/0xa5fc0bbfcd05827ed582869b7254b6f141ba84eb#code). The list of multisig signers can be found [here](https://gnosis-safe.io/app/eth:0xA5fC0BbfcD05827ed582869b7254b6f141BA84Eb/settings/owners)
6+
7+
Iron Bank useful links;
8+
9+
* [GitHub](https://github.com/ibdotxyz)
10+
* [Documentation](https://docs.ib.xyz/v/ethereum/)
11+
* [Website](https://app.ib.xyz/)
12+
13+
## Oracles
14+
15+
Price Oracles are maintained by Iron Bank, more detail found [here](https://docs.ib.xyz/v/ethereum/lending-market/price-oracle), oracle updates are behind the [Iron Bank Timelock](https://etherscan.io/address/0x5b12f04e22384b01f42ed14da23eacd21f14ac17#code)
16+
17+
## ibXXX
18+
19+
ibXXX (Fixed Forex assets, example; ibCHF, ibEUR, ibAUD) are erc20 tokens that are pegged to their corresponding forex pair name. They can only be borrowed via Iron Bank by supplying collateral in one of Iron Bank's accepted collateral options, list available [here](https://docs.ib.xyz/v/ethereum/lending-market/collateral-factor).
20+
21+
This means that each ibXXX asset is backed by a $ amount equal to its fiat value. If 1 ibCHF is borrowed, it had to be backed by at least 1 CHF of value (whether that asset be in the form of BTC, CRV, ETH, etc).
22+
23+
Iron Bank liquidations ensure that the ibXXX assets maintain their peg. Further to this is the dynamic interest rate model. Should the peg drift above the underlying price, supply can be burned in Iron Bank, increasing interest rates (forcing repayments or liquidations). If the peg drifts below the underlying price, additional supply can be minted into Iron Bank to decrease interest rates, stimulating borrowing demand.
24+
25+
ibXXX assets are owned by the [ib\_controller](https://etherscan.io/address/0xa511da90c2f4c557456cd84cd003a1f74c202d80#code), which in turn is owned by the [Keep3r Multisig](https://etherscan.io/address/0x0d5dc686d0a2abbfdafdfb4d0533e886517d4e83). The list of Multisig signers can be found [here](https://gnosis-safe.io/app/eth:0x0d5dc686d0a2abbfdafdfb4d0533e886517d4e83/settings/owners)
26+
27+
Useful Links for Fixed Forex can be found in the [Links Section](broken-reference)
28+
29+
## Lifecycle
30+
31+
ibXXX (Fixed Forex assets, example: ibCHF) & cyXXX (Iron Bank assets, example: cyCHF) are explicitly linked. At contract deployment an ibXXX asset references a corresponding cyXXX asset, this can not be changed after deployment.
32+
33+
ibXXX assets can be `minted` only for the purpose of depositing into cyXXX assets. They can not be minted and sent to any other address. This ensures that ibXXX assets can only enter circulating supply by being borrowed from Iron Bank (and thus backed by collateral).
34+
35+
## Risk Vectors
36+
37+
* Keep3r Multisig can mint large supply into Iron Bank which decreases interest rates.
38+
* Keep3r Multisig can burn a large supply from Iron Bank which increases interest rates.
39+
* Iron Bank Multisig can add a dangerous oracle that incorrectly provides price, this is guarded by the Iron Bank Timelock.
40+
* Iron Bank Multisig can add a dangerous asset that can be used to drain collateral, this is guarded by the Iron Bank Timelock.

appendix/security.md

Lines changed: 0 additions & 2 deletions
This file was deleted.
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,13 @@
1+
---
2+
description: What is the utility of Fixed Forex assets?
3+
---
4+
15
# Fixed Forex Use Cases
26

7+
Fixed Forex assets aim to provide wide utility as on-chain stablecoins representing select fiat currencies
8+
9+
Current utility is limited to;
10+
11+
* Earning interest on Fixed Forex assets by providing supply to Iron Bank
12+
* Earning yield via rewards through providing liquidity for pools
13+
* Integration of Fixed Forex assets with [Mover](https://faq.viamover.com/iron-bank/how-to-top-up-mover-debit-card-with-iron-bank-forex-tokens) allowing real-world payments 

getting-started/glossary.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,59 @@
1+
---
2+
description: Common terms for understanding Fixed Forex ecosystem
3+
---
4+
15
# Glossary
26

7+
## Vesting
8+
9+
When $KP3R token holders stake or lock their token it is entered into a vesting contract that linearly decays towards 0. Vesting positions are represented by $vKP3R tokens & this entitles holders to a share of protocol fees. See the [Understanding $KP3R](../usdkp3r-token/understanding-usdkp3r.md) & [Vesting](broken-reference) sections for more details
10+
11+
## Fees
12+
13+
Fixed Forex shares fees generated by protocol activity with vested $KP3R token holders. Fees are distributed proportionally to individual vested token holding vs total amount of tokens locked 
14+
15+
## ibXXX
16+
17+
Representation of a Fixed Forex asset (i.e. $ibEUR, $ibCHF, $ibGBP, $ibAUD, $ibJPY, $ibKRW, etc.) 
18+
19+
## OLM (Options Liquidity Mining)
20+
21+
Fixed Forex incentivizes liquidity in a unique way, through the use of Options Liquidity Mining. For more details on OLM see the [Options Liquidity Mining Section](broken-reference)
22+
23+
## Iron Bank
24+
25+
Iron Bank is a decentralized lending platform focused on capital efficiency allowing protocols and individuals to supply and borrow cryptocurrencies.\
26+
\
27+
Iron Bank partners with Fixed Forex & the Keep3r Network (see the [Security Section](../appendix/minting-and-issuance-security.md)).
28+
29+
## Curve
30+
31+
Curve Finance is a decentralized exchange that specializes in pegged assets such as stablecoins. The native token of Curve is $CRV
32+
33+
Liquidity of Fixed Forex Assets is available on Curve, allowing utilization of ibXXX swaps & LP rewards
34+
35+
## Convex
36+
37+
Convex is a yield optimizer built on Curve Finance. Convex allows Curve liquidity providers to earn trading fees and claim boosted $CRV without locking $CRV themselves. Liquidity providers can receive boosted $CRV and liquidity mining rewards with minimal effort\
38+
\
39+
Liquidity Providers of Fixed Forex Assets can deposit LP positions on Convex to earn yield
40+
41+
## LP (Liquidity Provider)
42+
43+
Users providing liquidity (funds/assets) on decentralized exchange (DEX) protocols
44+
45+
## Yearn
46+
47+
Yearn Protocol is a set of Smart Contracts focused on creating a simple way to generate high risk-adjusted returns for depositors of various assets via best-in-class lending protocols, liquidity pools, and community-made yield farming strategies
48+
49+
Yearn strategies for Fixed Forex assets auto-compound rewards back into the ibXXX asset of choice
50+
51+
## Keep3r Jobs Network
52+
53+
Keep3r Network is a decentralized keeper network – it connects projects off-loading DevOps jobs and external teams ready to help. A _Job_ is a term used to refer to a smart contract that is awaiting for an external entity to perform an action
54+
55+
Keep3r Network utilizes the $KP3R token to reward keepers for completing _Jobs_
56+
57+
## Voting
58+
59+
Vested $KP3R token holders can vote for distribution of new $rKP3R rewards to Liquidity Providers of Fixed Forex Assets 

getting-started/understanding-fixed-forex.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Fixed Forex assets are [ERC-20 tokens ](https://ethereum.org/en/developers/docs/
1919
* $ibJPY - Japanese Yen
2020
* $ibKRW - Korean Won
2121

22-
Fixed Forex stablecoins are over-collateralized, meaning that each stablecoin issued must be backed by collateral maintained at a ratio greater than the fiat value of the stablecoins borrowed. Fixed Forex utilizes the [Iron Bank protocol](https://app.ib.xyz/markets/Ethereum) for the issue & minting of new Fixed Forex assets.
22+
Fixed Forex stablecoins are over-collateralized, meaning that each stablecoin issued must be backed by collateral maintained at a ratio greater than the fiat value of the stablecoins borrowed (i.e. more than €1 worth of collateral must be provided to borrow 1 $ibEUR). Fixed Forex utilizes the [Iron Bank protocol](https://app.ib.xyz/markets/Ethereum) for the issue & minting of new Fixed Forex assets.
2323

2424
## Where's the Whitepaper?
2525

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,34 @@
11
# Understanding $KP3R
22

3+
The $KP3R token is a representation of the single liquidity ecosystem that includes Fixed Forex & [the Keep3r Network](https://keep3r.network/)
4+
5+
## The Liquidity Ecosystem Explained
6+
7+
Something
8+
9+
## Token Versions Explained
10+
11+
There are four variations of the $KP3R token each serving different purposes within Fixed Forex. The table below provides an explanation for the purpose of each;
12+
13+
| $KP3R Token Version | Purpose |
14+
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
15+
| $KP3R | The Keep3r token, Fixed Forex users can receive through completing the redemption process for any $rKP3R held or earnt |
16+
| $rKP3R | Redeemable Keep3r, users receive as a reward for providing liquidity of Fixed Forex Assets or as a vested Keep3r token holder reward. Redeemable Keep3r entitles the holder to purchase $KP3R at a discount. See the [Options Liquidity Mining Section](broken-reference) for more details |
17+
| $oKP3R | Keep3r Options are created upon activation on the Fixed Forex site, and allow the holder 24 hours to purchase the option for discounted $KP3R. See the [Claiming OLM Rewards Section](../options-liquidity-mining/claiming-olm-rewards.md) for more details |
18+
| $vKP3R | Vested Keep3r is a "ve" locking mechanism. See the[ Vesting Section](broken-reference) for more details |
19+
20+
## Token Use Cases
21+
22+
Something
23+
24+
## Use in Fixed Forex
25+
26+
Something
27+
28+
## Vesting
29+
30+
Something
31+
32+
## Voting
33+
34+
Something

0 commit comments

Comments
 (0)