mirror of
				https://github.com/0glabs/0g-chain.git
				synced 2025-11-04 15:37:27 +00:00 
			
		
		
		
	* Add 'InterestFactor' to CDP type (#734) * update cdp type to include interest factor * fix build * Add cdp accumulator methods (#735) * remame fees to interest * add accumulate interest method * add basic test * add note * address review comments * update tests * Add sync cdp interest method (#737) * remame fees to interest * add accumulate interest method * add basic test * add note * address review comments * update tests * remove old fee functions * add method to synchronize cdp interest * add multi-cdp tests * add test with many blocks * add test for interest getter * address review comments * calculate time difference then convert to seconds * fix: update collateral index when syncing interest * fix: differentiate between case when apy is zero and all fees are being rounded to zero * fix: round time difference properly * update cdp genesis state and migrations (#738) * remame fees to interest * add accumulate interest method * add basic test * add note * address review comments * update tests * remove old fee functions * add method to synchronize cdp interest * add multi-cdp tests * add test with many blocks * add test for interest getter * update cdp genesis state and migrations * address review comments * calculate time difference then convert to seconds * fix: update collateral index when syncing interest * fix: differentiate between case when apy is zero and all fees are being rounded to zero * fix: simplify add/remove/update collateral index * update genesis state to include total principal amounts * update migration * Delete kava-4-cdp-state-block-500000.json * Add cdp liquidations by external keeper (#750) * feat: split liquidations between external keepers and automated begin blocker * address review comments * USDX incentive accumulators (#752) * feat: split liquidations between external keepers and automated begin blocker * wip: refactor usdx minting incentives to use accumulators/hooks * wip: refactor usdx minting claim object * feat: use accumulators/hooks for usdx minting rewards * fix: get tests passing * fix: don't create claim objects unless that cdp type is eligable for rewards * add begin blocker * update client * cleanup comments/tests * update querier * address review comments * fix: check for division by zero * address review comments * run hook before interest is synced * Remove savings rate (#764) * remove savings rate * remove savings rate from debt param * update migrations * address review comments * Add usdx incentives calculation test (#765) * add usdx incentive calculation test * update reward calculation * add allowable error to test criteria * Update x/incentive/keeper/rewards_test.go Co-authored-by: Kevin Davis <karzak@users.noreply.github.com> * fix: remove old fields from test genesis state Co-authored-by: Ruaridh <rhuairahrighairidh@users.noreply.github.com> Co-authored-by: Ruaridh <rhuairahrighairidh@users.noreply.github.com>
		
			
				
	
	
		
			79 lines
		
	
	
		
			2.4 KiB
		
	
	
	
		
			Markdown
		
	
	
	
	
	
			
		
		
	
	
			79 lines
		
	
	
		
			2.4 KiB
		
	
	
	
		
			Markdown
		
	
	
	
	
	
<!--
 | 
						|
order: 2
 | 
						|
-->
 | 
						|
 | 
						|
# State
 | 
						|
 | 
						|
For detail on the state tracked by the cdp module see the types package. In particular [keys.go](../types/keys.go) describes how state is stored in the key-value store.
 | 
						|
 | 
						|
## Module Accounts
 | 
						|
 | 
						|
The cdp module account controls two module accounts:
 | 
						|
 | 
						|
**CDP Account:** Stores the deposited cdp collateral, and the debt coins for the debt in all the cdps.
 | 
						|
 | 
						|
**Liquidator Account:** Stores debt coins that have been seized by the system, and any stable asset that has been raised through auctions.
 | 
						|
 | 
						|
## CDP
 | 
						|
 | 
						|
A CDP is a struct representing a debt position owned by one address. It has one collateral type and records the debt that has been drawn and how much fees should be repaid.
 | 
						|
 | 
						|
Only an owner is authorized to draw or repay debt, but anyone can deposit collateral to a CDP. Deposits are scoped per address and are recorded separately in `Deposit` types. Depositors are free to withdraw their collateral provided it does not put the CDP below the liquidation ratio.
 | 
						|
 | 
						|
The CDP's collateral always equal to the total of the deposits.
 | 
						|
 | 
						|
```go
 | 
						|
type CDP struct {
 | 
						|
    ID              uint64
 | 
						|
    Owner           sdk.AccAddress
 | 
						|
    Type            string
 | 
						|
    Collateral      sdk.Coin
 | 
						|
    Principal       sdk.Coin
 | 
						|
    AccumulatedFees sdk.Coin
 | 
						|
    FeesUpdated     time.Time
 | 
						|
    InterestFactor  sdk.Dec
 | 
						|
}
 | 
						|
```
 | 
						|
 | 
						|
CDPs are stored with three database indexes for faster lookup:
 | 
						|
 | 
						|
- by collateral ratio - to look up cdps that are close to the liquidation ratio
 | 
						|
- by collateral denom - to look up cdps with a particular collateral asset
 | 
						|
- by owner index - to look up cdps that an address is the owner of
 | 
						|
 | 
						|
## Deposit
 | 
						|
 | 
						|
A Deposit is a struct recording collateral added to a CDP by one address. The address only has authorization to change their deposited amount (provided it does not put the CDP below the liquidation ratio).
 | 
						|
 | 
						|
```go
 | 
						|
type Deposit struct {
 | 
						|
    CdpID         uint64
 | 
						|
    Depositor     sdk.AccAddress
 | 
						|
    Amount        sdk.Coin
 | 
						|
}
 | 
						|
```
 | 
						|
 | 
						|
## Params
 | 
						|
 | 
						|
Module parameters controlled by governance. See [Parameters](04_params.md) for details.
 | 
						|
 | 
						|
## NextCDPID
 | 
						|
 | 
						|
A global counter used to create unique CDP ids.
 | 
						|
 | 
						|
## DebtDenom
 | 
						|
 | 
						|
The name of the internal debt coin. Its value can be configured at genesis.
 | 
						|
 | 
						|
## GovDenom
 | 
						|
 | 
						|
The name of the internal governance coin. Its value can be configured at genesis.
 | 
						|
 | 
						|
## Total Principle
 | 
						|
 | 
						|
Sum of all non seized debt plus accumulated fees.
 | 
						|
 | 
						|
## Previous Savings Distribution Time
 | 
						|
 | 
						|
A record of the last block time when the savings rate was distributed
 |