OCY_OUSD.sol
OCY -> On-Chain Yield
Last updated
OCY -> On-Chain Yield
Last updated
Zivoe Finance - Official Documentation
This contract escrows OUSD and handles accounting for yield distributions.
Type | Name | Description |
---|---|---|
address | GBL | The ZivoeGlobals contract. |
address | OUSD | Origin Dollar contract. |
address | OCT_YDL | The OCT_YDL contract. |
uint256 | basis | The basis of OUSD for distribution accounting. |
canPush() - Permission for owner to call pushToLocker()
. See ZivoeLocker.sol
canPull() - Permission for owner to call pullFromLocker()
. See ZivoeLocker.sol
canPullPartial() - Permission for owner to call pullFromLockerPartial()
. See ZivoeLocker.sol
pushToLocker() - Migrates specific amount of ERC20 from owner() to locker.
pullFromLocker() - Migrates entire ERC20 balance from locker to owner()
.
pullFromLockerPartial() - Migrates specific amount of ERC20 from locker to owner()
.
rebase() - Ensures this locker has opted-in for the OUSD rebase.
updateOCTYDL() - Updates the OCT_YDL endpoint.
forwardYield() - Forwards excess basis to OCT_YDL for conversion.
canPush()
Permission for owner to call pushToLocker()
. See ZivoeLocker.sol
canPull()
Permission for owner to call pullFromLocker()
. See ZivoeLocker.sol
canPullPartial()
Permission for owner to call pullFromLockerPartial()
. See ZivoeLocker.sol
pushToLocker()
Migrates specific amount of ERC20 from owner() to locker.
Type | Name | Description |
---|---|---|
address | asset | The asset to migrate. |
uint256 | amount | The amount of "asset" to migrate. |
bytes | data | Accompanying transaction data. |
Emits the BasisAdjusted() event
pullFromLocker()
Migrates entire ERC20 balance from locker to owner()
.
Type | Name | Description |
---|---|---|
address | asset | The asset to migrate. |
bytes | data | Accompanying transaction data. |
Emits the BasisAdjusted() event
pullFromLockerPartial()
Migrates specific amount of ERC20 from locker to owner()
.
Type | Name | Description |
---|---|---|
address | asset | The asset to migrate. |
uint256 | amount | The amount of "asset" to migrate. |
bytes | data | Accompanying transaction data. |
Emits the BasisAdjusted() event
rebase()
Ensures this locker has opted-in for the OUSD rebase.
updateOCTYDL()
Updates the OCT_YDL endpoint.
Type | Name | Description |
---|---|---|
address |
| The new address for OCT_YDL. |
Emits the UpdatedOCTYDL() event
forwardYield()
Forwards excess basis to OCT_YDL for conversion.
Emits the YieldForwarded() event
BasisAdjusted()
Emitted during pushToLocker(), pullFromLocker(), and pullFromLockerPartial()
Type | Indexed | Name | Description |
---|---|---|---|
uint256 | False | priorBasis | The prior value of basis. |
uint256 | False | newBasis | The new value of basis. |
UpdatedOCTYDL()
Emitted during updateOCTYDL()
Type | Indexed | Name | Description |
---|---|---|---|
address | True | newOCT | The new OCT_YDL contract. |
address | True | oldOCT | The old OCT_YDL contract. |
YieldForwarded()
Emitted during forwardYield()
Type | Indexed | Name | Description |
---|---|---|---|
uint256 | False | amount | The amount of OUSD forwarded. |
uint256 | False | newBasis | The new basis value. |