Document not found (404)
-This URL is invalid, sorry. Please use the navigation bar or search to continue.
- -":e:f.tabReplace?e.replace(/\t/g,f.tabReplace):e):e}function E(e){let n=null;const t=function(e){var n=e.className+" ";n+=e.parentNode?e.parentNode.className:"";const t=f.languageDetectRe.exec(n);if(t){var r=T(t[1]);return r||(console.warn(g.replace("{}",t[1])),console.warn("Falling back to no-highlight mode for this block.",e)),r?t[1]:"no-highlight"}return n.split(/\s+/).find(e=>p(e)||T(e))}(e);if(p(t))return;S("before:highlightBlock",{block:e,language:t}),f.useBR?(n=document.createElement("div")).innerHTML=e.innerHTML.replace(/\n/g,"").replace(/
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/book/mark.min.js b/docs/book/mark.min.js
deleted file mode 100644
index 16362318..00000000
--- a/docs/book/mark.min.js
+++ /dev/null
@@ -1,7 +0,0 @@
-/*!***************************************************
-* mark.js v8.11.1
-* https://markjs.io/
-* Copyright (c) 2014–2018, Julian Kühnel
-* Released under the MIT license https://git.io/vwTVl
-*****************************************************/
-!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?module.exports=t():"function"==typeof define&&define.amd?define(t):e.Mark=t()}(this,function(){"use strict";var e="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},t=function(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")},n=function(){function e(e,t){for(var n=0;n
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Kresko Protocol
-This repository contains the code for the Kresko Protocol. Kresko Protocol supports creating and managing crypto-backed synthetic assets. Prices for synthetic assets are derived from combination of oracle providers (on-demand/push). Protocol uses the EIP-2535 architecture. It enables composability through flexibile storage patterns while allowing users to access all core functionality with a single contract address. This is a usage and integration guide that assumes familiarity with Solidity (and EIP-2535), Foundry, Hardhat and core concepts of Kresko.
-
Usage
-Setup
-(OPTIONAL) create .env file cp .env.example .env
Dependencies
-Install forge dependencies
-forge install
-Install node dependencies
-(Authorized npm token is required in .npmrc for some internal packages. This will be lifted later.)
pnpm i
-Compiling
-Foundry
-Compile the contracts using foundry
-forge build
-Check your setup by running the local forge deployment
-forge script src/contracts/scripts/devnet/Devnet.s.sol:WithLocal
-Hardhat
-Compile the contracts using hardhat
-pnpm compile
-Check your setup by running the local hardhat deployment
-pnpm run deploy --tags local
-Testing
-NOTE: Primary test coverage uses hardhat. Forge tests are a work in progress.
-Hardhat
-Run tests with against a local deployment fixture:
-pnpm test
-Foundry
-forge test --ffi
-Deployment
-Hardhat
-To local network:
-pnpm local
-To live network:
-pnpm deploy --network <network>
-Foundry
-Local
-forge script src/contracts/scripts/devnet/Devnet.s.sol:WithLocal
-Forking
--
-
- value of
process.env.FORKINGmaps to network key and it's setup withinhardhat-configs/networks
- - set a specific block with
process.env.FORKING_BLOCKNUMBER
- - HRE is extended with helpers to get live deployments within the forked network (https://github.com/wighawag/hardhat-deploy#companionnetworks) -
Run deploy in fork
-pnpm fork:deploy
-Run tests with --grep Forking
pnpm fork:test
-Notes about the usage of ERC-2535 (Diamond)
-General
--
-
-
-
All external functions are contained in the facets,
-hardhat-diamond-abiwill combine their ABI to a separate artifact (Kresko.json) after compile.
- -
-
Core logic is mostly defined inside library functions. These internal functions are attached to the minter storage struct for ease of use.
-
- -
-
Storage is used through a inline assembly pointer inside free function. To access the storage (+ attached internal lib functions) simply call the free function anywhere within the diamond.
-
- -
-
Note that Staking, AMM and KreskoAsset contracts do not live inside the diamond scope.
-
-
State
-Nay
--
-
-
-
Do not add new state variables to the beginning or middle of structs. Doing this makes the new state variable overwrite existing state variable data and all state variables after the new state variable reference the wrong storage location.
-
- -
-
Do not put structs directly in structs unless you don’t plan on ever adding more state variables to the inner structs. You won't be able to add new state variables to inner structs in upgrades. This makes sense because a struct uses a fixed number of storage locations. Adding a new state variable to an inner struct would cause the next state variable after the inner struct to be overwritten. Structs that are in mappings can be extended in upgrades, because those structs are stored in random locations based on keccak256 hashing.
-
- -
-
Do not add new state variables to structs that are used in arrays.
-
- -
-
Do not use the same namespace string for different structs. This is obvious. Two different structs at the same location will overwrite each other.
-
-
Yay
--
-
-
-
To add new state variables to DiamondStorage pattern in eg. MinterStorage (ms), add them to the end of the struct. This makes sense because it is not possible for existing facets to overwrite state variables at new storage locations.
-
- -
-
New state variables can be added to the ends of structs that are used in mappings.
-
- -
-
The names of state variables can be changed, but that might be confusing if different facets are using different names for the same storage locations.
-
-
Learning references
-https://eip2535diamonds.substack.com/p/compliance-with-eip-2535-diamonds
-https://github.com/solidstate-network/solidstate-solidity
-https://eip2535diamonds.substack.com/p/how-eip2535-diamonds-reduces-gas
-Contributions
-Contributions to Kresko Protocol are encouraged, feel free to open an issue or pull request.
All contributions are licensed under BUSL1.1.
Contact
-Critical bug disclosures and inquiries should be directed to:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/book/searcher.js b/docs/book/searcher.js
deleted file mode 100644
index d2b0aeed..00000000
--- a/docs/book/searcher.js
+++ /dev/null
@@ -1,483 +0,0 @@
-"use strict";
-window.search = window.search || {};
-(function search(search) {
- // Search functionality
- //
- // You can use !hasFocus() to prevent keyhandling in your key
- // event handlers while the user is typing their search.
-
- if (!Mark || !elasticlunr) {
- return;
- }
-
- //IE 11 Compatibility from https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/startsWith
- if (!String.prototype.startsWith) {
- String.prototype.startsWith = function(search, pos) {
- return this.substr(!pos || pos < 0 ? 0 : +pos, search.length) === search;
- };
- }
-
- var search_wrap = document.getElementById('search-wrapper'),
- searchbar = document.getElementById('searchbar'),
- searchbar_outer = document.getElementById('searchbar-outer'),
- searchresults = document.getElementById('searchresults'),
- searchresults_outer = document.getElementById('searchresults-outer'),
- searchresults_header = document.getElementById('searchresults-header'),
- searchicon = document.getElementById('search-toggle'),
- content = document.getElementById('content'),
-
- searchindex = null,
- doc_urls = [],
- results_options = {
- teaser_word_count: 30,
- limit_results: 30,
- },
- search_options = {
- bool: "AND",
- expand: true,
- fields: {
- title: {boost: 1},
- body: {boost: 1},
- breadcrumbs: {boost: 0}
- }
- },
- mark_exclude = [],
- marker = new Mark(content),
- current_searchterm = "",
- URL_SEARCH_PARAM = 'search',
- URL_MARK_PARAM = 'highlight',
- teaser_count = 0,
-
- SEARCH_HOTKEY_KEYCODE = 83,
- ESCAPE_KEYCODE = 27,
- DOWN_KEYCODE = 40,
- UP_KEYCODE = 38,
- SELECT_KEYCODE = 13;
-
- function hasFocus() {
- return searchbar === document.activeElement;
- }
-
- function removeChildren(elem) {
- while (elem.firstChild) {
- elem.removeChild(elem.firstChild);
- }
- }
-
- // Helper to parse a url into its building blocks.
- function parseURL(url) {
- var a = document.createElement('a');
- a.href = url;
- return {
- source: url,
- protocol: a.protocol.replace(':',''),
- host: a.hostname,
- port: a.port,
- params: (function(){
- var ret = {};
- var seg = a.search.replace(/^\?/,'').split('&');
- var len = seg.length, i = 0, s;
- for (;i
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Kresko Protocol
-This repository contains the code for the Kresko Protocol. Kresko Protocol supports creating and managing crypto-backed synthetic assets. Prices for synthetic assets are derived from combination of oracle providers (on-demand/push). Protocol uses the EIP-2535 architecture. It enables composability through flexibile storage patterns while allowing users to access all core functionality with a single contract address. This is a usage and integration guide that assumes familiarity with Solidity (and EIP-2535), Foundry, Hardhat and core concepts of Kresko.
-
Usage
-Setup
-(OPTIONAL) create .env file cp .env.example .env
Dependencies
-Install forge dependencies
-forge install
-Install node dependencies
-(Authorized npm token is required in .npmrc for some internal packages. This will be lifted later.)
pnpm i
-Compiling
-Foundry
-Compile the contracts using foundry
-forge build
-Check your setup by running the local forge deployment
-forge script src/contracts/scripts/devnet/Devnet.s.sol:WithLocal
-Hardhat
-Compile the contracts using hardhat
-pnpm compile
-Check your setup by running the local hardhat deployment
-pnpm run deploy --tags local
-Testing
-NOTE: Primary test coverage uses hardhat. Forge tests are a work in progress.
-Hardhat
-Run tests with against a local deployment fixture:
-pnpm test
-Foundry
-forge test --ffi
-Deployment
-Hardhat
-To local network:
-pnpm local
-To live network:
-pnpm deploy --network <network>
-Foundry
-Local
-forge script src/contracts/scripts/devnet/Devnet.s.sol:WithLocal
-Forking
--
-
- value of
process.env.FORKINGmaps to network key and it's setup withinhardhat-configs/networks
- - set a specific block with
process.env.FORKING_BLOCKNUMBER
- - HRE is extended with helpers to get live deployments within the forked network (https://github.com/wighawag/hardhat-deploy#companionnetworks) -
Run deploy in fork
-pnpm fork:deploy
-Run tests with --grep Forking
pnpm fork:test
-Notes about the usage of ERC-2535 (Diamond)
-General
--
-
-
-
All external functions are contained in the facets,
-hardhat-diamond-abiwill combine their ABI to a separate artifact (Kresko.json) after compile.
- -
-
Core logic is mostly defined inside library functions. These internal functions are attached to the minter storage struct for ease of use.
-
- -
-
Storage is used through a inline assembly pointer inside free function. To access the storage (+ attached internal lib functions) simply call the free function anywhere within the diamond.
-
- -
-
Note that Staking, AMM and KreskoAsset contracts do not live inside the diamond scope.
-
-
State
-Nay
--
-
-
-
Do not add new state variables to the beginning or middle of structs. Doing this makes the new state variable overwrite existing state variable data and all state variables after the new state variable reference the wrong storage location.
-
- -
-
Do not put structs directly in structs unless you don’t plan on ever adding more state variables to the inner structs. You won't be able to add new state variables to inner structs in upgrades. This makes sense because a struct uses a fixed number of storage locations. Adding a new state variable to an inner struct would cause the next state variable after the inner struct to be overwritten. Structs that are in mappings can be extended in upgrades, because those structs are stored in random locations based on keccak256 hashing.
-
- -
-
Do not add new state variables to structs that are used in arrays.
-
- -
-
Do not use the same namespace string for different structs. This is obvious. Two different structs at the same location will overwrite each other.
-
-
Yay
--
-
-
-
To add new state variables to DiamondStorage pattern in eg. MinterStorage (ms), add them to the end of the struct. This makes sense because it is not possible for existing facets to overwrite state variables at new storage locations.
-
- -
-
New state variables can be added to the ends of structs that are used in mappings.
-
- -
-
The names of state variables can be changed, but that might be confusing if different facets are using different names for the same storage locations.
-
-
Learning references
-https://eip2535diamonds.substack.com/p/compliance-with-eip-2535-diamonds
-https://github.com/solidstate-network/solidstate-solidity
-https://eip2535diamonds.substack.com/p/how-eip2535-diamonds-reduces-gas
-Contributions
-Contributions to Kresko Protocol are encouraged, feel free to open an issue or pull request.
All contributions are licensed under BUSL1.1.
Contact
-Critical bug disclosures and inquiries should be directed to:
Contents
--
-
- core -
Contents
- -Contents
--
-
- facets -
- funcs -
- interfaces -
- IGnosisSafeL2 -
- Auth -
- Enums -
- Role -
- Constants -
- Percents -
- IErrorFieldProvider -
- Errors -
- LibModifiers -
- Modifiers -
- CommonState -
- GatingState -
- gs -
- cs -
- State constants -
- Oracle -
- FeedConfiguration -
- Asset -
- RoleData -
- MaxLiqVars -
- MaxLiqInfo -
- RawPrice -
- Pause -
- SafetyState -
- CommonInitArgs -
- SCDPCollateralArgs -
- SCDPKrAssetArgs -
- Validations -
Contents
--
-
- AssetConfigurationFacet -
- AssetStateFacet -
- AuthorizationFacet -
- CommonConfigurationFacet -
- CommonStateFacet -
- SafetyCouncilFacet -
AssetConfigurationFacet
- -Inherits: -IAssetConfigurationFacet, Modifiers, DSModifiers
-Functions
-addAsset
-Adds a new asset to the common state.
-Use validateAssetConfig / static call this for validation.
-function addAsset(address _assetAddr, Asset memory _config, address[2] memory _feeds)
- external
- onlyRole(Role.ADMIN)
- returns (Asset memory);
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | Asset address. |
_config | Asset | Configuration struct to save for the asset. |
_feeds | address[2] | Feed addresses, if both are address(0) they are ignored. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | Asset | Asset Result of addAsset. |
updateAsset
-Update asset config.
-Use validateAssetConfig / static call this for validation.
-function updateAsset(address _assetAddr, Asset memory _config) external onlyRole(Role.ADMIN) returns (Asset memory);
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | The asset address. |
_config | Asset | Configuration struct to apply for the asset. |
setAssetCFactor
-Updates the cFactor of a KreskoAsset. Convenience.
-function setAssetCFactor(address _assetAddr, uint16 _newFactor) public onlyRole(Role.ADMIN);
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | The collateral asset. |
_newFactor | uint16 | The new collateral factor. |
setAssetKFactor
-Updates the kFactor of a KreskoAsset.
-function setAssetKFactor(address _assetAddr, uint16 _newFactor) public onlyRole(Role.ADMIN);
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | The KreskoAsset. |
_newFactor | uint16 |
setAssetOracleOrder
-Update oracle order for an asset.
-function setAssetOracleOrder(address _assetAddr, Enums.OracleType[2] memory _newOracleOrder)
- external
- onlyRole(Role.ADMIN);
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | The asset address. |
_newOracleOrder | Enums.OracleType[2] | List of 2 OracleTypes. 0 is primary and 1 is the reference. |
validateAssetConfig
-Validate supplied asset config. Reverts with information if invalid.
-function validateAssetConfig(address _assetAddr, Asset memory _config) external view returns (bool);
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | The asset address. |
_config | Asset | Configuration for the asset. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | bool | bool True for convenience. |
AssetStateFacet
- -Inherits: -IAssetStateFacet
-Functions
-getAsset
-Get the state of a specific asset
-function getAsset(address _assetAddr) external view returns (Asset memory);
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | Address of the asset. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | Asset | Asset State of asset |
getValue
-Get value for an asset amount using the current price.
-function getValue(address _assetAddr, uint256 _amount) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | Asset address. |
_amount | uint256 | The amount (uint256). |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 Current value for _amount of _assetAddr. |
getFeedForAddress
-Gets corresponding feed address for the oracle type and asset address.
-function getFeedForAddress(address _assetAddr, Enums.OracleType _oracleType) external view returns (address);
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | The asset address. |
_oracleType | Enums.OracleType | The oracle type. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | address | feedAddr Feed address that the asset uses with the oracle type. |
getPrice
-Get price for an asset from address.
-function getPrice(address _assetAddr) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | Asset address. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 Current price for the asset. |
getPushPrice
-Get push price for an asset from address.
-function getPushPrice(address _assetAddr) external view returns (RawPrice memory);
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | Asset address. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | RawPrice | RawPrice Current raw price for the asset. |
AuthorizationFacet
- -Inherits: -IAuthorizationFacet
-Author: -Kresko
-The storage area is in the main proxy diamond storage.
-Difference here is the logic library that is shared and reused, there is no state here.
-Functions
-getRoleMember
-WARNING: -When using {getRoleMember} and {getRoleMemberCount}, make sure -you perform all queries on the same block. -See the following forum post for more information:
--
-
- https://forum.openzeppelin.com/t/iterating-over-elements-on-enumerableset-in-openzeppelin-contracts/2296 -
OpenZeppelin
-Returns one of the accounts that have role. index must be a
-value between 0 and {getRoleMemberCount}, non-inclusive.
-Role bearers are not sorted in any particular way, and their ordering may
-change at any point.
function getRoleMember(bytes32 role, uint256 index) external view returns (address);
-Returns
-| Name | Type | Description |
|---|---|---|
<none> | address | address with the role |
getRoleMemberCount
-See warning in {getRoleMember} if combining these two
-Returns the number of accounts that have role. Can be used
-together with {getRoleMember} to enumerate all bearers of a role.
function getRoleMemberCount(bytes32 role) external view returns (uint256);
-grantRole
-*Grants role to account.
-If account had not been already granted role, emits a {RoleGranted}
-event.
-Requirements:
-
-
- the caller must have
role's admin role.*
-
function grantRole(bytes32 role, address account) external;
-revokeRole
-Requirements
--
-
- the caller must have
role's admin role.
-
Revokes role from account.
function revokeRole(bytes32 role, address account) external;
-hasRole
-Returns true if account has been granted role.
function hasRole(bytes32 role, address account) external view returns (bool);
-getRoleAdmin
-To change a role's admin, use {_setRoleAdmin}.
-Returns the admin role that controls role. See {grantRole} and
-{revokeRole}.
function getRoleAdmin(bytes32 role) external view returns (bytes32);
-renounceRole
-Requirements
--
-
- the caller must be
account.
-
Revokes role from the calling account.
-Roles are often managed via {grantRole} and {revokeRole}: this function's
-purpose is to provide a mechanism for accounts to lose their privileges
-if they are compromised (such as when a trusted device is misplaced).
-If the calling account had been revoked role, emits a {RoleRevoked}
-event.
function renounceRole(bytes32 role, address account) external;
-CommonConfigurationFacet
- -Inherits: -ICommonConfigurationFacet, Modifiers, DSModifiers
-Functions
-initializeCommon
-function initializeCommon(CommonInitArgs calldata args) external initializer(2);
-setMinDebtValue
-Updates the contract's minimum debt value.
-function setMinDebtValue(uint96 _newMinDebtValue) public override onlyRole(Role.ADMIN);
-Parameters
-| Name | Type | Description |
|---|---|---|
_newMinDebtValue | uint96 | The new minimum debt value as a wad. |
setFeeRecipient
-Updates the fee recipient.
-function setFeeRecipient(address _newFeeRecipient) public override onlyRole(Role.ADMIN);
-Parameters
-| Name | Type | Description |
|---|---|---|
_newFeeRecipient | address | The new fee recipient. |
setDefaultOraclePrecision
-Sets the decimal precision of external oracle
-function setDefaultOraclePrecision(uint8 _decimals) public onlyRole(Role.ADMIN);
-Parameters
-| Name | Type | Description |
|---|---|---|
_decimals | uint8 | Amount of decimals |
setMaxPriceDeviationPct
-Sets the decimal precision of external oracle
-function setMaxPriceDeviationPct(uint16 _oracleDeviationPct) public onlyRole(Role.ADMIN);
-Parameters
-| Name | Type | Description |
|---|---|---|
_oracleDeviationPct | uint16 | Amount of decimals |
setFeedsForTicker
-Set feeds for a ticker.
-function setFeedsForTicker(bytes32 _ticker, FeedConfiguration calldata _feedConfig) external onlyRole(Role.ADMIN);
-Parameters
-| Name | Type | Description |
|---|---|---|
_ticker | bytes32 | Ticker in bytes32 eg. bytes32("ETH") |
_feedConfig | FeedConfiguration | List oracle configuration containing oracle identifiers and feed addresses. |
setChainlinkFeeds
-Set chainlink feeds for tickers.
-Has modifiers: onlyRole.
-function setChainlinkFeeds(bytes32[] calldata _tickers, address[] calldata _feeds) public onlyRole(Role.ADMIN);
-Parameters
-| Name | Type | Description |
|---|---|---|
_tickers | bytes32[] | Bytes32 list of tickers |
_feeds | address[] | List of feed addresses. |
setApi3Feeds
-Set api3 feeds for tickers.
-Has modifiers: onlyRole.
-function setApi3Feeds(bytes32[] calldata _tickers, address[] calldata _feeds) public onlyRole(Role.ADMIN);
-Parameters
-| Name | Type | Description |
|---|---|---|
_tickers | bytes32[] | Bytes32 list of tickers |
_feeds | address[] | List of feed addresses. |
setChainLinkFeed
-Set ChainLink feed address for ticker.
-function setChainLinkFeed(bytes32 _ticker, address _feedAddr) public onlyRole(Role.ADMIN);
-Parameters
-| Name | Type | Description |
|---|---|---|
_ticker | bytes32 | Ticker in bytes32 eg. bytes32("ETH") |
_feedAddr | address | The feed address. |
setApi3Feed
-Set API3 feed address for an asset.
-function setApi3Feed(bytes32 _ticker, address _feedAddr) public onlyRole(Role.ADMIN);
-Parameters
-| Name | Type | Description |
|---|---|---|
_ticker | bytes32 | Ticker in bytes32 eg. bytes32("ETH") |
_feedAddr | address | The feed address. |
setVaultFeed
-Set a vault feed for ticker.
-Has modifiers: onlyRole.
-function setVaultFeed(bytes32 _ticker, address _vaultAddr) public onlyRole(Role.ADMIN);
-Parameters
-| Name | Type | Description |
|---|---|---|
_ticker | bytes32 | Ticker in bytes32 eg. bytes32("ETH") |
_vaultAddr | address | Vault address |
setSequencerUptimeFeed
-Sets L2 sequencer uptime feed address
-function setSequencerUptimeFeed(address _sequencerUptimeFeed) public override onlyRole(Role.ADMIN);
-Parameters
-| Name | Type | Description |
|---|---|---|
_sequencerUptimeFeed | address | sequencer uptime feed address |
setSequencerGracePeriod
-Sets sequencer grace period time
-function setSequencerGracePeriod(uint32 _sequencerGracePeriodTime) public onlyRole(Role.ADMIN);
-Parameters
-| Name | Type | Description |
|---|---|---|
_sequencerGracePeriodTime | uint32 | grace period time |
setStaleTime
-Sets the time in seconds until a price is considered stale.
-function setStaleTime(uint32 _staleTime) public onlyRole(Role.ADMIN);
-Parameters
-| Name | Type | Description |
|---|---|---|
_staleTime | uint32 | Time in seconds. |
setGatingPhase
-Sets phase of gating mechanism
-function setGatingPhase(uint8 _phase) public override onlyRole(Role.ADMIN);
-Parameters
-| Name | Type | Description |
|---|---|---|
_phase | uint8 | phase id |
setKreskianCollection
-Sets address of Kreskian NFT contract
-function setKreskianCollection(address _kreskian) public override onlyRole(Role.ADMIN);
-Parameters
-| Name | Type | Description |
|---|---|---|
_kreskian | address | kreskian nft contract address |
setQuestForKreskCollection
-Sets address of Quest For Kresk NFT contract
-function setQuestForKreskCollection(address _questForKresk) public override onlyRole(Role.ADMIN);
-Parameters
-| Name | Type | Description |
|---|---|---|
_questForKresk | address | Quest For Kresk NFT contract address |
CommonStateFacet
- -Inherits: -ICommonStateFacet
-Functions
-getFeeRecipient
-The recipient of protocol fees.
-function getFeeRecipient() external view returns (address);
-getDefaultOraclePrecision
-Offchain oracle decimals
-function getDefaultOraclePrecision() external view returns (uint8);
-getMinDebtValue
-The minimum USD value of an individual synthetic asset debt position.
-function getMinDebtValue() external view returns (uint96);
-getOracleDeviationPct
-max deviation between main oracle and fallback oracle
-function getOracleDeviationPct() external view returns (uint16);
-getSequencerUptimeFeed
-Get the L2 sequencer uptime feed address.
-function getSequencerUptimeFeed() external view returns (address);
-getSequencerGracePeriod
-Get the L2 sequencer uptime feed grace period
-function getSequencerGracePeriod() external view returns (uint32);
-getOracleTimeout
-Get stale timeout treshold for oracle answers.
-function getOracleTimeout() external view returns (uint32);
-getFeedForId
-Get tickers configured feed address for the oracle type.
-function getFeedForId(bytes32 _ticker, Enums.OracleType _oracleType) external view returns (address);
-Parameters
-| Name | Type | Description |
|---|---|---|
_ticker | bytes32 | Ticker in bytes32, eg. bytes32("ETH"). |
_oracleType | Enums.OracleType | The oracle type. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | address | feedAddr Feed address matching the oracle type given. |
redstonePrice
-Price getter for Redstone, extracting the price from "hidden" calldata. -Reverts for a number of reasons, notably:
--
-
- Invalid calldata -
- Not enough signers for the price data. -
- Wrong signers for the price data. -
- Stale price data. -
- Not enough data points -
function redstonePrice(bytes32 _ticker, address) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_ticker | bytes32 | The reference asset ticker in bytes32, eg. bytes32("ETH"). |
<none> | address |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 Extracted price with enough unique signers. |
getAPI3Price
-Price getter for API3 type feeds.
-Valid call will revert if the answer is negative.
-function getAPI3Price(address _feedAddr) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_feedAddr | address | IProxy type feed address. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 Price answer from the feed, 0 if the price is stale. |
getVaultPrice
-Price getter for Vault based asset.
-function getVaultPrice(address _vaultAddr) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_vaultAddr | address | IVaultFeed type feed address. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 Current price of one vault share. |
getChainlinkPrice
-Price getter for AggregatorV3/Chainlink type feeds.
-Valid call will revert if the answer is negative.
-function getChainlinkPrice(address _feedAddr) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_feedAddr | address | AggregatorV3 type feed address. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 Price answer from the feed, 0 if the price is stale. |
SafetyCouncilFacet
- -Inherits: -Modifiers, ISafetyCouncilFacet
-Author: -Kresko
-Role.SAFETY_COUNCIL must be a multisig.
Functions
-toggleAssetsPaused
-These functions are only callable by a multisig quorum.
-Toggle paused-state of assets in a per-action basis
-function toggleAssetsPaused(address[] calldata _assets, Enums.Action _action, bool _withDuration, uint256 _duration)
- external
- override
- onlyRole(Role.SAFETY_COUNCIL);
-Parameters
-| Name | Type | Description |
|---|---|---|
_assets | address[] | list of addresses of krAssets and/or collateral assets |
_action | Enums.Action | One of possible user actions: Deposit = 0 Withdraw = 1, Repay = 2, Borrow = 3, Liquidate = 4 |
_withDuration | bool | Set a duration for this pause - @todo: implement it if required |
_duration | uint256 | Duration for the pause if _withDuration is true |
setSafetyStateSet
-set the safetyStateSet flag
-loop through _assets - be it krAsset or collateral
function setSafetyStateSet(bool val) external override onlyRole(Role.SAFETY_COUNCIL);
-safetyStateSet
-For external checks if a safety state has been set for any asset
-function safetyStateSet() external view override returns (bool);
-safetyStateFor
-View the state of safety measures for an asset on a per-action basis
-function safetyStateFor(address _assetAddr, Enums.Action _action) external view override returns (SafetyState memory);
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | krAsset / collateral asset |
_action | Enums.Action | One of possible user actions: Deposit = 0 Withdraw = 1, Repay = 2, Borrow = 3, Liquidate = 4 |
assetActionPaused
-Check if _assetAddr has a pause enabled for _action
function assetActionPaused(Enums.Action _action, address _assetAddr) external view returns (bool);
-Parameters
-| Name | Type | Description |
|---|---|---|
_action | Enums.Action | enum Action Deposit = 0 Withdraw = 1, Repay = 2, Borrow = 3, Liquidate = 4 |
_assetAddr | address |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | bool | true if _action is paused |
Contents
--
-
- burnKrAsset -
- burnSCDP -
- mintKrAsset -
- mintSCDP -
- Assets -
- collateralAmountToValues -
- debtAmountToValues -
- wadUSD -
- fromWad -
- valueToAmount -
- toWad -
- oraclePrice -
- vaultPrice -
- rawPrice -
- handleSequencerDown -
- API3RawPrice -
- aggregatorV3Price -
- API3Price -
- deducePrice -
- safePrice -
- aggregatorV3RawPrice -
- SDIPrice -
- isSequencerUp -
burnKrAsset
- -Burn kresko assets with anchor already known.
-function burnKrAsset(uint256 _burnAmount, address _fromAddr, address _anchorAddr) returns (uint256 burned);
-Parameters
-| Name | Type | Description |
|---|---|---|
_burnAmount | uint256 | The amount being burned |
_fromAddr | address | The account to burn assets from. |
_anchorAddr | address | The anchor token of the asset being burned. |
burnSCDP
- -Repay SCDP swap debt.
-function burnSCDP(Asset storage _asset, uint256 _burnAmount, address _fromAddr) returns (uint256 destroyed);
-Parameters
-| Name | Type | Description |
|---|---|---|
_asset | Asset | the asset being repaid |
_burnAmount | uint256 | the asset amount being burned |
_fromAddr | address | the account to burn assets from |
mintKrAsset
- -Mint kresko assets with anchor already known.
-function mintKrAsset(uint256 _mintAmount, address _toAddr, address _anchorAddr) returns (uint256 minted);
-Parameters
-| Name | Type | Description |
|---|---|---|
_mintAmount | uint256 | The asset amount being minted |
_toAddr | address | The account receiving minted assets. |
_anchorAddr | address | The anchor token of the minted asset. |
mintSCDP
- -Mint kresko assets from SCDP swap.
-function mintSCDP(Asset storage _asset, uint256 _mintAmount, address _toAddr) returns (uint256 issued);
-Parameters
-| Name | Type | Description |
|---|---|---|
_asset | Asset | the asset requested |
_mintAmount | uint256 | the asset amount requested |
_toAddr | address | the account to mint the assets to |
Assets
- -Functions
-price
-function price(Asset storage self) internal view returns (uint256);
-price
-function price(Asset storage self, uint256 maxPriceDeviationPct) internal view returns (uint256);
-uintUSD
-Get value for @param _assetAmount of @param self in uint256
-function uintUSD(Asset storage self, uint256 _amount) internal view returns (uint256);
-redstonePrice
-Get the oracle price of an asset in uint256 with oracleDecimals
-function redstonePrice(Asset storage self) internal view returns (uint256);
-marketStatus
-function marketStatus(Asset storage) internal pure returns (bool);
-boundRepayValue
-Ensure repayment value (and amount), clamp to max if necessary.
-function boundRepayValue(Asset storage self, uint256 _maxRepayValue, uint256 _repayAmount)
- internal
- view
- returns (uint256 repayValue, uint256 repayAmount);
-Parameters
-| Name | Type | Description |
|---|---|---|
self | Asset | |
_maxRepayValue | uint256 | The max liquidatable USD (uint256). |
_repayAmount | uint256 | The repay amount (uint256). |
Returns
-| Name | Type | Description |
|---|---|---|
repayValue | uint256 | Effective repayment value. |
repayAmount | uint256 | Effective repayment amount. |
collateralAmountToValue
-Gets the collateral value for a single collateral asset and amount.
-function collateralAmountToValue(Asset storage self, uint256 _amount, bool _ignoreFactor)
- internal
- view
- returns (uint256 value);
-Parameters
-| Name | Type | Description |
|---|---|---|
self | Asset | |
_amount | uint256 | Amount of asset to get the value for. |
_ignoreFactor | bool | Should collateral factor be ignored. |
Returns
-| Name | Type | Description |
|---|---|---|
value | uint256 | Value for _amount of the asset. |
collateralAmountToValueWithPrice
-Gets the collateral value for _amount and returns the price used.
function collateralAmountToValueWithPrice(Asset storage self, uint256 _amount, bool _ignoreFactor)
- internal
- view
- returns (uint256 value, uint256 assetPrice);
-Parameters
-| Name | Type | Description |
|---|---|---|
self | Asset | |
_amount | uint256 | Amount of asset |
_ignoreFactor | bool | Should collateral factor be ignored. |
Returns
-| Name | Type | Description |
|---|---|---|
value | uint256 | Value for _amount of the asset. |
assetPrice | uint256 | Price of the collateral asset. |
debtAmountToValue
-Gets the USD value for a single Kresko asset and amount.
-function debtAmountToValue(Asset storage self, uint256 _amount, bool _ignoreKFactor)
- internal
- view
- returns (uint256 value);
-Parameters
-| Name | Type | Description |
|---|---|---|
self | Asset | |
_amount | uint256 | Amount of the Kresko asset to calculate the value for. |
_ignoreKFactor | bool | Boolean indicating if the asset's k-factor should be ignored. |
Returns
-| Name | Type | Description |
|---|---|---|
value | uint256 | Value for the provided amount of the Kresko asset. |
debtValueToAmount
-Gets the amount for a single debt asset and value.
-function debtValueToAmount(Asset storage self, uint256 _value, bool _ignoreKFactor)
- internal
- view
- returns (uint256 amount);
-Parameters
-| Name | Type | Description |
|---|---|---|
self | Asset | |
_value | uint256 | Value of the asset to calculate the amount for. |
_ignoreKFactor | bool | Boolean indicating if the asset's k-factor should be ignored. |
Returns
-| Name | Type | Description |
|---|---|---|
amount | uint256 | Amount for the provided value of the Kresko asset. |
debtAmountToSDI
-Preview SDI amount from krAsset amount.
-function debtAmountToSDI(Asset storage asset, uint256 amount, bool ignoreFactors)
- internal
- view
- returns (uint256 shares);
-checkDust
-Check that amount does not put the user's debt position below the minimum debt value.
-function checkDust(Asset storage _asset, uint256 _burnAmount, uint256 _debtAmount)
- internal
- view
- returns (uint256 amount);
-Parameters
-| Name | Type | Description |
|---|---|---|
_asset | Asset | Asset being burned. |
_burnAmount | uint256 | Debt amount burned. |
_debtAmount | uint256 | Debt amount before burn. |
Returns
-| Name | Type | Description |
|---|---|---|
amount | uint256 | >= minDebtAmount |
ensureMinDebtValue
-Checks min debt value against some amount.
-function ensureMinDebtValue(Asset storage _asset, address _krAsset, uint256 _debtAmount) internal view;
-Parameters
-| Name | Type | Description |
|---|---|---|
_asset | Asset | The asset (Asset). |
_krAsset | address | The kresko asset address. |
_debtAmount | uint256 | The debt amount (uint256). |
minCollateralValueAtRatio
-Get the minimum collateral value required to -back a Kresko asset amount at a given collateralization ratio.
-function minCollateralValueAtRatio(Asset storage _krAsset, uint256 _amount, uint32 _ratio)
- internal
- view
- returns (uint256 minCollateralValue);
-Parameters
-| Name | Type | Description |
|---|---|---|
_krAsset | Asset | Address of the Kresko asset. |
_amount | uint256 | Kresko Asset debt amount. |
_ratio | uint32 | Collateralization ratio for the minimum collateral value. |
Returns
-| Name | Type | Description |
|---|---|---|
minCollateralValue | uint256 | Minimum collateral value required for _amount of the Kresko Asset. |
exists
-function exists(Asset storage self) internal view returns (bool);
-isVoid
-function isVoid(Asset storage self) internal view returns (bool);
-ensureMinKrAssetCollateral
-EDGE CASE: If the collateral asset is also a kresko asset, ensure that the deposit amount is above the minimum.
-This is done because kresko assets can be rebased.
-function ensureMinKrAssetCollateral(Asset storage self, address _self, uint256 _newCollateralAmount) internal view;
-toRebasingAmount
-Amount of non rebasing tokens -> amount of rebasing tokens
-DO use this function when reading values storage.
-DONT use this function when writing to storage.
-function toRebasingAmount(Asset storage self, uint256 _unrebasedAmount)
- internal
- view
- returns (uint256 maybeRebasedAmount);
-Parameters
-| Name | Type | Description |
|---|---|---|
self | Asset | |
_unrebasedAmount | uint256 | Unrebased amount to convert. |
Returns
-| Name | Type | Description |
|---|---|---|
maybeRebasedAmount | uint256 | Possibly rebased amount of asset |
toNonRebasingAmount
-Amount of rebasing tokens -> amount of non rebasing tokens
-DONT use this function when reading from storage.
-DO use this function when writing to storage.
-function toNonRebasingAmount(Asset storage self, uint256 _maybeRebasedAmount)
- internal
- view
- returns (uint256 maybeUnrebasedAmount);
-Parameters
-| Name | Type | Description |
|---|---|---|
self | Asset | |
_maybeRebasedAmount | uint256 | Possibly rebased amount of asset. |
Returns
-| Name | Type | Description |
|---|---|---|
maybeUnrebasedAmount | uint256 | Possibly unrebased amount of asset |
collateralAmountToValues
- -Helper function to get unadjusted, adjusted and price values for collateral assets
-function collateralAmountToValues(Asset storage self, uint256 _amount)
- view
- returns (uint256 value, uint256 valueAdjusted, uint256 price);
-debtAmountToValues
- -Helper function to get unadjusted, adjusted and price values for debt assets
-function debtAmountToValues(Asset storage self, uint256 _amount)
- view
- returns (uint256 value, uint256 valueAdjusted, uint256 price);
-wadUSD
- -Get the value of _amount and convert to 18 decimal precision.
function wadUSD(uint256 _amount, uint8 _amountDecimal, uint256 _price, uint8 _priceDecimals) pure returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_amount | uint256 | Amount of tokens to calculate. |
_amountDecimal | uint8 | Precision of _amount. |
_price | uint256 | Price to use. |
_priceDecimals | uint8 | Precision of _price. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 Value of _amount in 18 decimal precision. |
fromWad
- -Converts wad precision _amount to wad decimal precision, which is 18 decimals.
Multiplies if precision is greater and divides if precision is less than 18 decimals.
-function fromWad(uint256 _wadAmount, uint8 _decimals) pure returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_wadAmount | uint256 | Wad precision amount to convert. |
_decimals | uint8 | Decimal precision for the result. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 Amount converted to _decimals precision. |
valueToAmount
- -Calculate amount for value provided with possible incentive multiplier for value.
-function valueToAmount(uint256 _value, uint256 _price, uint16 _multiplier) pure returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_value | uint256 | Value to convert into amount. |
_price | uint256 | The price to apply. |
_multiplier | uint16 | Multiplier to apply, 1e4 = 100.00% precision. |
function toWad
- -toWad(uint256, uint8)
-Converts decimal precision of _amount to wad decimal precision, which is 18 decimals.
Multiplies if precision is less and divides if precision is greater than 18 decimals.
-function toWad(uint256 _amount, uint8 _decimals) pure returns (uint256);
-toWad(int256, uint8)
-function toWad(int256 _amount, uint8 _decimals) pure returns (uint256);
-oraclePrice
- -Call the price getter for the oracle provided and return the price.
-function oraclePrice(Enums.OracleType _oracleId, bytes32 _ticker) view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_oracleId | Enums.OracleType | The oracle id (uint8). |
_ticker | bytes32 | Ticker for the asset |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 oracle price. This will return 0 if the oracle is not set. |
vaultPrice
- -Gets the price from the provided vault.
-Vault exchange rate is in 18 decimal precision so we normalize to 8 decimals.
-function vaultPrice(address _vaultAddr) view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_vaultAddr | address | The vault address. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 The price of the vault share in 8 decimal precision. |
rawPrice
- -Return raw answer info from the oracles provided
-function rawPrice(Enums.OracleType[2] memory _oracles, bytes32 _ticker) view returns (RawPrice memory);
-Parameters
-| Name | Type | Description |
|---|---|---|
_oracles | Enums.OracleType[2] | Oracles to check. |
_ticker | bytes32 | Ticker for the asset. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | RawPrice | RawPrice Unparsed answer with metadata. |
handleSequencerDown
- -Handles the prices in case the sequencer is down.
-Looks for redstone price, reverting if not available for asset.
-function handleSequencerDown(Enums.OracleType[2] memory oracles, uint256[2] memory prices) pure returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
oracles | Enums.OracleType[2] | The oracle types. |
prices | uint256[2] | The fetched oracle prices. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 Usable price of the asset. |
API3RawPrice
- -Gets raw answer info from IAPI3 type feed.
-function API3RawPrice(address _feedAddr) view returns (RawPrice memory);
-Parameters
-| Name | Type | Description |
|---|---|---|
_feedAddr | address | The feed address. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | RawPrice | RawPrice Unparsed answer with metadata. |
aggregatorV3Price
- -Gets answer from AggregatorV3 type feed.
-function aggregatorV3Price(address _feedAddr, uint256 _staleTime) view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_feedAddr | address | The feed address. |
_staleTime | uint256 | Time in seconds for the feed to be considered stale. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 Parsed answer from the feed, 0 if its stale. |
API3Price
- -Gets answer from IAPI3 type feed.
-function API3Price(address _feedAddr, uint256 _staleTime) view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_feedAddr | address | The feed address. |
_staleTime | uint256 | Staleness threshold. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 Parsed answer from the feed, 0 if its stale. |
deducePrice
- -Checks the primary and reference price for deviations.
-Reverts if the price deviates more than _oracleDeviationPct
function deducePrice(uint256 _primaryPrice, uint256 _referencePrice, uint256 _oracleDeviationPct)
- pure
- returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_primaryPrice | uint256 | the primary price source to use |
_referencePrice | uint256 | the reference price to compare primary against |
_oracleDeviationPct | uint256 | the deviation percentage to use for the oracle |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 Primary price if its within deviation range of reference price. = the primary price is reference price is 0. = the reference price if primary price is 0. = reverts if price deviates more than _oracleDeviationPct |
safePrice
- -Gets the oracle price using safety checks for deviation and sequencer uptime
-Reverts when price deviates more than _oracleDeviationPct
function safePrice(bytes32 _ticker, Enums.OracleType[2] memory _oracles, uint256 _oracleDeviationPct)
- view
- returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_ticker | bytes32 | Ticker of the price |
_oracles | Enums.OracleType[2] | The list of oracle identifiers |
_oracleDeviationPct | uint256 | the deviation percentage |
aggregatorV3RawPrice
- -Gets raw answer info from AggregatorV3 type feed.
-function aggregatorV3RawPrice(address _feedAddr) view returns (RawPrice memory);
-Parameters
-| Name | Type | Description |
|---|---|---|
_feedAddr | address | The feed address. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | RawPrice | RawPrice Unparsed answer with metadata. |
SDIPrice
- -Get the price of SDI in USD, oracle precision.
-function SDIPrice() view returns (uint256);
-isSequencerUp
- -Checks if the L2 sequencer is up. -1 means the sequencer is down, 0 means the sequencer is up.
-function isSequencerUp(address _uptimeFeed, uint256 _gracePeriod) view returns (bool);
-Parameters
-| Name | Type | Description |
|---|---|---|
_uptimeFeed | address | The address of the uptime feed. |
_gracePeriod | uint256 | The grace period in seconds. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | bool | bool returns true/false if the sequencer is up/not. |
Contents
--
-
- IAssetConfigurationFacet -
- IAssetStateFacet -
- IAuthorizationFacet -
- ICommonConfigurationFacet -
- ICommonStateFacet -
- IERC1155 -
- ISafetyCouncilFacet -
IAssetConfigurationFacet
- -Functions
-addAsset
-Adds a new asset to the common state.
-Performs validations according to the _config provided.
Use validateAssetConfig / static call this for validation.
-function addAsset(address _assetAddr, Asset memory _config, address[2] memory _feeds) external returns (Asset memory);
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | Asset address. |
_config | Asset | Configuration struct to save for the asset. |
_feeds | address[2] | Feed addresses, if both are address(0) they are ignored. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | Asset | Asset Result of addAsset. |
updateAsset
-Update asset config.
-Performs validations according to the _config set.
Use validateAssetConfig / static call this for validation.
-function updateAsset(address _assetAddr, Asset memory _config) external returns (Asset memory);
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | The asset address. |
_config | Asset | Configuration struct to apply for the asset. |
setAssetCFactor
-Updates the cFactor of a KreskoAsset. Convenience.
-function setAssetCFactor(address _assetAddr, uint16 _newFactor) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | The collateral asset. |
_newFactor | uint16 | The new collateral factor. |
setAssetKFactor
-Updates the kFactor of a KreskoAsset.
-function setAssetKFactor(address _assetAddr, uint16 _newKFactor) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | The KreskoAsset. |
_newKFactor | uint16 | The new kFactor. |
validateAssetConfig
-Validate supplied asset config. Reverts with information if invalid.
-function validateAssetConfig(address _assetAddr, Asset memory _config) external view returns (bool);
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | The asset address. |
_config | Asset | Configuration for the asset. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | bool | bool True for convenience. |
setAssetOracleOrder
-Update oracle order for an asset.
-function setAssetOracleOrder(address _assetAddr, Enums.OracleType[2] memory _newOracleOrder) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | The asset address. |
_newOracleOrder | Enums.OracleType[2] | List of 2 OracleTypes. 0 is primary and 1 is the reference. |
IAssetStateFacet
- -Functions
-getAsset
-Get the state of a specific asset
-function getAsset(address _assetAddr) external view returns (Asset memory);
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | Address of the asset. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | Asset | Asset State of asset |
getPrice
-Get price for an asset from address.
-function getPrice(address _assetAddr) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | Asset address. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 Current price for the asset. |
getPushPrice
-Get push price for an asset from address.
-function getPushPrice(address _assetAddr) external view returns (RawPrice memory);
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | Asset address. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | RawPrice | RawPrice Current raw price for the asset. |
getValue
-Get value for an asset amount using the current price.
-function getValue(address _assetAddr, uint256 _amount) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | Asset address. |
_amount | uint256 | The amount (uint256). |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 Current value for _amount of _assetAddr. |
getFeedForAddress
-Gets corresponding feed address for the oracle type and asset address.
-function getFeedForAddress(address _assetAddr, Enums.OracleType _oracleType) external view returns (address feedAddr);
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | The asset address. |
_oracleType | Enums.OracleType | The oracle type. |
Returns
-| Name | Type | Description |
|---|---|---|
feedAddr | address | Feed address that the asset uses with the oracle type. |
IAuthorizationFacet
- -Functions
-getRoleMember
-WARNING: -When using {getRoleMember} and {getRoleMemberCount}, make sure -you perform all queries on the same block. -See the following forum post for more information:
--
-
- https://forum.openzeppelin.com/t/iterating-over-elements-on-enumerableset-in-openzeppelin-contracts/2296 -
OpenZeppelin
-Returns one of the accounts that have role. index must be a
-value between 0 and {getRoleMemberCount}, non-inclusive.
-Role bearers are not sorted in any particular way, and their ordering may
-change at any point.
*Kresko -TL;DR above:
--
-
- If you iterate the EnumSet outside a single block scope you might get different results. -
- Since when EnumSet member is deleted it is replaced with the highest index.* -
function getRoleMember(bytes32 role, uint256 index) external view returns (address);
-Returns
-| Name | Type | Description |
|---|---|---|
<none> | address | address with the role |
getRoleMemberCount
-See warning in {getRoleMember} if combining these two
-Returns the number of accounts that have role. Can be used
-together with {getRoleMember} to enumerate all bearers of a role.
function getRoleMemberCount(bytes32 role) external view returns (uint256);
-grantRole
-*Grants role to account.
-If account had not been already granted role, emits a {RoleGranted}
-event.
-Requirements:
-
-
- the caller must have
role's admin role.*
-
function grantRole(bytes32 role, address account) external;
-getRoleAdmin
-To change a role's admin, use {_setRoleAdmin}.
-Returns the admin role that controls role. See {grantRole} and
-{revokeRole}.
function getRoleAdmin(bytes32 role) external view returns (bytes32);
-hasRole
-Returns true if account has been granted role.
function hasRole(bytes32 role, address account) external view returns (bool);
-renounceRole
-Requirements
--
-
- the caller must be
account.
-
Revokes role from the calling account.
-Roles are often managed via {grantRole} and {revokeRole}: this function's
-purpose is to provide a mechanism for accounts to lose their privileges
-if they are compromised (such as when a trusted device is misplaced).
-If the calling account had been revoked role, emits a {RoleRevoked}
-event.
function renounceRole(bytes32 role, address account) external;
-revokeRole
-Requirements
--
-
- the caller must have
role's admin role.
-
Revokes role from account.
function revokeRole(bytes32 role, address account) external;
-ICommonConfigurationFacet
- -Functions
-setFeeRecipient
-Updates the fee recipient.
-function setFeeRecipient(address _newFeeRecipient) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_newFeeRecipient | address | The new fee recipient. |
setMinDebtValue
-Updates the contract's minimum debt value.
-function setMinDebtValue(uint96 _newMinDebtValue) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_newMinDebtValue | uint96 | The new minimum debt value as a wad. |
setDefaultOraclePrecision
-Sets the decimal precision of external oracle
-function setDefaultOraclePrecision(uint8 _decimals) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_decimals | uint8 | Amount of decimals |
setMaxPriceDeviationPct
-Sets the decimal precision of external oracle
-function setMaxPriceDeviationPct(uint16 _oracleDeviationPct) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_oracleDeviationPct | uint16 | Amount of decimals |
setSequencerUptimeFeed
-Sets L2 sequencer uptime feed address
-function setSequencerUptimeFeed(address _sequencerUptimeFeed) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_sequencerUptimeFeed | address | sequencer uptime feed address |
setSequencerGracePeriod
-Sets sequencer grace period time
-function setSequencerGracePeriod(uint32 _sequencerGracePeriodTime) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_sequencerGracePeriodTime | uint32 | grace period time |
setStaleTime
-Sets the time in seconds until a price is considered stale.
-function setStaleTime(uint32 _staleTime) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_staleTime | uint32 | Time in seconds. |
setFeedsForTicker
-Set feeds for a ticker.
-function setFeedsForTicker(bytes32 _ticker, FeedConfiguration memory _feedConfig) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_ticker | bytes32 | Ticker in bytes32 eg. bytes32("ETH") |
_feedConfig | FeedConfiguration | List oracle configuration containing oracle identifiers and feed addresses. |
setChainlinkFeeds
-Set chainlink feeds for tickers.
-Has modifiers: onlyRole.
-function setChainlinkFeeds(bytes32[] calldata _tickers, address[] calldata _feeds) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_tickers | bytes32[] | Bytes32 list of tickers |
_feeds | address[] | List of feed addresses. |
setApi3Feeds
-Set api3 feeds for tickers.
-Has modifiers: onlyRole.
-function setApi3Feeds(bytes32[] calldata _tickers, address[] calldata _feeds) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_tickers | bytes32[] | Bytes32 list of tickers |
_feeds | address[] | List of feed addresses. |
setVaultFeed
-Set a vault feed for ticker.
-Has modifiers: onlyRole.
-function setVaultFeed(bytes32 _ticker, address _vaultAddr) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_ticker | bytes32 | Ticker in bytes32 eg. bytes32("ETH") |
_vaultAddr | address | Vault address |
setChainLinkFeed
-Set ChainLink feed address for ticker.
-function setChainLinkFeed(bytes32 _ticker, address _feedAddr) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_ticker | bytes32 | Ticker in bytes32 eg. bytes32("ETH") |
_feedAddr | address | The feed address. |
setApi3Feed
-Set API3 feed address for an asset.
-function setApi3Feed(bytes32 _ticker, address _feedAddr) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_ticker | bytes32 | Ticker in bytes32 eg. bytes32("ETH") |
_feedAddr | address | The feed address. |
setGatingPhase
-Sets phase of gating mechanism
-function setGatingPhase(uint8 _phase) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_phase | uint8 | phase id |
setKreskianCollection
-Sets address of Kreskian NFT contract
-function setKreskianCollection(address _kreskian) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_kreskian | address | kreskian nft contract address |
setQuestForKreskCollection
-Sets address of Quest For Kresk NFT contract
-function setQuestForKreskCollection(address _questForKresk) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_questForKresk | address | Quest For Kresk NFT contract address |
ICommonStateFacet
- -Functions
-getFeeRecipient
-The recipient of protocol fees.
-function getFeeRecipient() external view returns (address);
-getDefaultOraclePrecision
-Offchain oracle decimals
-function getDefaultOraclePrecision() external view returns (uint8);
-getOracleDeviationPct
-max deviation between main oracle and fallback oracle
-function getOracleDeviationPct() external view returns (uint16);
-getMinDebtValue
-The minimum USD value of an individual synthetic asset debt position.
-function getMinDebtValue() external view returns (uint96);
-getSequencerUptimeFeed
-Get the L2 sequencer uptime feed address.
-function getSequencerUptimeFeed() external view returns (address);
-getSequencerGracePeriod
-Get the L2 sequencer uptime feed grace period
-function getSequencerGracePeriod() external view returns (uint32);
-getOracleTimeout
-Get stale timeout treshold for oracle answers.
-function getOracleTimeout() external view returns (uint32);
-getFeedForId
-Get tickers configured feed address for the oracle type.
-function getFeedForId(bytes32 _ticker, Enums.OracleType _oracleType) external view returns (address feedAddr);
-Parameters
-| Name | Type | Description |
|---|---|---|
_ticker | bytes32 | Ticker in bytes32, eg. bytes32("ETH"). |
_oracleType | Enums.OracleType | The oracle type. |
Returns
-| Name | Type | Description |
|---|---|---|
feedAddr | address | Feed address matching the oracle type given. |
getChainlinkPrice
-Price getter for AggregatorV3/Chainlink type feeds.
-Returns 0-price if answer is stale. This triggers the use of a secondary provider if available.
-Valid call will revert if the answer is negative.
-function getChainlinkPrice(address _feedAddr) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_feedAddr | address | AggregatorV3 type feed address. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 Price answer from the feed, 0 if the price is stale. |
getVaultPrice
-Price getter for Vault based asset.
-Reverts if for stale, 0 or negative answers.
-function getVaultPrice(address _vaultAddr) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_vaultAddr | address | IVaultFeed type feed address. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 Current price of one vault share. |
redstonePrice
-Price getter for Redstone, extracting the price from "hidden" calldata. -Reverts for a number of reasons, notably:
--
-
- Invalid calldata -
- Not enough signers for the price data. -
- Wrong signers for the price data. -
- Stale price data. -
- Not enough data points -
function redstonePrice(bytes32 _ticker, address) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_ticker | bytes32 | The reference asset ticker in bytes32, eg. bytes32("ETH"). |
<none> | address |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 Extracted price with enough unique signers. |
getAPI3Price
-Price getter for API3 type feeds.
-Decimal precision is NOT the same as other sources.
-Returns 0-price if answer is stale.This triggers the use of a secondary provider if available.
-Valid call will revert if the answer is negative.
-function getAPI3Price(address _feedAddr) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_feedAddr | address | IProxy type feed address. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 Price answer from the feed, 0 if the price is stale. |
IERC1155
- -Functions
-balanceOf
-function balanceOf(address account, uint256 id) external view returns (uint256);
-ISafetyCouncilFacet
- -Functions
-toggleAssetsPaused
-These functions are only callable by a multisig quorum.
-Toggle paused-state of assets in a per-action basis
-function toggleAssetsPaused(address[] memory _assets, Enums.Action _action, bool _withDuration, uint256 _duration)
- external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_assets | address[] | list of addresses of krAssets and/or collateral assets |
_action | Enums.Action | One of possible user actions: Deposit = 0 Withdraw = 1, Repay = 2, Borrow = 3, Liquidate = 4 |
_withDuration | bool | Set a duration for this pause - @todo: implement it if required |
_duration | uint256 | Duration for the pause if _withDuration is true |
setSafetyStateSet
-set the safetyStateSet flag
-function setSafetyStateSet(bool val) external;
-safetyStateSet
-For external checks if a safety state has been set for any asset
-function safetyStateSet() external view returns (bool);
-safetyStateFor
-View the state of safety measures for an asset on a per-action basis
-function safetyStateFor(address _assetAddr, Enums.Action _action) external view returns (SafetyState memory);
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | krAsset / collateral asset |
_action | Enums.Action | One of possible user actions: Deposit = 0 Withdraw = 1, Repay = 2, Borrow = 3, Liquidate = 4 |
assetActionPaused
-Check if _assetAddr has a pause enabled for _action
function assetActionPaused(Enums.Action _action, address _assetAddr) external view returns (bool);
-Parameters
-| Name | Type | Description |
|---|---|---|
_action | Enums.Action | enum Action Deposit = 0 Withdraw = 1, Repay = 2, Borrow = 3, Liquidate = 4 |
_assetAddr | address |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | bool | true if _action is paused |
IGnosisSafeL2
- -Functions
-isOwner
-function isOwner(address owner) external view returns (bool);
-getOwners
-function getOwners() external view returns (address[] memory);
-Auth
- -Author: -Kresko
-Functions
-hasRole
-function hasRole(bytes32 role, address account) internal view returns (bool);
-getRoleMemberCount
-function getRoleMemberCount(bytes32 role) internal view returns (uint256);
-checkRole
-Revert with a standard message if msg.sender is missing role.
-Overriding this function changes the behavior of the {onlyRole} modifier.
-Format of the revert message is described in {_checkRole}.
-Available since v4.6.
function checkRole(bytes32 role) internal view;
-_checkRole
-Revert with a standard message if account is missing role.
-The format of the revert reason is given by the following regular expression:
-/^AccessControl: account (0x[0-9a-f]{40}) is missing role (0x[0-9a-f]{64})$/
function _checkRole(bytes32 role, address account) internal view;
-getRoleAdmin
-Returns the admin role that controls role. See {grantRole} and
-{revokeRole}.
-To change a role's admin, use {_setRoleAdmin}.
function getRoleAdmin(bytes32 role) internal view returns (bytes32);
-getRoleMember
-function getRoleMember(bytes32 role, uint256 index) internal view returns (address);
-setupSecurityCouncil
-setups the security council
-function setupSecurityCouncil(address _councilAddress) internal;
-transferSecurityCouncil
-function transferSecurityCouncil(address _newCouncil) internal;
-grantRole
-*Grants role to account.
-If account had not been already granted role, emits a {RoleGranted}
-event.
-Requirements:
-
-
- the caller must have
role's admin role.*
-
function grantRole(bytes32 role, address account) internal;
-revokeRole
-*Revokes role from account.
-If account had been granted role, emits a {RoleRevoked} event.
-Requirements:
-
-
- the caller must have
role's admin role.*
-
function revokeRole(bytes32 role, address account) internal;
-_renounceRole
-*Revokes role from the calling account.
-Roles are often managed via {grantRole} and {revokeRole}: this function's
-purpose is to provide a mechanism for accounts to lose their privileges
-if they are compromised (such as when a trusted device is misplaced).
-If the calling account had been revoked role, emits a {RoleRevoked}
-event.
-Requirements:
-
-
- the caller must be
account.*
-
function _renounceRole(bytes32 role, address account) internal;
-_setRoleAdmin
-Sets adminRole as role's admin role.
-Emits a {RoleAdminChanged} event.
function _setRoleAdmin(bytes32 role, bytes32 adminRole) internal;
-_grantRole
-Cannot grant the role SAFETY_COUNCIL - must be done via explicit function.
-Internal function without access restriction.
Grants role to account.
function _grantRole(bytes32 role, address account) internal ensureNotSafetyCouncil(role);
-_revokeRole
-Revokes role from account.
-Internal function without access restriction.
function _revokeRole(bytes32 role, address account) internal;
-ensureNotSafetyCouncil
-Ensure we use the explicit grantSafetyCouncilRole function.
modifier ensureNotSafetyCouncil(bytes32 role);
-Events
-RoleAdminChanged
-Emitted when newAdminRole is set as role's admin role, replacing previousAdminRole
-ADMIN_ROLE is the starting admin for all roles, despite
-{RoleAdminChanged} not being emitted signaling this.
-Available since v3.1.
event RoleAdminChanged(bytes32 indexed role, bytes32 indexed previousAdminRole, bytes32 indexed newAdminRole);
-RoleGranted
-Emitted when account is granted role.
-sender is the account that originated the contract call, an admin role
-bearer except when using {AccessControl-_setupRole}.
event RoleGranted(bytes32 indexed role, address indexed account, address indexed sender);
-RoleRevoked
-*Emitted when account is revoked role.
-sender is the account that originated the contract call:
-
-
- if using
revokeRole, it is the admin role bearer
- - if using
renounceRole, it is the role bearer (i.e.account)*
-
event RoleRevoked(bytes32 indexed role, address indexed account, address indexed sender);
-Enums
- -Enums
-MinterFee
-Minter fees for minting and burning. -Open = 0 -Close = 1
-enum MinterFee {
- Open,
- Close
-}
-SwapFee
-Swap fee types for shared collateral debt pool swaps. -Open = 0 -Close = 1
-enum SwapFee {
- In,
- Out
-}
-OracleType
-Configurable oracle types for assets. -Empty = 0 -Redstone = 1, -Chainlink = 2, -API3 = 3, -Vault = 4
-enum OracleType {
- Empty,
- Redstone,
- Chainlink,
- API3,
- Vault
-}
-Action
-Protocol core actions. -Deposit = 0 -Withdraw = 1, -Repay = 2, -Borrow = 3, -Liquidate = 4 -SCDPDeposit = 5, -SCDPSwap = 6, -SCDPWithdraw = 7, -SCDPRepay = 8, -SCDPLiquidation = 9
-enum Action {
- Deposit,
- Withdraw,
- Repay,
- Borrow,
- Liquidation,
- SCDPDeposit,
- SCDPSwap,
- SCDPWithdraw,
- SCDPRepay,
- SCDPLiquidation
-}
-Role
- -State Variables
-DEFAULT_ADMIN
-Meta role for all roles.
-bytes32 internal constant DEFAULT_ADMIN = 0x00;
-ADMIN
-keccak256("kresko.roles.minter.admin")
-bytes32 internal constant ADMIN = 0xb9dacdf02281f2e98ddbadaaf44db270b3d5a916342df47c59f77937a6bcd5d8;
-OPERATOR
-keccak256("kresko.roles.minter.operator")
-bytes32 internal constant OPERATOR = 0x112e48a576fb3a75acc75d9fcf6e0bc670b27b1dbcd2463502e10e68cf57d6fd;
-MANAGER
-keccak256("kresko.roles.minter.manager")
-bytes32 internal constant MANAGER = 0x46925e0f0cc76e485772167edccb8dc449d43b23b55fc4e756b063f49099e6a0;
-SAFETY_COUNCIL
-keccak256("kresko.roles.minter.safety.council")
-bytes32 internal constant SAFETY_COUNCIL = 0x9c387ecf1663f9144595993e2c602b45de94bf8ba3a110cb30e3652d79b581c0;
-Constants
- -State Variables
-NOT_ENTERED
-Set the initial value to 1, (not hindering possible gas refunds by setting it to 0 on exit).
-uint8 internal constant NOT_ENTERED = 1;
-ENTERED
-uint8 internal constant ENTERED = 2;
-NOT_INITIALIZING
-uint8 internal constant NOT_INITIALIZING = 1;
-INITIALIZING
-uint8 internal constant INITIALIZING = 2;
-ZERO_BYTES32
-bytes32 internal constant ZERO_BYTES32 = bytes32("");
-MIN_ORACLE_DECIMALS
-The min oracle decimal precision
-uint256 internal constant MIN_ORACLE_DECIMALS = 8;
-MIN_KRASSET_COLLATERAL_AMOUNT
-The minimum collateral amount for a kresko asset.
-uint256 internal constant MIN_KRASSET_COLLATERAL_AMOUNT = 1e12;
-MAX_MIN_DEBT_VALUE
-The maximum configurable minimum debt USD value. 8 decimals.
-uint256 internal constant MAX_MIN_DEBT_VALUE = 1_000 * 1e8;
-Percents
- -State Variables
-ONE
-uint16 internal constant ONE = 0.01e4;
-HUNDRED
-uint16 internal constant HUNDRED = 1e4;
-TWENTY_FIVE
-uint16 internal constant TWENTY_FIVE = 0.25e4;
-FIFTY
-uint16 internal constant FIFTY = 0.5e4;
-MAX_DEVIATION
-uint16 internal constant MAX_DEVIATION = TWENTY_FIVE;
-BASIS_POINT
-uint16 internal constant BASIS_POINT = 1;
-MAX_CLOSE_FEE
-The maximum configurable close fee.
-uint16 internal constant MAX_CLOSE_FEE = 0.25e4;
-MAX_OPEN_FEE
-The maximum configurable open fee.
-uint16 internal constant MAX_OPEN_FEE = 0.25e4;
-MAX_SCDP_FEE
-The maximum configurable protocol fee per asset for collateral pool swaps.
-uint16 internal constant MAX_SCDP_FEE = 0.5e4;
-MIN_LT
-The minimum configurable minimum collateralization ratio.
-uint16 internal constant MIN_LT = HUNDRED + ONE;
-MIN_MCR
-uint16 internal constant MIN_MCR = HUNDRED + ONE + ONE;
-MIN_LIQ_INCENTIVE
-The minimum configurable liquidation incentive multiplier. -This means liquidator only receives equal amount of collateral to debt repaid.
-uint16 internal constant MIN_LIQ_INCENTIVE = HUNDRED;
-MAX_LIQ_INCENTIVE
-The maximum configurable liquidation incentive multiplier. -This means liquidator receives 25% bonus collateral compared to the debt repaid.
-uint16 internal constant MAX_LIQ_INCENTIVE = 1.25e4;
-IErrorFieldProvider
- -Functions
-symbol
-function symbol() external view returns (string memory);
-Errors
- -Functions
-id
-function id(address _addr) internal view returns (ID memory);
-symbol
-function symbol(address _addr) internal view returns (string memory symbol_);
-Errors
-ADDRESS_HAS_NO_CODE
-error ADDRESS_HAS_NO_CODE(address);
-NOT_INITIALIZING
-error NOT_INITIALIZING();
-COMMON_ALREADY_INITIALIZED
-error COMMON_ALREADY_INITIALIZED();
-MINTER_ALREADY_INITIALIZED
-error MINTER_ALREADY_INITIALIZED();
-SCDP_ALREADY_INITIALIZED
-error SCDP_ALREADY_INITIALIZED();
-STRING_HEX_LENGTH_INSUFFICIENT
-error STRING_HEX_LENGTH_INSUFFICIENT();
-SAFETY_COUNCIL_NOT_ALLOWED
-error SAFETY_COUNCIL_NOT_ALLOWED();
-SAFETY_COUNCIL_SETTER_IS_NOT_ITS_OWNER
-error SAFETY_COUNCIL_SETTER_IS_NOT_ITS_OWNER(address);
-SAFETY_COUNCIL_ALREADY_EXISTS
-error SAFETY_COUNCIL_ALREADY_EXISTS(address given, address existing);
-MULTISIG_NOT_ENOUGH_OWNERS
-error MULTISIG_NOT_ENOUGH_OWNERS(address, uint256 owners, uint256 required);
-ACCESS_CONTROL_NOT_SELF
-error ACCESS_CONTROL_NOT_SELF(address who, address self);
-MARKET_CLOSED
-error MARKET_CLOSED(ID, string);
-SCDP_ASSET_ECONOMY
-error SCDP_ASSET_ECONOMY(ID, uint256 seizeReductionPct, ID, uint256 repayIncreasePct);
-MINTER_ASSET_ECONOMY
-error MINTER_ASSET_ECONOMY(ID, uint256 seizeReductionPct, ID, uint256 repayIncreasePct);
-INVALID_TICKER
-error INVALID_TICKER(ID, string ticker);
-ASSET_NOT_ENABLED
-error ASSET_NOT_ENABLED(ID);
-ASSET_CANNOT_BE_USED_TO_COVER
-error ASSET_CANNOT_BE_USED_TO_COVER(ID);
-ASSET_PAUSED_FOR_THIS_ACTION
-error ASSET_PAUSED_FOR_THIS_ACTION(ID, uint8 action);
-ASSET_NOT_MINTER_COLLATERAL
-error ASSET_NOT_MINTER_COLLATERAL(ID);
-ASSET_NOT_MINTABLE_FROM_MINTER
-error ASSET_NOT_MINTABLE_FROM_MINTER(ID);
-ASSET_NOT_SWAPPABLE
-error ASSET_NOT_SWAPPABLE(ID);
-ASSET_DOES_NOT_HAVE_DEPOSITS
-error ASSET_DOES_NOT_HAVE_DEPOSITS(ID);
-ASSET_NOT_DEPOSITABLE
-error ASSET_NOT_DEPOSITABLE(ID);
-ASSET_ALREADY_ENABLED
-error ASSET_ALREADY_ENABLED(ID);
-ASSET_ALREADY_DISABLED
-error ASSET_ALREADY_DISABLED(ID);
-ASSET_DOES_NOT_EXIST
-error ASSET_DOES_NOT_EXIST(ID);
-ASSET_ALREADY_EXISTS
-error ASSET_ALREADY_EXISTS(ID);
-ASSET_IS_VOID
-error ASSET_IS_VOID(ID);
-INVALID_ASSET
-error INVALID_ASSET(ID);
-CANNOT_REMOVE_COLLATERAL_THAT_HAS_USER_DEPOSITS
-error CANNOT_REMOVE_COLLATERAL_THAT_HAS_USER_DEPOSITS(ID);
-CANNOT_REMOVE_SWAPPABLE_ASSET_THAT_HAS_DEBT
-error CANNOT_REMOVE_SWAPPABLE_ASSET_THAT_HAS_DEBT(ID);
-INVALID_CONTRACT_KRASSET
-error INVALID_CONTRACT_KRASSET(ID krAsset);
-INVALID_CONTRACT_KRASSET_ANCHOR
-error INVALID_CONTRACT_KRASSET_ANCHOR(ID anchor, ID krAsset);
-NOT_SWAPPABLE_KRASSET
-error NOT_SWAPPABLE_KRASSET(ID);
-IDENTICAL_ASSETS
-error IDENTICAL_ASSETS(ID);
-WITHDRAW_NOT_SUPPORTED
-error WITHDRAW_NOT_SUPPORTED();
-DEPOSIT_NOT_SUPPORTED
-error DEPOSIT_NOT_SUPPORTED();
-REDEEM_NOT_SUPPORTED
-error REDEEM_NOT_SUPPORTED();
-NATIVE_TOKEN_DISABLED
-error NATIVE_TOKEN_DISABLED(ID);
-EXCEEDS_ASSET_DEPOSIT_LIMIT
-error EXCEEDS_ASSET_DEPOSIT_LIMIT(ID, uint256 deposits, uint256 limit);
-EXCEEDS_ASSET_MINTING_LIMIT
-error EXCEEDS_ASSET_MINTING_LIMIT(ID, uint256 deposits, uint256 limit);
-UINT128_OVERFLOW
-error UINT128_OVERFLOW(ID, uint256 deposits, uint256 limit);
-INVALID_SENDER
-error INVALID_SENDER(address, address);
-INVALID_MIN_DEBT
-error INVALID_MIN_DEBT(uint256 invalid, uint256 valid);
-INVALID_SCDP_FEE
-error INVALID_SCDP_FEE(ID, uint256 invalid, uint256 valid);
-INVALID_MCR
-error INVALID_MCR(uint256 invalid, uint256 valid);
-MLR_CANNOT_BE_LESS_THAN_LIQ_THRESHOLD
-error MLR_CANNOT_BE_LESS_THAN_LIQ_THRESHOLD(uint256 mlt, uint256 lt);
-INVALID_LIQ_THRESHOLD
-error INVALID_LIQ_THRESHOLD(uint256 lt, uint256 min, uint256 max);
-INVALID_PROTOCOL_FEE
-error INVALID_PROTOCOL_FEE(ID, uint256 invalid, uint256 valid);
-INVALID_ASSET_FEE
-error INVALID_ASSET_FEE(ID, uint256 invalid, uint256 valid);
-INVALID_ORACLE_DEVIATION
-error INVALID_ORACLE_DEVIATION(uint256 invalid, uint256 valid);
-INVALID_ORACLE_TYPE
-error INVALID_ORACLE_TYPE(uint8 invalid);
-INVALID_FEE_RECIPIENT
-error INVALID_FEE_RECIPIENT(address invalid);
-INVALID_LIQ_INCENTIVE
-error INVALID_LIQ_INCENTIVE(ID, uint256 invalid, uint256 min, uint256 max);
-INVALID_KFACTOR
-error INVALID_KFACTOR(ID, uint256 invalid, uint256 valid);
-INVALID_CFACTOR
-error INVALID_CFACTOR(ID, uint256 invalid, uint256 valid);
-INVALID_MINTER_FEE
-error INVALID_MINTER_FEE(ID, uint256 invalid, uint256 valid);
-INVALID_PRICE_PRECISION
-error INVALID_PRICE_PRECISION(uint256 decimals, uint256 valid);
-INVALID_DECIMALS
-error INVALID_DECIMALS(ID, uint256 decimals);
-INVALID_FEE
-error INVALID_FEE(ID, uint256 invalid, uint256 valid);
-INVALID_FEE_TYPE
-error INVALID_FEE_TYPE(uint8 invalid, uint8 valid);
-INVALID_VAULT_PRICE
-error INVALID_VAULT_PRICE(string ticker, address);
-INVALID_API3_PRICE
-error INVALID_API3_PRICE(string ticker, address);
-INVALID_CL_PRICE
-error INVALID_CL_PRICE(string ticker, address);
-INVALID_PRICE
-error INVALID_PRICE(ID, address oracle, int256 price);
-INVALID_KRASSET_OPERATOR
-error INVALID_KRASSET_OPERATOR(ID, address invalidOperator, address validOperator);
-INVALID_DENOMINATOR
-error INVALID_DENOMINATOR(ID, uint256 denominator, uint256 valid);
-INVALID_OPERATOR
-error INVALID_OPERATOR(ID, address who, address valid);
-INVALID_SUPPLY_LIMIT
-error INVALID_SUPPLY_LIMIT(ID, uint256 invalid, uint256 valid);
-NEGATIVE_PRICE
-error NEGATIVE_PRICE(address asset, int256 price);
-STALE_PRICE
-error STALE_PRICE(string ticker, uint256 price, uint256 timeFromUpdate, uint256 threshold);
-RAW_PRICE_STALE
-error RAW_PRICE_STALE(
- ID asset, string ticker, int256 price, uint8 oracleType, address feed, uint256 timeFromUpdate, uint256 threshold
-);
-PRICE_UNSTABLE
-error PRICE_UNSTABLE(uint256 primaryPrice, uint256 referencePrice, uint256 deviationPct);
-ZERO_OR_STALE_VAULT_PRICE
-error ZERO_OR_STALE_VAULT_PRICE(ID, address, uint256);
-ZERO_OR_STALE_PRICE
-error ZERO_OR_STALE_PRICE(string ticker, uint8[2] oracles);
-RAW_PRICE_LTE_ZERO
-error RAW_PRICE_LTE_ZERO(ID asset, string ticker, int256 price, uint8 oracleType, address feed);
-NO_PUSH_ORACLE_SET
-error NO_PUSH_ORACLE_SET(string ticker);
-NOT_SUPPORTED_YET
-error NOT_SUPPORTED_YET();
-WRAP_NOT_SUPPORTED
-error WRAP_NOT_SUPPORTED();
-BURN_AMOUNT_OVERFLOW
-error BURN_AMOUNT_OVERFLOW(ID, uint256 burnAmount, uint256 debtAmount);
-PAUSED
-error PAUSED(address who);
-L2_SEQUENCER_DOWN
-error L2_SEQUENCER_DOWN();
-FEED_ZERO_ADDRESS
-error FEED_ZERO_ADDRESS(string ticker);
-INVALID_SEQUENCER_UPTIME_FEED
-error INVALID_SEQUENCER_UPTIME_FEED(address);
-NO_MINTED_ASSETS
-error NO_MINTED_ASSETS(address who);
-NO_COLLATERALS_DEPOSITED
-error NO_COLLATERALS_DEPOSITED(address who);
-MISSING_PHASE_3_NFT
-error MISSING_PHASE_3_NFT();
-MISSING_PHASE_2_NFT
-error MISSING_PHASE_2_NFT();
-MISSING_PHASE_1_NFT
-error MISSING_PHASE_1_NFT();
-CANNOT_RE_ENTER
-error CANNOT_RE_ENTER();
-ARRAY_LENGTH_MISMATCH
-error ARRAY_LENGTH_MISMATCH(string ticker, uint256 arr1, uint256 arr2);
-COLLATERAL_VALUE_GREATER_THAN_REQUIRED
-error COLLATERAL_VALUE_GREATER_THAN_REQUIRED(uint256 collateralValue, uint256 minCollateralValue, uint32 ratio);
-ACCOUNT_COLLATERAL_VALUE_LESS_THAN_REQUIRED
-error ACCOUNT_COLLATERAL_VALUE_LESS_THAN_REQUIRED(
- address who, uint256 collateralValue, uint256 minCollateralValue, uint32 ratio
-);
-COLLATERAL_VALUE_LESS_THAN_REQUIRED
-error COLLATERAL_VALUE_LESS_THAN_REQUIRED(uint256 collateralValue, uint256 minCollateralValue, uint32 ratio);
-CANNOT_LIQUIDATE_HEALTHY_ACCOUNT
-error CANNOT_LIQUIDATE_HEALTHY_ACCOUNT(address who, uint256 collateralValue, uint256 minCollateralValue, uint32 ratio);
-CANNOT_LIQUIDATE_SELF
-error CANNOT_LIQUIDATE_SELF();
-LIQUIDATION_AMOUNT_GREATER_THAN_DEBT
-error LIQUIDATION_AMOUNT_GREATER_THAN_DEBT(ID repayAsset, uint256 repayAmount, uint256 availableAmount);
-LIQUIDATION_SEIZED_LESS_THAN_EXPECTED
-error LIQUIDATION_SEIZED_LESS_THAN_EXPECTED(ID, uint256, uint256);
-LIQUIDATION_VALUE_IS_ZERO
-error LIQUIDATION_VALUE_IS_ZERO(ID repayAsset, ID seizeAsset);
-NOTHING_TO_WITHDRAW
-error NOTHING_TO_WITHDRAW(address who, ID, uint256 requested, uint256 principal, uint256 scaled);
-ACCOUNT_KRASSET_NOT_FOUND
-error ACCOUNT_KRASSET_NOT_FOUND(address account, ID, address[] accountCollaterals);
-ACCOUNT_COLLATERAL_NOT_FOUND
-error ACCOUNT_COLLATERAL_NOT_FOUND(address account, ID, address[] accountCollaterals);
-ELEMENT_DOES_NOT_MATCH_PROVIDED_INDEX
-error ELEMENT_DOES_NOT_MATCH_PROVIDED_INDEX(ID element, uint256 index, address[] elements);
-REPAY_OVERFLOW
-error REPAY_OVERFLOW(ID repayAsset, ID seizeAsset, uint256 invalid, uint256 valid);
-INCOME_AMOUNT_IS_ZERO
-error INCOME_AMOUNT_IS_ZERO(ID incomeAsset);
-NO_LIQUIDITY_TO_GIVE_INCOME_FOR
-error NO_LIQUIDITY_TO_GIVE_INCOME_FOR(ID incomeAsset, uint256 userDeposits, uint256 totalDeposits);
-NOT_ENOUGH_SWAP_DEPOSITS_TO_SEIZE
-error NOT_ENOUGH_SWAP_DEPOSITS_TO_SEIZE(ID repayAsset, ID seizeAsset, uint256 invalid, uint256 valid);
-SWAP_ROUTE_NOT_ENABLED
-error SWAP_ROUTE_NOT_ENABLED(ID assetIn, ID assetOut);
-RECEIVED_LESS_THAN_DESIRED
-error RECEIVED_LESS_THAN_DESIRED(ID, uint256 invalid, uint256 valid);
-SWAP_ZERO_AMOUNT_IN
-error SWAP_ZERO_AMOUNT_IN(ID tokenIn);
-INVALID_WITHDRAW
-error INVALID_WITHDRAW(ID withdrawAsset, uint256 sharesIn, uint256 assetsOut);
-ROUNDING_ERROR
-error ROUNDING_ERROR(ID asset, uint256 sharesIn, uint256 assetsOut);
-MAX_DEPOSIT_EXCEEDED
-error MAX_DEPOSIT_EXCEEDED(ID asset, uint256 assetsIn, uint256 maxDeposit);
-COLLATERAL_AMOUNT_LOW
-error COLLATERAL_AMOUNT_LOW(ID krAssetCollateral, uint256 amount, uint256 minAmount);
-MINT_VALUE_LESS_THAN_MIN_DEBT_VALUE
-error MINT_VALUE_LESS_THAN_MIN_DEBT_VALUE(ID, uint256 value, uint256 minRequiredValue);
-NOT_A_CONTRACT
-error NOT_A_CONTRACT(address who);
-NO_ALLOWANCE
-error NO_ALLOWANCE(address spender, address owner, uint256 requested, uint256 allowed);
-NOT_ENOUGH_BALANCE
-error NOT_ENOUGH_BALANCE(address who, uint256 requested, uint256 available);
-SENDER_NOT_OPERATOR
-error SENDER_NOT_OPERATOR(ID, address sender, address kresko);
-ZERO_SHARES_FROM_ASSETS
-error ZERO_SHARES_FROM_ASSETS(ID, uint256 assets, ID);
-ZERO_SHARES_OUT
-error ZERO_SHARES_OUT(ID, uint256 assets);
-ZERO_SHARES_IN
-error ZERO_SHARES_IN(ID, uint256 assets);
-ZERO_ASSETS_FROM_SHARES
-error ZERO_ASSETS_FROM_SHARES(ID, uint256 shares, ID);
-ZERO_ASSETS_OUT
-error ZERO_ASSETS_OUT(ID, uint256 shares);
-ZERO_ASSETS_IN
-error ZERO_ASSETS_IN(ID, uint256 shares);
-ZERO_ADDRESS
-error ZERO_ADDRESS();
-ZERO_DEPOSIT
-error ZERO_DEPOSIT(ID);
-ZERO_AMOUNT
-error ZERO_AMOUNT(ID);
-ZERO_WITHDRAW
-error ZERO_WITHDRAW(ID);
-ZERO_MINT
-error ZERO_MINT(ID);
-ZERO_REPAY
-error ZERO_REPAY(ID, uint256 repayAmount, uint256 seizeAmount);
-ZERO_BURN
-error ZERO_BURN(ID);
-ZERO_DEBT
-error ZERO_DEBT(ID);
-Structs
-ID
-struct ID {
- string symbol;
- address addr;
-}
-LibModifiers
- -Functions
-onlyUnpaused
-Simple check for the enabled flag
-function onlyUnpaused(CommonState storage self, address _assetAddr, Enums.Action _action)
- internal
- view
- returns (Asset storage asset);
-Parameters
-| Name | Type | Description |
|---|---|---|
self | CommonState | |
_assetAddr | address | The address of the asset. |
_action | Enums.Action | The action to this is called from. |
Returns
-| Name | Type | Description |
|---|---|---|
asset | Asset | The asset struct. |
onlyExistingAsset
-function onlyExistingAsset(CommonState storage self, address _assetAddr) internal view returns (Asset storage asset);
-onlyMinterCollateral
-Reverts if address is not a minter collateral asset.
-function onlyMinterCollateral(CommonState storage self, address _assetAddr)
- internal
- view
- returns (Asset storage asset);
-Parameters
-| Name | Type | Description |
|---|---|---|
self | CommonState | |
_assetAddr | address | The address of the asset. |
Returns
-| Name | Type | Description |
|---|---|---|
asset | Asset | The asset struct. |
onlyMinterCollateral
-function onlyMinterCollateral(CommonState storage self, address _assetAddr, Enums.Action _action)
- internal
- view
- returns (Asset storage asset);
-onlyMinterMintable
-Reverts if address is not a Kresko Asset.
-function onlyMinterMintable(CommonState storage self, address _assetAddr) internal view returns (Asset storage asset);
-Parameters
-| Name | Type | Description |
|---|---|---|
self | CommonState | |
_assetAddr | address | The address of the asset. |
Returns
-| Name | Type | Description |
|---|---|---|
asset | Asset | The asset struct. |
onlyMinterMintable
-function onlyMinterMintable(CommonState storage self, address _assetAddr, Enums.Action _action)
- internal
- view
- returns (Asset storage asset);
-onlySharedCollateral
-Reverts if address is not depositable to SCDP.
-function onlySharedCollateral(CommonState storage self, address _assetAddr)
- internal
- view
- returns (Asset storage asset);
-Parameters
-| Name | Type | Description |
|---|---|---|
self | CommonState | |
_assetAddr | address | The address of the asset. |
Returns
-| Name | Type | Description |
|---|---|---|
asset | Asset | The asset struct. |
onlySwapMintable
-Reverts if address is not swappable Kresko Asset.
-function onlySwapMintable(CommonState storage self, address _assetAddr) internal view returns (Asset storage asset);
-Parameters
-| Name | Type | Description |
|---|---|---|
self | CommonState | |
_assetAddr | address | The address of the asset. |
Returns
-| Name | Type | Description |
|---|---|---|
asset | Asset | The asset struct. |
onlyActiveSharedCollateral
-function onlyActiveSharedCollateral(CommonState storage self, address _assetAddr)
- internal
- view
- returns (Asset storage asset);
-onlyCoverAsset
-function onlyCoverAsset(CommonState storage self, address _assetAddr) internal view returns (Asset storage asset);
-onlyIncomeAsset
-function onlyIncomeAsset(CommonState storage self, address _assetAddr) internal view returns (Asset storage asset);
-Modifiers
- -Functions
-initializeAsAdmin
-Modifier that checks if the contract is initializing and if so, gives the caller the ADMIN role
-modifier initializeAsAdmin();
-onlyRole
-Modifier that checks that an account has a specific role. Reverts -with a standardized message including the required role. -The format of the revert reason is given by the following regular expression: -/^AccessControl: account (0x[0-9a-f]{40}) is missing role (0x[0-9a-f]{64})$/ -Available since v4.1.
-modifier onlyRole(bytes32 role);
-onlyRoleIf
-Ensure only trusted contracts can act on behalf of _account
modifier onlyRoleIf(bool _accountIsNotMsgSender, bytes32 role);
-Parameters
-| Name | Type | Description |
|---|---|---|
_accountIsNotMsgSender | bool | The address of the collateral asset. |
role | bytes32 |
nonReentrant
-modifier nonReentrant();
-gate
-Reverts if the caller does not have the required NFT's for the gated phase
-modifier gate();
-CommonState
- -struct CommonState {
- mapping(address => Asset) assets;
- mapping(bytes32 => mapping(Enums.OracleType => Oracle)) oracles;
- mapping(address => mapping(Enums.Action => SafetyState)) safetyState;
- address feeRecipient;
- uint96 minDebtValue;
- address sequencerUptimeFeed;
- uint32 sequencerGracePeriodTime;
- uint32 staleTime;
- uint16 maxPriceDeviationPct;
- uint8 oracleDecimals;
- bool safetyStateSet;
- uint256 entered;
- mapping(bytes32 role => RoleData data) _roles;
- mapping(bytes32 role => EnumerableSet.AddressSet member) _roleMembers;
-}
-GatingState
- -struct GatingState {
- address kreskian;
- address questForKresk;
- uint8 phase;
-}
-gs
- -function gs() pure returns (GatingState storage state);
-cs
- -function cs() pure returns (CommonState storage state);
-Constants
- -COMMON_STORAGE_POSITION
-bytes32 constant COMMON_STORAGE_POSITION = keccak256("kresko.common.storage");
-GATING_STORAGE_POSITION
-bytes32 constant GATING_STORAGE_POSITION = keccak256("kresko.gating.storage");
-Oracle
- -Oracle configuration mapped to Asset.ticker.
struct Oracle {
- address feed;
- function(address) external view returns (uint256) priceGetter;
-}
-FeedConfiguration
- -Feed configuration.
-struct FeedConfiguration {
- Enums.OracleType[2] oracleIds;
- address[2] feeds;
-}
-Asset
- -Author: -Kresko
-All assets in the protocol share this configuration.
-ticker is not unique, eg. krETH and WETH both would use bytes32('ETH')
-Percentages use 2 decimals: 1e4 (10000) == 100.00%. See {PercentageMath.sol}.
-Note that the percentage value for uint16 caps at 655.36%.
-struct Asset {
- bytes32 ticker;
- address anchor;
- Enums.OracleType[2] oracles;
- uint16 factor;
- uint16 kFactor;
- uint16 openFee;
- uint16 closeFee;
- uint16 liqIncentive;
- uint256 maxDebtMinter;
- uint256 maxDebtSCDP;
- uint256 depositLimitSCDP;
- uint128 liquidityIndexSCDP;
- uint16 swapInFeeSCDP;
- uint16 swapOutFeeSCDP;
- uint16 protocolFeeShareSCDP;
- uint16 liqIncentiveSCDP;
- uint8 decimals;
- bool isMinterCollateral;
- bool isMinterMintable;
- bool isSharedCollateral;
- bool isSwapMintable;
- bool isSharedOrSwappedCollateral;
- bool isCoverAsset;
-}
-RoleData
- -The access control role data.
-struct RoleData {
- mapping(address => bool) members;
- bytes32 adminRole;
-}
-MaxLiqVars
- -Variables used for calculating the max liquidation value.
-struct MaxLiqVars {
- Asset collateral;
- uint256 accountCollateralValue;
- uint256 minCollateralValue;
- uint256 seizeCollateralAccountValue;
- uint192 minDebtValue;
- uint32 gainFactor;
- uint32 maxLiquidationRatio;
- uint32 debtFactor;
-}
-MaxLiqInfo
- -struct MaxLiqInfo {
- address account;
- address seizeAssetAddr;
- address repayAssetAddr;
- uint256 repayValue;
- uint256 repayAmount;
- uint256 seizeAmount;
- uint256 seizeValue;
- uint256 repayAssetPrice;
- uint256 repayAssetIndex;
- uint256 seizeAssetPrice;
- uint256 seizeAssetIndex;
-}
-RawPrice
- -Convenience struct for checking configurations
-struct RawPrice {
- int256 answer;
- uint256 timestamp;
- bool isStale;
- bool isZero;
- Enums.OracleType oracle;
- address feed;
-}
-Pause
- -Configuration for pausing Action
struct Pause {
- bool enabled;
- uint256 timestamp0;
- uint256 timestamp1;
-}
-SafetyState
- -Safety configuration for assets
-struct SafetyState {
- Pause pause;
-}
-CommonInitArgs
- -Initialization arguments for common values
-struct CommonInitArgs {
- address admin;
- address council;
- address treasury;
- uint64 minDebtValue;
- uint16 maxPriceDeviationPct;
- uint8 oracleDecimals;
- address sequencerUptimeFeed;
- uint32 sequencerGracePeriodTime;
- uint32 staleTime;
- address kreskian;
- address questForKresk;
- uint8 phase;
-}
-SCDPCollateralArgs
- -struct SCDPCollateralArgs {
- uint256 depositLimit;
- uint128 liquidityIndex;
- uint8 decimals;
-}
-SCDPKrAssetArgs
- -struct SCDPKrAssetArgs {
- uint256 maxDebtMinter;
- uint16 liqIncentive;
- uint16 protocolFee;
- uint16 openFee;
- uint16 closeFee;
-}
-Validations
- -Functions
-validatePriceDeviationPct
-function validatePriceDeviationPct(uint16 _deviationPct) internal pure;
-validateMinDebtValue
-function validateMinDebtValue(uint256 _minDebtValue) internal pure;
-validateFeeRecipient
-function validateFeeRecipient(address _feeRecipient) internal pure;
-validateOraclePrecision
-function validateOraclePrecision(uint256 _decimalPrecision) internal pure;
-validateMinCollateralRatio
-function validateMinCollateralRatio(uint256 _minCollateralRatio, uint256 _liqThreshold) internal pure;
-validateLiquidationThreshold
-function validateLiquidationThreshold(uint256 _liquidationThreshold, uint256 _minCollateralRatio) internal pure;
-validateMaxLiquidationRatio
-function validateMaxLiquidationRatio(uint256 _maxLiquidationRatio, uint256 _liquidationThreshold) internal pure;
-validateAddAssetArgs
-function validateAddAssetArgs(address _assetAddr, Asset memory _config)
- internal
- view
- returns (string memory symbol, string memory tickerStr, uint8 decimals);
-validateUpdateAssetArgs
-function validateUpdateAssetArgs(address _assetAddr, Asset memory _config)
- internal
- view
- returns (string memory symbol, string memory tickerStr, Asset storage asset);
-validateAsset
-function validateAsset(address _assetAddr, Asset memory _config) internal view returns (bool);
-validateMinterCollateral
-function validateMinterCollateral(address _assetAddr, Asset memory _config)
- internal
- view
- returns (bool isMinterCollateral);
-validateSCDPDepositAsset
-function validateSCDPDepositAsset(address _assetAddr, Asset memory _config)
- internal
- view
- returns (bool isSharedCollateral);
-validateMinterKrAsset
-function validateMinterKrAsset(address _assetAddr, Asset memory _config) internal view returns (bool isMinterKrAsset);
-validateSCDPKrAsset
-function validateSCDPKrAsset(address _assetAddr, Asset memory _config) internal view returns (bool isSwapMintable);
-validateSDICoverAsset
-function validateSDICoverAsset(address _assetAddr) internal view returns (Asset storage asset);
-validateKrAssetContract
-function validateKrAssetContract(address _assetAddr, address _anchorAddr) internal view;
-ensureUnique
-function ensureUnique(address _asset1Addr, address _asset2Addr) internal view;
-validateRoute
-function validateRoute(address _assetInAddr, address _assetOutAddr) internal view;
-validateDecimals
-function validateDecimals(address _assetAddr, uint8 _decimals) internal view;
-validateVaultAssetDecimals
-function validateVaultAssetDecimals(address _assetAddr, uint8 _decimals) internal view;
-validateUint128
-function validateUint128(address _assetAddr, uint256 _value) internal view;
-validateCFactor
-function validateCFactor(address _assetAddr, uint16 _cFactor) internal view;
-validateKFactor
-function validateKFactor(address _assetAddr, uint16 _kFactor) internal view;
-validateFees
-function validateFees(address _assetAddr, uint16 _fee1, uint16 _fee2) internal view;
-validateLiqIncentive
-function validateLiqIncentive(address _assetAddr, uint16 _liqIncentive) internal view;
-validateLiqConfig
-function validateLiqConfig(address _assetAddr) internal view;
-validateLiquidationMarket
-function validateLiquidationMarket(
- address _seizeAssetAddr,
- Asset storage seizeAsset,
- address _repayAssetAddr,
- Asset storage repayAsset
-) internal view;
-validateCollateralArgs
-function validateCollateralArgs(
- MinterState storage self,
- address _account,
- address _collateralAsset,
- uint256 _collateralIndex,
- uint256 _amount
-) internal view;
-rawAssetPrice
-function rawAssetPrice(Asset storage self) internal view returns (RawPrice memory);
-validateRawAssetPrice
-function validateRawAssetPrice(address _assetAddr) internal view;
-Contents
--
-
- facets -
- interfaces -
- DSCore -
- DSModifiers -
- Facet -
- FacetAddressAndPosition -
- FacetFunctionSelectors -
- FacetCutAction -
- FacetCut -
- Initializer -
- DiamondState -
- ds -
- DState constants -
- Diamond -
Contents
- -DiamondCutFacet
- -Inherits: -IDiamondCutFacet, IExtendedDiamondCutFacet, DSModifiers, Modifiers
-Authors: -Nick Mudge, Kresko
-Reference implementation of diamondCut. Extended to allow executing initializers without cuts.
-Functions
-diamondCut
-Add/replace/remove any number of functions, optionally execute a function with delegatecall
-function diamondCut(FacetCut[] calldata _diamondCut, address _initializer, bytes calldata _calldata)
- external
- onlyRole(Role.DEFAULT_ADMIN);
-Parameters
-| Name | Type | Description |
|---|---|---|
_diamondCut | FacetCut[] | Contains the facet addresses and function selectors |
_initializer | address | The address of the contract or facet to execute _calldata |
_calldata | bytes | A function call, including function selector and arguments _calldata is executed with delegatecall on _init |
executeInitializer
-Use an initializer contract without cutting.
-function executeInitializer(address _initializer, bytes calldata _calldata) external onlyRole(Role.DEFAULT_ADMIN);
-Parameters
-| Name | Type | Description |
|---|---|---|
_initializer | address | Address of contract or facet to execute _calldata |
_calldata | bytes | A function call, including function selector and arguments - _calldata is executed with delegatecall on _init |
executeInitializers
-Execute multiple initializers without cutting.
-function executeInitializers(Initializer[] calldata _initializers) external onlyRole(Role.DEFAULT_ADMIN);
-DiamondLoupeFacet
- -Inherits: -IDiamondLoupeFacet
-Functions
-facets
-Gets all facet addresses and their four byte function selectors.
-function facets() external view override returns (Facet[] memory facets_);
-Returns
-| Name | Type | Description |
|---|---|---|
facets_ | Facet[] | Facet |
facetFunctionSelectors
-Gets all the function selectors supported by a specific facet.
-function facetFunctionSelectors(address _facet)
- external
- view
- override
- returns (bytes4[] memory facetFunctionSelectors_);
-Parameters
-| Name | Type | Description |
|---|---|---|
_facet | address | The facet address. |
Returns
-| Name | Type | Description |
|---|---|---|
facetFunctionSelectors_ | bytes4[] | facetFunctionSelectors_ |
facetAddresses
-Get all the facet addresses used by a diamond.
-function facetAddresses() external view override returns (address[] memory facetAddresses_);
-Returns
-| Name | Type | Description |
|---|---|---|
facetAddresses_ | address[] | facetAddresses_ |
facetAddress
-Gets the facet that supports the given selector.
-If facet is not found return address(0).
-function facetAddress(bytes4 _functionSelector) external view override returns (address facetAddress_);
-Parameters
-| Name | Type | Description |
|---|---|---|
_functionSelector | bytes4 | The function selector. |
Returns
-| Name | Type | Description |
|---|---|---|
facetAddress_ | address | The facet address. |
DiamondStateFacet
- -Inherits: -IDiamondStateFacet, DSModifiers
-Functions
-transferOwnership
-Initiate ownership transfer to a new address
-function transferOwnership(address _newOwner) external override;
-Parameters
-| Name | Type | Description |
|---|---|---|
_newOwner | address | address that is set as the pending new owner |
acceptOwnership
-Transfer the ownership to the new pending owner
-function acceptOwnership() external override;
-owner
-Get the address of the owner
-function owner() external view override returns (address owner_);
-Returns
-| Name | Type | Description |
|---|---|---|
owner_ | address | The address of the owner. |
pendingOwner
-Get the address of pending owner
-function pendingOwner() external view override returns (address pendingOwner_);
-Returns
-| Name | Type | Description |
|---|---|---|
pendingOwner_ | address | The address of the pending owner. |
initialized
-function initialized() external view returns (bool);
-domainSeparator
-The EIP-712 typehash for the contract's domain.
-function domainSeparator() external view returns (bytes32);
-getStorageVersion
-Get the storage version (amount of times the storage has been upgraded)
-function getStorageVersion() external view returns (uint256);
-Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 The storage version. |
ERC165Facet
- -Inherits: -IERC165Facet, DSModifiers, Modifiers
-Functions
-supportsInterface
-Query if a contract implements an interface
-Interface identification is specified in ERC-165. This function -uses less than 30,000 gas.
-function supportsInterface(bytes4 _interfaceId) external view override returns (bool);
-Parameters
-| Name | Type | Description |
|---|---|---|
_interfaceId | bytes4 |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | bool | true if the contract implements interfaceID and interfaceID is not 0xffffffff, false otherwise |
setERC165
-set or unset ERC165 using DiamondStorage.supportedInterfaces
-function setERC165(bytes4[] calldata interfaceIds, bytes4[] calldata interfaceIdsToRemove)
- external
- onlyRole(Role.ADMIN);
-Parameters
-| Name | Type | Description |
|---|---|---|
interfaceIds | bytes4[] | list of interface id to set as supported |
interfaceIdsToRemove | bytes4[] | list of interface id to unset as supported. Technically, you can remove support of ERC165 by having the IERC165 id itself being part of that array. |
Contents
- -IDiamondCutFacet
- -Functions
-diamondCut
-Add/replace/remove any number of functions, optionally execute a function with delegatecall
-function diamondCut(FacetCut[] calldata _diamondCut, address _initializer, bytes calldata _calldata) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_diamondCut | FacetCut[] | Contains the facet addresses and function selectors |
_initializer | address | The address of the contract or facet to execute _calldata |
_calldata | bytes | A function call, including function selector and arguments _calldata is executed with delegatecall on _init |
IExtendedDiamondCutFacet
- -Functions
-executeInitializer
-Use an initializer contract without cutting.
-function executeInitializer(address _initializer, bytes calldata _calldata) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_initializer | address | Address of contract or facet to execute _calldata |
_calldata | bytes | A function call, including function selector and arguments - _calldata is executed with delegatecall on _init |
executeInitializers
-Execute multiple initializers without cutting.
-function executeInitializers(Initializer[] calldata _initializers) external;
-IDiamondLoupeFacet
- -Functions
-facets
-Gets all facet addresses and their four byte function selectors.
-function facets() external view returns (Facet[] memory facets_);
-Returns
-| Name | Type | Description |
|---|---|---|
facets_ | Facet[] | Facet |
facetFunctionSelectors
-Gets all the function selectors supported by a specific facet.
-function facetFunctionSelectors(address _facet) external view returns (bytes4[] memory facetFunctionSelectors_);
-Parameters
-| Name | Type | Description |
|---|---|---|
_facet | address | The facet address. |
Returns
-| Name | Type | Description |
|---|---|---|
facetFunctionSelectors_ | bytes4[] | facetFunctionSelectors_ |
facetAddresses
-Get all the facet addresses used by a diamond.
-function facetAddresses() external view returns (address[] memory facetAddresses_);
-Returns
-| Name | Type | Description |
|---|---|---|
facetAddresses_ | address[] | facetAddresses_ |
facetAddress
-Gets the facet that supports the given selector.
-If facet is not found return address(0).
-function facetAddress(bytes4 _functionSelector) external view returns (address facetAddress_);
-Parameters
-| Name | Type | Description |
|---|---|---|
_functionSelector | bytes4 | The function selector. |
Returns
-| Name | Type | Description |
|---|---|---|
facetAddress_ | address | The facet address. |
IDiamondStateFacet
- -Functions for the diamond state itself.
-Functions
-initialized
-Whether the diamond is initialized.
-function initialized() external view returns (bool);
-domainSeparator
-The EIP-712 typehash for the contract's domain.
-function domainSeparator() external view returns (bytes32);
-getStorageVersion
-Get the storage version (amount of times the storage has been upgraded)
-function getStorageVersion() external view returns (uint256);
-Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 The storage version. |
owner
-Get the address of the owner
-function owner() external view returns (address owner_);
-Returns
-| Name | Type | Description |
|---|---|---|
owner_ | address | The address of the owner. |
pendingOwner
-Get the address of pending owner
-function pendingOwner() external view returns (address pendingOwner_);
-Returns
-| Name | Type | Description |
|---|---|---|
pendingOwner_ | address | The address of the pending owner. |
transferOwnership
-Initiate ownership transfer to a new address
-caller must be the current contract owner
-the new owner cannot be address(0)
-emits a {PendingOwnershipTransfer} event
-function transferOwnership(address _newOwner) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_newOwner | address | address that is set as the pending new owner |
acceptOwnership
-Transfer the ownership to the new pending owner
-caller must be the pending owner
-emits a {OwnershipTransferred} event
-function acceptOwnership() external;
-IERC165Facet
- -Functions
-supportsInterface
-Query if a contract implements an interface
-Interface identification is specified in ERC-165. This function -uses less than 30,000 gas.
-function supportsInterface(bytes4 interfaceId) external view returns (bool);
-Parameters
-| Name | Type | Description |
|---|---|---|
interfaceId | bytes4 | The interface identifier, as specified in ERC-165 |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | bool | true if the contract implements interfaceID and interfaceID is not 0xffffffff, false otherwise |
setERC165
-set or unset ERC165 using DiamondStorage.supportedInterfaces
-function setERC165(bytes4[] calldata interfaceIds, bytes4[] calldata interfaceIdsToRemove) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
interfaceIds | bytes4[] | list of interface id to set as supported |
interfaceIdsToRemove | bytes4[] | list of interface id to unset as supported. Technically, you can remove support of ERC165 by having the IERC165 id itself being part of that array. |
DSCore
- -Functions
-create
-Setup the DiamondState, add initial facets and execute all initializers.
-function create(FacetCut[] memory _initialFacets, Initializer[] memory _initializers, address _contractOwner)
- internal;
-Parameters
-| Name | Type | Description |
|---|---|---|
_initialFacets | FacetCut[] | Facets to add to the diamond. |
_initializers | Initializer[] | Initializer contracts to execute. |
_contractOwner | address | Address to set as the contract owner. |
exec
-Execute some logic on a contract through delegatecall.
-function exec(address _initializer, bytes memory _calldata) internal;
-Parameters
-| Name | Type | Description |
|---|---|---|
_initializer | address | Contract to delegatecall. |
_calldata | bytes | Data to pass into the delegatecall. |
cut
-function cut(FacetCut[] memory _diamondCut, address _initializer, bytes memory _calldata) internal;
-addFunctions
-function addFunctions(DiamondState storage self, address _facetAddress, bytes4[] memory _functionSelectors) internal;
-replaceFunctions
-function replaceFunctions(DiamondState storage self, address _facetAddress, bytes4[] memory _functionSelectors)
- internal;
-removeFunctions
-function removeFunctions(DiamondState storage self, address _facetAddress, bytes4[] memory _functionSelectors)
- internal;
-addFacet
-function addFacet(DiamondState storage self, address _facetAddress) internal;
-addFunction
-function addFunction(DiamondState storage self, bytes4 _selector, uint96 _selectorPosition, address _facetAddress)
- internal;
-removeFunction
-function removeFunction(DiamondState storage self, address _facetAddress, bytes4 _selector) internal;
-initiateOwnershipTransfer
-caller must be the current contract owner
-Initiate ownership transfer to a new address
-function initiateOwnershipTransfer(DiamondState storage self, address _newOwner) internal;
-Parameters
-| Name | Type | Description |
|---|---|---|
self | DiamondState | |
_newOwner | address | address that is set as the pending new owner |
finalizeOwnershipTransfer
-caller must be the pending owner
-Transfer the ownership to the new pending owner
-function finalizeOwnershipTransfer(DiamondState storage self) internal;
-Events
-InitializerExecuted
-Emitted when execute is called with some initializer.
Overlaps DiamondCut but thats fine as its used by some indexers.
-event InitializerExecuted(
- uint256 indexed version,
- address sender,
- address diamondOwner,
- address initializer,
- bytes data,
- uint256 facetCount,
- uint256 block,
- uint256 timestamp
-);
-DiamondCut
-event DiamondCut(FacetCut[] diamondCut, address initializer, bytes data);
-OwnershipTransferred
-event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
-PendingOwnershipTransfer
-event PendingOwnershipTransfer(address indexed previousOwner, address indexed newOwner);
-Errors
-DIAMOND_FUNCTION_DOES_NOT_EXIST
-error DIAMOND_FUNCTION_DOES_NOT_EXIST(bytes4 selector);
-DIAMOND_INIT_DATA_PROVIDED_BUT_INIT_ADDRESS_WAS_ZERO
-error DIAMOND_INIT_DATA_PROVIDED_BUT_INIT_ADDRESS_WAS_ZERO(bytes data);
-DIAMOND_INIT_ADDRESS_PROVIDED_BUT_INIT_DATA_WAS_EMPTY
-error DIAMOND_INIT_ADDRESS_PROVIDED_BUT_INIT_DATA_WAS_EMPTY(address initializer);
-DIAMOND_FUNCTION_ALREADY_EXISTS
-error DIAMOND_FUNCTION_ALREADY_EXISTS(address newFacet, address oldFacet, bytes4 func);
-DIAMOND_INIT_FAILED
-error DIAMOND_INIT_FAILED(address initializer, bytes data);
-DIAMOND_NOT_INITIALIZING
-error DIAMOND_NOT_INITIALIZING();
-DIAMOND_ALREADY_INITIALIZED
-error DIAMOND_ALREADY_INITIALIZED(uint256 initializerVersion, uint256 currentVersion);
-DIAMOND_CUT_ACTION_WAS_NOT_ADD_REPLACE_REMOVE
-error DIAMOND_CUT_ACTION_WAS_NOT_ADD_REPLACE_REMOVE();
-DIAMOND_FACET_ADDRESS_CANNOT_BE_ZERO_WHEN_ADDING_FUNCTIONS
-error DIAMOND_FACET_ADDRESS_CANNOT_BE_ZERO_WHEN_ADDING_FUNCTIONS(bytes4[] selectors);
-DIAMOND_FACET_ADDRESS_CANNOT_BE_ZERO_WHEN_REPLACING_FUNCTIONS
-error DIAMOND_FACET_ADDRESS_CANNOT_BE_ZERO_WHEN_REPLACING_FUNCTIONS(bytes4[] selectors);
-DIAMOND_FACET_ADDRESS_MUST_BE_ZERO_WHEN_REMOVING_FUNCTIONS
-error DIAMOND_FACET_ADDRESS_MUST_BE_ZERO_WHEN_REMOVING_FUNCTIONS(address facet, bytes4[] selectors);
-DIAMOND_NO_FACET_SELECTORS
-error DIAMOND_NO_FACET_SELECTORS(address facet);
-DIAMOND_FACET_ADDRESS_CANNOT_BE_ZERO_WHEN_REMOVING_ONE_FUNCTION
-error DIAMOND_FACET_ADDRESS_CANNOT_BE_ZERO_WHEN_REMOVING_ONE_FUNCTION(bytes4 selector);
-DIAMOND_REPLACE_FUNCTION_NEW_FACET_IS_SAME_AS_OLD
-error DIAMOND_REPLACE_FUNCTION_NEW_FACET_IS_SAME_AS_OLD(address facet, bytes4 selector);
-NEW_OWNER_CANNOT_BE_ZERO_ADDRESS
-error NEW_OWNER_CANNOT_BE_ZERO_ADDRESS();
-NOT_DIAMOND_OWNER
-error NOT_DIAMOND_OWNER(address who, address owner);
-NOT_PENDING_DIAMOND_OWNER
-error NOT_PENDING_DIAMOND_OWNER(address who, address pendingOwner);
-DSModifiers
- -Functions
-initializer
-modifier initializer(uint256 version);
-onlyDiamondOwner
-modifier onlyDiamondOwner();
-onlyPendingDiamondOwner
-modifier onlyPendingDiamondOwner();
-Facet
- -These functions are expected to be called frequently -by tools.
-struct Facet {
- address facetAddress;
- bytes4[] functionSelectors;
-}
-FacetAddressAndPosition
- -struct FacetAddressAndPosition {
- address facetAddress;
- uint96 functionSelectorPosition;
-}
-FacetFunctionSelectors
- -struct FacetFunctionSelectors {
- bytes4[] functionSelectors;
- uint256 facetAddressPosition;
-}
-FacetCutAction
- -Add=0, Replace=1, Remove=2
-enum FacetCutAction {
- Add,
- Replace,
- Remove
-}
-FacetCut
- -struct FacetCut {
- address facetAddress;
- FacetCutAction action;
- bytes4[] functionSelectors;
-}
-Initializer
- -struct Initializer {
- address initContract;
- bytes initData;
-}
-DiamondState
- -struct DiamondState {
- mapping(bytes4 => FacetAddressAndPosition) selectorToFacetAndPosition;
- mapping(address => FacetFunctionSelectors) facetFunctionSelectors;
- address[] facetAddresses;
- mapping(bytes4 => bool) supportedInterfaces;
- address self;
- bool initialized;
- uint8 initializing;
- bytes32 diamondDomainSeparator;
- address contractOwner;
- address pendingOwner;
- uint96 storageVersion;
-}
-ds
- -Ds, a pure free function.
-function ds() pure returns (DiamondState storage state);
-Returns
-| Name | Type | Description |
|---|---|---|
state | DiamondState | A DiamondState value. |
Constants
- -DIAMOND_STORAGE_POSITION
-bytes32 constant DIAMOND_STORAGE_POSITION = keccak256("kresko.diamond.storage");
-Diamond
- -Functions
-constructor
-constructor(address owner, FacetCut[] memory facets, Initializer[] memory initializers);
-fallback
-Find the matching facet for the call signature and delegate.
-This does not return to its internal call site, it will return directly to the external caller.
fallback() external payable;
-receive
-receive() external payable;
-Contents
- -DeploymentFactory
- -Inherits: -ProxyAdmin, IDeploymentFactory
-Author: -Kresko
-Deploys contracts, optionally with a {TransparentUpgradeableProxy}. Is the (immutable) admin of proxies.
-Upgrades of proxies are only available for the owner of the DeploymentFactory.
-Deployments can be made by the owner or whitelisted deployer.
-State Variables
-_deployer
-mapping(address => bool) private _deployer;
-_deployment
-mapping(address => Deployment) private _deployment;
-_deploymentList
-Deployment[] private _deploymentList;
-Functions
-constructor
-Set the initial owner of the contract.
-constructor(address initialOwner) ProxyAdmin(initialOwner);
-setDeployer
-function setDeployer(address who, bool value) external onlyOwner;
-isDeployer
-function isDeployer(address who) external view returns (bool);
-onlyDeployerOrOwner
-modifier onlyDeployerOrOwner();
-getDeployment
-Get available deployment information for address.
-function getDeployment(address addr) external view returns (Deployment memory);
-Parameters
-| Name | Type | Description |
|---|---|---|
addr | address | Address of the contract. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | Deployment | Deployment Deployment information. |
getLatestDeployments
-Get the topmost count of deployments.
function getLatestDeployments(uint256 count) external view returns (Deployment[] memory result);
-Returns
-| Name | Type | Description |
|---|---|---|
result | Deployment[] | Deployment[] List of information about the deployments. |
getDeployByIndex
-Get available information of deployment in index.
-function getDeployByIndex(uint256 index) external view returns (Deployment memory);
-Parameters
-| Name | Type | Description |
|---|---|---|
index | uint256 | Index of the deployment. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | Deployment | Deployment Deployment information. |
getDeployments
-Get all deployments.
-function getDeployments() external view returns (Deployment[] memory);
-Returns
-| Name | Type | Description |
|---|---|---|
<none> | Deployment[] | Deployment[] Array of deployments. |
getDeployCount
-Get number of deployments.
-function getDeployCount() external view returns (uint256);
-Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 Number of deployments. |
isDeployment
-Inspect if an address is created by this contract.
-function isDeployment(address addr) external view returns (bool);
-Parameters
-| Name | Type | Description |
|---|---|---|
addr | address | Address to inspect |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | bool | bool True if deployment was created by this contract. |
isNonProxy
-Inspect if an address is a non proxy deployment created by this contract.
-function isNonProxy(address addr) external view returns (bool);
-isProxy
-Inspect if an address is a proxy created by this contract.
-function isProxy(address addr) external view returns (bool);
-Parameters
-| Name | Type | Description |
|---|---|---|
addr | address | Address to inspect |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | bool | bool True if proxy was created by this contract. |
isDeterministic
-function isDeterministic(address addr) public view returns (bool);
-getImplementation
-Inspect the current implementation address of a proxy.
-function getImplementation(address proxy) external view override returns (address);
-Parameters
-| Name | Type | Description |
|---|---|---|
proxy | address | Address of the proxy. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | address | address Implementation address of the proxy |
getProxyInitCodeHash
-Get the init code hash for a proxy.
-function getProxyInitCodeHash(address implementation, bytes memory _calldata) public view returns (bytes32);
-Parameters
-| Name | Type | Description |
|---|---|---|
implementation | address | Address of the implementation. |
_calldata | bytes |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | bytes32 | bytes32 Hash of the init code. |
getCreate2Address
-Preview address from CREATE2 with given salt and creation code.
-function getCreate2Address(bytes32 salt, bytes memory creationCode) public view returns (address);
-getCreate3Address
-Preview address from CREATE3 with given salt.
-function getCreate3Address(bytes32 salt) public view returns (address);
-previewCreateProxy
-function previewCreateProxy(address implementation, bytes memory _calldata) external returns (address proxyPreview);
-previewCreate2Proxy
-Preview resulting proxy address from {create2AndCall} with given salt.
-function previewCreate2Proxy(address implementation, bytes memory _calldata, bytes32 salt)
- public
- view
- returns (address proxyPreview);
-Parameters
-| Name | Type | Description |
|---|---|---|
implementation | address | Address of the implementation. |
_calldata | bytes | Initializer calldata. |
salt | bytes32 | Salt for the deterministic deployment. |
Returns
-| Name | Type | Description |
|---|---|---|
proxyPreview | address | Address of the proxy that would be created. |
previewCreate3Proxy
-Preview resulting proxy address from {create3AndCall} or {deployCreate3AndCall} with given salt.
-function previewCreate3Proxy(bytes32 salt) external view returns (address proxyPreview);
-Parameters
-| Name | Type | Description |
|---|---|---|
salt | bytes32 | Salt for the deterministic deployment. |
Returns
-| Name | Type | Description |
|---|---|---|
proxyPreview | address | Address of the proxy that would be created. |
previewCreateProxyAndLogic
-function previewCreateProxyAndLogic(bytes memory implementation, bytes memory _calldata)
- external
- returns (address proxyPreview, address implementationPreview);
-previewCreate2ProxyAndLogic
-Preview resulting proxy and implementation address from {deployCreate2AndCall} with given salt.
-function previewCreate2ProxyAndLogic(bytes memory implementation, bytes memory _calldata, bytes32 salt)
- external
- view
- returns (address proxyPreview, address implementationPreview);
-Parameters
-| Name | Type | Description |
|---|---|---|
implementation | bytes | Bytecode of the implementation. |
_calldata | bytes | Initializer calldata. |
salt | bytes32 | Salt for the deterministic deployment. |
Returns
-| Name | Type | Description |
|---|---|---|
proxyPreview | address | Address of the proxy that would be created. |
implementationPreview | address | Address of the deployed implementation. |
previewCreate3ProxyAndLogic
-Preview implementation and proxy address from {deployCreate3AndCall} with given salt.
-function previewCreate3ProxyAndLogic(bytes32 salt)
- external
- view
- returns (address proxyPreview, address implementationPreview);
-Parameters
-| Name | Type | Description |
|---|---|---|
salt | bytes32 | Salt for the deterministic deployment. |
Returns
-| Name | Type | Description |
|---|---|---|
proxyPreview | address | Address of the new proxy. |
implementationPreview | address | Address of the deployed implementation. |
previewCreate2Upgrade
-Preview resulting implementation address from {upgrade2AndCall} with given salt.
-function previewCreate2Upgrade(ITransparentUpgradeableProxy proxy, bytes memory implementation)
- external
- view
- returns (address implementationPreview, uint256 version);
-Parameters
-| Name | Type | Description |
|---|---|---|
proxy | ITransparentUpgradeableProxy | Existing ITransparentUpgradeableProxy address. |
implementation | bytes | Bytecode of the new implementation. |
Returns
-| Name | Type | Description |
|---|---|---|
implementationPreview | address | Address for the next implementation. |
version | uint256 | New version number of the proxy. |
previewCreate3Upgrade
-Preview resulting implementation address from {upgrade3AndCall} with given salt.
-function previewCreate3Upgrade(ITransparentUpgradeableProxy proxy)
- external
- view
- returns (address implementationPreview, uint256 version);
-Parameters
-| Name | Type | Description |
|---|---|---|
proxy | ITransparentUpgradeableProxy | Existing ITransparentUpgradeableProxy address. |
Returns
-| Name | Type | Description |
|---|---|---|
implementationPreview | address | Address for the next implementation. |
version | uint256 | New version number of the proxy. |
createProxy
-Creates a new proxy for the implementation and initializes it with data.
function createProxy(address implementation, bytes memory _calldata)
- public
- payable
- onlyDeployerOrOwner
- returns (Deployment memory newProxy);
-Parameters
-| Name | Type | Description |
|---|---|---|
implementation | address | Address of the implementation. |
_calldata | bytes | Initializer calldata. |
Returns
-| Name | Type | Description |
|---|---|---|
newProxy | Deployment | Deployment information. See {TransparentUpgradeableProxy-constructor}. |
create2Proxy
-Creates a new proxy with deterministic address derived from arguments given.
-function create2Proxy(address implementation, bytes memory _calldata, bytes32 salt)
- public
- payable
- onlyDeployerOrOwner
- returns (Deployment memory newProxy);
-Parameters
-| Name | Type | Description |
|---|---|---|
implementation | address | Address of the implementation. |
_calldata | bytes | Initializer calldata. |
salt | bytes32 | Salt for the deterministic deployment. |
Returns
-| Name | Type | Description |
|---|---|---|
newProxy | Deployment | Deployment information. |
create3Proxy
-Creates a new proxy with deterministic address derived only from the salt given.
-function create3Proxy(address implementation, bytes memory _calldata, bytes32 salt)
- public
- payable
- onlyDeployerOrOwner
- returns (Deployment memory newProxy);
-Parameters
-| Name | Type | Description |
|---|---|---|
implementation | address | Address of the implementation. |
_calldata | bytes | Initializer calldata. |
salt | bytes32 | Salt for the deterministic deployment. |
Returns
-| Name | Type | Description |
|---|---|---|
newProxy | Deployment | Deployment information. |
createProxyAndLogic
-Deploys an implementation and creates a proxy initialized with data for it.
function createProxyAndLogic(bytes memory implementation, bytes memory _calldata)
- external
- payable
- onlyDeployerOrOwner
- returns (Deployment memory);
-Parameters
-| Name | Type | Description |
|---|---|---|
implementation | bytes | Bytecode of the implementation. |
_calldata | bytes | Initializer calldata. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | Deployment | newProxy Deployment information. |
create2ProxyAndLogic
-Deterministic version of {deployCreateAndCall} where arguments are used to derive the salt.
-Implementation salt is salt + 1. Use {previewDeployCreate3} to preview.
-function create2ProxyAndLogic(bytes memory implementation, bytes memory _calldata, bytes32 salt)
- external
- payable
- onlyDeployerOrOwner
- returns (Deployment memory);
-Parameters
-| Name | Type | Description |
|---|---|---|
implementation | bytes | Bytecode of the implementation. |
_calldata | bytes | Initializer calldata. |
salt | bytes32 | Salt to derive both addresses from. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | Deployment | newProxy Deployment information. |
create3ProxyAndLogic
-Deterministic version of {deployCreateAndCall} where only salt matters.
-Implementation salt is salt + 1. Use {previewDeployCreate3} to preview.
-function create3ProxyAndLogic(bytes memory implementation, bytes memory _calldata, bytes32 salt)
- external
- payable
- onlyDeployerOrOwner
- returns (Deployment memory);
-Parameters
-| Name | Type | Description |
|---|---|---|
implementation | bytes | Bytecode of the implementation to deploy. |
_calldata | bytes | Initializer calldata. |
salt | bytes32 | Salt to derive both addresses from. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | Deployment | newProxy Deployment information. |
upgradeAndCall
-function upgradeAndCall(ITransparentUpgradeableProxy proxy, address implementation, bytes memory _calldata)
- public
- payable
- override(ProxyAdmin);
-upgradeAndCall
-Deploys the @param implementation for {upgradeAndCall} and @return Deployment information.
-function upgradeAndCall(ITransparentUpgradeableProxy proxy, bytes memory implementation, bytes memory _calldata)
- external
- payable
- returns (Deployment memory);
-upgradeAndCallReturn
-Same as {upgradeAndCall} but @return Deployment information.
-function upgradeAndCallReturn(ITransparentUpgradeableProxy proxy, address implementation, bytes memory _calldata)
- public
- payable
- returns (Deployment memory);
-create2UpgradeAndCall
-Deterministically deploys the upgrade implementation and calls the {ProxyAdmin-upgradeAndCall}.
-Implementation salt is salt + next version. Use {previewUpgrade2} to preview.
-function create2UpgradeAndCall(ITransparentUpgradeableProxy proxy, bytes memory implementation, bytes memory _calldata)
- external
- payable
- returns (Deployment memory);
-Parameters
-| Name | Type | Description |
|---|---|---|
proxy | ITransparentUpgradeableProxy | Existing ITransparentUpgradeableProxy to upgrade. |
implementation | bytes | Bytecode of the new implementation. |
_calldata | bytes | Initializer calldata. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | Deployment | Deployment Deployment information. |
create3UpgradeAndCall
-Deterministically deploys the upgrade implementatio and calls the {ProxyAdmin-upgradeAndCall}.
-Implementation salt is salt + next version. Use {previewUpgrade3} to preview.
-function create3UpgradeAndCall(ITransparentUpgradeableProxy proxy, bytes memory implementation, bytes memory _calldata)
- public
- payable
- returns (Deployment memory);
-Parameters
-| Name | Type | Description |
|---|---|---|
proxy | ITransparentUpgradeableProxy | Existing ITransparentUpgradeableProxy to upgrade. |
implementation | bytes | Bytecode of the new implementation. |
_calldata | bytes | Initializer calldata. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | Deployment | Deployment Deployment information. |
batchStatic
-Batch view data from this contract.
-function batchStatic(bytes[] calldata calls) external view returns (bytes[] memory results);
-batch
-Batch any action in this contract.
-Reverts if any of the calls fail.
-function batch(bytes[] calldata calls) external payable onlyDeployerOrOwner returns (bytes[] memory);
-deployCreate2
-function deployCreate2(bytes memory creationCode, bytes calldata _calldata, bytes32 salt)
- external
- payable
- onlyDeployerOrOwner
- returns (Deployment memory newDeployment);
-deployCreate3
-function deployCreate3(bytes memory creationCode, bytes calldata _calldata, bytes32 salt)
- external
- payable
- onlyDeployerOrOwner
- returns (Deployment memory newDeployment);
-_save
-Updates deployment fields to _deployment and _deploymentList.
-function _save(Deployment memory update) internal returns (Deployment memory);
-_tryParseRevert
-Function that tries to extract some useful information about a failed call.
-If returned data is malformed or has incorrect encoding this can fail itself.
-function _tryParseRevert(bytes memory _returnData) internal pure;
-CreationKind
- -enum CreationKind {
- NONE,
- CREATE,
- CREATE2,
- CREATE3
-}
-Deployment
- -Deployment information
-struct Deployment {
- address implementation;
- uint88 updatedAt;
- CreationKind kind;
- ITransparentUpgradeableProxy proxy;
- uint48 index;
- uint48 createdAt;
- uint256 version;
- bytes32 salt;
-}
-IDeploymentFactory
- -Functions
-setDeployer
-function setDeployer(address who, bool value) external;
-isDeployer
-function isDeployer(address who) external view returns (bool);
-getDeployment
-Get available deployment information for address.
-function getDeployment(address addr) external view returns (Deployment memory);
-Parameters
-| Name | Type | Description |
|---|---|---|
addr | address | Address of the contract. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | Deployment | Deployment Deployment information. |
getLatestDeployments
-Get the topmost count of deployments.
function getLatestDeployments(uint256 count) external view returns (Deployment[] memory);
-Returns
-| Name | Type | Description |
|---|---|---|
<none> | Deployment[] | Deployment[] List of information about the deployments. |
getDeployByIndex
-Get available information of deployment in index.
-function getDeployByIndex(uint256 index) external view returns (Deployment memory);
-Parameters
-| Name | Type | Description |
|---|---|---|
index | uint256 | Index of the deployment. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | Deployment | Deployment Deployment information. |
getDeployments
-Get all deployments.
-function getDeployments() external view returns (Deployment[] memory);
-Returns
-| Name | Type | Description |
|---|---|---|
<none> | Deployment[] | Deployment[] Array of deployments. |
getDeployCount
-Get number of deployments.
-function getDeployCount() external view returns (uint256);
-Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 Number of deployments. |
isDeployment
-Inspect if an address is created by this contract.
-function isDeployment(address addr) external view returns (bool);
-Parameters
-| Name | Type | Description |
|---|---|---|
addr | address | Address to inspect |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | bool | bool True if deployment was created by this contract. |
isProxy
-Inspect if an address is a proxy created by this contract.
-function isProxy(address addr) external view returns (bool);
-Parameters
-| Name | Type | Description |
|---|---|---|
addr | address | Address to inspect |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | bool | bool True if proxy was created by this contract. |
isNonProxy
-Inspect if an address is a non proxy deployment created by this contract.
-function isNonProxy(address addr) external view returns (bool);
-isDeterministic
-function isDeterministic(address addr) external view returns (bool);
-getImplementation
-Inspect the current implementation address of a proxy.
-function getImplementation(address proxy) external view returns (address);
-Parameters
-| Name | Type | Description |
|---|---|---|
proxy | address | Address of the proxy. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | address | address Implementation address of the proxy |
getProxyInitCodeHash
-Get the init code hash for a proxy.
-function getProxyInitCodeHash(address implementation, bytes memory data) external view returns (bytes32);
-Parameters
-| Name | Type | Description |
|---|---|---|
implementation | address | Address of the implementation. |
data | bytes | Initializer calldata. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | bytes32 | bytes32 Hash of the init code. |
getCreate2Address
-Preview address from CREATE2 with given salt and creation code.
-function getCreate2Address(bytes32 _salt, bytes memory _creationCode) external view returns (address);
-getCreate3Address
-Preview address from CREATE3 with given salt.
-function getCreate3Address(bytes32 salt) external view returns (address);
-previewCreateProxy
-Preview proxy address from {createProxy} through {CreateProxyPreview} custom error.
-function previewCreateProxy(address implementation, bytes memory _calldata) external returns (address proxyPreview);
-Parameters
-| Name | Type | Description |
|---|---|---|
implementation | address | Bytecode of the implementation. |
_calldata | bytes | Initializer calldata. |
Returns
-| Name | Type | Description |
|---|---|---|
proxyPreview | address | Address of the proxy that would be created. |
previewCreate2Proxy
-Preview resulting proxy address from {create2AndCall} with given salt.
-function previewCreate2Proxy(address implementation, bytes memory _calldata, bytes32 salt)
- external
- view
- returns (address proxyPreview);
-Parameters
-| Name | Type | Description |
|---|---|---|
implementation | address | Address of the implementation. |
_calldata | bytes | Initializer calldata. |
salt | bytes32 | Salt for the deterministic deployment. |
Returns
-| Name | Type | Description |
|---|---|---|
proxyPreview | address | Address of the proxy that would be created. |
previewCreate3Proxy
-Preview resulting proxy address from {create3AndCall} or {deployCreate3AndCall} with given salt.
-function previewCreate3Proxy(bytes32 salt) external view returns (address proxyPreview);
-Parameters
-| Name | Type | Description |
|---|---|---|
salt | bytes32 | Salt for the deterministic deployment. |
Returns
-| Name | Type | Description |
|---|---|---|
proxyPreview | address | Address of the proxy that would be created. |
previewCreateProxyAndLogic
-Preview resulting proxy and implementation address from {deployCreateAndCall} through the {CreateProxyAndLogic} custom error.
-function previewCreateProxyAndLogic(bytes memory implementation, bytes memory _calldata)
- external
- returns (address proxyPreview, address implementationPreview);
-Parameters
-| Name | Type | Description |
|---|---|---|
implementation | bytes | Bytecode of the implementation. |
_calldata | bytes | Initializer calldata. |
Returns
-| Name | Type | Description |
|---|---|---|
proxyPreview | address | Address of the proxy that would be created. |
implementationPreview | address | Address of the deployed implementation. |
previewCreate2ProxyAndLogic
-Preview resulting proxy and implementation address from {deployCreate2AndCall} with given salt.
-function previewCreate2ProxyAndLogic(bytes memory implementation, bytes memory _calldata, bytes32 salt)
- external
- view
- returns (address proxyPreview, address implementationPreview);
-Parameters
-| Name | Type | Description |
|---|---|---|
implementation | bytes | Bytecode of the implementation. |
_calldata | bytes | Initializer calldata. |
salt | bytes32 | Salt for the deterministic deployment. |
Returns
-| Name | Type | Description |
|---|---|---|
proxyPreview | address | Address of the proxy that would be created. |
implementationPreview | address | Address of the deployed implementation. |
previewCreate3ProxyAndLogic
-Preview implementation and proxy address from {deployCreate3AndCall} with given salt.
-function previewCreate3ProxyAndLogic(bytes32 salt)
- external
- view
- returns (address proxyPreview, address implementationPreview);
-Parameters
-| Name | Type | Description |
|---|---|---|
salt | bytes32 | Salt for the deterministic deployment. |
Returns
-| Name | Type | Description |
|---|---|---|
proxyPreview | address | Address of the new proxy. |
implementationPreview | address | Address of the deployed implementation. |
previewCreate2Upgrade
-Preview resulting implementation address from {upgrade2AndCall} with given salt.
-function previewCreate2Upgrade(ITransparentUpgradeableProxy proxy, bytes memory implementation)
- external
- view
- returns (address implementationPreview, uint256 version);
-Parameters
-| Name | Type | Description |
|---|---|---|
proxy | ITransparentUpgradeableProxy | Existing ITransparentUpgradeableProxy address. |
implementation | bytes | Bytecode of the new implementation. |
Returns
-| Name | Type | Description |
|---|---|---|
implementationPreview | address | Address for the next implementation. |
version | uint256 | New version number of the proxy. |
previewCreate3Upgrade
-Preview resulting implementation address from {upgrade3AndCall} with given salt.
-function previewCreate3Upgrade(ITransparentUpgradeableProxy proxy)
- external
- view
- returns (address implementationPreview, uint256 version);
-Parameters
-| Name | Type | Description |
|---|---|---|
proxy | ITransparentUpgradeableProxy | Existing ITransparentUpgradeableProxy address. |
Returns
-| Name | Type | Description |
|---|---|---|
implementationPreview | address | Address for the next implementation. |
version | uint256 | New version number of the proxy. |
createProxy
-Creates a new proxy for the implementation and initializes it with data.
function createProxy(address implementation, bytes memory _calldata)
- external
- payable
- returns (Deployment memory newProxy);
-Parameters
-| Name | Type | Description |
|---|---|---|
implementation | address | Address of the implementation. |
_calldata | bytes | Initializer calldata. |
Returns
-| Name | Type | Description |
|---|---|---|
newProxy | Deployment | Deployment information. See {TransparentUpgradeableProxy-constructor}. |
create2Proxy
-Creates a new proxy with deterministic address derived from arguments given.
-function create2Proxy(address implementation, bytes memory _calldata, bytes32 salt)
- external
- payable
- returns (Deployment memory newProxy);
-Parameters
-| Name | Type | Description |
|---|---|---|
implementation | address | Address of the implementation. |
_calldata | bytes | Initializer calldata. |
salt | bytes32 | Salt for the deterministic deployment. |
Returns
-| Name | Type | Description |
|---|---|---|
newProxy | Deployment | Deployment information. |
create3Proxy
-Creates a new proxy with deterministic address derived only from the salt given.
-function create3Proxy(address implementation, bytes memory _calldata, bytes32 salt)
- external
- payable
- returns (Deployment memory newProxy);
-Parameters
-| Name | Type | Description |
|---|---|---|
implementation | address | Address of the implementation. |
_calldata | bytes | Initializer calldata. |
salt | bytes32 | Salt for the deterministic deployment. |
Returns
-| Name | Type | Description |
|---|---|---|
newProxy | Deployment | Deployment information. |
createProxyAndLogic
-Deploys an implementation and creates a proxy initialized with data for it.
function createProxyAndLogic(bytes memory implementation, bytes memory _calldata)
- external
- payable
- returns (Deployment memory newProxy);
-Parameters
-| Name | Type | Description |
|---|---|---|
implementation | bytes | Bytecode of the implementation. |
_calldata | bytes | Initializer calldata. |
Returns
-| Name | Type | Description |
|---|---|---|
newProxy | Deployment | Deployment information. |
create2ProxyAndLogic
-Deterministic version of {deployCreateAndCall} where arguments are used to derive the salt.
-Implementation salt is salt + 1. Use {previewDeployCreate3} to preview.
-function create2ProxyAndLogic(bytes memory implementation, bytes memory _calldata, bytes32 salt)
- external
- payable
- returns (Deployment memory newProxy);
-Parameters
-| Name | Type | Description |
|---|---|---|
implementation | bytes | Bytecode of the implementation. |
_calldata | bytes | Initializer calldata. |
salt | bytes32 | Salt to derive both addresses from. |
Returns
-| Name | Type | Description |
|---|---|---|
newProxy | Deployment | Deployment information. |
create3ProxyAndLogic
-Deterministic version of {deployCreateAndCall} where only salt matters.
-Implementation salt is salt + 1. Use {previewDeployCreate3} to preview.
-function create3ProxyAndLogic(bytes memory implementation, bytes memory _calldata, bytes32 salt)
- external
- payable
- returns (Deployment memory newProxy);
-Parameters
-| Name | Type | Description |
|---|---|---|
implementation | bytes | Bytecode of the implementation to deploy. |
_calldata | bytes | Initializer calldata. |
salt | bytes32 | Salt to derive both addresses from. |
Returns
-| Name | Type | Description |
|---|---|---|
newProxy | Deployment | Deployment information. |
upgradeAndCall
-Deploys the @param implementation for {upgradeAndCall} and @return Deployment information.
-function upgradeAndCall(ITransparentUpgradeableProxy proxy, bytes memory implementation, bytes memory _calldata)
- external
- payable
- returns (Deployment memory);
-upgradeAndCallReturn
-Same as {upgradeAndCall} but @return Deployment information.
-function upgradeAndCallReturn(ITransparentUpgradeableProxy proxy, address implementation, bytes memory _calldata)
- external
- payable
- returns (Deployment memory);
-create2UpgradeAndCall
-Deterministically deploys the upgrade implementation and calls the {ProxyAdmin-upgradeAndCall}.
-Implementation salt is salt + next version. Use {previewUpgrade2} to preview.
-function create2UpgradeAndCall(ITransparentUpgradeableProxy proxy, bytes memory implementation, bytes memory _calldata)
- external
- payable
- returns (Deployment memory);
-Parameters
-| Name | Type | Description |
|---|---|---|
proxy | ITransparentUpgradeableProxy | Existing ITransparentUpgradeableProxy to upgrade. |
implementation | bytes | Bytecode of the new implementation. |
_calldata | bytes | Initializer calldata. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | Deployment | Deployment Deployment information. |
create3UpgradeAndCall
-Deterministically deploys the upgrade implementatio and calls the {ProxyAdmin-upgradeAndCall}.
-Implementation salt is salt + next version. Use {previewUpgrade3} to preview.
-function create3UpgradeAndCall(ITransparentUpgradeableProxy proxy, bytes memory implementation, bytes memory _calldata)
- external
- payable
- returns (Deployment memory);
-Parameters
-| Name | Type | Description |
|---|---|---|
proxy | ITransparentUpgradeableProxy | Existing ITransparentUpgradeableProxy to upgrade. |
implementation | bytes | Bytecode of the new implementation. |
_calldata | bytes | Initializer calldata. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | Deployment | Deployment Deployment information. |
deployCreate2
-Deploy contract using create2.
-function deployCreate2(bytes memory creationCode, bytes memory _calldata, bytes32 salt)
- external
- payable
- returns (Deployment memory newDeployment);
-Parameters
-| Name | Type | Description |
|---|---|---|
creationCode | bytes | The creation code (bytes). |
_calldata | bytes | The calldata (bytes). |
salt | bytes32 | The salt (bytes32). |
Returns
-| Name | Type | Description |
|---|---|---|
newDeployment | Deployment | Deployment information. |
deployCreate3
-Deploy contract using create3.
-function deployCreate3(bytes memory creationCode, bytes memory _calldata, bytes32 salt)
- external
- payable
- returns (Deployment memory newDeployment);
-Parameters
-| Name | Type | Description |
|---|---|---|
creationCode | bytes | The creation code (bytes). |
_calldata | bytes | The calldata (bytes). |
salt | bytes32 | The salt (bytes32). |
Returns
-| Name | Type | Description |
|---|---|---|
newDeployment | Deployment | Deployment information. |
batch
-Batch any action in this contract.
-Reverts if any of the calls fail.
-Delegates to self which keeps context, so msg.value is fine.
-function batch(bytes[] calldata calls) external payable returns (bytes[] memory results);
-batchStatic
-Batch view data from this contract.
-function batchStatic(bytes[] calldata calls) external view returns (bytes[] memory results);
-Events
-DeployerSet
-event DeployerSet(address, bool);
-Deployed
-event Deployed(Deployment);
-Upgrade
-event Upgrade(Deployment);
-Errors
-BatchRevertSilentOrCustomError
-error BatchRevertSilentOrCustomError(bytes innerError);
-CreateProxyPreview
-error CreateProxyPreview(address proxy);
-CreateProxyAndLogicPreview
-error CreateProxyAndLogicPreview(address proxy, address implementation);
-InvalidKind
-error InvalidKind(Deployment);
-ArrayLengthMismatch
-error ArrayLengthMismatch(uint256 proxies, uint256 implementations, uint256 datas);
-InvalidSalt
-error InvalidSalt(Deployment);
-DeployerAlreadySet
-error DeployerAlreadySet(address, bool);
-TransparentUpgradeableProxy
- -Inherits: -ERC1967Proxy
-*This contract implements a proxy that is upgradeable through an associated {ProxyAdmin} instance. -To avoid https://medium.com/nomic-labs-blog/malicious-backdoors-in-ethereum-proxies-62629adf3357[proxy selector -clashing], which can potentially be used in an attack, this contract uses the -https://blog.openzeppelin.com/the-transparent-proxy-pattern/[transparent proxy pattern]. This pattern implies two -things that go hand in hand:
--
-
- If any account other than the admin calls the proxy, the call will be forwarded to the implementation, even if -that call matches the {ITransparentUpgradeableProxy-upgradeToAndCall} function exposed by the proxy itself. -
- If the admin calls the proxy, it can call the
upgradeToAndCallfunction but any other call won't be forwarded to -the implementation. If the admin tries to call a function on the implementation it will fail with an error indicating -the proxy admin cannot fallback to the target implementation. -These properties mean that the admin account can only be used for upgrading the proxy, so it's best if it's a -dedicated account that is not used for anything else. This will avoid headaches due to sudden errors when trying to -call a function from the proxy implementation. For this reason, the proxy deploys an instance of {ProxyAdmin} and -allows upgrades only if they come through it. You should think of theProxyAdmininstance as the administrative -interface of the proxy, including the ability to change who can trigger upgrades by transferring ownership. -NOTE: The real interface of this proxy is that defined inITransparentUpgradeableProxy. This contract does not -inherit from that interface, and insteadupgradeToAndCallis implicitly implemented using a custom dispatch -mechanism in_fallback. Consequently, the compiler will not produce an ABI for this contract. This is necessary to -fully implement transparency without decoding reverts caused by selector clashes between the proxy and the -implementation. -NOTE: This proxy does not inherit from {Context} deliberately. The {ProxyAdmin} of this contract won't send a -meta-transaction in any way, and any other meta-transaction setup should be made in the implementation contract. -IMPORTANT: This contract avoids unnecessary storage reads by setting the admin only during construction as an -immutable variable, preventing any changes thereafter. However, the admin slot defined in ERC-1967 can still be -overwritten by the implementation logic pointed to by this proxy. In such cases, the contract may end up in an -undesirable state where the admin slot is different from the actual admin. -WARNING: It is not recommended to extend this contract to add additional external functions. If you do so, the -compiler will not check that there are no selector conflicts, due to the note above. A selector clash between any new -function and the functions declared in {ITransparentUpgradeableProxy} will be resolved in favor of the new one. This -could render theupgradeToAndCallfunction inaccessible, preventing upgradeability and compromising transparency.*
-
State Variables
-_admin
-address private immutable _admin;
-Functions
-constructor
-Kresko
-Initializes an upgradeable proxy managed by an instance of a {ProxyAdmin} with an initialOwner,
-backed by the implementation at _logic, and optionally initialized with _data as explained in
-{ERC1967Proxy-constructor}.
Removed ProxyAdmin construction - instead using the creator {DeploymentFactory} as {ProxyAdmin}.
-Factory address is explicitly passed as argument (and not as msg.sender) to support "CREATE3".
-constructor(address _logic, address _factory, bytes memory _data) payable ERC1967Proxy(_logic, _data);
-_proxyAdmin
-Returns the admin of this proxy.
-function _proxyAdmin() internal virtual returns (address);
-_fallback
-If caller is the admin process the call internally, otherwise transparently fallback to the proxy behavior.
-function _fallback() internal virtual override;
-_dispatchUpgradeToAndCall
-*Upgrade the implementation of the proxy. See {ERC1967Utils-upgradeToAndCall}. -Requirements:
--
-
- If
datais empty,msg.valuemust be zero.*
-
function _dispatchUpgradeToAndCall() private;
-Errors
-ProxyDeniedAdminAccess
-The proxy caller is the current admin, and can't fallback to the proxy target.
-error ProxyDeniedAdminAccess();
-Contents
--
-
- interfaces -
- KISS -
Contents
--
-
- IKISS -
IKISS
- -Inherits: -IVaultExtender, IKreskoAssetIssuer, IERC165
-Functions
-issue
-This function adds KISS to circulation -Caller must be a contract and have the OPERATOR_ROLE
-function issue(uint256 _amount, address _to) external override returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_amount | uint256 | amount to mint |
_to | address | address to mint tokens to |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 amount minted |
destroy
-This function removes KISS from circulation -Caller must be a contract and have the OPERATOR_ROLE
-function destroy(uint256 _amount, address _from) external override returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_amount | uint256 | amount to burn |
_from | address | address to burn tokens from |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 amount burned |
pause
-Triggers stopped state. -Requirements:
--
-
- The contract must not be paused. -
function pause() external;
-unpause
-Returns to normal state. -Requirements:
--
-
- The contract must be paused. -
function unpause() external;
-exchangeRate
-Exchange rate of vKISS to USD.
-function exchangeRate() external view returns (uint256 rate);
-Returns
-| Name | Type | Description |
|---|---|---|
rate | uint256 | vKISS/USD exchange rate. |
grantRole
-Overrides AccessControl.grantRole for following:
EOA cannot be granted Role.OPERATOR role
-function grantRole(bytes32 _role, address _to) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_role | bytes32 | role to grant |
_to | address | address to grant role for |
KISS
- -Inherits: -IKISS, ERC20Upgradeable, PausableUpgradeable, AccessControlEnumerableUpgradeable
-Author: -Kresko
-State Variables
-kresko
-address public kresko;
-vKISS
-address public vKISS;
-Functions
-initialize
-function initialize(
- string memory name_,
- string memory symbol_,
- uint8 dec_,
- address admin_,
- address kresko_,
- address vKISS_
-) external initializer;
-onlyContract
-modifier onlyContract();
-issue
-This function adds KISS to circulation -Caller must be a contract and have the OPERATOR_ROLE
-function issue(uint256 _amount, address _to) public override onlyRole(Role.OPERATOR) returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_amount | uint256 | amount to mint |
_to | address | address to mint tokens to |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 amount minted |
destroy
-This function removes KISS from circulation -Caller must be a contract and have the OPERATOR_ROLE
-function destroy(uint256 _amount, address _from) external onlyRole(Role.OPERATOR) returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_amount | uint256 | amount to burn |
_from | address | address to burn tokens from |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 amount burned |
vaultDeposit
-Deposit tokens to vault for shares and convert them to equal amount of extender token.
-function vaultDeposit(address _assetAddr, uint256 _assets, address _receiver)
- external
- returns (uint256 sharesOut, uint256 assetFee);
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | Supported vault asset address |
_assets | uint256 | amount of _assetAddr to deposit |
_receiver | address | Address receive extender tokens |
Returns
-| Name | Type | Description |
|---|---|---|
sharesOut | uint256 | amount of shares/extender tokens minted |
assetFee | uint256 | amount of _assetAddr vault took as fee |
vaultMint
-Deposit supported vault assets to receive _shares, depositing the shares for equal amount of extender token.
function vaultMint(address _assetAddr, uint256 _shares, address _receiver)
- external
- returns (uint256 assetsIn, uint256 assetFee);
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | Supported vault asset address |
_shares | uint256 | Amount of shares to receive |
_receiver | address | Address receive extender tokens |
Returns
-| Name | Type | Description |
|---|---|---|
assetsIn | uint256 | Amount of assets for _shares |
assetFee | uint256 | Amount of _assetAddr vault took as fee |
vaultWithdraw
-Withdraw supported vault asset, burning extender tokens and withdrawing shares from vault.
-function vaultWithdraw(address _assetAddr, uint256 _assets, address _receiver, address _owner)
- external
- returns (uint256 sharesIn, uint256 assetFee);
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | Supported vault asset address |
_assets | uint256 | amount of _assetAddr to deposit |
_receiver | address | Address receive extender tokens |
_owner | address | Owner of extender tokens |
Returns
-| Name | Type | Description |
|---|---|---|
sharesIn | uint256 | amount of shares/extender tokens burned |
assetFee | uint256 | amount of _assetAddr vault took as fee |
vaultRedeem
-Withdraw supported vault asset for _shares of extender tokens.
Does not return a value
-function vaultRedeem(address _assetAddr, uint256 _shares, address _receiver, address _owner)
- external
- returns (uint256 assetsOut, uint256 assetFee);
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | Token to deposit into vault for shares. |
_shares | uint256 | amount of extender tokens to burn |
_receiver | address | Address to receive assets withdrawn |
_owner | address | Owner of extender tokens |
Returns
-| Name | Type | Description |
|---|---|---|
assetsOut | uint256 | sharesIn amount of shares/extender tokens minted |
assetFee | uint256 | amount of _assetAddr vault took as fee |
deposit
-Deposit shares for equal amount of extender token.
-Does not return a value
-function deposit(uint256 _shares, address _receiver) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_shares | uint256 | amount of vault shares to deposit |
_receiver | address | address to mint extender tokens to |
withdraw
-Withdraw shares for equal amount of extender token.
-Does not return a value
-function withdraw(uint256 _amount, address _receiver) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_amount | uint256 | amount of vault extender tokens to burn |
_receiver | address | address to send shares to |
withdrawFrom
-Withdraw shares for equal amount of extender token with allowance.
-Does not return a value
-function withdrawFrom(address _from, address _to, uint256 _amount) public;
-Parameters
-| Name | Type | Description |
|---|---|---|
_from | address | address to burn extender tokens from |
_to | address | address to send shares to |
_amount | uint256 | amount to convert |
pause
-Triggers stopped state. -Requirements:
--
-
- The contract must not be paused. -
function pause() public onlyContract onlyRole(Role.ADMIN);
-unpause
-Returns to normal state. -Requirements:
--
-
- The contract must be paused. -
function unpause() public onlyContract onlyRole(Role.ADMIN);
-grantRole
-Overrides AccessControl.grantRole for following:
function grantRole(bytes32 _role, address _to)
- public
- override(IKISS, AccessControlUpgradeable, IAccessControl)
- onlyRole(Role.ADMIN);
-Parameters
-| Name | Type | Description |
|---|---|---|
_role | bytes32 | role to grant |
_to | address | address to grant role for |
exchangeRate
-Exchange rate of vKISS to USD.
-function exchangeRate() external view returns (uint256);
-Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | rate vKISS/USD exchange rate. |
convertToShares
-Preview conversion from KrAsset amount: @param assets to matching amount of Anchor tokens: @return shares
-function convertToShares(uint256 assets) external pure returns (uint256);
-convertManyToShares
-Preview conversion from KrAsset amounts: @param assets to matching amounts of Anchor tokens: @return shares
-function convertManyToShares(uint256[] calldata assets) external pure returns (uint256[] calldata shares);
-convertToAssets
-Preview conversion from Anchor token amount: @param shares to matching KrAsset amount: @return assets
-function convertToAssets(uint256 shares) external pure returns (uint256);
-convertManyToAssets
-Preview conversion from Anchor token amounts: @param shares to matching amounts of KrAssets: @return assets
-function convertManyToAssets(uint256[] calldata shares) external pure returns (uint256[] calldata assets);
-supportsInterface
-Query if a contract implements an interface
-Interface identification is specified in ERC-165. This function -uses less than 30,000 gas.
-function supportsInterface(bytes4 interfaceId)
- public
- view
- override(AccessControlEnumerableUpgradeable, IERC165)
- returns (bool);
-Parameters
-| Name | Type | Description |
|---|---|---|
interfaceId | bytes4 | The interface identifier, as specified in ERC-165 |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | bool | true if the contract implements interfaceID and interfaceID is not 0xffffffff, false otherwise |
_withdraw
-function _withdraw(address from, address to, uint256 amount) internal;
-_beforeTokenTransfer
-*See {ERC20-_beforeTokenTransfer}. -Requirements:
--
-
- the contract must not be paused.* -
function _beforeTokenTransfer(address from, address to, uint256 amount) internal override;
-Contents
--
-
- ERC4626Upgradeable -
- IERC4626Upgradeable -
- ISyncable -
- IKreskoAsset -
- IKreskoAssetAnchor -
- IKreskoAssetIssuer -
- KreskoAsset -
- KreskoAssetAnchor -
- Rebaser -
ERC4626Upgradeable
- -Inherits: -IERC4626Upgradeable, ERC20Upgradeable
-Authors: -Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/mixins/ERC4626.sol), Kresko (https://www.kresko.fi)
-Minimal ERC4626 tokenized Vault implementation.
-Kresko: -Adds issue/destroy functions that are called when KreskoAssets are minted/burned through the protocol.
-shares = anchor tokens
-assets = underlying KreskoAssets
-State Variables
-asset
-The underlying Kresko Asset
-IKreskoAsset public immutable asset;
-Functions
-constructor
-constructor(IKreskoAsset _asset) payable;
-__ERC4626Upgradeable_init
-Initializes the ERC4626.
-decimals are read from the underlying asset
-function __ERC4626Upgradeable_init(IERC20Permit _asset, string memory _name, string memory _symbol)
- internal
- onlyInitializing;
-Parameters
-| Name | Type | Description |
|---|---|---|
_asset | IERC20Permit | The underlying (Kresko) Asset |
_name | string | Name of the anchor token |
_symbol | string | Symbol of the anchor token |
issue
-When new KreskoAssets are minted: -Issues the equivalent amount of anchor tokens to Kresko -Issues the equivalent amount of assets to user
-function issue(uint256 assets, address to) public virtual returns (uint256 shares);
-destroy
-When new KreskoAssets are burned: -Destroys the equivalent amount of anchor tokens from Kresko -Destroys the equivalent amount of assets from user
-function destroy(uint256 assets, address from) public virtual returns (uint256 shares);
-totalAssets
-function totalAssets() public view virtual returns (uint256);
-convertToShares
-function convertToShares(uint256 assets) public view virtual returns (uint256 shares);
-convertToAssets
-function convertToAssets(uint256 shares) public view virtual returns (uint256 assets);
-previewIssue
-function previewIssue(uint256 assets) public view virtual returns (uint256);
-Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | shares for amount of @param assets |
previewDeposit
-function previewDeposit(uint256 assets) public view virtual returns (uint256);
-Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | shares for amount of @param assets |
previewDestroy
-function previewDestroy(uint256 shares) public view virtual returns (uint256);
-Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | assets for amount of @param shares |
previewRedeem
-function previewRedeem(uint256 shares) public view virtual returns (uint256);
-Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | assets for amount of @param shares |
previewMint
-function previewMint(uint256 shares) public view virtual returns (uint256);
-Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | assets for amount of @param shares |
previewWithdraw
-function previewWithdraw(uint256 assets) public view virtual returns (uint256);
-Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | shares for amount of @param assets |
maxDeposit
-function maxDeposit(address) public view virtual returns (uint256);
-maxIssue
-function maxIssue(address) public view virtual returns (uint256);
-maxMint
-function maxMint(address) public view virtual returns (uint256);
-maxDestroy
-function maxDestroy(address owner) public view virtual returns (uint256);
-maxWithdraw
-function maxWithdraw(address owner) public view virtual returns (uint256);
-maxRedeem
-function maxRedeem(address owner) public view virtual returns (uint256);
-deposit
-Deposit KreskoAssets for equivalent amount of anchor tokens
-function deposit(uint256 assets, address receiver) public virtual returns (uint256 shares);
-Parameters
-| Name | Type | Description |
|---|---|---|
assets | uint256 | Amount of KreskoAssets to deposit |
receiver | address | Address to send shares to |
Returns
-| Name | Type | Description |
|---|---|---|
shares | uint256 | Amount of shares minted |
withdraw
-Withdraw KreskoAssets for equivalent amount of anchor tokens
-shares are burned from owner, not msg.sender
-function withdraw(uint256 assets, address receiver, address owner) public virtual returns (uint256 shares);
-Parameters
-| Name | Type | Description |
|---|---|---|
assets | uint256 | Amount of KreskoAssets to withdraw |
receiver | address | Address to send KreskoAssets to |
owner | address | Address to burn shares from |
Returns
-| Name | Type | Description |
|---|---|---|
shares | uint256 | Amount of shares burned |
mint
-Mint shares of anchor tokens for equivalent amount of KreskoAssets
-function mint(uint256 shares, address receiver) public virtual returns (uint256 assets);
-Parameters
-| Name | Type | Description |
|---|---|---|
shares | uint256 | Amount of shares to mint |
receiver | address | Address to send shares to |
Returns
-| Name | Type | Description |
|---|---|---|
assets | uint256 | Amount of KreskoAssets redeemed |
redeem
-Redeem shares of anchor for KreskoAssets
-function redeem(uint256 shares, address receiver, address owner) public virtual returns (uint256 assets);
-Parameters
-| Name | Type | Description |
|---|---|---|
shares | uint256 | Amount of shares to redeem |
receiver | address | Address to send KreskoAssets to |
owner | address | Address to burn shares from |
Returns
-| Name | Type | Description |
|---|---|---|
assets | uint256 | Amount of KreskoAssets redeemed |
_anchorId
-function _anchorId() internal view returns (Errors.ID memory);
-_assetId
-function _assetId() internal view returns (Errors.ID memory);
-_beforeWithdraw
-function _beforeWithdraw(uint256 assets, uint256 shares) internal virtual;
-_afterDeposit
-function _afterDeposit(uint256 assets, uint256 shares) internal virtual;
-Events
-Issue
-event Issue(address indexed caller, address indexed owner, uint256 assets, uint256 shares);
-Deposit
-event Deposit(address indexed caller, address indexed owner, uint256 assets, uint256 shares);
-Destroy
-event Destroy(address indexed caller, address indexed receiver, address indexed owner, uint256 assets, uint256 shares);
-Withdraw
-event Withdraw(address indexed caller, address indexed receiver, address indexed owner, uint256 assets, uint256 shares);
-IERC4626Upgradeable
- -Functions
-asset
-The underlying Kresko Asset
-function asset() external view returns (IKreskoAsset);
-deposit
-Deposit KreskoAssets for equivalent amount of anchor tokens
-function deposit(uint256 assets, address receiver) external returns (uint256 shares);
-Parameters
-| Name | Type | Description |
|---|---|---|
assets | uint256 | Amount of KreskoAssets to deposit |
receiver | address | Address to send shares to |
Returns
-| Name | Type | Description |
|---|---|---|
shares | uint256 | Amount of shares minted |
withdraw
-Withdraw KreskoAssets for equivalent amount of anchor tokens
-shares are burned from owner, not msg.sender
-function withdraw(uint256 assets, address receiver, address owner) external returns (uint256 shares);
-Parameters
-| Name | Type | Description |
|---|---|---|
assets | uint256 | Amount of KreskoAssets to withdraw |
receiver | address | Address to send KreskoAssets to |
owner | address | Address to burn shares from |
Returns
-| Name | Type | Description |
|---|---|---|
shares | uint256 | Amount of shares burned |
maxDeposit
-function maxDeposit(address) external view returns (uint256);
-maxMint
-function maxMint(address) external view returns (uint256 assets);
-maxRedeem
-function maxRedeem(address owner) external view returns (uint256 assets);
-maxWithdraw
-function maxWithdraw(address owner) external view returns (uint256 assets);
-mint
-Mint shares of anchor tokens for equivalent amount of KreskoAssets
-function mint(uint256 shares, address receiver) external returns (uint256 assets);
-Parameters
-| Name | Type | Description |
|---|---|---|
shares | uint256 | Amount of shares to mint |
receiver | address | Address to send shares to |
Returns
-| Name | Type | Description |
|---|---|---|
assets | uint256 | Amount of KreskoAssets redeemed |
previewDeposit
-function previewDeposit(uint256 assets) external view returns (uint256 shares);
-previewMint
-function previewMint(uint256 shares) external view returns (uint256 assets);
-previewRedeem
-function previewRedeem(uint256 shares) external view returns (uint256 assets);
-previewWithdraw
-function previewWithdraw(uint256 assets) external view returns (uint256 shares);
-totalAssets
-Track the underlying amount
-function totalAssets() external view returns (uint256);
-Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | Total supply for the underlying |
redeem
-Redeem shares of anchor for KreskoAssets
-function redeem(uint256 shares, address receiver, address owner) external returns (uint256 assets);
-Parameters
-| Name | Type | Description |
|---|---|---|
shares | uint256 | Amount of shares to redeem |
receiver | address | Address to send KreskoAssets to |
owner | address | Address to burn shares from |
Returns
-| Name | Type | Description |
|---|---|---|
assets | uint256 | Amount of KreskoAssets redeemed |
ISyncable
- -Functions
-sync
-function sync() external;
-IKreskoAsset
- -Inherits: -IERC20Permit, IAccessControlEnumerable, IERC165
-Functions
-initialize
-Initializes a KreskoAsset ERC20 token.
-Intended to be operated by the Kresko smart contract.
-function initialize(
- string memory _name,
- string memory _symbol,
- uint8 _decimals,
- address _admin,
- address _kresko,
- address _underlyingAddr,
- address _feeRecipient,
- uint48 _openFee,
- uint40 _closeFee
-) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_name | string | The name of the KreskoAsset. |
_symbol | string | The symbol of the KreskoAsset. |
_decimals | uint8 | Decimals for the asset. |
_admin | address | The adminstrator of this contract. |
_kresko | address | The protocol, can perform mint and burn. |
_underlyingAddr | address | The underlying token if available. |
_feeRecipient | address | Fee recipient for synth wraps. |
_openFee | uint48 | Synth warp open fee. |
_closeFee | uint40 | Synth wrap close fee. |
kresko
-function kresko() external view returns (address);
-rebaseInfo
-function rebaseInfo() external view returns (Rebase memory);
-wrappingInfo
-function wrappingInfo() external view returns (Wrapping memory);
-isRebased
-function isRebased() external view returns (bool);
-rebase
-Perform a rebase, changing the denumerator and its operator
-denumerator values 0 and 1 ether will disable the rebase
-function rebase(uint248 _denominator, bool _positive, address[] calldata _pools) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_denominator | uint248 | the denumerator for the operator, 1 ether = 1 |
_positive | bool | supply increasing/reducing rebase |
_pools | address[] | UniswapV2Pair address to sync so we wont get rekt by skim() calls. |
reinitializeERC20
-Updates ERC20 metadata for the token in case eg. a ticker change
-function reinitializeERC20(string memory _name, string memory _symbol, uint8 _version) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_name | string | new name for the asset |
_symbol | string | new symbol for the asset |
_version | uint8 | number that must be greater than latest emitted Initialized version |
mint
-Mints tokens to an address.
-Only callable by operator.
-Internal balances are always unrebased, events emitted are not.
-function mint(address _to, uint256 _amount) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_to | address | The address to mint tokens to. |
_amount | uint256 | The amount of tokens to mint. |
burn
-Burns tokens from an address.
-Only callable by operator.
-Internal balances are always unrebased, events emitted are not.
-function burn(address _from, uint256 _amount) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_from | address | The address to burn tokens from. |
_amount | uint256 | The amount of tokens to burn. |
pause
-Triggers stopped state. -Requirements:
--
-
- The contract must not be paused. -
function pause() external;
-unpause
-Returns to normal state. -Requirements:
--
-
- The contract must be paused. -
function unpause() external;
-wrap
-Deposit underlying tokens to receive equal value of krAsset (-fee).
-function wrap(address _to, uint256 _amount) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_to | address | The to address. |
_amount | uint256 | The amount (uint256). |
unwrap
-Withdraw kreskoAsset to receive underlying tokens / native (-fee).
-function unwrap(uint256 _amount, bool _receiveNative) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_amount | uint256 | The amount (uint256). |
_receiveNative | bool | bool whether to receive underlying as native |
setAnchorToken
-Sets anchor token address
-Has modifiers: onlyRole.
-function setAnchorToken(address _anchor) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_anchor | address | The anchor address. |
enableNativeUnderlying
-Enables depositing native token ETH in case of krETH
-Has modifiers: onlyRole.
-function enableNativeUnderlying(bool _enabled) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_enabled | bool | The enabled (bool). |
setFeeRecipient
-Sets fee recipient address
-Has modifiers: onlyRole.
-function setFeeRecipient(address _feeRecipient) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_feeRecipient | address | The fee recipient address. |
setOpenFee
-Sets deposit fee
-Has modifiers: onlyRole.
-function setOpenFee(uint48 _openFee) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_openFee | uint48 | The open fee (uint48). |
setCloseFee
-Sets withdraw fee
-Has modifiers: onlyRole.
-function setCloseFee(uint40 _closeFee) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_closeFee | uint40 | The open fee (uint48). |
setUnderlying
-Sets underlying token address (and its decimals)
-Zero address will disable functionality provided for the underlying.
-Has modifiers: onlyRole.
-function setUnderlying(address _underlyingAddr) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_underlyingAddr | address | The underlying address. |
Structs
-Rebase
-Rebase information
-struct Rebase {
- uint248 denominator;
- bool positive;
-}
-Wrapping
-Wrapping information for the Kresko Asset
-struct Wrapping {
- address underlying;
- uint8 underlyingDecimals;
- uint48 openFee;
- uint40 closeFee;
- bool nativeUnderlyingEnabled;
- address payable feeRecipient;
-}
-IKreskoAssetAnchor
- -Inherits: -IKreskoAssetIssuer, IERC4626Upgradeable, IERC20Permit, IAccessControlEnumerable, IERC165
-Functions
-totalAssets
-function totalAssets() external view override(IERC4626Upgradeable) returns (uint256);
-initialize
-Initializes the Kresko Asset Anchor.
-Decimals are not supplied as they are read from the underlying Kresko Asset
-function initialize(IKreskoAsset _asset, string memory _name, string memory _symbol, address _admin) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_asset | IKreskoAsset | The underlying (Kresko) Asset |
_name | string | Name of the anchor token |
_symbol | string | Symbol of the anchor token |
_admin | address | The adminstrator of this contract. |
reinitializeERC20
-Updates ERC20 metadata for the token in case eg. a ticker change
-function reinitializeERC20(string memory _name, string memory _symbol, uint8 _version) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_name | string | new name for the asset |
_symbol | string | new symbol for the asset |
_version | uint8 | number that must be greater than latest emitted Initialized version |
wrap
-Mint Kresko Anchor Asset to Kresko Asset (Only KreskoAsset can call)
-function wrap(uint256 assets) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
assets | uint256 | The assets (uint256). |
unwrap
-Burn Kresko Anchor Asset to Kresko Asset (Only KreskoAsset can call)
-function unwrap(uint256 assets) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
assets | uint256 | The assets (uint256). |
IKreskoAssetIssuer
- -Author: -Kresko
-Contract that allows minting and burning through Kresko.
-All mintable assets in Kresko must implement this. (enforced through introspection)
-Functions
-issue
-Mints @param _assets of krAssets for @param _to,
-Mints relative @return _shares of anchor tokens.
-function issue(uint256 _assets, address _to) external returns (uint256 shares);
-destroy
-Burns @param _assets of krAssets from @param _from,
-Burns relative @return _shares of anchor tokens.
-function destroy(uint256 _assets, address _from) external returns (uint256 shares);
-convertToShares
-Preview conversion from KrAsset amount: @param assets to matching amount of Anchor tokens: @return shares
-function convertToShares(uint256 assets) external view returns (uint256 shares);
-convertToAssets
-Preview conversion from Anchor token amount: @param shares to matching KrAsset amount: @return assets
-function convertToAssets(uint256 shares) external view returns (uint256 assets);
-convertManyToAssets
-Preview conversion from Anchor token amounts: @param shares to matching amounts of KrAssets: @return assets
-function convertManyToAssets(uint256[] calldata shares) external view returns (uint256[] memory assets);
-convertManyToShares
-Preview conversion from KrAsset amounts: @param assets to matching amounts of Anchor tokens: @return shares
-function convertManyToShares(uint256[] calldata assets) external view returns (uint256[] memory shares);
-KreskoAsset
- -Inherits: -ERC20Upgradeable, AccessControlEnumerableUpgradeable, PausableUpgradeable, IKreskoAsset
-Author: -Kresko
-Rebases to adjust for stock splits and reverse stock splits
-Minting, burning and rebasing can only be performed by the Role.OPERATOR
State Variables
-rebasing
-Rebase private rebasing;
-isRebased
-bool public isRebased;
-kresko
-address public kresko;
-anchor
-address public anchor;
-wrapping
-Wrapping private wrapping;
-Functions
-constructor
-constructor();
-initialize
-Initializes a KreskoAsset ERC20 token.
-Intended to be operated by the Kresko smart contract.
-function initialize(
- string memory _name,
- string memory _symbol,
- uint8 _decimals,
- address _admin,
- address _kresko,
- address _underlying,
- address _feeRecipient,
- uint48 _openFee,
- uint40 _closeFee
-) external initializer;
-Parameters
-| Name | Type | Description |
|---|---|---|
_name | string | The name of the KreskoAsset. |
_symbol | string | The symbol of the KreskoAsset. |
_decimals | uint8 | Decimals for the asset. |
_admin | address | The adminstrator of this contract. |
_kresko | address | The protocol, can perform mint and burn. |
_underlying | address | |
_feeRecipient | address | Fee recipient for synth wraps. |
_openFee | uint48 | Synth warp open fee. |
_closeFee | uint40 | Synth wrap close fee. |
setAnchorToken
-Sets anchor token address
-Has modifiers: onlyRole.
-function setAnchorToken(address _anchor) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_anchor | address | The anchor address. |
setUnderlying
-Sets underlying token address (and its decimals)
-Has modifiers: onlyRole.
-function setUnderlying(address _underlyingAddr) public onlyRole(Role.ADMIN);
-Parameters
-| Name | Type | Description |
|---|---|---|
_underlyingAddr | address | The underlying address. |
enableNativeUnderlying
-Enables depositing native token ETH in case of krETH
-Has modifiers: onlyRole.
-function enableNativeUnderlying(bool _enabled) external onlyRole(Role.ADMIN);
-Parameters
-| Name | Type | Description |
|---|---|---|
_enabled | bool | The enabled (bool). |
setFeeRecipient
-Sets fee recipient address
-Has modifiers: onlyRole.
-function setFeeRecipient(address _feeRecipient) public onlyRole(Role.ADMIN);
-Parameters
-| Name | Type | Description |
|---|---|---|
_feeRecipient | address | The fee recipient address. |
setOpenFee
-Sets deposit fee
-Has modifiers: onlyRole.
-function setOpenFee(uint48 _openFee) public onlyRole(Role.ADMIN);
-Parameters
-| Name | Type | Description |
|---|---|---|
_openFee | uint48 | The open fee (uint48). |
setCloseFee
-Sets withdraw fee
-Has modifiers: onlyRole.
-function setCloseFee(uint40 _closeFee) public onlyRole(Role.ADMIN);
-Parameters
-| Name | Type | Description |
|---|---|---|
_closeFee | uint40 | The open fee (uint48). |
supportsInterface
-Query if a contract implements an interface
-Interface identification is specified in ERC-165. This function -uses less than 30,000 gas.
-function supportsInterface(bytes4 interfaceId)
- public
- view
- virtual
- override(AccessControlEnumerableUpgradeable, IERC165)
- returns (bool);
-Parameters
-| Name | Type | Description |
|---|---|---|
interfaceId | bytes4 | The interface identifier, as specified in ERC-165 |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | bool | true if the contract implements interfaceID and interfaceID is not 0xffffffff, false otherwise |
wrappingInfo
-function wrappingInfo() external view override returns (Wrapping memory);
-rebaseInfo
-function rebaseInfo() external view override returns (Rebase memory);
-totalSupply
-function totalSupply() public view override(ERC20Upgradeable, IERC20) returns (uint256);
-balanceOf
-function balanceOf(address _account) public view override(ERC20Upgradeable, IERC20) returns (uint256);
-allowance
-function allowance(address _owner, address _account) public view override(ERC20Upgradeable, IERC20) returns (uint256);
-pause
-Triggers stopped state. -Requirements:
--
-
- The contract must not be paused. -
function pause() public onlyRole(Role.ADMIN);
-unpause
-Returns to normal state. -Requirements:
--
-
- The contract must be paused. -
function unpause() public onlyRole(Role.ADMIN);
-reinitializeERC20
-Updates ERC20 metadata for the token in case eg. a ticker change
-function reinitializeERC20(string memory _name, string memory _symbol, uint8 _version)
- external
- onlyRole(Role.ADMIN)
- reinitializer(_version);
-Parameters
-| Name | Type | Description |
|---|---|---|
_name | string | new name for the asset |
_symbol | string | new symbol for the asset |
_version | uint8 | number that must be greater than latest emitted Initialized version |
approve
-function approve(address _spender, uint256 _amount) public override(ERC20Upgradeable, IERC20) returns (bool);
-transfer
-function transfer(address _to, uint256 _amount) public override(ERC20Upgradeable, IERC20) returns (bool);
-transferFrom
-function transferFrom(address _from, address _to, uint256 _amount)
- public
- override(ERC20Upgradeable, IERC20)
- returns (bool);
-rebase
-Perform a rebase, changing the denumerator and its operator
-denumerator values 0 and 1 ether will disable the rebase
-function rebase(uint248 _denominator, bool _positive, address[] calldata _pools) external onlyRole(Role.ADMIN);
-Parameters
-| Name | Type | Description |
|---|---|---|
_denominator | uint248 | the denumerator for the operator, 1 ether = 1 |
_positive | bool | supply increasing/reducing rebase |
_pools | address[] | UniswapV2Pair address to sync so we wont get rekt by skim() calls. |
mint
-Mints tokens to an address.
-Only callable by operator.
-function mint(address _to, uint256 _amount) external onlyRole(Role.OPERATOR);
-Parameters
-| Name | Type | Description |
|---|---|---|
_to | address | The address to mint tokens to. |
_amount | uint256 | The amount of tokens to mint. |
burn
-Burns tokens from an address.
-Only callable by operator.
-function burn(address _from, uint256 _amount) external onlyRole(Role.OPERATOR);
-Parameters
-| Name | Type | Description |
|---|---|---|
_from | address | The address to burn tokens from. |
_amount | uint256 | The amount of tokens to burn. |
wrap
-Deposit underlying tokens to receive equal value of krAsset (-fee).
-function wrap(address _to, uint256 _amount) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_to | address | The to address. |
_amount | uint256 | The amount (uint256). |
unwrap
-Withdraw kreskoAsset to receive underlying tokens / native (-fee).
-function unwrap(uint256 _amount, bool _receiveNative) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_amount | uint256 | The amount (uint256). |
_receiveNative | bool | bool whether to receive underlying as native |
receive
-receive() external payable;
-_mint
-function _mint(address _to, uint256 _amount) internal override;
-_burn
-function _burn(address _from, uint256 _amount) internal override;
-_transfer
-Internal balances are always unrebased, events emitted are not.
-function _transfer(address _from, address _to, uint256 _amount) internal returns (bool);
-_adjustDecimals
-function _adjustDecimals(uint256 _amount, uint8 _fromDecimal, uint8 _toDecimal) internal pure returns (uint256);
-_assetId
-function _assetId() internal view returns (Errors.ID memory);
-KreskoAssetAnchor
- -Inherits: -ERC4626Upgradeable, IKreskoAssetAnchor, AccessControlEnumerableUpgradeable
-Author: -Kresko
-Main purpose of this token is to represent a static amount of the possibly rebased underlying KreskoAsset. -Main use-cases are normalized book-keeping, bridging and integration with external contracts.
-Shares means amount of this token.
-Assets mean amount of KreskoAssets.
-Functions
-constructor
-constructor(IKreskoAsset _asset) payable ERC4626Upgradeable(_asset);
-initialize
-Initializes the Kresko Asset Anchor.
-Decimals are not supplied as they are read from the underlying Kresko Asset
-function initialize(IKreskoAsset _asset, string memory _name, string memory _symbol, address _admin)
- external
- initializer;
-Parameters
-| Name | Type | Description |
|---|---|---|
_asset | IKreskoAsset | The underlying (Kresko) Asset |
_name | string | Name of the anchor token |
_symbol | string | Symbol of the anchor token |
_admin | address | The adminstrator of this contract. |
supportsInterface
-Query if a contract implements an interface
-Interface identification is specified in ERC-165. This function -uses less than 30,000 gas.
-function supportsInterface(bytes4 interfaceId)
- public
- view
- virtual
- override(AccessControlEnumerableUpgradeable, IERC165)
- returns (bool);
-Parameters
-| Name | Type | Description |
|---|---|---|
interfaceId | bytes4 | The interface identifier, as specified in ERC-165 |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | bool | true if the contract implements interfaceID and interfaceID is not 0xffffffff, false otherwise |
reinitializeERC20
-Updates ERC20 metadata for the token in case eg. a ticker change
-function reinitializeERC20(string memory _name, string memory _symbol, uint8 _version)
- external
- onlyRole(Role.ADMIN)
- reinitializer(_version);
-Parameters
-| Name | Type | Description |
|---|---|---|
_name | string | new name for the asset |
_symbol | string | new symbol for the asset |
_version | uint8 | number that must be greater than latest emitted Initialized version |
totalAssets
-function totalAssets() public view virtual override(IKreskoAssetAnchor, ERC4626Upgradeable) returns (uint256);
-convertToAssets
-Preview conversion from Anchor token amount: @param shares to matching KrAsset amount: @return assets
-function convertToAssets(uint256 shares)
- public
- view
- virtual
- override(ERC4626Upgradeable, IKreskoAssetIssuer)
- returns (uint256 assets);
-convertManyToShares
-function convertManyToShares(uint256[] calldata assets) external view returns (uint256[] memory shares);
-convertManyToAssets
-Preview conversion from Anchor token amounts: @param shares to matching amounts of KrAssets: @return assets
-function convertManyToAssets(uint256[] calldata shares) external view returns (uint256[] memory assets);
-convertToShares
-Preview conversion from KrAsset amount: @param assets to matching amount of Anchor tokens: @return shares
-function convertToShares(uint256 assets)
- public
- view
- virtual
- override(ERC4626Upgradeable, IKreskoAssetIssuer)
- returns (uint256 shares);
-issue
-Mints @param _assets of krAssets for @param _to,
-function issue(uint256 _assets, address _to)
- public
- virtual
- override(ERC4626Upgradeable, IKreskoAssetIssuer)
- returns (uint256 shares);
-destroy
-Burns @param _assets of krAssets from @param _from,
-function destroy(uint256 _assets, address _from)
- public
- virtual
- override(ERC4626Upgradeable, IKreskoAssetIssuer)
- returns (uint256 shares);
-wrap
-Mint Kresko Anchor Asset to Kresko Asset (Only KreskoAsset can call)
-function wrap(uint256 assets) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
assets | uint256 | The assets (uint256). |
unwrap
-Burn Kresko Anchor Asset to Kresko Asset (Only KreskoAsset can call)
-function unwrap(uint256 assets) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
assets | uint256 | The assets (uint256). |
deposit
-reverting function, kept to maintain compatibility with ERC4626 standard
-function deposit(uint256, address) public pure override(ERC4626Upgradeable, IERC4626Upgradeable) returns (uint256);
-withdraw
-reverting function, kept to maintain compatibility with ERC4626 standard
-function withdraw(uint256, address, address)
- public
- pure
- override(ERC4626Upgradeable, IERC4626Upgradeable)
- returns (uint256);
-redeem
-reverting function, kept to maintain compatibility with ERC4626 standard
-function redeem(uint256, address, address)
- public
- pure
- override(ERC4626Upgradeable, IERC4626Upgradeable)
- returns (uint256);
-_onlyOperator
-function _onlyOperator() internal view;
-_onlyOperatorOrAsset
-function _onlyOperatorOrAsset() private view;
-_beforeWithdraw
-function _beforeWithdraw(uint256 assets, uint256 shares) internal virtual override;
-_afterDeposit
-function _afterDeposit(uint256 assets, uint256 shares) internal virtual override;
-Rebaser
- -Functions
-unrebase
-Unrebase a value by a given rebase struct.
-function unrebase(uint256 self, IKreskoAsset.Rebase storage _rebase) internal view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
self | uint256 | The value to unrebase. |
_rebase | IKreskoAsset.Rebase | The rebase struct. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | The unrebased value. |
rebase
-Rebase a value by a given rebase struct.
-function rebase(uint256 self, IKreskoAsset.Rebase storage _rebase) internal view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
self | uint256 | The value to rebase. |
_rebase | IKreskoAsset.Rebase | The rebase struct. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | The rebased value. |
Contents
--
-
- Arrays -
- EnumerableSet -
- FixedPointMath -
- Meta -
- PercentageMath -
- Redstone -
- NumericArrayLib -
- RedstoneDefaultsLib -
- BitmapLib -
- SignatureLib -
- RedstoneError -
- Solady -
- Strings -
- Conversions -
- Deploys -
- Proxies -
- WadRay -
Arrays
- -Functions
-empty
-function empty(address[2] memory _addresses) internal pure returns (bool);
-empty
-function empty(Enums.OracleType[2] memory _oracles) internal pure returns (bool);
-find
-function find(address[] storage _elements, address _elementToFind) internal pure returns (FindResult memory result);
-find
-function find(bytes32[] storage _elements, bytes32 _elementToFind) internal pure returns (FindResult memory result);
-find
-function find(string[] storage _elements, string memory _elementToFind)
- internal
- pure
- returns (FindResult memory result);
-pushUnique
-function pushUnique(address[] storage _elements, address _elementToAdd) internal;
-pushUnique
-function pushUnique(bytes32[] storage _elements, bytes32 _elementToAdd) internal;
-pushUnique
-function pushUnique(string[] storage _elements, string memory _elementToAdd) internal;
-removeExisting
-function removeExisting(address[] storage _addresses, address _elementToRemove) internal;
-removeAddress
-Removes an element by copying the last element to the element to remove's place and removing -the last element.
-function removeAddress(address[] storage _addresses, address _elementToRemove, uint256 _elementIndex) internal;
-Parameters
-| Name | Type | Description |
|---|---|---|
_addresses | address[] | The address array containing the item to be removed. |
_elementToRemove | address | The element to be removed. |
_elementIndex | uint256 | The index of the element to be removed. |
Structs
-FindResult
-struct FindResult {
- uint256 index;
- bool exists;
-}
-EnumerableSet
- -*Library for managing -https://en.wikipedia.org/wiki/Set_(abstract_data_type)[sets] of primitive -types. -Sets have the following properties:
--
-
- Elements are added, removed, and checked for existence in constant time -(O(1)). -
- Elements are enumerated in O(n). No guarantees are made on the ordering. -
contract Example {
-// Add the library methods
-using EnumerableSet for EnumerableSet.AddressSet;
-// Declare a set state variable
-EnumerableSet.AddressSet private mySet;
-}
-As of v3.3.0, sets of type bytes32 (Bytes32Set), address (AddressSet)
-and uint256 (UintSet) are supported.*
Functions
-_add
-Add a value to a set. O(1). -Returns true if the value was added to the set, that is if it was not -already present.
-function _add(Set storage set, bytes32 value) private returns (bool);
-_remove
-Removes a value from a set. O(1). -Returns true if the value was removed from the set, that is if it was -present.
-function _remove(Set storage set, bytes32 value) private returns (bool);
-_contains
-Returns true if the value is in the set. O(1).
-function _contains(Set storage set, bytes32 value) private view returns (bool);
-_length
-Returns the number of values on the set. O(1).
-function _length(Set storage set) private view returns (uint256);
-_at
-*Returns the value stored at position index in the set. O(1).
-Note that there are no guarantees on the ordering of values inside the
-array, and it may change when more values are added or removed.
-Requirements:
-
-
indexmust be strictly less than {length}.*
-
function _at(Set storage set, uint256 index) private view returns (bytes32);
-_values
-Return the entire set in an array -WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed -to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that -this function has an unbounded cost, and using it as part of a state-changing function may render the function -uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
-function _values(Set storage set) private view returns (bytes32[] memory);
-add
-Add a value to a set. O(1). -Returns true if the value was added to the set, that is if it was not -already present.
-function add(Bytes32Set storage set, bytes32 value) internal returns (bool);
-remove
-Removes a value from a set. O(1). -Returns true if the value was removed from the set, that is if it was -present.
-function remove(Bytes32Set storage set, bytes32 value) internal returns (bool);
-contains
-Returns true if the value is in the set. O(1).
-function contains(Bytes32Set storage set, bytes32 value) internal view returns (bool);
-length
-Returns the number of values in the set. O(1).
-function length(Bytes32Set storage set) internal view returns (uint256);
-at
-*Returns the value stored at position index in the set. O(1).
-Note that there are no guarantees on the ordering of values inside the
-array, and it may change when more values are added or removed.
-Requirements:
-
-
indexmust be strictly less than {length}.*
-
function at(Bytes32Set storage set, uint256 index) internal view returns (bytes32);
-values
-Return the entire set in an array -WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed -to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that -this function has an unbounded cost, and using it as part of a state-changing function may render the function -uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
-function values(Bytes32Set storage set) internal view returns (bytes32[] memory);
-add
-Add a value to a set. O(1). -Returns true if the value was added to the set, that is if it was not -already present.
-function add(AddressSet storage set, address value) internal returns (bool);
-remove
-Removes a value from a set. O(1). -Returns true if the value was removed from the set, that is if it was -present.
-function remove(AddressSet storage set, address value) internal returns (bool);
-contains
-Returns true if the value is in the set. O(1).
-function contains(AddressSet storage set, address value) internal view returns (bool);
-length
-Returns the number of values in the set. O(1).
-function length(AddressSet storage set) internal view returns (uint256);
-at
-*Returns the value stored at position index in the set. O(1).
-Note that there are no guarantees on the ordering of values inside the
-array, and it may change when more values are added or removed.
-Requirements:
-
-
indexmust be strictly less than {length}.*
-
function at(AddressSet storage set, uint256 index) internal view returns (address);
-values
-Return the entire set in an array -WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed -to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that -this function has an unbounded cost, and using it as part of a state-changing function may render the function -uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
-function values(AddressSet storage set) internal view returns (address[] memory);
-add
-Add a value to a set. O(1). -Returns true if the value was added to the set, that is if it was not -already present.
-function add(UintSet storage set, uint256 value) internal returns (bool);
-remove
-Removes a value from a set. O(1). -Returns true if the value was removed from the set, that is if it was -present.
-function remove(UintSet storage set, uint256 value) internal returns (bool);
-contains
-Returns true if the value is in the set. O(1).
-function contains(UintSet storage set, uint256 value) internal view returns (bool);
-length
-Returns the number of values on the set. O(1).
-function length(UintSet storage set) internal view returns (uint256);
-at
-*Returns the value stored at position index in the set. O(1).
-Note that there are no guarantees on the ordering of values inside the
-array, and it may change when more values are added or removed.
-Requirements:
-
-
indexmust be strictly less than {length}.*
-
function at(UintSet storage set, uint256 index) internal view returns (uint256);
-values
-Return the entire set in an array -WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed -to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that -this function has an unbounded cost, and using it as part of a state-changing function may render the function -uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
-function values(UintSet storage set) internal view returns (uint256[] memory);
-Structs
-Set
-struct Set {
- bytes32[] _values;
- mapping(bytes32 => uint256) _indexes;
-}
-Bytes32Set
-struct Bytes32Set {
- Set _inner;
-}
-AddressSet
-struct AddressSet {
- Set _inner;
-}
-UintSet
-struct UintSet {
- Set _inner;
-}
-FixedPointMath
- -Authors: -Solmate (https://github.com/transmissions11/solmate/blob/main/src/utils/FixedPointMathLib.sol), Inspired by USM (https://github.com/usmfum/USM/blob/master/contracts/WadMath.sol)
-Arithmetic library with operations for fixed-point numbers.
-State Variables
-MAX_UINT256
-uint256 internal constant MAX_UINT256 = 2 ** 256 - 1;
-WAD
-uint256 internal constant WAD = 1e18;
-Functions
-mulWadDown
-function mulWadDown(uint256 x, uint256 y) internal pure returns (uint256);
-mulWadUp
-function mulWadUp(uint256 x, uint256 y) internal pure returns (uint256);
-divWadDown
-function divWadDown(uint256 x, uint256 y) internal pure returns (uint256);
-divWadUp
-function divWadUp(uint256 x, uint256 y) internal pure returns (uint256);
-mulDivDown
-function mulDivDown(uint256 x, uint256 y, uint256 denominator) internal pure returns (uint256 z);
-mulDivUp
-function mulDivUp(uint256 x, uint256 y, uint256 denominator) internal pure returns (uint256 z);
-rpow
-function rpow(uint256 x, uint256 n, uint256 scalar) internal pure returns (uint256 z);
-sqrt
-function sqrt(uint256 x) internal pure returns (uint256 z);
-unsafeMod
-function unsafeMod(uint256 x, uint256 y) internal pure returns (uint256 z);
-unsafeDiv
-function unsafeDiv(uint256 x, uint256 y) internal pure returns (uint256 r);
-unsafeDivUp
-function unsafeDivUp(uint256 x, uint256 y) internal pure returns (uint256 z);
-Meta
- -State Variables
-EIP712_DOMAIN_TYPEHASH
-bytes32 internal constant EIP712_DOMAIN_TYPEHASH =
- keccak256(bytes("EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)"));
-Functions
-domainSeparator
-function domainSeparator(string memory name, string memory version) internal view returns (bytes32 domainSeparator_);
-getChainID
-function getChainID() internal view returns (uint256 id);
-msgSender
-function msgSender() internal view returns (address sender_);
-enforceHasContractCode
-function enforceHasContractCode(address _contract) internal view;
-PercentageMath
- -Author: -Aave
-Provides functions to perform percentage calculations
-PercentageMath are defined by default with 2 decimals of precision (100.00). -The precision is indicated by PERCENTAGE_FACTOR
-Operations are rounded. If a value is >=.5, will be rounded up, otherwise rounded down.
-State Variables
-PERCENTAGE_FACTOR
-uint256 internal constant PERCENTAGE_FACTOR = 1e4;
-HALF_PERCENTAGE_FACTOR
-uint256 internal constant HALF_PERCENTAGE_FACTOR = 0.5e4;
-Functions
-percentMul
-Executes a percentage multiplication
-assembly optimized for improved gas savings: https://twitter.com/transmissions11/status/1451131036377571328
-function percentMul(uint256 value, uint256 percentage) internal pure returns (uint256 result);
-Parameters
-| Name | Type | Description |
|---|---|---|
value | uint256 | The value of which the percentage needs to be calculated |
percentage | uint256 | The percentage of the value to be calculated |
Returns
-| Name | Type | Description |
|---|---|---|
result | uint256 | value percentmul percentage |
percentDiv
-Executes a percentage division
-assembly optimized for improved gas savings: https://twitter.com/transmissions11/status/1451131036377571328
-function percentDiv(uint256 value, uint256 percentage) internal pure returns (uint256 result);
-Parameters
-| Name | Type | Description |
|---|---|---|
value | uint256 | The value of which the percentage needs to be calculated |
percentage | uint256 | The percentage of the value to be calculated |
Returns
-| Name | Type | Description |
|---|---|---|
result | uint256 | value percentdiv percentage |
Redstone
- -State Variables
-STANDARD_SLOT_BS
-uint256 internal constant STANDARD_SLOT_BS = 32;
-FREE_MEMORY_PTR
-uint256 internal constant FREE_MEMORY_PTR = 0x40;
-BYTES_ARR_LEN_VAR_BS
-uint256 internal constant BYTES_ARR_LEN_VAR_BS = 32;
-FUNCTION_SIGNATURE_BS
-uint256 internal constant FUNCTION_SIGNATURE_BS = 4;
-REVERT_MSG_OFFSET
-uint256 internal constant REVERT_MSG_OFFSET = 68;
-STRING_ERR_MESSAGE_MASK
-uint256 internal constant STRING_ERR_MESSAGE_MASK = 0x08c379a000000000000000000000000000000000000000000000000000000000;
-SIG_BS
-uint256 internal constant SIG_BS = 65;
-TIMESTAMP_BS
-uint256 internal constant TIMESTAMP_BS = 6;
-DATA_PACKAGES_COUNT_BS
-uint256 internal constant DATA_PACKAGES_COUNT_BS = 2;
-DATA_POINTS_COUNT_BS
-uint256 internal constant DATA_POINTS_COUNT_BS = 3;
-DATA_POINT_VALUE_BYTE_SIZE_BS
-uint256 internal constant DATA_POINT_VALUE_BYTE_SIZE_BS = 4;
-DATA_POINT_SYMBOL_BS
-uint256 internal constant DATA_POINT_SYMBOL_BS = 32;
-DEFAULT_DATA_POINT_VALUE_BS
-uint256 internal constant DEFAULT_DATA_POINT_VALUE_BS = 32;
-UNSIGNED_METADATA_BYTE_SIZE_BS
-uint256 internal constant UNSIGNED_METADATA_BYTE_SIZE_BS = 3;
-REDSTONE_MARKER_BS
-uint256 internal constant REDSTONE_MARKER_BS = 9;
-REDSTONE_MARKER_MASK
-uint256 internal constant REDSTONE_MARKER_MASK = 0x0000000000000000000000000000000000000000000000000002ed57011e0000;
-TIMESTAMP_NEGATIVE_OFFSET_IN_DATA_PACKAGE_WITH_STANDARD_SLOT_BS
-uint256 internal constant TIMESTAMP_NEGATIVE_OFFSET_IN_DATA_PACKAGE_WITH_STANDARD_SLOT_BS = 104;
-DATA_PACKAGE_WITHOUT_DATA_POINTS_BS
-uint256 internal constant DATA_PACKAGE_WITHOUT_DATA_POINTS_BS = 78;
-DATA_PACKAGE_WITHOUT_DATA_POINTS_AND_SIG_BS
-uint256 internal constant DATA_PACKAGE_WITHOUT_DATA_POINTS_AND_SIG_BS = 13;
-REDSTONE_MARKER_BS_PLUS_STANDARD_SLOT_BS
-uint256 internal constant REDSTONE_MARKER_BS_PLUS_STANDARD_SLOT_BS = 41;
-Functions
-sub
-function sub(uint256 a, uint256 b) internal pure returns (uint256);
-add
-function add(uint256 a, uint256 b) internal pure returns (uint256);
-getPrice
-This function can be used in a consumer contract to securely extract an -oracle value for a given data feed id. Security is achieved by -signatures verification, timestamp validation, and aggregating values -from different authorised signers into a single numeric value. If any of the -required conditions do not match, the function will revert. -Note! This function expects that tx calldata contains redstone payload in the end -Learn more about redstone payload here: https://github.com/redstone-finance/redstone-oracles-monorepo/tree/main/packages/evm-connector#readme
-function getPrice(bytes32 dataFeedId) internal view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
dataFeedId | bytes32 | bytes32 value that uniquely identifies the data feed |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | Extracted and verified numeric oracle value for the given data feed id |
getAuthorisedSignerIndex
-function getAuthorisedSignerIndex(address signerAddress) internal pure returns (uint8);
-getPrices
-This function can be used in a consumer contract to securely extract several -numeric oracle values for a given array of data feed ids. Security is achieved by -signatures verification, timestamp validation, and aggregating values -from different authorised signers into a single numeric value. If any of the -required conditions do not match, the function will revert. -Note! This function expects that tx calldata contains redstone payload in the end -Learn more about redstone payload here: https://github.com/redstone-finance/redstone-oracles-monorepo/tree/main/packages/evm-connector#readme
-function getPrices(bytes32[] memory dataFeedIds) internal view returns (uint256[] memory);
-Parameters
-| Name | Type | Description |
|---|---|---|
dataFeedIds | bytes32[] | An array of unique data feed identifiers |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256[] | An array of the extracted and verified oracle values in the same order as they are requested in the dataFeedIds array |
validateTimestamp
-This function may be overridden by the child consumer contract. -It should validate the timestamp against the current time (block.timestamp) -It should revert with a helpful message if the timestamp is not valid
-function validateTimestamp(uint256 receivedTimestampMilliseconds) internal view;
-Parameters
-| Name | Type | Description |
|---|---|---|
receivedTimestampMilliseconds | uint256 | Timestamp extracted from calldata |
getUniqueSignersThreshold
-This function should be overridden by the child consumer contract.
-function getUniqueSignersThreshold() internal pure returns (uint8);
-Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint8 | The minimum required value of unique authorised signers |
aggregateValues
-This function may be overridden by the child consumer contract. -It should aggregate values from different signers to a single uint value. -By default, it calculates the median value
-function aggregateValues(uint256[] memory values) internal pure returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
values | uint256[] | An array of uint256 values from different signers |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | Result of the aggregation in the form of a single number |
_securelyExtractOracleValuesFromTxMsg
-This is an internal helpful function for secure extraction oracle values
-from the tx calldata. Security is achieved by signatures verification, timestamp
-validation, and aggregating values from different authorised signers into a
-single numeric value. If any of the required conditions (e.g. too old timestamp or
-insufficient number of authorised signers) do not match, the function will revert.
-Note! You should not call this function in a consumer contract. You can use
-getOracleNumericValuesFromTxMsg or getOracleNumericValueFromTxMsg instead.
function _securelyExtractOracleValuesFromTxMsg(bytes32[] memory dataFeedIds) private view returns (uint256[] memory);
-Parameters
-| Name | Type | Description |
|---|---|---|
dataFeedIds | bytes32[] | An array of unique data feed identifiers |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256[] | An array of the extracted and verified oracle values in the same order as they are requested in dataFeedIds array |
_extractDataPackage
-This is a private helpful function, which extracts data for a data package based -on the given negative calldata offset, verifies them, and in the case of successful -verification updates the corresponding data package values in memory
-function _extractDataPackage(
- bytes32[] memory dataFeedIds,
- uint256[] memory uniqueSignerCountForDataFeedIds,
- uint256[] memory signersBitmapForDataFeedIds,
- uint256[][] memory valuesForDataFeeds,
- uint256 calldataNegativeOffset
-) private view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
dataFeedIds | bytes32[] | an array of unique data feed identifiers |
uniqueSignerCountForDataFeedIds | uint256[] | an array with the numbers of unique signers for each data feed |
signersBitmapForDataFeedIds | uint256[] | an array of signer bitmaps for data feeds |
valuesForDataFeeds | uint256[][] | 2-dimensional array, valuesForDataFeeds[i][j] contains j-th value for the i-th data feed |
calldataNegativeOffset | uint256 | negative calldata offset for the given data package |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | An array of the aggregated values |
_getAggregatedValues
-This is a private helpful function, which aggregates values from different -authorised signers for the given arrays of values for each data feed
-function _getAggregatedValues(uint256[][] memory valuesForDataFeeds, uint256[] memory uniqueSignerCountForDataFeedIds)
- private
- pure
- returns (uint256[] memory);
-Parameters
-| Name | Type | Description |
|---|---|---|
valuesForDataFeeds | uint256[][] | 2-dimensional array, valuesForDataFeeds[i][j] contains j-th value for the i-th data feed |
uniqueSignerCountForDataFeedIds | uint256[] | an array with the numbers of unique signers for each data feed |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256[] | An array of the aggregated values |
_extractDataPointsDetailsForDataPackage
-function _extractDataPointsDetailsForDataPackage(uint256 calldataNegativeOffsetForDataPackage)
- private
- pure
- returns (uint256 dataPointsCount, uint256 eachDataPointValueByteSize);
-_extractByteSizeOfUnsignedMetadata
-function _extractByteSizeOfUnsignedMetadata() private pure returns (uint256);
-_extractDataPackagesCountFromCalldata
-function _extractDataPackagesCountFromCalldata(uint256 calldataNegativeOffset)
- private
- pure
- returns (uint16 dataPackagesCount);
-_extractDataPointValueAndDataFeedId
-function _extractDataPointValueAndDataFeedId(
- uint256 calldataNegativeOffsetForDataPackage,
- uint256 defaultDataPointValueByteSize,
- uint256 dataPointIndex
-) private pure returns (bytes32 dataPointDataFeedId, uint256 dataPointValue);
-proxyCalldata
-function proxyCalldata(address contractAddress, bytes memory encodedFunction, bool forwardValue)
- internal
- returns (bytes memory);
-proxyDelegateCalldata
-function proxyDelegateCalldata(address contractAddress, bytes memory encodedFunction) internal returns (bytes memory);
-proxyCalldataView
-function proxyCalldataView(address contractAddress, bytes memory encodedFunction)
- internal
- view
- returns (bytes memory);
-_prepareMessage
-function _prepareMessage(bytes memory encodedFunction) private pure returns (bytes memory);
-_getRedstonePayloadByteSize
-function _getRedstonePayloadByteSize() private pure returns (uint256);
-_getDataPackageByteSize
-function _getDataPackageByteSize(uint256 calldataNegativeOffset) private pure returns (uint256);
-_prepareReturnValue
-function _prepareReturnValue(bool success, bytes memory result) internal pure returns (bytes memory);
-NumericArrayLib
- -State Variables
-BYTES_ARR_LEN_VAR_BS
-uint256 internal constant BYTES_ARR_LEN_VAR_BS = 32;
-UINT256_VALUE_BS
-uint256 internal constant UINT256_VALUE_BS = 32;
-Functions
-pickMedian
-function pickMedian(uint256[] memory arr) internal pure returns (uint256);
-sort
-function sort(uint256[] memory arr) internal pure;
-Errors
-CanNotPickMedianOfEmptyArray
-error CanNotPickMedianOfEmptyArray();
-RedstoneDefaultsLib
- -Author: -The Redstone Oracles team
-State Variables
-DEFAULT_MAX_DATA_TIMESTAMP_DELAY_SECONDS
-uint256 internal constant DEFAULT_MAX_DATA_TIMESTAMP_DELAY_SECONDS = 3 minutes;
-DEFAULT_MAX_DATA_TIMESTAMP_AHEAD_SECONDS
-uint256 internal constant DEFAULT_MAX_DATA_TIMESTAMP_AHEAD_SECONDS = 1 minutes;
-Functions
-validateTimestamp
-function validateTimestamp(uint256 receivedTimestampMilliseconds) internal view;
-aggregateValues
-function aggregateValues(uint256[] memory values) internal pure returns (uint256);
-Errors
-TimestampFromTooLongFuture
-error TimestampFromTooLongFuture(uint256 receivedTimestampSeconds, uint256 blockTimestamp);
-TimestampIsTooOld
-error TimestampIsTooOld(uint256 receivedTimestampSeconds, uint256 blockTimestamp);
-BitmapLib
- -Functions
-setBitInBitmap
-function setBitInBitmap(uint256 bitmap, uint256 bitIndex) internal pure returns (uint256);
-getBitFromBitmap
-function getBitFromBitmap(uint256 bitmap, uint256 bitIndex) internal pure returns (bool);
-SignatureLib
- -State Variables
-ECDSA_SIG_R_BS
-uint256 internal constant ECDSA_SIG_R_BS = 32;
-ECDSA_SIG_S_BS
-uint256 internal constant ECDSA_SIG_S_BS = 32;
-Functions
-recoverSignerAddress
-function recoverSignerAddress(bytes32 signedHash, uint256 signatureCalldataNegativeOffset)
- internal
- pure
- returns (address);
-RedstoneError
- -Author: -The Redstone Oracles team
-It mainly contains redstone-related values, which improve readability -of other contracts (e.g. CalldataExtractor and RedstoneConsumerBase)
-Errors
-ProxyCalldataFailedWithoutErrMsg2
-error ProxyCalldataFailedWithoutErrMsg2();
-ProxyCalldataFailedWithoutErrMsg
-error ProxyCalldataFailedWithoutErrMsg();
-CalldataOverOrUnderFlow
-error CalldataOverOrUnderFlow();
-ProxyCalldataFailedWithCustomError
-error ProxyCalldataFailedWithCustomError(bytes result);
-IncorrectUnsignedMetadataSize
-error IncorrectUnsignedMetadataSize();
-ProxyCalldataFailedWithStringMessage
-error ProxyCalldataFailedWithStringMessage(string);
-InsufficientNumberOfUniqueSigners
-error InsufficientNumberOfUniqueSigners(uint256 receivedSignersCount, uint256 requiredSignersCount);
-EachSignerMustProvideTheSameValue
-error EachSignerMustProvideTheSameValue();
-EmptyCalldataPointersArr
-error EmptyCalldataPointersArr();
-InvalidCalldataPointer
-error InvalidCalldataPointer();
-CalldataMustHaveValidPayload
-error CalldataMustHaveValidPayload();
-SignerNotAuthorised
-error SignerNotAuthorised(address receivedSigner);
-Solady
- -Author: -Solady https://github.com/Vectorized/solady
-State Variables
-_PROXY_BYTECODE
--------------------------------------------------------------------+ -Opcode | Mnemonic | Stack | Memory | --------------------------------------------------------------------| -36 | CALLDATASIZE | cds | | -3d | RETURNDATASIZE | 0 cds | | -3d | RETURNDATASIZE | 0 0 cds | | -37 | CALLDATACOPY | | [0..cds): calldata | -36 | CALLDATASIZE | cds | [0..cds): calldata | -3d | RETURNDATASIZE | 0 cds | [0..cds): calldata | -34 | CALLVALUE | value 0 cds | [0..cds): calldata | -f0 | CREATE | newContract | [0..cds): calldata | --------------------------------------------------------------------| -Opcode | Mnemonic | Stack | Memory | --------------------------------------------------------------------| -67 bytecode | PUSH8 bytecode | bytecode | | -3d | RETURNDATASIZE | 0 bytecode | | -52 | MSTORE | | [0..8): bytecode | -60 0x08 | PUSH1 0x08 | 0x08 | [0..8): bytecode | -60 0x18 | PUSH1 0x18 | 0x18 0x08 | [0..8): bytecode | -f3 | RETURN | | [0..8): bytecode | --------------------------------------------------------------------+
-The proxy bytecode.
-uint256 private constant _PROXY_BYTECODE = 0x67363d3d37363d34f03d5260086018f3;
-_PROXY_BYTECODE_HASH
-Hash of the _PROXY_BYTECODE.
-Equivalent to keccak256(abi.encodePacked(hex"67363d3d37363d34f03d5260086018f3")).
bytes32 private constant _PROXY_BYTECODE_HASH = 0x21c35dbe1b344a2488cf3321d6ce542f8e9f305544ff09e4993a62319a497c1f;
-Functions
-create3
-Deploy to deterministic addresses without an initcode factor. -Modified from Solmate (https://github.com/transmissions11/solmate/blob/main/src/utils/CREATE3.sol) -Modified from 0xSequence (https://github.com/0xSequence/create3/blob/master/contracts/Create3.sol)
-Deploys creationCode deterministically with a salt.
-The deployed contract is funded with value (in wei) ETH.
-Returns the deterministic address of the deployed contract,
-which solely depends on salt.
function create3(bytes32 salt, bytes memory creationCode, uint256 value) internal returns (address deployed);
-peek3
-Returns the deterministic address for salt.
function peek3(bytes32 salt) internal view returns (address deployed);
-multicall
-Enables a single call to call multiple methods on itself. -Solady (https://github.com/vectorized/solady/blob/main/src/utils/Multicallable.sol) -Modified from Solmate (https://github.com/transmissions11/solmate/blob/main/src/utils/Multicallable.sol)
-Apply DELEGATECALL with the current contract to each calldata in data,
-and store the abi.encode formatted results of each DELEGATECALL into results.
-If any of the DELEGATECALLs reverts, the entire context is reverted,
-and the error is bubbled up.
-For payable, see: https://www.paradigm.xyz/2021/08/two-rights-might-make-a-wrong)
-For efficiency, this function will directly return the results, terminating the context.
-If called internally, it must be called at the end of a function
-that returns (bytes[] memory).
function multicall(bytes[] calldata data) internal returns (bytes[] memory);
-Errors
-DeploymentFailed
-Unable to deploy the contract.
-error DeploymentFailed();
-InitializationFailed
-Unable to initialize the contract.
-error InitializationFailed();
-Strings
- -String operations.
-State Variables
-_HEX_SYMBOLS
-bytes16 private constant _HEX_SYMBOLS = "0123456789abcdef";
-Functions
-toString
-function toString(bytes32 value) internal pure returns (string memory);
-toString
-Converts a uint256 to its ASCII string decimal representation.
function toString(uint256 value) internal pure returns (string memory);
-toHexString
-Converts a uint256 to its ASCII string hexadecimal representation.
function toHexString(uint256 value) internal pure returns (string memory);
-toHexString
-Converts a uint256 to its ASCII string hexadecimal representation with fixed length.
function toHexString(uint256 value, uint256 length) internal pure returns (string memory);
-Conversions
- -Functions
-toAddress
-function toAddress(bytes32 b) internal pure returns (address);
-toBytes32
-function toBytes32(address a) internal pure returns (bytes32);
-toAddr
-function toAddr(bytes memory b) internal pure returns (address);
-toDeployment
-function toDeployment(bytes memory b) internal pure returns (Deployment memory);
-toAsset
-function toAsset(bytes memory b) internal pure returns (Asset memory);
-toArray
-function toArray(bytes memory value) internal pure returns (bytes[] memory result);
-add
-function add(bytes32 a, uint256 b) internal pure returns (bytes32);
-sub
-function sub(bytes32 a, uint256 b) internal pure returns (bytes32);
-map
-function map(bytes[] memory rawData, function(bytes memory) pure returns (address) dataHandler)
- internal
- pure
- returns (address[] memory result);
-map
-function map(bytes[] memory rawData, function(bytes memory) pure returns (Deployment memory) dataHandler)
- internal
- pure
- returns (Deployment[] memory result);
-Deploys
- -Functions
-create
-function create(bytes memory creationCode, uint256 value) internal returns (address location);
-create2
-function create2(bytes32 salt, bytes memory creationCode, uint256 value) internal returns (address location);
-create3
-function create3(bytes32 salt, bytes memory creationCode, uint256 value) internal returns (address location);
-create
-function create(bytes memory creationCode) internal returns (address location);
-create2
-function create2(bytes32 salt, bytes memory creationCode) internal returns (address location);
-create3
-function create3(bytes32 salt, bytes memory creationCode) internal returns (address location);
-peek2
-function peek2(bytes32 salt, address _c2caller, bytes memory creationCode) internal pure returns (address);
-peek3
-function peek3(bytes32 salt) internal view returns (address);
-Proxies
- -Functions
-proxyInitCode
-function proxyInitCode(address implementation, address _factory, bytes memory _calldata)
- internal
- pure
- returns (bytes memory);
-proxyInitCode
-function proxyInitCode(address implementation, bytes memory _calldata) internal view returns (bytes memory);
-proxyInitCodeHash
-function proxyInitCodeHash(address implementation, address _factory, bytes memory _calldata)
- internal
- pure
- returns (bytes32);
-proxyInitCodeHash
-function proxyInitCodeHash(address implementation, bytes memory _calldata) internal view returns (bytes32);
-asInterface
-function asInterface(address proxy) internal pure returns (ITransparentUpgradeableProxy);
-WadRay
- -Author: -Aave
-Provides functions to perform calculations with Wad and Ray units
-Provides mul and div function for wads (decimal numbers with 18 digits of precision) and rays (decimal numbers -with 27 digits of precision)
-Operations are rounded. If a value is >=.5, will be rounded up, otherwise rounded down.
-State Variables
-WAD
-uint256 internal constant WAD = 1e18;
-HALF_WAD
-uint256 internal constant HALF_WAD = 0.5e18;
-RAY
-uint256 internal constant RAY = 1e27;
-HALF_RAY
-uint256 internal constant HALF_RAY = 0.5e27;
-WAD_RAY_RATIO
-uint256 internal constant WAD_RAY_RATIO = 1e9;
-Functions
-wadMul
-Multiplies two wad, rounding half up to the nearest wad
-assembly optimized for improved gas savings: https://twitter.com/transmissions11/status/1451131036377571328
-function wadMul(uint256 a, uint256 b) internal pure returns (uint256 c);
-Parameters
-| Name | Type | Description |
|---|---|---|
a | uint256 | Wad |
b | uint256 | Wad |
Returns
-| Name | Type | Description |
|---|---|---|
c | uint256 | = a*b, in wad |
wadDiv
-Divides two wad, rounding half up to the nearest wad
-assembly optimized for improved gas savings: https://twitter.com/transmissions11/status/1451131036377571328
-function wadDiv(uint256 a, uint256 b) internal pure returns (uint256 c);
-Parameters
-| Name | Type | Description |
|---|---|---|
a | uint256 | Wad |
b | uint256 | Wad |
Returns
-| Name | Type | Description |
|---|---|---|
c | uint256 | = a/b, in wad |
rayMul
-Multiplies two ray, rounding half up to the nearest ray
-assembly optimized for improved gas savings: https://twitter.com/transmissions11/status/1451131036377571328
-function rayMul(uint256 a, uint256 b) internal pure returns (uint256 c);
-Parameters
-| Name | Type | Description |
|---|---|---|
a | uint256 | Ray |
b | uint256 | Ray |
Returns
-| Name | Type | Description |
|---|---|---|
c | uint256 | = a raymul b |
rayDiv
-Divides two ray, rounding half up to the nearest ray
-assembly optimized for improved gas savings: https://twitter.com/transmissions11/status/1451131036377571328
-function rayDiv(uint256 a, uint256 b) internal pure returns (uint256 c);
-Parameters
-| Name | Type | Description |
|---|---|---|
a | uint256 | Ray |
b | uint256 | Ray |
Returns
-| Name | Type | Description |
|---|---|---|
c | uint256 | = a raydiv b |
rayToWad
-Casts ray down to wad
-assembly optimized for improved gas savings: https://twitter.com/transmissions11/status/1451131036377571328
-function rayToWad(uint256 a) internal pure returns (uint256 b);
-Parameters
-| Name | Type | Description |
|---|---|---|
a | uint256 | Ray |
Returns
-| Name | Type | Description |
|---|---|---|
b | uint256 | = a converted to wad, rounded half up to the nearest wad |
wadToRay
-Converts wad up to ray
-assembly optimized for improved gas savings: https://twitter.com/transmissions11/status/1451131036377571328
-function wadToRay(uint256 a) internal pure returns (uint256 b);
-Parameters
-| Name | Type | Description |
|---|---|---|
a | uint256 | Wad |
Returns
-| Name | Type | Description |
|---|---|---|
b | uint256 | = a converted in ray |
Contents
--
-
- facets -
- funcs -
- interfaces -
- IEventFieldProvider -
- MEvent -
- MinterState -
- ms -
- MState constants -
- LiquidateExecution -
- LiquidationArgs -
- MinterAccountState -
- MinterInitArgs -
- MinterParams -
Contents
--
-
- MinterAccountStateFacet -
- accountTotalDebtValues -
- accountTotalCollateralValues -
- MinterBurnFacet -
- MinterConfigurationFacet -
- MinterDepositWithdrawFacet -
- MinterLiquidationFacet -
- MinterMintFacet -
- MinterStateFacet -
MinterAccountStateFacet
- -Inherits: -IMinterAccountStateFacet
-Author: -Kresko
-Views concerning account state
-Functions
-getAccountLiquidatable
-Calculates if an account's current collateral value is under its minimum collateral value
-function getAccountLiquidatable(address _account) external view returns (bool);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | The account to check. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | bool | bool Indicates if the account can be liquidated. |
getAccountState
-Get accounts state in the Minter.
-function getAccountState(address _account) external view returns (MinterAccountState memory);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | Account address to get the state for. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | MinterAccountState | MinterAccountState Total debt value, total collateral value and collateral ratio. |
getAccountMintIndex
-Gets an index for the Kresko asset the account has minted.
-function getAccountMintIndex(address _account, address _krAsset) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | The account to get the minted Kresko assets for. |
_krAsset | address | The asset lookup address. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | index The index of asset in the minted assets array. |
getAccountMintedAssets
-Gets an array of Kresko assets the account has minted.
-function getAccountMintedAssets(address _account) external view returns (address[] memory);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | The account to get the minted Kresko assets for. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | address[] | address[] Array of Kresko Asset addresses the account has minted. |
getAccountTotalDebtValues
-Gets the total Kresko asset debt value in USD for an account.
-function getAccountTotalDebtValues(address _account) external view returns (uint256 value, uint256 valueAdjusted);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | Account to calculate the Kresko asset value for. |
Returns
-| Name | Type | Description |
|---|---|---|
value | uint256 | The unadjusted value of debt. |
valueAdjusted | uint256 | The kFactor adjusted value of debt. |
getAccountTotalDebtValue
-Gets the total Kresko asset debt value in USD for an account.
-function getAccountTotalDebtValue(address _account) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | The account to calculate the Kresko asset value for. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 Total debt value of _account. |
getAccountDebtAmount
-Get _account debt amount for _asset
function getAccountDebtAmount(address _account, address _assetAddr) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | The account to query amount for |
_assetAddr | address | The asset address |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 Amount of debt for _assetAddr |
getAccountCollateralAssets
-Gets an array of collateral assets the account has deposited.
-function getAccountCollateralAssets(address _account) external view returns (address[] memory);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | The account to get the deposited collateral assets for. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | address[] | address[] Array of collateral asset addresses the account has deposited. |
getAccountCollateralAmount
-Get _account collateral deposit amount for _assetAddr
function getAccountCollateralAmount(address _account, address _assetAddr) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | The account to query amount for |
_assetAddr | address | The asset address |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 Amount of collateral deposited for _assetAddr |
getAccountDepositIndex
-Gets an index for the collateral asset the account has deposited.
-function getAccountDepositIndex(address _account, address _collateralAsset) external view returns (uint256 i);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | Account to get the index for. |
_collateralAsset | address | Asset address. |
Returns
-| Name | Type | Description |
|---|---|---|
i | uint256 | Index of the minted collateral asset. |
getAccountTotalCollateralValue
-Gets the adjusted collateral value of a particular account.
-function getAccountTotalCollateralValue(address _account) public view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | Account to calculate the collateral value for. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | valueAdjusted Collateral value of a particular account. |
getAccountTotalCollateralValues
-Gets the adjusted and unadjusted collateral value of _account.
function getAccountTotalCollateralValues(address _account) public view returns (uint256 value, uint256 valueAdjusted);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | Account to get the values for |
Returns
-| Name | Type | Description |
|---|---|---|
value | uint256 | Unadjusted total value of the collateral deposits. |
valueAdjusted | uint256 | cFactor adjusted total value of the collateral deposits. |
getAccountCollateralValues
-Get the unadjusted and the adjusted value of collateral deposits of _assetAddr for _account.
function getAccountCollateralValues(address _account, address _assetAddr)
- external
- view
- returns (uint256 value, uint256 adjustedValue, uint256 price);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | Account to get the collateral values for. |
_assetAddr | address | Asset to get the collateral values for. |
Returns
-| Name | Type | Description |
|---|---|---|
value | uint256 | Unadjusted value of the collateral deposits. |
adjustedValue | uint256 | valueAdjusted cFactor adjusted value of the collateral deposits. |
price | uint256 | Price for the collateral asset |
getAccountMinCollateralAtRatio
-Get an account's minimum collateral value required -to back a Kresko asset amount at a given collateralization ratio.
-Accounts that have their collateral value under the minimum collateral value are considered unhealthy, -accounts with their collateral value under the liquidation threshold are considered liquidatable.
-function getAccountMinCollateralAtRatio(address _account, uint32 _ratio) public view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | Account to calculate the minimum collateral value for. |
_ratio | uint32 | Collateralization ratio required: higher ratio = more collateral required |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 Minimum collateral value of a particular account. |
getAccountCollateralRatio
-Get a list of accounts and their collateral ratios
-function getAccountCollateralRatio(address _account) public view returns (uint256 ratio);
-Returns
-| Name | Type | Description |
|---|---|---|
ratio | uint256 | The collateral ratio of _account |
getAccountCollateralRatios
-Get a list of account collateral ratios
-function getAccountCollateralRatios(address[] calldata _accounts) external view returns (uint256[] memory);
-Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256[] | ratios Collateral ratios of the _accounts |
previewFee
-Calculates the expected fee to be taken from a user's deposited collateral assets, -by imitating calcFee without modifying state.
-function previewFee(address _account, address _krAsset, uint256 _kreskoAssetAmount, Enums.MinterFee _feeType)
- external
- view
- returns (address[] memory, uint256[] memory);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | Account to charge the open fee from. |
_krAsset | address | Address of the kresko asset being burned. |
_kreskoAssetAmount | uint256 | Amount of the kresko asset being minted. |
_feeType | Enums.MinterFee | Fee type (open or close). |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | address[] | assets Collateral types as an array of addresses. |
<none> | uint256[] | amounts Collateral amounts as an array of uint256. |
accountTotalDebtValues
- -Gets the total debt value in USD for an account.
-function accountTotalDebtValues(address _account) view returns (uint256 value, uint256 valueAdjusted);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | Account to calculate the KreskoAsset value for. |
Returns
-| Name | Type | Description |
|---|---|---|
value | uint256 | Total kresko asset debt value |
valueAdjusted | uint256 | Total adjusted kresko asset debt value |
accountTotalCollateralValues
- -Gets the collateral value of a particular account.
-function accountTotalCollateralValues(address _account) view returns (uint256 value, uint256 valueAdjusted);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | The account to calculate the collateral value for. |
Returns
-| Name | Type | Description |
|---|---|---|
value | uint256 | Total collateral value |
valueAdjusted | uint256 | Total adjusted collateral value |
MinterBurnFacet
- -Inherits: -Modifiers, IMinterBurnFacet
-Author: -Kresko
-Core burning functionality for Kresko Minter.
-Functions
-burnKreskoAsset
-Burns existing Kresko assets.
-function burnKreskoAsset(address _account, address _krAsset, uint256 _burnAmount, uint256 _mintedKreskoAssetIndex)
- external
- nonReentrant
- onlyRoleIf(_account != msg.sender, Role.MANAGER);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | The address to burn kresko assets for |
_krAsset | address | The address of the Kresko asset. |
_burnAmount | uint256 | The amount of the Kresko asset to be burned. |
_mintedKreskoAssetIndex | uint256 | The index of the kresko asset in the user's minted assets array. Only needed if burning all principal debt of a particular collateral asset. |
MinterConfigurationFacet
- -Inherits: -DSModifiers, Modifiers, IMinterConfigurationFacet
-Author: -Kresko
-Functionality for Role.ADMIN level actions.
Can be only initialized by the deployer/owner.
-Functions
-initializeMinter
-function initializeMinter(MinterInitArgs calldata args) external initializer(3) initializeAsAdmin;
-setMinCollateralRatioMinter
-Updates the contract's collateralization ratio.
-function setMinCollateralRatioMinter(uint32 _newMinCollateralRatio) public override onlyRole(Role.ADMIN);
-Parameters
-| Name | Type | Description |
|---|---|---|
_newMinCollateralRatio | uint32 | The new minimum collateralization ratio as wad. |
setLiquidationThresholdMinter
-Updates the contract's liquidation threshold value
-function setLiquidationThresholdMinter(uint32 _newLT) public override onlyRole(Role.ADMIN);
-Parameters
-| Name | Type | Description |
|---|---|---|
_newLT | uint32 |
setMaxLiquidationRatioMinter
-Updates the max liquidation ratior value.
-function setMaxLiquidationRatioMinter(uint32 _newMaxLiquidationRatio) public onlyRole(Role.ADMIN);
-Parameters
-| Name | Type | Description |
|---|---|---|
_newMaxLiquidationRatio | uint32 | Percent value in wad precision. |
setCollateralLiquidationIncentiveMinter
-Updates the liquidation incentive multiplier.
-function setCollateralLiquidationIncentiveMinter(address _collateralAsset, uint16 _newLiqIncentive)
- public
- onlyRole(Role.ADMIN);
-Parameters
-| Name | Type | Description |
|---|---|---|
_collateralAsset | address | The collateral asset to update. |
_newLiqIncentive | uint16 |
MinterDepositWithdrawFacet
- -Inherits: -Modifiers, IMinterDepositWithdrawFacet
-Author: -Kresko
-Core collateral deposit and withdrawal functionality for Kresko Minter.
-Functions
-depositCollateral
-Deposits collateral into the protocol.
-function depositCollateral(address _account, address _collateralAsset, uint256 _depositAmount)
- external
- nonReentrant
- gate;
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | The user to deposit collateral for. |
_collateralAsset | address | The address of the collateral asset. |
_depositAmount | uint256 | The amount of the collateral asset to deposit. |
withdrawCollateral
-Withdraws sender's collateral from the protocol.
-Requires that the post-withdrawal collateral value does not violate minimum collateral requirement.
-function withdrawCollateral(
- address _account,
- address _collateralAsset,
- uint256 _withdrawAmount,
- uint256 _collateralIndex
-) external nonReentrant onlyRoleIf(_account != msg.sender, Role.MANAGER);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | The address to withdraw assets for. |
_collateralAsset | address | The address of the collateral asset. |
_withdrawAmount | uint256 | The amount of the collateral asset to withdraw. |
_collateralIndex | uint256 | The index of the collateral asset in the sender's deposited collateral assets array. Only needed if withdrawing the entire deposit of a particular collateral asset. |
withdrawCollateralUnchecked
-Withdraws sender's collateral from the protocol before checking minimum collateral ratio.
-Executes post-withdraw-callback triggering onUncheckedCollateralWithdraw on the caller
-function withdrawCollateralUnchecked(
- address _account,
- address _collateralAsset,
- uint256 _withdrawAmount,
- uint256 _collateralIndex,
- bytes memory _userData
-) external onlyRole(Role.MANAGER);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | The address to withdraw assets for. |
_collateralAsset | address | The address of the collateral asset. |
_withdrawAmount | uint256 | The amount of the collateral asset to withdraw. |
_collateralIndex | uint256 | The index of the collateral asset in the sender's deposited collateral assets array. Only needed if withdrawing the entire deposit of a particular collateral asset. |
_userData | bytes |
MinterLiquidationFacet
- -Inherits: -Modifiers, IMinterLiquidationFacet
-Author: -Kresko
-Main end-user functionality concerning liquidations within Kresko's Minter system.
-Functions
-liquidate
-Attempts to liquidate an account by repaying the portion of the account's Kresko asset -debt, receiving in return a portion of the account's collateral at a discounted rate.
-function liquidate(LiquidationArgs memory _args) external nonReentrant gate;
-Parameters
-| Name | Type | Description |
|---|---|---|
_args | LiquidationArgs | LiquidationArgs struct containing the arguments necessary to perform a liquidation. |
getMaxLiqValue
-Calculates the total value that is allowed to be liquidated from an account (if it is liquidatable)
-function getMaxLiqValue(address _account, address _repayAssetAddr, address _seizeAssetAddr)
- external
- view
- returns (MaxLiqInfo memory);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | Address of the account to liquidate |
_repayAssetAddr | address | Address of Kresko Asset to repay |
_seizeAssetAddr | address | Address of Collateral to seize |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | MaxLiqInfo | MaxLiqInfo Calculated information about the maximum liquidation. |
_liquidateAssets
-function _liquidateAssets(Asset storage collateral, Asset storage krAsset, LiquidateExecution memory args)
- internal
- returns (uint256 seizedAmount);
-_getMaxLiqValue
-function _getMaxLiqValue(
- address _account,
- Asset storage _repayAsset,
- Asset storage _seizeAsset,
- address _seizeAssetAddr
-) internal view returns (uint256 maxValue);
-_calcMaxLiqValue
-function _calcMaxLiqValue(
- Asset storage _repayAsset,
- Asset storage _seizeAsset,
- uint256 _minCollateralValue,
- uint256 _totalCollateralValue,
- uint256 _seizeAssetValue,
- uint96 _minDebtValue,
- uint32 _maxLiquidationRatio
-) internal view returns (uint256);
-MinterMintFacet
- -Inherits: -IMinterMintFacet, Modifiers
-Author: -Kresko
-Core minting functionality for Kresko Minter.
-Functions
-mintKreskoAsset
-Mints new Kresko assets.
-function mintKreskoAsset(address _account, address _krAsset, uint256 _mintAmount)
- external
- onlyRoleIf(_account != msg.sender, Role.MANAGER)
- nonReentrant
- gate;
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | The address to mint assets for. |
_krAsset | address | The address of the Kresko asset. |
_mintAmount | uint256 | The amount of the Kresko asset to be minted. |
MinterStateFacet
- -Inherits: -IMinterStateFacet
-Author: -Kresko
-As structs do not create views for members, we must expose most of the state values explicitly.
-Functions
-getMinCollateralRatioMinter
-The minimum ratio of collateral to debt that can be taken by direct action.
-function getMinCollateralRatioMinter() external view returns (uint32);
-getLiquidationThresholdMinter
-The collateralization ratio at which positions may be liquidated.
-function getLiquidationThresholdMinter() external view returns (uint32);
-getMaxLiquidationRatioMinter
-Multiplies max liquidation multiplier, if a full liquidation happens this is the resulting CR.
-function getMaxLiquidationRatioMinter() external view returns (uint32);
-getParametersMinter
-get all meaningful protocol parameters
-function getParametersMinter() external view returns (MinterParams memory);
-getKrAssetExists
-simple check if kresko asset exists
-function getKrAssetExists(address _krAsset) external view returns (bool);
-getCollateralExists
-simple check if collateral asset exists
-function getCollateralExists(address _collateralAsset) external view returns (bool);
-getCollateralValueWithPrice
-Gets the USD value for a single collateral asset and amount.
-function getCollateralValueWithPrice(address _collateralAsset, uint256 _amount)
- external
- view
- returns (uint256 value, uint256 adjustedValue, uint256 price);
-Parameters
-| Name | Type | Description |
|---|---|---|
_collateralAsset | address | The address of the collateral asset. |
_amount | uint256 | The amount of the collateral asset to calculate the value for. |
Returns
-| Name | Type | Description |
|---|---|---|
value | uint256 | The unadjusted value for the provided amount of the collateral asset. |
adjustedValue | uint256 | The (cFactor) adjusted value for the provided amount of the collateral asset. |
price | uint256 | The price of the collateral asset. |
getDebtValueWithPrice
-Gets the USD value for a single Kresko asset and amount.
-function getDebtValueWithPrice(address _krAsset, uint256 _amount)
- external
- view
- returns (uint256 value, uint256 adjustedValue, uint256 price);
-Parameters
-| Name | Type | Description |
|---|---|---|
_krAsset | address | The address of the Kresko asset. |
_amount | uint256 | The amount of the Kresko asset to calculate the value for. |
Returns
-| Name | Type | Description |
|---|---|---|
value | uint256 | The unadjusted value for the provided amount of the debt asset. |
adjustedValue | uint256 | The (kFactor) adjusted value for the provided amount of the debt asset. |
price | uint256 | The price of the debt asset. |
Contents
- -MAccounts
- -Functions
-checkAccountLiquidatable
-Checks if accounts collateral value is less than required.
-Reverts if account is not liquidatable.
-function checkAccountLiquidatable(MinterState storage self, address _account) internal view;
-Parameters
-| Name | Type | Description |
|---|---|---|
self | MinterState | |
_account | address | Account to check. |
isAccountLiquidatable
-Gets the liquidatable status of an account.
-function isAccountLiquidatable(MinterState storage self, address _account) internal view returns (bool);
-Parameters
-| Name | Type | Description |
|---|---|---|
self | MinterState | |
_account | address | Account to check. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | bool | bool Indicating if the account is liquidatable. |
checkAccountCollateral
-verifies that the account has enough collateral value
-function checkAccountCollateral(MinterState storage self, address _account) internal view;
-Parameters
-| Name | Type | Description |
|---|---|---|
self | MinterState | |
_account | address | The address of the account to verify the collateral for. |
accountTotalDebtValue
-Gets the total debt value in USD for an account.
-function accountTotalDebtValue(MinterState storage self, address _account) internal view returns (uint256 value);
-Parameters
-| Name | Type | Description |
|---|---|---|
self | MinterState | |
_account | address | Account to calculate the KreskoAsset value for. |
Returns
-| Name | Type | Description |
|---|---|---|
value | uint256 | Total kresko asset debt value of _account. |
accountDebtAmount
-Gets _account principal debt amount for _asset
Principal debt is rebase adjusted due to possible stock splits/reverse splits
-function accountDebtAmount(MinterState storage self, address _account, address _assetAddr, Asset storage _asset)
- internal
- view
- returns (uint256 debtAmount);
-Parameters
-| Name | Type | Description |
|---|---|---|
self | MinterState | |
_account | address | Account to get debt amount for. |
_assetAddr | address | Kresko asset address |
_asset | Asset | Asset truct for the kresko asset. |
Returns
-| Name | Type | Description |
|---|---|---|
debtAmount | uint256 | Amount of debt the _account has for _asset |
accountMintIndex
-Gets an index for the Kresko asset the account has minted.
-function accountMintIndex(MinterState storage self, address _account, address _krAsset)
- internal
- view
- returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
self | MinterState | |
_account | address | Account to get the minted Kresko assets for. |
_krAsset | address | Asset address. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 Index of the minted asset. Reverts if not found. |
accountDebtAssets
-Gets an array of kresko assets the account has minted.
-function accountDebtAssets(MinterState storage self, address _account)
- internal
- view
- returns (address[] memory mintedAssets);
-Parameters
-| Name | Type | Description |
|---|---|---|
self | MinterState | |
_account | address | Account to get the minted kresko assets for. |
Returns
-| Name | Type | Description |
|---|---|---|
mintedAssets | address[] | Array of addresses of kresko assets the account has minted. |
accountMinCollateralAtRatio
-Gets accounts min collateral value required to cover debt at a given collateralization ratio.
-Account with min collateral value under MCR cannot borrow.
-Account with min collateral value under LT can be liquidated up to maxLiquidationRatio.
-function accountMinCollateralAtRatio(MinterState storage self, address _account, uint32 _ratio)
- internal
- view
- returns (uint256 minCollateralValue);
-Parameters
-| Name | Type | Description |
|---|---|---|
self | MinterState | |
_account | address | Account to calculate the minimum collateral value for. |
_ratio | uint32 | Collateralization ratio to apply for the minimum collateral value. |
Returns
-| Name | Type | Description |
|---|---|---|
minCollateralValue | uint256 | Minimum collateral value required for the account with _ratio. |
accountCollateralAssets
-Gets the array of collateral assets the account has deposited.
-function accountCollateralAssets(MinterState storage self, address _account)
- internal
- view
- returns (address[] memory depositedAssets);
-Parameters
-| Name | Type | Description |
|---|---|---|
self | MinterState | |
_account | address | Account to get the deposited collateral assets for. |
Returns
-| Name | Type | Description |
|---|---|---|
depositedAssets | address[] | Array of deposited collateral assets for _account. |
accountCollateralAmount
-Gets the deposited collateral asset amount for an account
-Performs rebasing conversion for KreskoAssets
-function accountCollateralAmount(
- MinterState storage self,
- address _account,
- address _assetAddress,
- Asset storage _asset
-) internal view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
self | MinterState | |
_account | address | Account to query amount for |
_assetAddress | address | Collateral asset address |
_asset | Asset | Asset struct of the collateral asset |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 Collateral deposit amount of _asset for _account |
accountTotalCollateralValue
-Gets the collateral value of a particular account.
-function accountTotalCollateralValue(MinterState storage self, address _account)
- internal
- view
- returns (uint256 totalCollateralValue);
-Parameters
-| Name | Type | Description |
|---|---|---|
self | MinterState | |
_account | address | Account to calculate the collateral value for. |
Returns
-| Name | Type | Description |
|---|---|---|
totalCollateralValue | uint256 | Collateral value of a particular account. |
accountTotalCollateralValue
-Gets the total collateral deposits value of an account while extracting value for _collateralAsset.
function accountTotalCollateralValue(MinterState storage self, address _account, address _collateralAsset)
- internal
- view
- returns (uint256 totalValue, uint256 assetValue);
-Parameters
-| Name | Type | Description |
|---|---|---|
self | MinterState | |
_account | address | Account to calculate the collateral value for. |
_collateralAsset | address | Collateral asset to extract value for. |
Returns
-| Name | Type | Description |
|---|---|---|
totalValue | uint256 | Total collateral value of _account |
assetValue | uint256 | Collateral value of _collateralAsset for _account |
accountDepositIndex
-Gets the deposit index of _collateralAsset for _account.
function accountDepositIndex(MinterState storage self, address _account, address _collateralAsset)
- internal
- view
- returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
self | MinterState | |
_account | address | Account to get the index for. |
_collateralAsset | address | Collateral asset address. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 Index of the deposited collateral asset. Reverts if not found. |
MCore
- -Functions
-mint
-function mint(MinterState storage self, address _krAsset, address _anchor, uint256 _amount, address _account)
- internal;
-burn
-Repay user kresko asset debt.
-Updates the principal in MinterState
-function burn(MinterState storage self, address _krAsset, address _anchor, uint256 _burnAmount, address _account)
- internal;
-Parameters
-| Name | Type | Description |
|---|---|---|
self | MinterState | |
_krAsset | address | the asset being repaid |
_anchor | address | the anchor token of the asset being repaid |
_burnAmount | uint256 | the asset amount being burned |
_account | address | the account the debt is subtracted from |
handleDeposit
-Records account as having deposited an amount of a collateral asset.
-Token transfers are expected to be done by the caller.
-function handleDeposit(
- MinterState storage self,
- Asset storage _asset,
- address _account,
- address _collateralAsset,
- uint256 _depositAmount
-) internal;
-Parameters
-| Name | Type | Description |
|---|---|---|
self | MinterState | |
_asset | Asset | The asset struct |
_account | address | The address of the collateral asset. |
_collateralAsset | address | The address of the collateral asset. |
_depositAmount | uint256 | The amount of the collateral asset deposited. |
handleWithdrawal
-Verifies that the account has sufficient collateral for the requested amount and records the collateral
-function handleWithdrawal(
- MinterState storage self,
- Asset storage _asset,
- address _account,
- address _collateralAsset,
- uint256 _withdrawAmount,
- uint256 _collateralDeposits,
- uint256 _collateralIndex
-) internal;
-Parameters
-| Name | Type | Description |
|---|---|---|
self | MinterState | |
_asset | Asset | The asset struct |
_account | address | The address of the account to verify the collateral for. |
_collateralAsset | address | The address of the collateral asset. |
_withdrawAmount | uint256 | The amount of the collateral asset to withdraw. |
_collateralDeposits | uint256 | Collateral deposits for the account. |
_collateralIndex | uint256 | Index of the collateral asset in the account's deposited collateral assets array. |
handleUncheckedWithdrawal
-records the collateral withdrawal
-function handleUncheckedWithdrawal(
- MinterState storage self,
- Asset storage _asset,
- address _account,
- address _collateralAsset,
- uint256 _withdrawAmount,
- uint256 _collateralDeposits,
- uint256 _collateralIndex
-) internal;
-Parameters
-| Name | Type | Description |
|---|---|---|
self | MinterState | |
_asset | Asset | The collateral asset struct. |
_account | address | The address of the account to verify the collateral for. |
_collateralAsset | address | The address of the collateral asset. |
_withdrawAmount | uint256 | The amount of the collateral asset to withdraw. |
_collateralDeposits | uint256 | Collateral deposits for the account. |
_collateralIndex | uint256 | Index of the collateral asset in the account's deposited collateral assets array. |
handleMinterFee
- -Charges the protocol open fee based off the value of the minted asset.
-Takes the fee from the account's collateral assets. Attempts collateral assets -in reverse order of the account's deposited collateral assets array.
-function handleMinterFee(Asset storage _krAsset, address _account, uint256 _mintAmount, Enums.MinterFee _feeType);
-Parameters
-| Name | Type | Description |
|---|---|---|
_krAsset | Asset | Asset struct of the kresko asset being minted. |
_account | address | Account to charge the open fee from. |
_mintAmount | uint256 | Amount of the kresko asset being minted. |
_feeType | Enums.MinterFee | MinterFee type |
_calcFeeAndHandleCollateralRemoval
- -Calculates the fee to be taken from a user's deposited collateral asset.
-function _calcFeeAndHandleCollateralRemoval(
- Asset storage _asset,
- address _collateralAsset,
- address _account,
- uint256 _feeValue,
- uint256 _collateralAssetIndex
-) returns (uint256 transferAmount, uint256 feeValuePaid);
-Parameters
-| Name | Type | Description |
|---|---|---|
_asset | Asset | Asset struct of the collateral asset. |
_collateralAsset | address | The collateral asset from which to take to the fee. |
_account | address | The owner of the collateral. |
_feeValue | uint256 | The original value of the fee. |
_collateralAssetIndex | uint256 | The collateral asset's index in the user's depositedCollateralAssets array. |
Returns
-| Name | Type | Description |
|---|---|---|
transferAmount | uint256 | to be received as a uint256 |
feeValuePaid | uint256 | wad representing the fee value paid. |
Contents
--
-
- ICollateralReceiver -
- IMinterAccountStateFacet -
- IMinterBurnFacet -
- IMinterConfigurationFacet -
- IMinterDepositWithdrawFacet -
- IMinterLiquidationFacet -
- IMinterMintFacet -
- IMinterStateFacet -
ICollateralReceiver
- -Functions
-onUncheckedCollateralWithdraw
-function onUncheckedCollateralWithdraw(
- address _account,
- address _collateralAsset,
- uint256 _withdrawalAmount,
- uint256 _depositedCollateralAssetIndex,
- bytes memory _userData
-) external returns (bytes memory);
-IMinterAccountStateFacet
- -Functions
-getAccountLiquidatable
-Calculates if an account's current collateral value is under its minimum collateral value
-function getAccountLiquidatable(address _account) external view returns (bool);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | The account to check. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | bool | bool Indicates if the account can be liquidated. |
getAccountState
-Get accounts state in the Minter.
-function getAccountState(address _account) external view returns (MinterAccountState memory);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | Account address to get the state for. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | MinterAccountState | MinterAccountState Total debt value, total collateral value and collateral ratio. |
getAccountMintedAssets
-Gets an array of Kresko assets the account has minted.
-function getAccountMintedAssets(address _account) external view returns (address[] memory);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | The account to get the minted Kresko assets for. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | address[] | address[] Array of Kresko Asset addresses the account has minted. |
getAccountMintIndex
-Gets an index for the Kresko asset the account has minted.
-function getAccountMintIndex(address _account, address _krAsset) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | The account to get the minted Kresko assets for. |
_krAsset | address | The asset lookup address. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | index The index of asset in the minted assets array. |
getAccountTotalDebtValues
-Gets the total Kresko asset debt value in USD for an account.
-Adjusted value means it is multiplied by kFactor.
-function getAccountTotalDebtValues(address _account) external view returns (uint256 value, uint256 valueAdjusted);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | Account to calculate the Kresko asset value for. |
Returns
-| Name | Type | Description |
|---|---|---|
value | uint256 | The unadjusted value of debt. |
valueAdjusted | uint256 | The kFactor adjusted value of debt. |
getAccountTotalDebtValue
-Gets the total Kresko asset debt value in USD for an account.
-function getAccountTotalDebtValue(address _account) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | The account to calculate the Kresko asset value for. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 Total debt value of _account. |
getAccountDebtAmount
-Get _account debt amount for _asset
function getAccountDebtAmount(address _account, address _assetAddr) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | The account to query amount for |
_assetAddr | address | The asset address |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 Amount of debt for _assetAddr |
getAccountCollateralValues
-Get the unadjusted and the adjusted value of collateral deposits of _assetAddr for _account.
Adjusted value means it is multiplied by cFactor.
-function getAccountCollateralValues(address _account, address _assetAddr)
- external
- view
- returns (uint256 value, uint256 valueAdjusted, uint256 price);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | Account to get the collateral values for. |
_assetAddr | address | Asset to get the collateral values for. |
Returns
-| Name | Type | Description |
|---|---|---|
value | uint256 | Unadjusted value of the collateral deposits. |
valueAdjusted | uint256 | cFactor adjusted value of the collateral deposits. |
price | uint256 | Price for the collateral asset |
getAccountTotalCollateralValue
-Gets the adjusted collateral value of a particular account.
-function getAccountTotalCollateralValue(address _account) external view returns (uint256 valueAdjusted);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | Account to calculate the collateral value for. |
Returns
-| Name | Type | Description |
|---|---|---|
valueAdjusted | uint256 | Collateral value of a particular account. |
getAccountTotalCollateralValues
-Gets the adjusted and unadjusted collateral value of _account.
Adjusted value means it is multiplied by cFactor.
-function getAccountTotalCollateralValues(address _account)
- external
- view
- returns (uint256 value, uint256 valueAdjusted);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | Account to get the values for |
Returns
-| Name | Type | Description |
|---|---|---|
value | uint256 | Unadjusted total value of the collateral deposits. |
valueAdjusted | uint256 | cFactor adjusted total value of the collateral deposits. |
getAccountMinCollateralAtRatio
-Get an account's minimum collateral value required -to back a Kresko asset amount at a given collateralization ratio.
-Accounts that have their collateral value under the minimum collateral value are considered unhealthy, -accounts with their collateral value under the liquidation threshold are considered liquidatable.
-function getAccountMinCollateralAtRatio(address _account, uint32 _ratio) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | Account to calculate the minimum collateral value for. |
_ratio | uint32 | Collateralization ratio required: higher ratio = more collateral required |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 Minimum collateral value of a particular account. |
getAccountCollateralRatio
-Get a list of accounts and their collateral ratios
-function getAccountCollateralRatio(address _account) external view returns (uint256 ratio);
-Returns
-| Name | Type | Description |
|---|---|---|
ratio | uint256 | The collateral ratio of _account |
getAccountCollateralRatios
-Get a list of account collateral ratios
-function getAccountCollateralRatios(address[] memory _accounts) external view returns (uint256[] memory);
-Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256[] | ratios Collateral ratios of the _accounts |
getAccountDepositIndex
-Gets an index for the collateral asset the account has deposited.
-function getAccountDepositIndex(address _account, address _collateralAsset) external view returns (uint256 i);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | Account to get the index for. |
_collateralAsset | address | Asset address. |
Returns
-| Name | Type | Description |
|---|---|---|
i | uint256 | Index of the minted collateral asset. |
getAccountCollateralAssets
-Gets an array of collateral assets the account has deposited.
-function getAccountCollateralAssets(address _account) external view returns (address[] memory);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | The account to get the deposited collateral assets for. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | address[] | address[] Array of collateral asset addresses the account has deposited. |
getAccountCollateralAmount
-Get _account collateral deposit amount for _assetAddr
function getAccountCollateralAmount(address _account, address _assetAddr) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | The account to query amount for |
_assetAddr | address | The asset address |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 Amount of collateral deposited for _assetAddr |
previewFee
-Calculates the expected fee to be taken from a user's deposited collateral assets, -by imitating calcFee without modifying state.
-function previewFee(address _account, address _krAsset, uint256 _kreskoAssetAmount, Enums.MinterFee _feeType)
- external
- view
- returns (address[] memory assets, uint256[] memory amounts);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | Account to charge the open fee from. |
_krAsset | address | Address of the kresko asset being burned. |
_kreskoAssetAmount | uint256 | Amount of the kresko asset being minted. |
_feeType | Enums.MinterFee | Fee type (open or close). |
Returns
-| Name | Type | Description |
|---|---|---|
assets | address[] | Collateral types as an array of addresses. |
amounts | uint256[] | Collateral amounts as an array of uint256. |
Structs
-ExpectedFeeRuntimeInfo
-struct ExpectedFeeRuntimeInfo {
- address[] assets;
- uint256[] amounts;
- uint256 collateralTypeCount;
-}
-IMinterBurnFacet
- -Functions
-burnKreskoAsset
-Burns existing Kresko assets.
-function burnKreskoAsset(address _account, address _krAsset, uint256 _burnAmount, uint256 _mintedKreskoAssetIndex)
- external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | The address to burn kresko assets for |
_krAsset | address | The address of the Kresko asset. |
_burnAmount | uint256 | The amount of the Kresko asset to be burned. |
_mintedKreskoAssetIndex | uint256 | The index of the kresko asset in the user's minted assets array. Only needed if burning all principal debt of a particular collateral asset. |
IMinterConfigurationFacet
- -Functions
-initializeMinter
-function initializeMinter(MinterInitArgs calldata args) external;
-setCollateralLiquidationIncentiveMinter
-Updates the liquidation incentive multiplier.
-function setCollateralLiquidationIncentiveMinter(address _collateralAsset, uint16 _newLiquidationIncentive) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_collateralAsset | address | The collateral asset to update. |
_newLiquidationIncentive | uint16 | The new liquidation incentive multiplier for the asset. |
setMinCollateralRatioMinter
-Updates the contract's collateralization ratio.
-function setMinCollateralRatioMinter(uint32 _newMinCollateralRatio) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_newMinCollateralRatio | uint32 | The new minimum collateralization ratio as wad. |
setLiquidationThresholdMinter
-Updates the contract's liquidation threshold value
-function setLiquidationThresholdMinter(uint32 _newThreshold) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_newThreshold | uint32 | The new liquidation threshold value |
setMaxLiquidationRatioMinter
-Updates the max liquidation ratior value.
-This is the maximum collateral ratio that liquidations can liquidate to.
-function setMaxLiquidationRatioMinter(uint32 _newMaxLiquidationRatio) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_newMaxLiquidationRatio | uint32 | Percent value in wad precision. |
IMinterDepositWithdrawFacet
- -Functions
-depositCollateral
-Deposits collateral into the protocol.
-function depositCollateral(address _account, address _collateralAsset, uint256 _depositAmount) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | The user to deposit collateral for. |
_collateralAsset | address | The address of the collateral asset. |
_depositAmount | uint256 | The amount of the collateral asset to deposit. |
withdrawCollateral
-Withdraws sender's collateral from the protocol.
-Requires that the post-withdrawal collateral value does not violate minimum collateral requirement.
-function withdrawCollateral(
- address _account,
- address _collateralAsset,
- uint256 _withdrawAmount,
- uint256 _collateralIndex
-) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | The address to withdraw assets for. |
_collateralAsset | address | The address of the collateral asset. |
_withdrawAmount | uint256 | The amount of the collateral asset to withdraw. |
_collateralIndex | uint256 | The index of the collateral asset in the sender's deposited collateral assets array. Only needed if withdrawing the entire deposit of a particular collateral asset. |
withdrawCollateralUnchecked
-Withdraws sender's collateral from the protocol before checking minimum collateral ratio.
-Executes post-withdraw-callback triggering onUncheckedCollateralWithdraw on the caller
-Requires that the post-withdraw-callback collateral value does not violate minimum collateral requirement.
-function withdrawCollateralUnchecked(
- address _account,
- address _collateralAsset,
- uint256 _withdrawAmount,
- uint256 _collateralIndex,
- bytes memory _userData
-) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | The address to withdraw assets for. |
_collateralAsset | address | The address of the collateral asset. |
_withdrawAmount | uint256 | The amount of the collateral asset to withdraw. |
_collateralIndex | uint256 | The index of the collateral asset in the sender's deposited collateral assets array. Only needed if withdrawing the entire deposit of a particular collateral asset. |
_userData | bytes |
IMinterLiquidationFacet
- -Functions
-liquidate
-Attempts to liquidate an account by repaying the portion of the account's Kresko asset -debt, receiving in return a portion of the account's collateral at a discounted rate.
-function liquidate(LiquidationArgs memory _args) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_args | LiquidationArgs | LiquidationArgs struct containing the arguments necessary to perform a liquidation. |
getMaxLiqValue
-Calculates the total value that is allowed to be liquidated from an account (if it is liquidatable)
-function getMaxLiqValue(address _account, address _repayAssetAddr, address _seizeAssetAddr)
- external
- view
- returns (MaxLiqInfo memory);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | Address of the account to liquidate |
_repayAssetAddr | address | Address of Kresko Asset to repay |
_seizeAssetAddr | address | Address of Collateral to seize |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | MaxLiqInfo | MaxLiqInfo Calculated information about the maximum liquidation. |
IMinterMintFacet
- -Functions
-mintKreskoAsset
-Mints new Kresko assets.
-function mintKreskoAsset(address _account, address _krAsset, uint256 _mintAmount) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | The address to mint assets for. |
_krAsset | address | The address of the Kresko asset. |
_mintAmount | uint256 | The amount of the Kresko asset to be minted. |
IMinterStateFacet
- -Functions
-getLiquidationThresholdMinter
-The collateralization ratio at which positions may be liquidated.
-function getLiquidationThresholdMinter() external view returns (uint32);
-getMaxLiquidationRatioMinter
-Multiplies max liquidation multiplier, if a full liquidation happens this is the resulting CR.
-function getMaxLiquidationRatioMinter() external view returns (uint32);
-getMinCollateralRatioMinter
-The minimum ratio of collateral to debt that can be taken by direct action.
-function getMinCollateralRatioMinter() external view returns (uint32);
-getKrAssetExists
-simple check if kresko asset exists
-function getKrAssetExists(address _krAsset) external view returns (bool);
-getCollateralExists
-simple check if collateral asset exists
-function getCollateralExists(address _collateralAsset) external view returns (bool);
-getParametersMinter
-get all meaningful protocol parameters
-function getParametersMinter() external view returns (MinterParams memory);
-getCollateralValueWithPrice
-Gets the USD value for a single collateral asset and amount.
-function getCollateralValueWithPrice(address _collateralAsset, uint256 _amount)
- external
- view
- returns (uint256 value, uint256 adjustedValue, uint256 price);
-Parameters
-| Name | Type | Description |
|---|---|---|
_collateralAsset | address | The address of the collateral asset. |
_amount | uint256 | The amount of the collateral asset to calculate the value for. |
Returns
-| Name | Type | Description |
|---|---|---|
value | uint256 | The unadjusted value for the provided amount of the collateral asset. |
adjustedValue | uint256 | The (cFactor) adjusted value for the provided amount of the collateral asset. |
price | uint256 | The price of the collateral asset. |
getDebtValueWithPrice
-Gets the USD value for a single Kresko asset and amount.
-function getDebtValueWithPrice(address _krAsset, uint256 _amount)
- external
- view
- returns (uint256 value, uint256 adjustedValue, uint256 price);
-Parameters
-| Name | Type | Description |
|---|---|---|
_krAsset | address | The address of the Kresko asset. |
_amount | uint256 | The amount of the Kresko asset to calculate the value for. |
Returns
-| Name | Type | Description |
|---|---|---|
value | uint256 | The unadjusted value for the provided amount of the debt asset. |
adjustedValue | uint256 | The (kFactor) adjusted value for the provided amount of the debt asset. |
price | uint256 | The price of the debt asset. |
IEventFieldProvider
- -Functions
-symbol
-function symbol() external view returns (string memory);
-MEvent
- -Functions
-symbol
-function symbol(address _addr) internal view returns (string memory symbol_);
-Events
-CollateralAssetAdded
-Emitted when a collateral asset is added to the protocol.
-Can only be emitted once for a given collateral asset.
-event CollateralAssetAdded(
- string indexed ticker,
- string indexed symbol,
- address indexed collateralAsset,
- uint256 factor,
- address anchor,
- uint256 liqIncentive
-);
-CollateralAssetUpdated
-Emitted when a collateral asset is updated.
-event CollateralAssetUpdated(
- string indexed ticker,
- string indexed symbol,
- address indexed collateralAsset,
- uint256 factor,
- address anchor,
- uint256 liqIncentive
-);
-CollateralDeposited
-Emitted when an account deposits collateral.
-event CollateralDeposited(address indexed account, address indexed collateralAsset, uint256 amount);
-CollateralWithdrawn
-Emitted when an account withdraws collateral.
-event CollateralWithdrawn(address indexed account, address indexed collateralAsset, uint256 amount);
-UncheckedCollateralWithdrawn
-Emitted when AMM helper withdraws account collateral without MCR checks.
-event UncheckedCollateralWithdrawn(address indexed account, address indexed collateralAsset, uint256 amount);
-KreskoAssetAdded
-Emitted when a KreskoAsset is added to the protocol.
-Can only be emitted once for a given Kresko asset.
-event KreskoAssetAdded(
- string indexed ticker,
- string indexed symbol,
- address indexed kreskoAsset,
- address anchor,
- uint256 kFactor,
- uint256 maxDebtMinter,
- uint256 closeFee,
- uint256 openFee
-);
-KreskoAssetUpdated
-Emitted when a Kresko asset's oracle is updated.
-event KreskoAssetUpdated(
- string indexed ticker,
- string indexed symbol,
- address indexed kreskoAsset,
- address anchor,
- uint256 kFactor,
- uint256 maxDebtMinter,
- uint256 closeFee,
- uint256 openFee
-);
-KreskoAssetMinted
-Emitted when an account mints a Kresko asset.
-event KreskoAssetMinted(address indexed account, address indexed kreskoAsset, uint256 amount);
-KreskoAssetBurned
-Emitted when an account burns a Kresko asset.
-event KreskoAssetBurned(address indexed account, address indexed kreskoAsset, uint256 amount);
-CFactorUpdated
-Emitted when cFactor is updated for a collateral asset.
-event CFactorUpdated(string indexed symbol, address indexed collateralAsset, uint256 from, uint256 to);
-KFactorUpdated
-Emitted when kFactor is updated for a KreskoAsset.
-event KFactorUpdated(string indexed symbol, address indexed kreskoAsset, uint256 from, uint256 to);
-DebtPositionClosed
-Emitted when an account burns a Kresko asset.
-event DebtPositionClosed(address indexed account, address indexed kreskoAsset, uint256 amount);
-FeePaid
-Emitted when an account pays an open/close fee with a collateral asset in the Minter.
-This can be emitted multiple times for a single asset.
-event FeePaid(
- address indexed account,
- address indexed paymentCollateralAsset,
- uint256 indexed feeType,
- uint256 paymentAmount,
- uint256 paymentValue,
- uint256 feeValue
-);
-LiquidationOccurred
-Emitted when a liquidation occurs.
-event LiquidationOccurred(
- address indexed account,
- address indexed liquidator,
- address indexed repayKreskoAsset,
- uint256 repayAmount,
- address seizedCollateralAsset,
- uint256 collateralSent
-);
-SafetyStateChange
-Emitted when a safety state is triggered for an asset
-event SafetyStateChange(Enums.Action indexed action, string indexed symbol, address indexed asset, string description);
-FeeRecipientUpdated
-Emitted when the fee recipient is updated.
-event FeeRecipientUpdated(address from, address to);
-LiquidationIncentiveUpdated
-Emitted when the liquidation incentive multiplier is updated.
-event LiquidationIncentiveUpdated(string indexed symbol, address indexed asset, uint256 from, uint256 to);
-MinCollateralRatioUpdated
-Emitted when the minimum collateralization ratio is updated.
-event MinCollateralRatioUpdated(uint256 from, uint256 to);
-MinimumDebtValueUpdated
-Emitted when the minimum debt value updated.
-event MinimumDebtValueUpdated(uint256 from, uint256 to);
-LiquidationThresholdUpdated
-Emitted when the liquidation threshold value is updated
-event LiquidationThresholdUpdated(uint256 from, uint256 to, uint256 mlr);
-MaxLiquidationRatioUpdated
-Emitted when the max liquidation ratio is updated
-event MaxLiquidationRatioUpdated(uint256 from, uint256 to);
-MinterState
- -Author: -Kresko
-struct MinterState {
- mapping(address => address[]) depositedCollateralAssets;
- mapping(address => mapping(address => uint256)) collateralDeposits;
- mapping(address => mapping(address => uint256)) kreskoAssetDebt;
- mapping(address => address[]) mintedKreskoAssets;
- address[] krAssets;
- address[] collaterals;
- address feeRecipient;
- uint32 maxLiquidationRatio;
- uint32 minCollateralRatio;
- uint32 liquidationThreshold;
-}
-ms
- -function ms() pure returns (MinterState storage state);
-Constants
- -MINTER_STORAGE_POSITION
-bytes32 constant MINTER_STORAGE_POSITION = keccak256("kresko.minter.storage");
-LiquidateExecution
- -Internal, used execute _liquidateAssets.
-struct LiquidateExecution {
- address account;
- uint256 repayAmount;
- uint256 seizeAmount;
- address repayAssetAddr;
- uint256 repayAssetIndex;
- address seizedAssetAddr;
- uint256 seizedAssetIndex;
-}
-LiquidationArgs
- -External, used when caling liquidate.
-struct LiquidationArgs {
- address account;
- address repayAssetAddr;
- uint256 repayAmount;
- address seizeAssetAddr;
- uint256 repayAssetIndex;
- uint256 seizeAssetIndex;
-}
-MinterAccountState
- -struct MinterAccountState {
- uint256 totalDebtValue;
- uint256 totalCollateralValue;
- uint256 collateralRatio;
-}
-MinterInitArgs
- -Initialization arguments for the protocol
-struct MinterInitArgs {
- uint32 liquidationThreshold;
- uint32 minCollateralRatio;
-}
-MinterParams
- -Configurable parameters within the protocol
-struct MinterParams {
- uint32 minCollateralRatio;
- uint32 liquidationThreshold;
- uint32 maxLiquidationRatio;
-}
-Contents
--
-
- facets -
- funcs -
- interfaces -
- SDICoverRecipient -
- SEvent -
- SCDPState -
- SDIState -
- sdi -
- scdp -
- SState constants -
- SCDPInitArgs -
- SCDPParameters -
- SwapRouteSetter -
- SCDPAssetData -
- GlobalData -
- AssetData -
- UserAssetData -
- UserData -
Contents
- -SCDPConfigFacet
- -Inherits: -ISCDPConfigFacet, DSModifiers, Modifiers
-Functions
-initializeSCDP
-Initialize SCDP. -Callable by diamond owner only.
-function initializeSCDP(SCDPInitArgs calldata args) external initializer(4) initializeAsAdmin;
-Parameters
-| Name | Type | Description |
|---|---|---|
args | SCDPInitArgs |
getParametersSCDP
-Get the pool configuration.
-function getParametersSCDP() external view override returns (SCDPParameters memory);
-setFeeAssetSCDP
-function setFeeAssetSCDP(address _assetAddr) external onlyRole(Role.ADMIN);
-setMinCollateralRatioSCDP
-Set the minimum collateralization ratio for SCDP.
-function setMinCollateralRatioSCDP(uint32 _newMCR) public onlyRole(Role.ADMIN);
-setLiquidationThresholdSCDP
-Set the liquidation threshold for SCDP while updating MLR to one percent above it.
-function setLiquidationThresholdSCDP(uint32 _newLT) public onlyRole(Role.ADMIN);
-setMaxLiquidationRatioSCDP
-function setMaxLiquidationRatioSCDP(uint32 _newMLR) external onlyRole(Role.ADMIN);
-setDepositLimitSCDP
-Update the deposit asset limit configuration. -Only callable by admin. -emits PoolCollateralUpdated
-function setDepositLimitSCDP(address _assetAddr, uint256 _newDepositLimitSCDP) external onlyRole(Role.ADMIN);
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | The Collateral asset to update |
_newDepositLimitSCDP | uint256 | The new deposit limit for the collateral |
setKrAssetLiqIncentiveSCDP
-Set the new liquidation incentive for a swappable asset.
-function setKrAssetLiqIncentiveSCDP(address _assetAddr, uint16 _newLiqIncentiveSCDP) external onlyRole(Role.ADMIN);
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | Asset address |
_newLiqIncentiveSCDP | uint16 | New liquidation incentive. Bounded to 1e4 <-> 1.25e4. |
setAssetIsSharedCollateralSCDP
-Disable or enable a deposit asset. Reverts if invalid asset. -Only callable by admin.
-function setAssetIsSharedCollateralSCDP(address _assetAddr, bool _enabled) external onlyRole(Role.ADMIN);
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | Asset to set. |
_enabled | bool | Whether to enable or disable the asset. |
setAssetIsSwapMintableSCDP
-Disable or enable a kresko asset to be used in swaps. -Reverts if invalid asset. Enabling will also add it to collateral value calculations. -Only callable by admin.
-function setAssetIsSwapMintableSCDP(address _assetAddr, bool _enabled) external onlyRole(Role.ADMIN);
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | Asset to set. |
_enabled | bool | Whether to enable or disable the asset. |
setAssetIsSharedOrSwappedCollateralSCDP
-function setAssetIsSharedOrSwappedCollateralSCDP(address _assetAddr, bool _enabled) external onlyRole(Role.ADMIN);
-setAssetSwapFeesSCDP
-Sets the fees for a kresko asset
-Only callable by admin.
-function setAssetSwapFeesSCDP(address _assetAddr, uint16 _openFee, uint16 _closeFee, uint16 _protocolFee)
- external
- onlyRole(Role.ADMIN);
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | The kresko asset to set fees for. |
_openFee | uint16 | The new open fee. |
_closeFee | uint16 | The new close fee. |
_protocolFee | uint16 | The protocol fee share. |
setSwapRoutesSCDP
-Set whether swap routes for pairs are enabled or not. Both ways. -Only callable by admin.
-function setSwapRoutesSCDP(SwapRouteSetter[] calldata _pairs) external onlyRole(Role.ADMIN);
-Parameters
-| Name | Type | Description |
|---|---|---|
_pairs | SwapRouteSetter[] |
setSingleSwapRouteSCDP
-Set whether a swap route for a pair is enabled or not. -Only callable by admin.
-function setSingleSwapRouteSCDP(SwapRouteSetter calldata _pair) external onlyRole(Role.ADMIN);
-Parameters
-| Name | Type | Description |
|---|---|---|
_pair | SwapRouteSetter |
SCDPFacet
- -Inherits: -ISCDPFacet, Modifiers
-Functions
-depositSCDP
-Deposit collateral for account to the collateral pool.
-function depositSCDP(address _account, address _collateralAsset, uint256 _amount) external nonReentrant gate;
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | The account to deposit for. |
_collateralAsset | address | The collateral asset to deposit. |
_amount | uint256 | The amount to deposit. |
withdrawSCDP
-Withdraw collateral for account from the collateral pool.
-function withdrawSCDP(address _account, address _collateralAsset, uint256 _amount) external nonReentrant gate;
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | The account to withdraw for. |
_collateralAsset | address | The collateral asset to withdraw. |
_amount | uint256 | The amount to withdraw. |
repaySCDP
-Repay debt for no fees or slippage.
-function repaySCDP(address _repayAssetAddr, uint256 _repayAmount, address _seizeAssetAddr) external nonReentrant gate;
-Parameters
-| Name | Type | Description |
|---|---|---|
_repayAssetAddr | address | The asset to repay the debt in. |
_repayAmount | uint256 | The amount of the asset to repay the debt with. |
_seizeAssetAddr | address | The collateral asset to seize. |
getLiquidatableSCDP
-function getLiquidatableSCDP() external view returns (bool);
-getMaxLiqValueSCDP
-function getMaxLiqValueSCDP(address _repayAssetAddr, address _seizeAssetAddr)
- external
- view
- returns (MaxLiqInfo memory);
-liquidateSCDP
-Liquidate the collateral pool.
-function liquidateSCDP(address _repayAssetAddr, uint256 _repayAmount, address _seizeAssetAddr)
- external
- nonReentrant
- gate;
-Parameters
-| Name | Type | Description |
|---|---|---|
_repayAssetAddr | address | The asset to repay the debt in. |
_repayAmount | uint256 | The amount of the asset to repay the debt with. |
_seizeAssetAddr | address | The collateral asset to seize. |
_getMaxLiqValue
-function _getMaxLiqValue(Asset storage _repayAsset, Asset storage _seizeAsset, address _seizeAssetAddr)
- internal
- view
- returns (uint256 maxLiquidatableUSD);
-_calcMaxLiqValue
-function _calcMaxLiqValue(
- Asset storage _repayAsset,
- Asset storage _seizeAsset,
- uint256 _minCollateralValue,
- uint256 _totalCollateralValue,
- uint256 _seizeAssetValue,
- uint96 _minDebtValue,
- uint32 _maxLiquidationRatio
-) internal view returns (uint256);
-SCDPStateFacet
- -Inherits: -ISCDPStateFacet
-Author: -Kresko
-This facet is used to view the state of the scdp.
-Functions
-getAccountDepositSCDP
-Get the total collateral principal deposits for _account
function getAccountDepositSCDP(address _account, address _depositAsset) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | The account. |
_depositAsset | address | The deposit asset |
getAccountScaledDepositsSCDP
-Get the collateral pool deposit balance of _account. Including fees.
function getAccountScaledDepositsSCDP(address _account, address _depositAsset) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | The account. |
_depositAsset | address | The deposit asset. |
getAccountDepositFeesGainedSCDP
-function getAccountDepositFeesGainedSCDP(address _account, address _depositAsset) external view returns (uint256);
-getAccountDepositValueSCDP
-Get the (principal) deposit value for _account
function getAccountDepositValueSCDP(address _account, address _depositAsset) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | The account. |
_depositAsset | address | The deposit asset |
getAccountScaledDepositValueCDP
-Get the full value of account and fees for _account
function getAccountScaledDepositValueCDP(address _account, address _depositAsset) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | The account. |
_depositAsset | address | The collateral asset |
getAccountTotalDepositsValueSCDP
-Get the total collateral deposit value for _account
function getAccountTotalDepositsValueSCDP(address _account) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | The account. |
getAccountTotalScaledDepositsValueSCDP
-Get the full value of account and fees for _account
function getAccountTotalScaledDepositsValueSCDP(address _account) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | The account. |
getDepositAssetsSCDP
-Get all pool CollateralAssets
-function getDepositAssetsSCDP() external view returns (address[] memory result);
-getCollateralsSCDP
-function getCollateralsSCDP() external view returns (address[] memory result);
-getDepositsSCDP
-Get the total collateral deposits for _collateralAsset
function getDepositsSCDP(address _depositAsset) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_depositAsset | address |
getSwapDepositsSCDP
-Get the total collateral swap deposits for _collateralAsset
function getSwapDepositsSCDP(address _collateralAsset) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_collateralAsset | address | The collateral asset |
getCollateralValueSCDP
-Get the total collateral deposit value for _collateralAsset
function getCollateralValueSCDP(address _depositAsset, bool _ignoreFactors) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_depositAsset | address | The collateral asset |
_ignoreFactors | bool | Ignore factors when calculating collateral and debt value. |
getTotalCollateralValueSCDP
-Get the total collateral value, oracle precision
-function getTotalCollateralValueSCDP(bool _ignoreFactors) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_ignoreFactors | bool | Ignore factors when calculating collateral value. |
getKreskoAssetsSCDP
-Get all pool KreskoAssets
-function getKreskoAssetsSCDP() external view returns (address[] memory);
-getDebtSCDP
-Get the collateral debt amount for _krAsset
function getDebtSCDP(address _krAsset) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_krAsset | address | The KreskoAsset |
getDebtValueSCDP
-Get the debt value for _krAsset
function getDebtValueSCDP(address _krAsset, bool _ignoreFactors) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_krAsset | address | The KreskoAsset |
_ignoreFactors | bool | Ignore factors when calculating collateral and debt value. |
getTotalDebtValueSCDP
-Get the total debt value of krAssets in oracle precision
-function getTotalDebtValueSCDP(bool _ignoreFactors) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_ignoreFactors | bool | Ignore factors when calculating debt value. |
getAssetEnabledSCDP
-Get enabled state of asset
-function getAssetEnabledSCDP(address _assetAddr) external view returns (bool);
-getDepositEnabledSCDP
-function getDepositEnabledSCDP(address _assetAddr) external view returns (bool);
-getSwapEnabledSCDP
-Get whether swap is enabled from _assetIn to _assetOut
function getSwapEnabledSCDP(address _assetIn, address _assetOut) external view returns (bool);
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetIn | address | The asset to swap from |
_assetOut | address | The asset to swap to |
getCollateralRatioSCDP
-function getCollateralRatioSCDP() public view returns (uint256);
-getStatisticsSCDP
-Get pool collateral values and debt values with CR.
-function getStatisticsSCDP() external view returns (GlobalData memory);
-Returns
-| Name | Type | Description |
|---|---|---|
<none> | GlobalData | GlobalData struct |
getAccountInfoSCDP
-function getAccountInfoSCDP(address _account, address[] memory _assets) public view returns (UserData memory result);
-getAccountInfosSCDP
-function getAccountInfosSCDP(address[] memory _accounts, address[] memory _assets)
- external
- view
- returns (UserData[] memory result);
-getAssetInfoSCDP
-function getAssetInfoSCDP(address _assetAddr) public view returns (AssetData memory results);
-getAssetInfosSCDP
-function getAssetInfosSCDP(address[] memory _assets) external view returns (AssetData[] memory results);
-SCDPSwapFacet
- -Inherits: -ISCDPSwapFacet, Modifiers
-Functions
-cumulateIncomeSCDP
-Accumulates fees to deposits as a fixed, instantaneous income.
-function cumulateIncomeSCDP(address _assetAddr, uint256 _incomeAmount) external nonReentrant returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | |
_incomeAmount | uint256 | Amount to accumulate |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | nextLiquidityIndex Next liquidity index for the asset. |
previewSwapSCDP
-Preview the amount out received.
-function previewSwapSCDP(address _assetInAddr, address _assetOutAddr, uint256 _amountIn)
- external
- view
- returns (uint256 amountOut, uint256 feeAmount, uint256 feeAmountProtocol);
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetInAddr | address | |
_assetOutAddr | address | |
_amountIn | uint256 | The amount of _assetIn to pay. |
Returns
-| Name | Type | Description |
|---|---|---|
amountOut | uint256 | The amount of _assetOut to receive according to _amountIn. |
feeAmount | uint256 | |
feeAmountProtocol | uint256 |
swapSCDP
-Swap kresko assets with KISS using the shared collateral pool. -Uses oracle pricing of _amountIn to determine how much _assetOut to send.
-function swapSCDP(
- address _receiver,
- address _assetInAddr,
- address _assetOutAddr,
- uint256 _amountIn,
- uint256 _amountOutMin
-) external nonReentrant;
-Parameters
-| Name | Type | Description |
|---|---|---|
_receiver | address | |
_assetInAddr | address | |
_assetOutAddr | address | |
_amountIn | uint256 | The amount of _assetIn to pay. |
_amountOutMin | uint256 | The minimum amount of _assetOut to receive, this is due to possible oracle price change. |
_swap
-Swaps assets in the collateral pool.
-function _swap(
- address _receiver,
- address _assetInAddr,
- Asset storage _assetIn,
- address _assetOutAddr,
- uint256 _amountIn,
- uint256 _amountOutMin
-) private returns (uint256 amountOut);
-Parameters
-| Name | Type | Description |
|---|---|---|
_receiver | address | The address to receive the swapped assets. |
_assetInAddr | address | The asset to swap in. |
_assetIn | Asset | The asset in struct. |
_assetOutAddr | address | The asset to swap out. |
_amountIn | uint256 | The amount of _assetIn to swap in. |
_amountOutMin | uint256 | The minimum amount of _assetOut to receive. |
_swapFeeAssetOut
-Swaps assets in the collateral pool.
-function _swapFeeAssetOut(
- address _receiver,
- address _assetInAddr,
- Asset storage _assetIn,
- uint256 _amountIn,
- uint256 _amountOutMin
-) private returns (uint256 amountOut);
-Parameters
-| Name | Type | Description |
|---|---|---|
_receiver | address | The address to receive the swapped assets. |
_assetInAddr | address | The asset to swap in. |
_assetIn | Asset | The asset in struct. |
_amountIn | uint256 | The amount of _assetIn to swap in. |
_amountOutMin | uint256 | The minimum amount of _assetOut to receive. |
_swapToFeeAsset
-Swaps assets in the collateral pool.
-function _swapToFeeAsset(
- address _receiver,
- address _assetInAddr,
- Asset storage _assetIn,
- address _assetOutAddr,
- Asset storage _assetOut,
- uint256 _amountIn
-) private returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_receiver | address | The address to receive the swapped assets. |
_assetInAddr | address | The asset to swap in. |
_assetIn | Asset | The asset in struct. |
_assetOutAddr | address | The asset to swap out. |
_assetOut | Asset | The asset out struct. |
_amountIn | uint256 | The amount of _assetIn to swap in |
_checkAndPayFees
-function _checkAndPayFees(
- address _payAssetAddr,
- Asset storage _payAsset,
- uint256 _amountOut,
- uint256 _amountOutMin,
- uint256 _feeAmount,
- uint256 _protocolFeePct
-) private;
-_paySwapFees
-function _paySwapFees(
- address _feeAssetAddress,
- Asset storage _feeAsset,
- address _payAssetAddress,
- Asset storage _payAsset,
- uint256 _feeAmount,
- uint256 _protocolFeePct
-) private;
-getSwapFees
- -Get fee percentage for a swap pair.
-function getSwapFees(Asset storage _assetIn, Asset storage _assetOut)
- view
- returns (uint256 feePercentage, uint256 protocolFee);
-Returns
-| Name | Type | Description |
|---|---|---|
feePercentage | uint256 | fee percentage for this swap |
protocolFee | uint256 | protocol fee percentage taken from the fee |
SDIFacet
- -Inherits: -ISDIFacet, DSModifiers, Modifiers
-Functions
-totalSDI
-function totalSDI() external view returns (uint256);
-getTotalSDIDebt
-function getTotalSDIDebt() external view returns (uint256);
-getEffectiveSDIDebt
-function getEffectiveSDIDebt() external view returns (uint256);
-getEffectiveSDIDebtUSD
-function getEffectiveSDIDebtUSD() external view returns (uint256);
-getSDICoverAmount
-function getSDICoverAmount() external view returns (uint256);
-previewSCDPBurn
-function previewSCDPBurn(address _assetAddr, uint256 _burnAmount, bool _ignoreFactors)
- external
- view
- returns (uint256 shares);
-previewSCDPMint
-function previewSCDPMint(address _assetAddr, uint256 _mintAmount, bool _ignoreFactors)
- external
- view
- returns (uint256 shares);
-getSDIPrice
-Get the price of SDI in USD, oracle precision.
-function getSDIPrice() external view returns (uint256);
-getCoverAssetsSDI
-function getCoverAssetsSDI() external view returns (address[] memory);
-SDICover
-function SDICover(address _assetAddr, uint256 _amount) external returns (uint256 shares, uint256 value);
-enableCoverAssetSDI
-function enableCoverAssetSDI(address _assetAddr) external onlyRole(Role.ADMIN);
-disableCoverAssetSDI
-function disableCoverAssetSDI(address _assetAddr) external onlyRole(Role.ADMIN);
-setCoverRecipientSDI
-function setCoverRecipientSDI(address _newCoverRecipient) external onlyRole(Role.ADMIN);
-Contents
--
-
- SAccounts -
- SDebtIndex -
- SDeposits -
- SGlobal -
- totalCollateralValuesSCDP -
- accountDepositAmountsAndValues -
- totalDebtValuesAtRatioSCDP -
- accountTotalDepositValues -
- Swap -
SAccounts
- -Functions
-accountScaledDeposits
-Get accounts deposit amount that is scaled by the liquidity index.
-The liquidity index is updated when: A) Income is accrued B) Liquidation occurs.
-function accountScaledDeposits(SCDPState storage self, address _account, address _assetAddr, Asset storage _asset)
- internal
- view
- returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
self | SCDPState | |
_account | address | The account to get the amount for |
_assetAddr | address | The asset address |
_asset | Asset | The asset struct |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | Amount of scaled debt. |
accountPrincipalDeposits
-Get accounts principal deposits.
-Uses scaled deposits if its lower than principal (realizing liquidations).
-function accountPrincipalDeposits(SCDPState storage self, address _account, address _assetAddr, Asset storage _asset)
- internal
- view
- returns (uint256 principalDeposits);
-Parameters
-| Name | Type | Description |
|---|---|---|
self | SCDPState | |
_account | address | The account to get the amount for |
_assetAddr | address | The deposit asset address |
_asset | Asset | The deposit asset struct |
Returns
-| Name | Type | Description |
|---|---|---|
principalDeposits | uint256 | The principal deposit amount for the account. |
accountTotalDepositValue
-Returns the value of the deposits for _account.
function accountTotalDepositValue(SCDPState storage self, address _account, bool _ignoreFactors)
- internal
- view
- returns (uint256 totalValue);
-Parameters
-| Name | Type | Description |
|---|---|---|
self | SCDPState | |
_account | address | Account to get total deposit value for |
_ignoreFactors | bool | Whether to ignore cFactor and kFactor |
accountTotalScaledDepositsValue
-Returns the value of the collateral assets in the pool for _account for the scaled deposit amount.
Ignores all factors.
-function accountTotalScaledDepositsValue(SCDPState storage self, address _account)
- internal
- view
- returns (uint256 totalValue);
-Parameters
-| Name | Type | Description |
|---|---|---|
self | SCDPState | |
_account | address | account |
SDebtIndex
- -Functions
-valueToSDI
-function valueToSDI(uint256 valueIn, uint8 oracleDecimals) internal view returns (uint256);
-cover
-Cover by pulling assets.
-function cover(SDIState storage self, address _assetAddr, uint256 _amount)
- internal
- returns (uint256 shares, uint256 value);
-effectiveDebt
-Returns the total effective debt amount of the SCDP.
-function effectiveDebt(SDIState storage self) internal view returns (uint256);
-effectiveDebtValue
-Returns the total effective debt value of the SCDP.
-function effectiveDebtValue(SDIState storage self) internal view returns (uint256);
-totalCoverAmount
-function totalCoverAmount(SDIState storage self) internal view returns (uint256);
-totalCoverValue
-Gets the total cover debt value, oracle precision
-function totalCoverValue(SDIState storage self) internal view returns (uint256 result);
-totalSDI
-Simply returns the total supply of SDI.
-function totalSDI(SDIState storage self) internal view returns (uint256);
-coverAssetValue
-Get total deposit value of asset in USD, oracle precision.
function coverAssetValue(SDIState storage self, address _assetAddr) internal view returns (uint256);
-SDeposits
- -Functions
-handleDepositSCDP
-Records a deposit of collateral asset.
-Saves principal, scaled and global deposit amounts.
-function handleDepositSCDP(
- SCDPState storage self,
- Asset storage _asset,
- address _account,
- address _assetAddr,
- uint256 _amount
-) internal;
-Parameters
-| Name | Type | Description |
|---|---|---|
self | SCDPState | |
_asset | Asset | Asset struct for the deposit asset |
_account | address | depositor |
_assetAddr | address | the deposit asset |
_amount | uint256 | amount of collateral asset to deposit |
handleWithdrawSCDP
-Records a withdrawal of collateral asset from the SCDP.
-function handleWithdrawSCDP(
- SCDPState storage self,
- Asset storage _asset,
- address _account,
- address _assetAddr,
- uint256 _amount
-) internal returns (uint256 amountOut, uint256 feesOut);
-Parameters
-| Name | Type | Description |
|---|---|---|
self | SCDPState | |
_asset | Asset | Asset struct for the deposit asset |
_account | address | The withdrawing account |
_assetAddr | address | the deposit asset |
_amount | uint256 | The amount of collateral withdrawn |
Returns
-| Name | Type | Description |
|---|---|---|
amountOut | uint256 | The actual amount of collateral withdrawn |
feesOut | uint256 | The fees paid for during the withdrawal |
handleSeizeSCDP
-This function seizes collateral from the shared pool
-Adjusts all deposits in the case where swap deposits do not cover the amount.
-function handleSeizeSCDP(SCDPState storage self, Asset storage _sAsset, address _assetAddr, uint256 _seizeAmount)
- internal;
-Parameters
-| Name | Type | Description |
|---|---|---|
self | SCDPState | |
_sAsset | Asset | The asset struct (Asset). |
_assetAddr | address | The seized asset address. |
_seizeAmount | uint256 | The seize amount (uint256). |
SGlobal
- -Functions
-ensureLiquidatableSCDP
-Checks whether the shared debt pool can be liquidated.
-Reverts if collateral value .
-function ensureLiquidatableSCDP(SCDPState storage self) internal view;
-checkCoverableSCDP
-Checks whether the shared debt pool can be liquidated.
-Reverts if collateral value .
-function checkCoverableSCDP(SCDPState storage self) internal view;
-ensureCollateralRatio
-Checks whether the collateral value is less than minimum required.
-Reverts when collateralValue is below minimum required.
-function ensureCollateralRatio(SCDPState storage self, uint32 _ratio) internal view;
-Parameters
-| Name | Type | Description |
|---|---|---|
self | SCDPState | |
_ratio | uint32 | Ratio to check in 1e4 percentage precision (uint32). |
totalDebtValueAtRatioSCDP
-Returns the value of the krAsset held in the pool at a ratio.
-function totalDebtValueAtRatioSCDP(SCDPState storage self, uint32 _ratio, bool _ignorekFactor)
- internal
- view
- returns (uint256 totalValue);
-Parameters
-| Name | Type | Description |
|---|---|---|
self | SCDPState | |
_ratio | uint32 | Percentage ratio to apply for the value in 1e4 percentage precision (uint32). |
_ignorekFactor | bool | Whether to ignore kFactor |
Returns
-| Name | Type | Description |
|---|---|---|
totalValue | uint256 | Total value in USD |
totalCollateralValueSCDP
-Calculates the total collateral value of collateral assets in the pool.
-function totalCollateralValueSCDP(SCDPState storage self, bool _ignoreFactors)
- internal
- view
- returns (uint256 totalValue);
-Parameters
-| Name | Type | Description |
|---|---|---|
self | SCDPState | |
_ignoreFactors | bool | Whether to ignore cFactor. |
Returns
-| Name | Type | Description |
|---|---|---|
totalValue | uint256 | Total value in USD |
totalCollateralValueSCDP
-Calculates total collateral value while extracting single asset value.
-function totalCollateralValueSCDP(SCDPState storage self, address _collateralAsset, bool _ignoreFactors)
- internal
- view
- returns (uint256 totalValue, uint256 assetValue);
-Parameters
-| Name | Type | Description |
|---|---|---|
self | SCDPState | |
_collateralAsset | address | Collateral asset to extract value for |
_ignoreFactors | bool | Whether to ignore cFactor. |
Returns
-| Name | Type | Description |
|---|---|---|
totalValue | uint256 | Total value in USD |
assetValue | uint256 | Asset value in USD |
totalDepositAmount
-Get pool collateral deposits of an asset.
-function totalDepositAmount(SCDPState storage self, address _assetAddress, Asset storage _asset)
- internal
- view
- returns (uint128);
-Parameters
-| Name | Type | Description |
|---|---|---|
self | SCDPState | |
_assetAddress | address | The asset address |
_asset | Asset | The asset struct |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint128 | Amount of scaled debt. |
userDepositAmount
-Get pool user collateral deposits of an asset.
-function userDepositAmount(SCDPState storage self, address _assetAddress, Asset storage _asset)
- internal
- view
- returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
self | SCDPState | |
_assetAddress | address | The asset address |
_asset | Asset | The asset struct |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | Amount of scaled debt. |
swapDepositAmount
-Get "swap" collateral deposits.
-function swapDepositAmount(SCDPState storage self, address _assetAddress, Asset storage _asset)
- internal
- view
- returns (uint128);
-Parameters
-| Name | Type | Description |
|---|---|---|
self | SCDPState | |
_assetAddress | address | The asset address |
_asset | Asset | The asset struct. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint128 | Amount of debt. |
totalCollateralValuesSCDP
- -Calculates the total collateral value of collateral assets in the pool.
-function totalCollateralValuesSCDP() view returns (uint256 value, uint256 valueAdjusted);
-Returns
-| Name | Type | Description |
|---|---|---|
value | uint256 | in USD |
valueAdjusted | uint256 | Value adjusted by cFactors in USD |
accountDepositAmountsAndValues
- -function accountDepositAmountsAndValues(address _account, address _assetAddr)
- view
- returns (UserAssetData memory result);
-totalDebtValuesAtRatioSCDP
- -Returns the values of the krAsset held in the pool at a ratio.
-function totalDebtValuesAtRatioSCDP(uint32 _ratio) view returns (uint256 value, uint256 valueAdjusted);
-Parameters
-| Name | Type | Description |
|---|---|---|
_ratio | uint32 | ratio |
Returns
-| Name | Type | Description |
|---|---|---|
value | uint256 | in USD |
valueAdjusted | uint256 | Value adjusted by kFactors in USD |
accountTotalDepositValues
- -function accountTotalDepositValues(address _account, address[] memory _assetData)
- view
- returns (uint256 totalValue, uint256 totalScaledValue, UserAssetData[] memory datas);
-Swap
- -Functions
-handleAssetsIn
-Records the assets received from account in a swap. -Burning any existing shared debt or increasing collateral deposits.
-function handleAssetsIn(
- SCDPState storage self,
- address _assetInAddr,
- Asset storage _assetIn,
- uint256 _amountIn,
- address _assetsFrom
-) internal returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
self | SCDPState | |
_assetInAddr | address | The asset received. |
_assetIn | Asset | The asset in struct. |
_amountIn | uint256 | The amount of the asset received. |
_assetsFrom | address | The account that holds the assets to burn. |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | The value of the assets received into the protocol, used to calculate assets out. |
handleAssetsOut
-Records the assets to send out in a swap. -Increasing debt of the pool by minting new assets when required.
-function handleAssetsOut(
- SCDPState storage self,
- address _assetOutAddr,
- Asset storage _assetOut,
- uint256 _valueIn,
- address _assetsTo
-) internal returns (uint256 amountOut);
-Parameters
-| Name | Type | Description |
|---|---|---|
self | SCDPState | |
_assetOutAddr | address | The asset to send out. |
_assetOut | Asset | The asset out struct. |
_valueIn | uint256 | The value received in. |
_assetsTo | address | The asset receiver. |
Returns
-| Name | Type | Description |
|---|---|---|
amountOut | uint256 | The amount of the asset out. |
cumulateIncome
-Accumulates fees to deposits as a fixed, instantaneous income.
-function cumulateIncome(SCDPState storage self, address _assetAddr, Asset storage _asset, uint256 _amount)
- internal
- returns (uint256 nextLiquidityIndex);
-Parameters
-| Name | Type | Description |
|---|---|---|
self | SCDPState | |
_assetAddr | address | The asset address |
_asset | Asset | The asset struct |
_amount | uint256 | The amount to accumulate |
Returns
-| Name | Type | Description |
|---|---|---|
nextLiquidityIndex | uint256 | The next liquidity index of the reserve |
Contents
- -ISCDPConfigFacet
- -Functions
-initializeSCDP
-Initialize SCDP. -Callable by diamond owner only.
-function initializeSCDP(SCDPInitArgs memory _init) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_init | SCDPInitArgs | The initial configuration. |
getParametersSCDP
-Get the pool configuration.
-function getParametersSCDP() external view returns (SCDPParameters memory);
-setFeeAssetSCDP
-Set the asset to cumulate swap fees into. -Only callable by admin.
-function setFeeAssetSCDP(address _assetAddr) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | Asset that is validated to be a deposit asset. |
setMinCollateralRatioSCDP
-Set the minimum collateralization ratio for SCDP.
-function setMinCollateralRatioSCDP(uint32 _newMCR) external;
-setLiquidationThresholdSCDP
-Set the liquidation threshold for SCDP while updating MLR to one percent above it.
-function setLiquidationThresholdSCDP(uint32 _newLT) external;
-setMaxLiquidationRatioSCDP
-Set the max liquidation ratio for SCDP.
-MLR is also updated automatically when setLiquidationThresholdSCDP is used.
-function setMaxLiquidationRatioSCDP(uint32 _newMLR) external;
-setKrAssetLiqIncentiveSCDP
-Set the new liquidation incentive for a swappable asset.
-function setKrAssetLiqIncentiveSCDP(address _assetAddr, uint16 _newLiqIncentiveSCDP) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | Asset address |
_newLiqIncentiveSCDP | uint16 | New liquidation incentive. Bounded to 1e4 <-> 1.25e4. |
setDepositLimitSCDP
-Update the deposit asset limit configuration. -Only callable by admin. -emits PoolCollateralUpdated
-function setDepositLimitSCDP(address _assetAddr, uint256 _newDepositLimitSCDP) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | The Collateral asset to update |
_newDepositLimitSCDP | uint256 | The new deposit limit for the collateral |
setAssetIsSharedCollateralSCDP
-Disable or enable a deposit asset. Reverts if invalid asset. -Only callable by admin.
-function setAssetIsSharedCollateralSCDP(address _assetAddr, bool _enabled) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | Asset to set. |
_enabled | bool | Whether to enable or disable the asset. |
setAssetIsSharedOrSwappedCollateralSCDP
-Disable or enable asset from shared collateral value calculations. -Reverts if invalid asset and if disabling asset that has user deposits. -Only callable by admin.
-function setAssetIsSharedOrSwappedCollateralSCDP(address _assetAddr, bool _enabled) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | Asset to set. |
_enabled | bool | Whether to enable or disable the asset. |
setAssetIsSwapMintableSCDP
-Disable or enable a kresko asset to be used in swaps. -Reverts if invalid asset. Enabling will also add it to collateral value calculations. -Only callable by admin.
-function setAssetIsSwapMintableSCDP(address _assetAddr, bool _enabled) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | Asset to set. |
_enabled | bool | Whether to enable or disable the asset. |
setAssetSwapFeesSCDP
-Sets the fees for a kresko asset
-Only callable by admin.
-function setAssetSwapFeesSCDP(address _assetAddr, uint16 _openFee, uint16 _closeFee, uint16 _protocolFee) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | The kresko asset to set fees for. |
_openFee | uint16 | The new open fee. |
_closeFee | uint16 | The new close fee. |
_protocolFee | uint16 | The protocol fee share. |
setSwapRoutesSCDP
-Set whether swap routes for pairs are enabled or not. Both ways. -Only callable by admin.
-function setSwapRoutesSCDP(SwapRouteSetter[] calldata _setters) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_setters | SwapRouteSetter[] | The configurations to set. |
setSingleSwapRouteSCDP
-Set whether a swap route for a pair is enabled or not. -Only callable by admin.
-function setSingleSwapRouteSCDP(SwapRouteSetter calldata _setter) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_setter | SwapRouteSetter | The configuration to set |
ISCDPFacet
- -Functions
-depositSCDP
-Deposit collateral for account to the collateral pool.
-function depositSCDP(address _account, address _collateralAsset, uint256 _amount) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | The account to deposit for. |
_collateralAsset | address | The collateral asset to deposit. |
_amount | uint256 | The amount to deposit. |
withdrawSCDP
-Withdraw collateral for account from the collateral pool.
-function withdrawSCDP(address _account, address _collateralAsset, uint256 _amount) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | The account to withdraw for. |
_collateralAsset | address | The collateral asset to withdraw. |
_amount | uint256 | The amount to withdraw. |
repaySCDP
-Repay debt for no fees or slippage.
-Only uses swap deposits, if none available, reverts.
-function repaySCDP(address _repayAssetAddr, uint256 _repayAmount, address _seizeAssetAddr) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_repayAssetAddr | address | The asset to repay the debt in. |
_repayAmount | uint256 | The amount of the asset to repay the debt with. |
_seizeAssetAddr | address | The collateral asset to seize. |
liquidateSCDP
-Liquidate the collateral pool.
-Adjusts everyones deposits if swap deposits do not cover the seized amount.
-function liquidateSCDP(address _repayAssetAddr, uint256 _repayAmount, address _seizeAssetAddr) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_repayAssetAddr | address | The asset to repay the debt in. |
_repayAmount | uint256 | The amount of the asset to repay the debt with. |
_seizeAssetAddr | address | The collateral asset to seize. |
getMaxLiqValueSCDP
-Calculates the total value that is allowed to be liquidated from SCDP (if it is liquidatable)
-function getMaxLiqValueSCDP(address _repayAssetAddr, address _seizeAssetAddr)
- external
- view
- returns (MaxLiqInfo memory);
-Parameters
-| Name | Type | Description |
|---|---|---|
_repayAssetAddr | address | Address of Kresko Asset to repay |
_seizeAssetAddr | address | Address of Collateral to seize |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | MaxLiqInfo | MaxLiqInfo Calculated information about the maximum liquidation. |
getLiquidatableSCDP
-function getLiquidatableSCDP() external view returns (bool);
-ISCDPStateFacet
- -Functions
-getAccountScaledDepositsSCDP
-Get the collateral pool deposit balance of _account. Including fees.
function getAccountScaledDepositsSCDP(address _account, address _depositAsset) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | The account. |
_depositAsset | address | The deposit asset. |
getAccountDepositSCDP
-Get the total collateral principal deposits for _account
function getAccountDepositSCDP(address _account, address _depositAsset) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | The account. |
_depositAsset | address | The deposit asset |
getAccountDepositFeesGainedSCDP
-function getAccountDepositFeesGainedSCDP(address _account, address _depositAsset) external view returns (uint256);
-getAccountDepositValueSCDP
-Get the (principal) deposit value for _account
function getAccountDepositValueSCDP(address _account, address _depositAsset) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | The account. |
_depositAsset | address | The deposit asset |
getAccountScaledDepositValueCDP
-Get the full value of account and fees for _account
function getAccountScaledDepositValueCDP(address _account, address _depositAsset) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | The account. |
_depositAsset | address | The collateral asset |
getAccountTotalDepositsValueSCDP
-Get the total collateral deposit value for _account
function getAccountTotalDepositsValueSCDP(address _account) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | The account. |
getAccountTotalScaledDepositsValueSCDP
-Get the full value of account and fees for _account
function getAccountTotalScaledDepositsValueSCDP(address _account) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | The account. |
getDepositAssetsSCDP
-Get all pool CollateralAssets
-function getDepositAssetsSCDP() external view returns (address[] memory);
-getDepositsSCDP
-Get the total collateral deposits for _collateralAsset
function getDepositsSCDP(address _collateralAsset) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_collateralAsset | address | The collateral asset |
getSwapDepositsSCDP
-Get the total collateral swap deposits for _collateralAsset
function getSwapDepositsSCDP(address _collateralAsset) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_collateralAsset | address | The collateral asset |
getCollateralValueSCDP
-Get the total collateral deposit value for _collateralAsset
function getCollateralValueSCDP(address _depositAsset, bool _ignoreFactors) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_depositAsset | address | The collateral asset |
_ignoreFactors | bool | Ignore factors when calculating collateral and debt value. |
getTotalCollateralValueSCDP
-Get the total collateral value, oracle precision
-function getTotalCollateralValueSCDP(bool _ignoreFactors) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_ignoreFactors | bool | Ignore factors when calculating collateral value. |
getKreskoAssetsSCDP
-Get all pool KreskoAssets
-function getKreskoAssetsSCDP() external view returns (address[] memory);
-getDebtSCDP
-Get the collateral debt amount for _krAsset
function getDebtSCDP(address _krAsset) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_krAsset | address | The KreskoAsset |
getDebtValueSCDP
-Get the debt value for _krAsset
function getDebtValueSCDP(address _krAsset, bool _ignoreFactors) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_krAsset | address | The KreskoAsset |
_ignoreFactors | bool | Ignore factors when calculating collateral and debt value. |
getTotalDebtValueSCDP
-Get the total debt value of krAssets in oracle precision
-function getTotalDebtValueSCDP(bool _ignoreFactors) external view returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
_ignoreFactors | bool | Ignore factors when calculating debt value. |
getAssetEnabledSCDP
-Get enabled state of asset
-function getAssetEnabledSCDP(address _assetAddr) external view returns (bool);
-getSwapEnabledSCDP
-Get whether swap is enabled from _assetIn to _assetOut
function getSwapEnabledSCDP(address _assetIn, address _assetOut) external view returns (bool);
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetIn | address | The asset to swap from |
_assetOut | address | The asset to swap to |
getCollateralRatioSCDP
-function getCollateralRatioSCDP() external view returns (uint256);
-getStatisticsSCDP
-Get pool collateral values and debt values with CR.
-function getStatisticsSCDP() external view returns (GlobalData memory);
-Returns
-| Name | Type | Description |
|---|---|---|
<none> | GlobalData | GlobalData struct |
ISCDPSwapFacet
- -Functions
-previewSwapSCDP
-Preview the amount out received.
-function previewSwapSCDP(address _assetIn, address _assetOut, uint256 _amountIn)
- external
- view
- returns (uint256 amountOut, uint256 feeAmount, uint256 protocolFee);
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetIn | address | The asset to pay with. |
_assetOut | address | The asset to receive. |
_amountIn | uint256 | The amount of _assetIn to pay. |
Returns
-| Name | Type | Description |
|---|---|---|
amountOut | uint256 | The amount of _assetOut to receive according to _amountIn. |
feeAmount | uint256 | |
protocolFee | uint256 |
swapSCDP
-Swap kresko assets with KISS using the shared collateral pool. -Uses oracle pricing of _amountIn to determine how much _assetOut to send.
-function swapSCDP(address _account, address _assetIn, address _assetOut, uint256 _amountIn, uint256 _amountOutMin)
- external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_account | address | The receiver of amount out. |
_assetIn | address | The asset to pay with. |
_assetOut | address | The asset to receive. |
_amountIn | uint256 | The amount of _assetIn to pay. |
_amountOutMin | uint256 | The minimum amount of _assetOut to receive, this is due to possible oracle price change. |
cumulateIncomeSCDP
-Accumulates fees to deposits as a fixed, instantaneous income.
-function cumulateIncomeSCDP(address _depositAssetAddr, uint256 _incomeAmount)
- external
- returns (uint256 nextLiquidityIndex);
-Parameters
-| Name | Type | Description |
|---|---|---|
_depositAssetAddr | address | Deposit asset to give income for |
_incomeAmount | uint256 | Amount to accumulate |
Returns
-| Name | Type | Description |
|---|---|---|
nextLiquidityIndex | uint256 | Next liquidity index for the asset. |
ISDIFacet
- -Functions
-getTotalSDIDebt
-function getTotalSDIDebt() external view returns (uint256);
-getEffectiveSDIDebtUSD
-function getEffectiveSDIDebtUSD() external view returns (uint256);
-getEffectiveSDIDebt
-function getEffectiveSDIDebt() external view returns (uint256);
-getSDICoverAmount
-function getSDICoverAmount() external view returns (uint256);
-previewSCDPBurn
-function previewSCDPBurn(address _assetAddr, uint256 _burnAmount, bool _ignoreFactors)
- external
- view
- returns (uint256 shares);
-previewSCDPMint
-function previewSCDPMint(address _assetAddr, uint256 _mintAmount, bool _ignoreFactors)
- external
- view
- returns (uint256 shares);
-totalSDI
-Simply returns the total supply of SDI.
-function totalSDI() external view returns (uint256);
-getSDIPrice
-Get the price of SDI in USD, oracle precision.
-function getSDIPrice() external view returns (uint256);
-SDICover
-function SDICover(address _assetAddr, uint256 _amount) external returns (uint256 shares, uint256 value);
-enableCoverAssetSDI
-function enableCoverAssetSDI(address _assetAddr) external;
-disableCoverAssetSDI
-function disableCoverAssetSDI(address _assetAddr) external;
-setCoverRecipientSDI
-function setCoverRecipientSDI(address _coverRecipient) external;
-getCoverAssetsSDI
-function getCoverAssetsSDI() external view returns (address[] memory);
-SDICoverRecipient
- -State Variables
-owner
-address public owner;
-pendingOwner
-address public pendingOwner;
-Functions
-constructor
-constructor(address _owner);
-withdraw
-function withdraw(address token, address recipient, uint256 amount) external;
-changeOwner
-function changeOwner(address _owner) external;
-acceptOwnership
-function acceptOwnership(address _owner) external;
-SEvent
- -Events
-SCDPDeposit
-event SCDPDeposit(address indexed depositor, address indexed collateralAsset, uint256 amount);
-SCDPWithdraw
-event SCDPWithdraw(address indexed withdrawer, address indexed collateralAsset, uint256 amount, uint256 feeAmount);
-SCDPRepay
-event SCDPRepay(
- address indexed repayer,
- address indexed repayKreskoAsset,
- uint256 repayAmount,
- address indexed receiveKreskoAsset,
- uint256 receiveAmount
-);
-SCDPLiquidationOccured
-event SCDPLiquidationOccured(
- address indexed liquidator,
- address indexed repayKreskoAsset,
- uint256 repayAmount,
- address indexed seizeCollateral,
- uint256 seizeAmount
-);
-PairSet
-event PairSet(address indexed assetIn, address indexed assetOut, bool enabled);
-FeeSet
-event FeeSet(address indexed _asset, uint256 openFee, uint256 closeFee, uint256 protocolFee);
-SCDPCollateralUpdated
-event SCDPCollateralUpdated(address indexed _asset, uint256 liquidationThreshold);
-SCDPKrAssetUpdated
-event SCDPKrAssetUpdated(
- address indexed _asset, uint256 openFee, uint256 closeFee, uint256 protocolFee, uint256 maxDebtMinter
-);
-Swap
-event Swap(address indexed who, address indexed assetIn, address indexed assetOut, uint256 amountIn, uint256 amountOut);
-SwapFee
-event SwapFee(address indexed feeAsset, address indexed assetIn, uint256 feeAmount, uint256 protocolFeeAmount);
-Income
-event Income(address asset, uint256 amount);
-SCDPLiquidationIncentiveUpdated
-Emitted when the liquidation incentive multiplier is updated for a swappable krAsset.
-event SCDPLiquidationIncentiveUpdated(string indexed symbol, address indexed asset, uint256 from, uint256 to);
-SCDPMinCollateralRatioUpdated
-Emitted when the minimum collateralization ratio is updated for the SCDP.
-event SCDPMinCollateralRatioUpdated(uint256 from, uint256 to);
-SCDPLiquidationThresholdUpdated
-Emitted when the liquidation threshold value is updated
-event SCDPLiquidationThresholdUpdated(uint256 from, uint256 to, uint256 mlr);
-SCDPMaxLiquidationRatioUpdated
-Emitted when the max liquidation ratio is updated
-event SCDPMaxLiquidationRatioUpdated(uint256 from, uint256 to);
-SCDPState
- -Author: -Kresko
-struct SCDPState {
- address[] collaterals;
- address[] krAssets;
- mapping(address => mapping(address => bool)) isRoute;
- mapping(address => bool) isEnabled;
- mapping(address => SCDPAssetData) assetData;
- mapping(address => mapping(address => uint256)) deposits;
- mapping(address => mapping(address => uint256)) depositsPrincipal;
- address feeAsset;
- uint32 minCollateralRatio;
- uint32 liquidationThreshold;
- uint32 maxLiquidationRatio;
-}
-SDIState
- -struct SDIState {
- uint256 totalDebt;
- uint256 totalCover;
- address coverRecipient;
- address[] coverAssets;
- uint8 sdiPricePrecision;
-}
-sdi
- -function sdi() pure returns (SDIState storage state);
-scdp
- -function scdp() pure returns (SCDPState storage state);
-Constants
- -SCDP_STORAGE_POSITION
-bytes32 constant SCDP_STORAGE_POSITION = keccak256("kresko.scdp.storage");
-SDI_STORAGE_POSITION
-bytes32 constant SDI_STORAGE_POSITION = keccak256("kresko.scdp.sdi.storage");
-SCDPInitArgs
- -SCDP initializer configuration.
-struct SCDPInitArgs {
- uint32 minCollateralRatio;
- uint32 liquidationThreshold;
- uint8 sdiPricePrecision;
-}
-SCDPParameters
- -SCDP initializer configuration.
-struct SCDPParameters {
- address feeAsset;
- uint32 minCollateralRatio;
- uint32 liquidationThreshold;
- uint32 maxLiquidationRatio;
- uint8 sdiPricePrecision;
-}
-SwapRouteSetter
- -struct SwapRouteSetter {
- address assetIn;
- address assetOut;
- bool enabled;
-}
-SCDPAssetData
- -struct SCDPAssetData {
- uint256 debt;
- uint128 totalDeposits;
- uint128 swapDeposits;
-}
-GlobalData
- -struct GlobalData {
- uint256 collateralValue;
- uint256 collateralValueAdjusted;
- uint256 debtValue;
- uint256 debtValueAdjusted;
- uint256 effectiveDebtValue;
- uint256 cr;
- uint256 crDebtValue;
- uint256 crDebtValueAdjusted;
-}
-AssetData
- -Periphery asset data
-struct AssetData {
- address addr;
- uint256 depositAmount;
- uint256 depositValue;
- uint256 depositValueAdjusted;
- uint256 debtAmount;
- uint256 debtValue;
- uint256 debtValueAdjusted;
- uint256 swapDeposits;
- Asset asset;
- uint256 assetPrice;
- string symbol;
-}
-UserAssetData
- -struct UserAssetData {
- address asset;
- uint256 assetPrice;
- uint256 depositAmount;
- uint256 scaledDepositAmount;
- uint256 depositValue;
- uint256 scaledDepositValue;
-}
-UserData
- -struct UserData {
- address account;
- uint256 totalDepositValue;
- uint256 totalScaledDepositValue;
- uint256 totalFeesValue;
- UserAssetData[] deposits;
-}
-Contents
- -Contents
--
-
- MockERC1155 -
- MockERC20Restricted -
- MockERC20 -
- WETH -
- USDC -
- DAI -
- USDT -
- MockOracle -
- MockSequencerUptimeFeed -
MockERC1155
- -Inherits: -ERC1155
-Functions
-constructor
-constructor() ERC1155("https://test");
-MockERC20Restricted
- -Inherits: -ERC20
-State Variables
-minters
-mapping(address => bool) public minters;
-owner
-address public owner;
-Functions
-constructor
-constructor(string memory _name, string memory _symbol, uint8 _decimals, uint256 _initialSupply)
- ERC20(_name, _symbol, _decimals);
-reinitializeERC20
-function reinitializeERC20(string memory _name, string memory _symbol) external;
-toggleMinters
-function toggleMinters(address[] calldata _minters) external;
-mint
-function mint(address to, uint256 value) public virtual;
-burn
-function burn(address from, uint256 value) public virtual;
-MockERC20
- -Inherits: -ERC20
-Functions
-constructor
-constructor(string memory name_, string memory symbol_, uint8 decimals_, uint256 mintAmount)
- ERC20(name_, symbol_, decimals_);
-mint
-function mint(address to, uint256 amount) external;
-burn
-function burn(address from, uint256 amount) external;
-WETH
- -Inherits: -MockERC20
-Functions
-constructor
-constructor() MockERC20("WETH", "WETH", 18, 0);
-deposit
-function deposit() external payable;
-withdraw
-function withdraw(uint256 amount) external;
-USDC
- -Inherits: -MockERC20
-Functions
-constructor
-constructor() MockERC20("USDC", "USDC", 18, 0);
-deposit
-function deposit() external payable;
-withdraw
-function withdraw(uint256 amount) external;
-DAI
- -Inherits: -MockERC20
-Functions
-constructor
-constructor() MockERC20("DAI", "DAI", 18, 0);
-deposit
-function deposit() external payable;
-withdraw
-function withdraw(uint256 amount) external;
-USDT
- -Inherits: -MockERC20
-Functions
-constructor
-constructor() MockERC20("USDT", "USDT", 6, 0);
-deposit
-function deposit() external payable;
-withdraw
-function withdraw(uint256 amount) external;
-MockOracle
- -Inherits: -IAggregatorV3
-State Variables
-decimals
-uint8 public decimals = 8;
-description
-string public override description;
-version
-uint256 public override version = 1;
-initialAnswer
-int256 public initialAnswer;
-Functions
-constructor
-constructor(string memory _description, uint256 _initialAnswer, uint8 _decimals);
-setPrice
-function setPrice(uint256 _answer) external;
-price
-function price() external view returns (uint256);
-getRoundData
-function getRoundData(uint80)
- external
- view
- override
- returns (uint80 roundId, int256 answer, uint256 startedAt, uint256 updatedAt, uint80 answeredInRound);
-latestRoundData
-function latestRoundData()
- external
- view
- override
- returns (uint80 roundId, int256 answer, uint256 startedAt, uint256 updatedAt, uint80 answeredInRound);
-MockSequencerUptimeFeed
- -State Variables
-__startedAt
-uint256 internal __startedAt;
-__updatedAt
-uint256 internal __updatedAt;
-__answer
-int256 internal __answer;
-Functions
-constructor
-constructor();
-setAnswers
-function setAnswers(int256 _answer, uint256 _startedAt, uint256 _updatedAt) external;
-setAnswer
-0 = up, 1 = down
-function setAnswer(int256 _answer) external;
-latestRoundData
-function latestRoundData()
- public
- view
- virtual
- returns (uint80 roundId, int256 answer, uint256 startedAt, uint256 updatedAt, uint80 answeredInRound);
-Contents
- -CalldataExtractor
- -Inherits: -RedstoneConstants
-Author: -The Redstone Oracles team
-This contract was created to reuse the same logic in the RedstoneConsumerBase -and the ProxyConnector contracts
-Functions
-_extractByteSizeOfUnsignedMetadata
-function _extractByteSizeOfUnsignedMetadata() internal pure returns (uint256);
-_extractDataPackagesCountFromCalldata
-function _extractDataPackagesCountFromCalldata(uint256 calldataNegativeOffset)
- internal
- pure
- returns (uint16 dataPackagesCount);
-_extractDataPointValueAndDataFeedId
-function _extractDataPointValueAndDataFeedId(
- uint256 calldataNegativeOffsetForDataPackage,
- uint256 defaultDataPointValueByteSize,
- uint256 dataPointIndex
-) internal pure virtual returns (bytes32 dataPointDataFeedId, uint256 dataPointValue);
-_extractDataPointsDetailsForDataPackage
-function _extractDataPointsDetailsForDataPackage(uint256 calldataNegativeOffsetForDataPackage)
- internal
- pure
- returns (uint256 dataPointsCount, uint256 eachDataPointValueByteSize);
-ProxyConnector
- -Inherits: -RedstoneConstants, CalldataExtractor
-Author: -The Redstone Oracles team
-Functions
-proxyCalldata
-function proxyCalldata(address contractAddress, bytes memory encodedFunction, bool forwardValue)
- internal
- returns (bytes memory);
-proxyDelegateCalldata
-function proxyDelegateCalldata(address contractAddress, bytes memory encodedFunction) internal returns (bytes memory);
-proxyCalldataView
-function proxyCalldataView(address contractAddress, bytes memory encodedFunction)
- internal
- view
- returns (bytes memory);
-_prepareMessage
-function _prepareMessage(bytes memory encodedFunction) private pure returns (bytes memory);
-_getRedstonePayloadByteSize
-function _getRedstonePayloadByteSize() private pure returns (uint256);
-_getDataPackageByteSize
-function _getDataPackageByteSize(uint256 calldataNegativeOffset) private pure returns (uint256);
-_prepareReturnValue
-function _prepareReturnValue(bool success, bytes memory result) internal pure returns (bytes memory);
-Errors
-ProxyCalldataFailedWithoutErrMsg
-error ProxyCalldataFailedWithoutErrMsg();
-ProxyCalldataFailedWithStringMessage
-error ProxyCalldataFailedWithStringMessage(string message);
-ProxyCalldataFailedWithCustomError
-error ProxyCalldataFailedWithCustomError(bytes result);
-RedstoneConstants
- -Author: -The Redstone Oracles team
-It mainly contains redstone-related values, which improve readability -of other contracts (e.g. CalldataExtractor and RedstoneConsumerBase)
-State Variables
-STANDARD_SLOT_BS
-uint256 internal constant STANDARD_SLOT_BS = 32;
-FREE_MEMORY_PTR
-uint256 internal constant FREE_MEMORY_PTR = 0x40;
-BYTES_ARR_LEN_VAR_BS
-uint256 internal constant BYTES_ARR_LEN_VAR_BS = 32;
-FUNCTION_SIGNATURE_BS
-uint256 internal constant FUNCTION_SIGNATURE_BS = 4;
-REVERT_MSG_OFFSET
-uint256 internal constant REVERT_MSG_OFFSET = 68;
-STRING_ERR_MESSAGE_MASK
-uint256 internal constant STRING_ERR_MESSAGE_MASK = 0x08c379a000000000000000000000000000000000000000000000000000000000;
-SIG_BS
-uint256 internal constant SIG_BS = 65;
-TIMESTAMP_BS
-uint256 internal constant TIMESTAMP_BS = 6;
-DATA_PACKAGES_COUNT_BS
-uint256 internal constant DATA_PACKAGES_COUNT_BS = 2;
-DATA_POINTS_COUNT_BS
-uint256 internal constant DATA_POINTS_COUNT_BS = 3;
-DATA_POINT_VALUE_BYTE_SIZE_BS
-uint256 internal constant DATA_POINT_VALUE_BYTE_SIZE_BS = 4;
-DATA_POINT_SYMBOL_BS
-uint256 internal constant DATA_POINT_SYMBOL_BS = 32;
-DEFAULT_DATA_POINT_VALUE_BS
-uint256 internal constant DEFAULT_DATA_POINT_VALUE_BS = 32;
-UNSIGNED_METADATA_BYTE_SIZE_BS
-uint256 internal constant UNSIGNED_METADATA_BYTE_SIZE_BS = 3;
-REDSTONE_MARKER_BS
-uint256 internal constant REDSTONE_MARKER_BS = 9;
-REDSTONE_MARKER_MASK
-uint256 internal constant REDSTONE_MARKER_MASK = 0x0000000000000000000000000000000000000000000000000002ed57011e0000;
-TIMESTAMP_NEGATIVE_OFFSET_IN_DATA_PACKAGE_WITH_STANDARD_SLOT_BS
-uint256 internal constant TIMESTAMP_NEGATIVE_OFFSET_IN_DATA_PACKAGE_WITH_STANDARD_SLOT_BS = 104;
-DATA_PACKAGE_WITHOUT_DATA_POINTS_BS
-uint256 internal constant DATA_PACKAGE_WITHOUT_DATA_POINTS_BS = 78;
-DATA_PACKAGE_WITHOUT_DATA_POINTS_AND_SIG_BS
-uint256 internal constant DATA_PACKAGE_WITHOUT_DATA_POINTS_AND_SIG_BS = 13;
-REDSTONE_MARKER_BS_PLUS_STANDARD_SLOT_BS
-uint256 internal constant REDSTONE_MARKER_BS_PLUS_STANDARD_SLOT_BS = 41;
-Errors
-CalldataOverOrUnderFlow
-error CalldataOverOrUnderFlow();
-IncorrectUnsignedMetadataSize
-error IncorrectUnsignedMetadataSize();
-InsufficientNumberOfUniqueSigners
-error InsufficientNumberOfUniqueSigners(uint256 receivedSignersCount, uint256 requiredSignersCount);
-EachSignerMustProvideTheSameValue
-error EachSignerMustProvideTheSameValue();
-EmptyCalldataPointersArr
-error EmptyCalldataPointersArr();
-InvalidCalldataPointer
-error InvalidCalldataPointer();
-CalldataMustHaveValidPayload
-error CalldataMustHaveValidPayload();
-SignerNotAuthorised
-error SignerNotAuthorised(address receivedSigner);
-Contents
--
-
- ISmockFacet -
- SmockCollateralReceiver -
- SmockFacet -
- SmockFacet constants -
- SmockFacet2 -
- SmockInit -
- Errors -
- SmockState -
- SmockState2 -
- SmockStorage -
ISmockFacet
- -Functions
-activate
-function activate() external;
-disable
-function disable() external;
-setMessage
-function setMessage(string memory message) external;
-Events
-NewMessage
-event NewMessage(address indexed caller, string message);
-SmockCollateralReceiver
- -Inherits: -ICollateralReceiver, ProxyConnector
-State Variables
-kresko
-IMinterDepositWithdrawFacet public kresko;
-callbackLogic
-function(address, address, uint256, bytes memory) internal callbackLogic;
-account
-address public account;
-collateralAsset
-address public collateralAsset;
-withdrawalAmountRequested
-uint256 public withdrawalAmountRequested;
-withdrawalAmountReceived
-uint256 public withdrawalAmountReceived;
-userData
-Params public userData;
-Functions
-constructor
-constructor(address _kresko);
-onUncheckedCollateralWithdraw
-function onUncheckedCollateralWithdraw(
- address _account,
- address _collateralAsset,
- uint256 _withdrawalAmount,
- uint256 _depositedCollateralAssetIndex,
- bytes memory _userData
-) external returns (bytes memory);
-execute
-function execute(
- address _collateralAsset,
- uint256 _amount,
- function(address, address, uint256, bytes memory) internal logic
-) internal;
-execute
-function execute(
- address _collateralAsset,
- uint256 _amount,
- bytes memory data,
- function(address, address, uint256, bytes memory) internal logic
-) internal;
-test
-function test(address _collateralAsset, uint256 _amount) external;
-testWithdrawalAmount
-function testWithdrawalAmount(address _collateralAsset, uint256 _amount) external;
-testRedeposit
-function testRedeposit(address _collateralAsset, uint256 _amount) external;
-testInsufficientRedeposit
-function testInsufficientRedeposit(address _collateralAsset, uint256 _amount) external;
-testDepositAlternate
-function testDepositAlternate(address _collateralWithdraw, uint256 _amount, address _collateralDeposit) external;
-logicDepositAlternate
-function logicDepositAlternate(
- address _account,
- address _collateralAsset,
- uint256 _withdrawalAmount,
- bytes memory _userData
-) internal;
-logicBase
-function logicBase(address _account, address _collateralAsset, uint256 _withdrawalAmount, bytes memory _userData)
- internal;
-logicTestWithdrawalAmount
-function logicTestWithdrawalAmount(
- address _account,
- address _collateralAsset,
- uint256 _withdrawalAmount,
- bytes memory _userData
-) internal;
-logicRedeposit
-function logicRedeposit(address _account, address _collateralAsset, uint256 _withdrawalAmount, bytes memory _userData)
- internal;
-logicInsufficientRedeposit
-function logicInsufficientRedeposit(
- address _account,
- address _collateralAsset,
- uint256 _withdrawalAmount,
- bytes memory _userData
-) internal;
-Structs
-Params
-struct Params {
- uint256 val;
- uint256 val1;
- address addr;
-}
-SmockFacet
- -Inherits: -DSModifiers, Modifiers, ISmockFacet
-Use for Smock fakes / mocks.
-State Variables
-MESSAGE_THROTTLE
-uint256 public constant MESSAGE_THROTTLE = 2;
-Functions
-operator
-function operator() external view returns (address);
-activate
-function activate() external override onlyRole(TEST_OPERATOR_ROLE) onlyDisabled;
-disable
-function disable() external override onlyRole(TEST_OPERATOR_ROLE) onlyActive;
-smockInitialized
-function smockInitialized() external view returns (bool);
-setMessage
-function setMessage(string memory message) external override onlyActive;
-onlyActive
-modifier onlyActive();
-onlyDisabled
-modifier onlyDisabled();
-Constants
- -TEST_OPERATOR_ROLE
-bytes32 constant TEST_OPERATOR_ROLE = keccak256("kresko.test.operator");
-SmockFacet2
- -Functions
-initialize
-function initialize() external;
-getOldStructValueFromExtended
-function getOldStructValueFromExtended() external view returns (bool);
-getNewStructValueFromExtended
-function getNewStructValueFromExtended() external view returns (bool);
-SmockInit
- -Inherits: -DSModifiers, Modifiers
-Functions
-initialize
-function initialize(address _operator) external onlyDiamondOwner onlyRole(Role.ADMIN);
-getNumber
-function getNumber() public pure returns (uint8);
-getBool
-function getBool() public pure returns (bool);
-upgradeState
-function upgradeState() external;
-Errors
- -State Variables
-INITIALIZED
-string public constant INITIALIZED = "Already initialized";
-NOT_ACTIVE
-string public constant NOT_ACTIVE = "SmockFacet: Not active";
-ACTIVE
-string public constant ACTIVE = "SmockFacet: Active";
-SmockState
- -struct SmockState {
- bool initialized;
- bool isActive;
- address operator;
- mapping(address => bool) callers;
- string message;
- uint256 lastMessageBlock;
-}
-SmockState2
- -struct SmockState2 {
- bool initialized;
- bool isActive;
- address operator;
- mapping(address => bool) callers;
- string message;
- uint256 lastMessageBlock;
- bool extended;
-}
-SmockStorage
- -State Variables
-SMOCK_STORAGE_POSITION
-bytes32 public constant SMOCK_STORAGE_POSITION = keccak256("kresko.smock.storage");
-Functions
-initialize
-function initialize(address _operator) internal;
-state
-function state() internal pure returns (SmockState storage ss);
-stateExtended
-function stateExtended() internal pure returns (SmockState2 storage ss);
-activate
-function activate() internal;
-disable
-function disable() internal;
-Events
-Call
-event Call(address indexed caller);
-Contents
- -Contents
--
-
- VAssets -
VAssets
- -Author: -Kresko
-Helper library for KreskoVault
-Functions
-price
-Gets the price of an asset from the oracle speficied.
-function price(VaultAsset storage self, VaultConfiguration storage config) internal view returns (uint256 answer);
-handleDepositFee
-Gets the price of an asset from the oracle speficied.
-function handleDepositFee(VaultAsset storage self, uint256 assets)
- internal
- view
- returns (uint256 assetsWithFee, uint256 fee);
-handleMintFee
-Gets the price of an asset from the oracle speficied.
-function handleMintFee(VaultAsset storage self, uint256 assets)
- internal
- view
- returns (uint256 assetsWithFee, uint256 fee);
-handleWithdrawFee
-Gets the price of an asset from the oracle speficied.
-function handleWithdrawFee(VaultAsset storage self, uint256 assets)
- internal
- view
- returns (uint256 assetsWithFee, uint256 fee);
-handleRedeemFee
-Gets the price of an asset from the oracle speficied.
-function handleRedeemFee(VaultAsset storage self, uint256 assets)
- internal
- view
- returns (uint256 assetsWithFee, uint256 fee);
-usdWad
-Gets the oracle decimal precision USD value for amount.
function usdWad(VaultAsset storage self, VaultConfiguration storage config, uint256 amount)
- internal
- view
- returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
self | VaultAsset | |
config | VaultConfiguration | vault configuration. |
amount | uint256 | amount of tokens to get USD value for. |
getDepositValue
-Gets the total deposit value of self in USD, oracle precision.
function getDepositValue(VaultAsset storage self, VaultConfiguration storage config) internal view returns (uint256);
-getDepositValueWad
-Gets the total deposit value of self in USD, oracle precision.
function getDepositValueWad(VaultAsset storage self, VaultConfiguration storage config)
- internal
- view
- returns (uint256);
-getAmount
-Gets the a token amount for value USD, oracle precision.
function getAmount(VaultAsset storage self, VaultConfiguration storage config, uint256 value)
- internal
- view
- returns (uint256);
-Contents
- -IVault
- -Functions
-deposit
-This function deposits assetsIn of asset, regardless of the amount of vault shares minted.
If depositFee > 0, depositFee of assetsIn is sent to the fee recipient.
emits Deposit(caller, receiver, asset, assetsIn, sharesOut);
-function deposit(address assetAddr, uint256 assetsIn, address receiver)
- external
- returns (uint256 sharesOut, uint256 assetFee);
-Parameters
-| Name | Type | Description |
|---|---|---|
assetAddr | address | Asset to deposit. |
assetsIn | uint256 | Amount of asset to deposit. |
receiver | address | Address to receive sharesOut of vault shares. |
Returns
-| Name | Type | Description |
|---|---|---|
sharesOut | uint256 | Amount of vault shares minted for assetsIn. |
assetFee | uint256 | Amount of fees paid in asset. |
mint
-This function mints sharesOut of vault shares, regardless of the amount of asset received.
If depositFee > 0, depositFee of assetsIn is sent to the fee recipient.
emits Deposit(caller, receiver, asset, assetsIn, sharesOut);
-function mint(address assetAddr, uint256 sharesOut, address receiver)
- external
- returns (uint256 assetsIn, uint256 assetFee);
-Parameters
-| Name | Type | Description |
|---|---|---|
assetAddr | address | Asset to deposit. |
sharesOut | uint256 | Amount of vault shares desired to mint. |
receiver | address | Address to receive sharesOut of shares. |
Returns
-| Name | Type | Description |
|---|---|---|
assetsIn | uint256 | Assets used to mint sharesOut of vault shares. |
assetFee | uint256 | Amount of fees paid in asset. |
redeem
-This function burns sharesIn of shares from owner, regardless of the amount of asset received.
If withdrawFee > 0, withdrawFee of assetsOut is sent to the fee recipient.
emits Withdraw(caller, receiver, asset, owner, assetsOut, sharesIn);
-function redeem(address assetAddr, uint256 sharesIn, address receiver, address owner)
- external
- returns (uint256 assetsOut, uint256 assetFee);
-Parameters
-| Name | Type | Description |
|---|---|---|
assetAddr | address | Asset to redeem. |
sharesIn | uint256 | Amount of vault shares to redeem. |
receiver | address | Address to receive the redeemed assets. |
owner | address | Owner of vault shares. |
Returns
-| Name | Type | Description |
|---|---|---|
assetsOut | uint256 | Amount of asset used for redeem assetsOut. |
assetFee | uint256 | Amount of fees paid in asset. |
withdraw
-This function withdraws assetsOut of assets, regardless of the amount of vault shares required.
If withdrawFee > 0, withdrawFee of assetsOut is sent to the fee recipient.
emits Withdraw(caller, receiver, asset, owner, assetsOut, sharesIn);
-function withdraw(address assetAddr, uint256 assetsOut, address receiver, address owner)
- external
- returns (uint256 sharesIn, uint256 assetFee);
-Parameters
-| Name | Type | Description |
|---|---|---|
assetAddr | address | Asset to withdraw. |
assetsOut | uint256 | Amount of asset desired to withdraw. |
receiver | address | Address to receive the withdrawn assets. |
owner | address | Owner of vault shares. |
Returns
-| Name | Type | Description |
|---|---|---|
sharesIn | uint256 | Amount of vault shares used to withdraw assetsOut of asset. |
assetFee | uint256 | Amount of fees paid in asset. |
getConfig
-Returns the current vault configuration
-function getConfig() external view returns (VaultConfiguration memory config);
-Returns
-| Name | Type | Description |
|---|---|---|
config | VaultConfiguration | Vault configuration struct |
totalAssets
-Returns the total value of all assets in the shares contract in USD WAD precision.
-function totalAssets() external view returns (uint256 result);
-assetList
-Assets array used for iterating through the assets in the shares contract
-function assetList(uint256 index) external view returns (address assetAddr);
-assets
-Returns the asset struct for a given asset
-function assets(address) external view returns (VaultAsset memory asset);
-Parameters
-| Name | Type | Description |
|---|---|---|
<none> | address |
Returns
-| Name | Type | Description |
|---|---|---|
asset | VaultAsset | Asset struct for asset |
assetPrice
-function assetPrice(address assetAddr) external view returns (uint256);
-previewDeposit
-This function is used for previewing the amount of shares minted for assetsIn of asset.
function previewDeposit(address assetAddr, uint256 assetsIn)
- external
- view
- returns (uint256 sharesOut, uint256 assetFee);
-Parameters
-| Name | Type | Description |
|---|---|---|
assetAddr | address | Supported asset address |
assetsIn | uint256 | Amount of asset in. |
Returns
-| Name | Type | Description |
|---|---|---|
sharesOut | uint256 | Amount of vault shares minted. |
assetFee | uint256 | Amount of fees paid in asset. |
previewMint
-This function is used for previewing assetsIn of asset required to mint sharesOut of vault shares.
function previewMint(address assetAddr, uint256 sharesOut) external view returns (uint256 assetsIn, uint256 assetFee);
-Parameters
-| Name | Type | Description |
|---|---|---|
assetAddr | address | Supported asset address |
sharesOut | uint256 | Desired amount of vault shares to mint. |
Returns
-| Name | Type | Description |
|---|---|---|
assetsIn | uint256 | Amount of asset required. |
assetFee | uint256 | Amount of fees paid in asset. |
previewRedeem
-This function is used for previewing assetsOut of asset received for sharesIn of vault shares.
function previewRedeem(address assetAddr, uint256 sharesIn)
- external
- view
- returns (uint256 assetsOut, uint256 assetFee);
-Parameters
-| Name | Type | Description |
|---|---|---|
assetAddr | address | Supported asset address |
sharesIn | uint256 | Desired amount of vault shares to burn. |
Returns
-| Name | Type | Description |
|---|---|---|
assetsOut | uint256 | Amount of asset received. |
assetFee | uint256 | Amount of fees paid in asset. |
previewWithdraw
-This function is used for previewing sharesIn of vault shares required to burn for assetsOut of asset.
function previewWithdraw(address assetAddr, uint256 assetsOut)
- external
- view
- returns (uint256 sharesIn, uint256 assetFee);
-Parameters
-| Name | Type | Description |
|---|---|---|
assetAddr | address | Supported asset address |
assetsOut | uint256 | Desired amount of asset out. |
Returns
-| Name | Type | Description |
|---|---|---|
sharesIn | uint256 | Amount of vault shares required. |
assetFee | uint256 | Amount of fees paid in asset. |
maxDeposit
-Returns the maximum deposit amount of asset
function maxDeposit(address assetAddr) external view returns (uint256 assetsIn);
-Parameters
-| Name | Type | Description |
|---|---|---|
assetAddr | address | Supported asset address |
Returns
-| Name | Type | Description |
|---|---|---|
assetsIn | uint256 | Maximum depositable amount of assets. |
maxMint
-Returns the maximum mint using asset
function maxMint(address assetAddr, address owner) external view returns (uint256 sharesOut);
-Parameters
-| Name | Type | Description |
|---|---|---|
assetAddr | address | Supported asset address. |
owner | address | Owner of assets. |
Returns
-| Name | Type | Description |
|---|---|---|
sharesOut | uint256 | Maximum mint amount. |
maxRedeem
-Returns the maximum redeemable amount for user
function maxRedeem(address assetAddr, address owner) external view returns (uint256 sharesIn);
-Parameters
-| Name | Type | Description |
|---|---|---|
assetAddr | address | Supported asset address. |
owner | address | Owner of vault shares. |
Returns
-| Name | Type | Description |
|---|---|---|
sharesIn | uint256 | Maximum redeemable amount of shares (vault share balance) |
maxWithdraw
-Returns the maximum redeemable amount for user
function maxWithdraw(address assetAddr, address owner) external view returns (uint256 amountOut);
-Parameters
-| Name | Type | Description |
|---|---|---|
assetAddr | address | Supported asset address. |
owner | address | Owner of vault shares. |
Returns
-| Name | Type | Description |
|---|---|---|
amountOut | uint256 | Maximum amount of asset received. |
exchangeRate
-Returns the exchange rate of one vault share to USD.
-function exchangeRate() external view returns (uint256 rate);
-Returns
-| Name | Type | Description |
|---|---|---|
rate | uint256 | Exchange rate of one vault share to USD in wad precision. |
addAsset
-Adds a new asset to the vault
-function addAsset(VaultAsset memory assetConfig) external returns (VaultAsset memory);
-Parameters
-| Name | Type | Description |
|---|---|---|
assetConfig | VaultAsset | Asset to add |
removeAsset
-Removes an asset from the vault
-function removeAsset(address assetAddr) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
assetAddr | address | Asset address to remove emits assetRemoved(asset, block.timestamp); |
setGovernance
-Current governance sets a new governance address
-function setGovernance(address newGovernance) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
newGovernance | address | The new governance address |
setFeeRecipient
-Current governance sets a new fee recipient address
-function setFeeRecipient(address newFeeRecipient) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
newFeeRecipient | address | The new fee recipient address |
setAssetFeed
-Sets a new oracle for a asset
-function setAssetFeed(address assetAddr, address feedAddr, uint24 newStaleTime) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
assetAddr | address | Asset to set the oracle for |
feedAddr | address | Feed to set |
newStaleTime | uint24 | Time in seconds for the feed to be considered stale |
setFeedPricePrecision
-Sets a new oracle decimals
-function setFeedPricePrecision(uint8 newDecimals) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
newDecimals | uint8 | New oracle decimal precision |
setMaxDeposits
-Sets the max deposit amount for a asset
-function setMaxDeposits(address assetAddr, uint248 newMaxDeposits) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
assetAddr | address | Asset to set the max deposits for |
newMaxDeposits | uint248 | Max deposits to set |
setAssetEnabled
-Sets the enabled status for a asset
-function setAssetEnabled(address assetAddr, bool isEnabled) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
assetAddr | address | Asset to set the enabled status for |
isEnabled | bool | Enabled status to set |
setDepositFee
-Sets the deposit fee for a asset
-function setDepositFee(address assetAddr, uint16 newDepositFee) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
assetAddr | address | Asset to set the deposit fee for |
newDepositFee | uint16 | Fee to set |
setWithdrawFee
-Sets the withdraw fee for a asset
-function setWithdrawFee(address assetAddr, uint16 newWithdrawFee) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
assetAddr | address | Asset to set the withdraw fee for |
newWithdrawFee | uint16 | Fee to set |
IVaultExtender
- -Functions
-vaultDeposit
-Deposit tokens to vault for shares and convert them to equal amount of extender token.
-function vaultDeposit(address _assetAddr, uint256 _assets, address _receiver)
- external
- returns (uint256 sharesOut, uint256 assetFee);
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | Supported vault asset address |
_assets | uint256 | amount of _assetAddr to deposit |
_receiver | address | Address receive extender tokens |
Returns
-| Name | Type | Description |
|---|---|---|
sharesOut | uint256 | amount of shares/extender tokens minted |
assetFee | uint256 | amount of _assetAddr vault took as fee |
vaultMint
-Deposit supported vault assets to receive _shares, depositing the shares for equal amount of extender token.
function vaultMint(address _assetAddr, uint256 _shares, address _receiver)
- external
- returns (uint256 assetsIn, uint256 assetFee);
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | Supported vault asset address |
_shares | uint256 | Amount of shares to receive |
_receiver | address | Address receive extender tokens |
Returns
-| Name | Type | Description |
|---|---|---|
assetsIn | uint256 | Amount of assets for _shares |
assetFee | uint256 | Amount of _assetAddr vault took as fee |
vaultWithdraw
-Withdraw supported vault asset, burning extender tokens and withdrawing shares from vault.
-function vaultWithdraw(address _assetAddr, uint256 _assets, address _receiver, address _owner)
- external
- returns (uint256 sharesIn, uint256 assetFee);
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | Supported vault asset address |
_assets | uint256 | amount of _assetAddr to deposit |
_receiver | address | Address receive extender tokens |
_owner | address | Owner of extender tokens |
Returns
-| Name | Type | Description |
|---|---|---|
sharesIn | uint256 | amount of shares/extender tokens burned |
assetFee | uint256 | amount of _assetAddr vault took as fee |
vaultRedeem
-Withdraw supported vault asset for _shares of extender tokens.
Does not return a value
-function vaultRedeem(address _assetAddr, uint256 _shares, address _receiver, address _owner)
- external
- returns (uint256 sharesIn, uint256 assetFee);
-Parameters
-| Name | Type | Description |
|---|---|---|
_assetAddr | address | Token to deposit into vault for shares. |
_shares | uint256 | amount of extender tokens to burn |
_receiver | address | Address to receive assets withdrawn |
_owner | address | Owner of extender tokens |
Returns
-| Name | Type | Description |
|---|---|---|
sharesIn | uint256 | amount of shares/extender tokens minted |
assetFee | uint256 | amount of _assetAddr vault took as fee |
deposit
-Deposit shares for equal amount of extender token.
-Does not return a value
-function deposit(uint256 _shares, address _receiver) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_shares | uint256 | amount of vault shares to deposit |
_receiver | address | address to mint extender tokens to |
withdraw
-Withdraw shares for equal amount of extender token.
-Does not return a value
-function withdraw(uint256 _amount, address _receiver) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_amount | uint256 | amount of vault extender tokens to burn |
_receiver | address | address to send shares to |
withdrawFrom
-Withdraw shares for equal amount of extender token with allowance.
-Does not return a value
-function withdrawFrom(address _from, address _to, uint256 _amount) external;
-Parameters
-| Name | Type | Description |
|---|---|---|
_from | address | address to burn extender tokens from |
_to | address | address to send shares to |
_amount | uint256 | amount to convert |
Events
-Deposit
-event Deposit(address indexed _from, address indexed _to, uint256 _amount);
-Withdraw
-event Withdraw(address indexed _from, address indexed _to, uint256 _amount);
-IVaultRateProvider
- -Author: -Kresko
-Minimal exchange rate interface for vaults.
-Functions
-exchangeRate
-Gets the exchange rate of one vault share to USD.
-function exchangeRate() external view returns (uint256);
-Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 The current exchange rate of the vault share in 18 decimals precision. |
VEvent
- -Events
-Deposit
-Emitted when a deposit/mint is made
-event Deposit(
- address indexed caller, address indexed receiver, address indexed asset, uint256 assetsIn, uint256 sharesOut
-);
-OracleSet
-Emitted when a new oracle is set for an asset
-event OracleSet(address indexed asset, address indexed feed, uint256 staletime, uint256 price, uint256 timestamp);
-AssetAdded
-Emitted when a new asset is added to the shares contract
-event AssetAdded(
- address indexed asset,
- address indexed feed,
- string indexed symbol,
- uint256 staletime,
- uint256 price,
- uint256 depositLimit,
- uint256 timestamp
-);
-AssetRemoved
-Emitted when a previously existing asset is removed from the shares contract
-event AssetRemoved(address indexed asset, uint256 timestamp);
-AssetEnabledChange
-Emitted when the enabled status for asset is changed
-event AssetEnabledChange(address indexed asset, bool enabled, uint256 timestamp);
-Withdraw
-Emitted when a withdraw/redeem is made
-event Withdraw(
- address indexed caller,
- address indexed receiver,
- address indexed asset,
- address owner,
- uint256 assetsOut,
- uint256 sharesIn
-);
-VaultAsset
- -Asset struct for deposit assets in contract
-struct VaultAsset {
- IERC20 token;
- IAggregatorV3 feed;
- uint24 staleTime;
- uint8 decimals;
- uint32 depositFee;
- uint32 withdrawFee;
- uint248 maxDeposits;
- bool enabled;
-}
-VaultConfiguration
- -Vault configuration struct
-struct VaultConfiguration {
- address sequencerUptimeFeed;
- uint96 sequencerGracePeriodTime;
- address governance;
- address feeRecipient;
- uint8 oracleDecimals;
-}
-Vault
- -Inherits: -IVault, ERC20
-Author: -Kresko
-This is derived from ERC4626 standard.
-Users deposit tokens into the vault and receive shares of equal value in return.
-Shares are redeemable for the underlying tokens at any time.
-Price or exchange rate of SHARE/USD is determined by the total value of the underlying tokens in the vault and the share supply.
-State Variables
-_config
-VaultConfiguration internal _config;
-_assets
-mapping(address => VaultAsset) internal _assets;
-assetList
-address[] public assetList;
-Functions
-constructor
-constructor(
- string memory _name,
- string memory _symbol,
- uint8 _decimals,
- uint8 _oracleDecimals,
- address _feeRecipient,
- address _sequencerUptimeFeed
-) ERC20(_name, _symbol, _decimals);
-onlyGovernance
-modifier onlyGovernance();
-check
-modifier check(address assetAddr);
-_checkAssetsIn
-Validate deposits.
-function _checkAssetsIn(address assetAddr, uint256 assetsIn, uint256 sharesOut) private view;
-deposit
-This function deposits assetsIn of asset, regardless of the amount of vault shares minted.
emits Deposit(caller, receiver, asset, assetsIn, sharesOut);
-function deposit(address assetAddr, uint256 assetsIn, address receiver)
- public
- virtual
- check(assetAddr)
- returns (uint256 sharesOut, uint256 assetFee);
-Parameters
-| Name | Type | Description |
|---|---|---|
assetAddr | address | Asset to deposit. |
assetsIn | uint256 | Amount of asset to deposit. |
receiver | address | Address to receive sharesOut of vault shares. |
Returns
-| Name | Type | Description |
|---|---|---|
sharesOut | uint256 | Amount of vault shares minted for assetsIn. |
assetFee | uint256 | Amount of fees paid in asset. |
mint
-This function mints sharesOut of vault shares, regardless of the amount of asset received.
emits Deposit(caller, receiver, asset, assetsIn, sharesOut);
-function mint(address assetAddr, uint256 sharesOut, address receiver)
- public
- virtual
- check(assetAddr)
- returns (uint256 assetsIn, uint256 assetFee);
-Parameters
-| Name | Type | Description |
|---|---|---|
assetAddr | address | Asset to deposit. |
sharesOut | uint256 | Amount of vault shares desired to mint. |
receiver | address | Address to receive sharesOut of shares. |
Returns
-| Name | Type | Description |
|---|---|---|
assetsIn | uint256 | Assets used to mint sharesOut of vault shares. |
assetFee | uint256 | Amount of fees paid in asset. |
redeem
-This function burns sharesIn of shares from owner, regardless of the amount of asset received.
emits Withdraw(caller, receiver, asset, owner, assetsOut, sharesIn);
-function redeem(address assetAddr, uint256 sharesIn, address receiver, address owner)
- public
- virtual
- check(assetAddr)
- returns (uint256 assetsOut, uint256 assetFee);
-Parameters
-| Name | Type | Description |
|---|---|---|
assetAddr | address | Asset to redeem. |
sharesIn | uint256 | Amount of vault shares to redeem. |
receiver | address | Address to receive the redeemed assets. |
owner | address | Owner of vault shares. |
Returns
-| Name | Type | Description |
|---|---|---|
assetsOut | uint256 | Amount of asset used for redeem assetsOut. |
assetFee | uint256 | Amount of fees paid in asset. |
withdraw
-This function withdraws assetsOut of assets, regardless of the amount of vault shares required.
emits Withdraw(caller, receiver, asset, owner, assetsOut, sharesIn);
-function withdraw(address assetAddr, uint256 assetsOut, address receiver, address owner)
- public
- virtual
- check(assetAddr)
- returns (uint256 sharesIn, uint256 assetFee);
-Parameters
-| Name | Type | Description |
|---|---|---|
assetAddr | address | Asset to withdraw. |
assetsOut | uint256 | Amount of asset desired to withdraw. |
receiver | address | Address to receive the withdrawn assets. |
owner | address | Owner of vault shares. |
Returns
-| Name | Type | Description |
|---|---|---|
sharesIn | uint256 | Amount of vault shares used to withdraw assetsOut of asset. |
assetFee | uint256 | Amount of fees paid in asset. |
getConfig
-Returns the current vault configuration
-function getConfig() external view returns (VaultConfiguration memory);
-Returns
-| Name | Type | Description |
|---|---|---|
<none> | VaultConfiguration | config Vault configuration struct |
assets
-Returns the asset struct for a given asset
-function assets(address assetAddr) external view returns (VaultAsset memory);
-Parameters
-| Name | Type | Description |
|---|---|---|
assetAddr | address |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | VaultAsset | asset Asset struct for asset |
assetPrice
-function assetPrice(address assetAddr) external view returns (uint256);
-totalAssets
-Returns the total value of all assets in the shares contract in USD WAD precision.
-function totalAssets() public view virtual returns (uint256 result);
-exchangeRate
-Returns the exchange rate of one vault share to USD.
-function exchangeRate() public view virtual returns (uint256);
-Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | rate Exchange rate of one vault share to USD in wad precision. |
previewDeposit
-This function is used for previewing the amount of shares minted for assetsIn of asset.
function previewDeposit(address assetAddr, uint256 assetsIn)
- public
- view
- virtual
- returns (uint256 sharesOut, uint256 assetFee);
-Parameters
-| Name | Type | Description |
|---|---|---|
assetAddr | address | Supported asset address |
assetsIn | uint256 | Amount of asset in. |
Returns
-| Name | Type | Description |
|---|---|---|
sharesOut | uint256 | Amount of vault shares minted. |
assetFee | uint256 | Amount of fees paid in asset. |
previewMint
-This function is used for previewing assetsIn of asset required to mint sharesOut of vault shares.
function previewMint(address assetAddr, uint256 sharesOut)
- public
- view
- virtual
- returns (uint256 assetsIn, uint256 assetFee);
-Parameters
-| Name | Type | Description |
|---|---|---|
assetAddr | address | Supported asset address |
sharesOut | uint256 | Desired amount of vault shares to mint. |
Returns
-| Name | Type | Description |
|---|---|---|
assetsIn | uint256 | Amount of asset required. |
assetFee | uint256 | Amount of fees paid in asset. |
previewRedeem
-This function is used for previewing assetsOut of asset received for sharesIn of vault shares.
function previewRedeem(address assetAddr, uint256 sharesIn)
- public
- view
- virtual
- returns (uint256 assetsOut, uint256 assetFee);
-Parameters
-| Name | Type | Description |
|---|---|---|
assetAddr | address | Supported asset address |
sharesIn | uint256 | Desired amount of vault shares to burn. |
Returns
-| Name | Type | Description |
|---|---|---|
assetsOut | uint256 | Amount of asset received. |
assetFee | uint256 | Amount of fees paid in asset. |
previewWithdraw
-This function is used for previewing sharesIn of vault shares required to burn for assetsOut of asset.
function previewWithdraw(address assetAddr, uint256 assetsOut)
- public
- view
- virtual
- returns (uint256 sharesIn, uint256 assetFee);
-Parameters
-| Name | Type | Description |
|---|---|---|
assetAddr | address | Supported asset address |
assetsOut | uint256 | Desired amount of asset out. |
Returns
-| Name | Type | Description |
|---|---|---|
sharesIn | uint256 | Amount of vault shares required. |
assetFee | uint256 | Amount of fees paid in asset. |
maxRedeem
-Returns the maximum redeemable amount for user
function maxRedeem(address assetAddr, address owner) public view virtual returns (uint256 max);
-Parameters
-| Name | Type | Description |
|---|---|---|
assetAddr | address | Supported asset address. |
owner | address | Owner of vault shares. |
Returns
-| Name | Type | Description |
|---|---|---|
max | uint256 | sharesIn Maximum redeemable amount of shares (vault share balance) |
maxWithdraw
-Returns the maximum redeemable amount for user
function maxWithdraw(address assetAddr, address owner) external view returns (uint256 max);
-Parameters
-| Name | Type | Description |
|---|---|---|
assetAddr | address | Supported asset address. |
owner | address | Owner of vault shares. |
Returns
-| Name | Type | Description |
|---|---|---|
max | uint256 | amountOut Maximum amount of asset received. |
maxDeposit
-Returns the maximum deposit amount of asset
function maxDeposit(address assetAddr) public view virtual returns (uint256);
-Parameters
-| Name | Type | Description |
|---|---|---|
assetAddr | address | Supported asset address |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | uint256 | assetsIn Maximum depositable amount of assets. |
maxMint
-Returns the maximum mint using asset
function maxMint(address assetAddr, address user) external view virtual returns (uint256 max);
-Parameters
-| Name | Type | Description |
|---|---|---|
assetAddr | address | Supported asset address. |
user | address |
Returns
-| Name | Type | Description |
|---|---|---|
max | uint256 | sharesOut Maximum mint amount. |
setSequencerUptimeFeed
-function setSequencerUptimeFeed(address newFeedAddr, uint96 gracePeriod) external onlyGovernance;
-addAsset
-Adds a new asset to the vault
-function addAsset(VaultAsset memory assetConfig) external onlyGovernance returns (VaultAsset memory);
-Parameters
-| Name | Type | Description |
|---|---|---|
assetConfig | VaultAsset | Asset to add |
removeAsset
-Removes an asset from the vault
-function removeAsset(address assetAddr) external onlyGovernance;
-Parameters
-| Name | Type | Description |
|---|---|---|
assetAddr | address | Asset address to remove emits assetRemoved(asset, block.timestamp); |
setAssetFeed
-Sets a new oracle for a asset
-function setAssetFeed(address assetAddr, address newFeedAddr, uint24 newStaleTime) external onlyGovernance;
-Parameters
-| Name | Type | Description |
|---|---|---|
assetAddr | address | Asset to set the oracle for |
newFeedAddr | address | |
newStaleTime | uint24 | Time in seconds for the feed to be considered stale |
setFeedPricePrecision
-Sets a new oracle decimals
-function setFeedPricePrecision(uint8 newDecimals) external onlyGovernance;
-Parameters
-| Name | Type | Description |
|---|---|---|
newDecimals | uint8 | New oracle decimal precision |
setAssetEnabled
-Sets the enabled status for a asset
-function setAssetEnabled(address assetAddr, bool isEnabled) external onlyGovernance;
-Parameters
-| Name | Type | Description |
|---|---|---|
assetAddr | address | Asset to set the enabled status for |
isEnabled | bool | Enabled status to set |
setDepositFee
-Sets the deposit fee for a asset
-function setDepositFee(address assetAddr, uint16 newDepositFee) external onlyGovernance;
-Parameters
-| Name | Type | Description |
|---|---|---|
assetAddr | address | Asset to set the deposit fee for |
newDepositFee | uint16 | Fee to set |
setWithdrawFee
-Sets the withdraw fee for a asset
-function setWithdrawFee(address assetAddr, uint16 newWithdrawFee) external onlyGovernance;
-Parameters
-| Name | Type | Description |
|---|---|---|
assetAddr | address | Asset to set the withdraw fee for |
newWithdrawFee | uint16 | Fee to set |
setMaxDeposits
-Sets the max deposit amount for a asset
-function setMaxDeposits(address assetAddr, uint248 newMaxDeposits) external onlyGovernance;
-Parameters
-| Name | Type | Description |
|---|---|---|
assetAddr | address | Asset to set the max deposits for |
newMaxDeposits | uint248 | Max deposits to set |
setGovernance
-Current governance sets a new governance address
-function setGovernance(address newGovernance) external onlyGovernance;
-Parameters
-| Name | Type | Description |
|---|---|---|
newGovernance | address | The new governance address |
setFeeRecipient
-Current governance sets a new fee recipient address
-function setFeeRecipient(address newFeeRecipient) external onlyGovernance;
-Parameters
-| Name | Type | Description |
|---|---|---|
newFeeRecipient | address | The new fee recipient address |
Contents
--
-
- IERC165 -
IERC165
- -Functions
-supportsInterface
-Query if a contract implements an interface
-Interface identification is specified in ERC-165. This function -uses less than 30,000 gas.
-function supportsInterface(bytes4 interfaceId) external view returns (bool);
-Parameters
-| Name | Type | Description |
|---|---|---|
interfaceId | bytes4 | The interface identifier, as specified in ERC-165 |
Returns
-| Name | Type | Description |
|---|---|---|
<none> | bool | true if the contract implements interfaceID and interfaceID is not 0xffffffff, false otherwise |