package
0.12.4
Repository: https://github.com/mokitanetwork/aether.git
Documentation: pkg.go.dev

# Functions

CdpKey key of a specific cdp in the store.
CollateralRatioBytes returns the liquidation ratio as sortable bytes.
CollateralRatioIterKey returns the key for iterating over cdps by denom and liquidation ratio.
CollateralRatioKey returns the key for querying a cdp by its liquidation ratio.
DefaultGenesisState returns a default genesis state.
DefaultParams returns default params for cdp module.
DenomIterKey returns the key for iterating over cdps of a certain denom in the store.
DepositIterKey returns the prefix key for iterating over deposits to a cdp.
DepositKey key of a specific deposit in the store.
GetCdpIDBytes returns the byte representation of the cdpID.
GetCdpIDFromBytes returns cdpID in uint64 format from a byte array.
NewAugmentedCDP creates a new AugmentedCDP object.
NewCDP creates a new CDP object.
NewCDPResponse creates a new CDPResponse object.
NewCDPWithFees creates a new CDP object, for use during migration.
NewCollateralParam returns a new CollateralParam.
NewDebtParam returns a new DebtParam.
NewDeposit creates a new Deposit object.
NewGenesisAccumulationTime returns a new GenesisAccumulationTime.
NewGenesisState returns a new genesis state.
NewGenesisTotalPrincipal returns a new GenesisTotalPrincipal.
No description provided by the author
NewMsgCreateCDP returns a new MsgPlaceBid.
NewMsgDeposit returns a new MsgDeposit.
NewMsgDrawDebt returns a new MsgDrawDebt.
NewMsgLiquidate returns a new MsgLiquidate.
NewMsgRepayDebt returns a new MsgRepayDebt.
NewMsgWithdraw returns a new MsgDeposit.
NewMultiCDPHooks returns a new MultiCDPHooks.
NewParams returns a new params object.
NewQueryCdpDeposits returns QueryCdpDeposits.
NewQueryCdpParams returns QueryCdpParams.
NewQueryCdpsByCollateralTypeParams returns QueryCdpsByCollateralTypeParams.
NewQueryCdpsByRatioParams returns QueryCdpsByRatioParams.
NewQueryCdpsParams creates a new QueryCdpsParams.
No description provided by the author
NewQueryGetTotalCollateralParams returns QueryGetTotalCollateralParams.
NewQueryGetTotalPrincipalParams returns QueryGetTotalPrincipalParams.
TotalCollateral returns a new TotalCollateral.
TotalPrincipal returns a new TotalPrincipal.
ParamKeyTable Key declaration for parameters.
ParseDecBytes parses a []byte encoded using SortableDecBytes back to sdk.Dec.
No description provided by the author
RegisterLegacyAminoCodec registers all the necessary types and interfaces for the governance module.
No description provided by the author
RegisterQueryHandler registers the http handlers for service Query to "mux".
RegisterQueryHandlerClient registers the http handlers for service Query to "mux".
RegisterQueryHandlerFromEndpoint is same as RegisterQueryHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
RegisterQueryHandlerServer registers the http handlers for service Query to "mux".
No description provided by the author
RelativePow raises x to the power of n, where x (and the result, z) are scaled by factor b.
SortableDecBytes returns a byte slice representation of a Dec that can be sorted.
SplitCdpKey returns the component parts of a cdp key.
SplitCollateralRatioIterKey split the collateral ratio key and return the denom, cdp id, and collateral:debt ratio.
SplitCollateralRatioKey split the collateral ratio key and return the denom, cdp id, and collateral:debt ratio.
SplitDenomIterKey returns the component part of a key for iterating over cdps by denom.
SplitDepositIterKey returns the component parts of a key for iterating over deposits on a cdp.
SplitDepositKey returns the component parts of a deposit key.
ValidSortableDec sdk.Dec can't have precision of less than 10^-18.

# Constants

Event types for cdp module.
Event types for cdp module.
Event types for cdp module.
Event types for cdp module.
DefaultParamspace default name for parameter store.
Event types for cdp module.
Event types for cdp module.
Event types for cdp module.
Event types for cdp module.
Event types for cdp module.
Event types for cdp module.
Event types for cdp module.
Event types for cdp module.
LiquidatorMacc module account for liquidator.
ModuleName The name that will be used throughout the module.
QuerierRoute Top level query string.
Querier routes for the cdp module.
Querier routes for the cdp module.
Querier routes for the cdp module.
Querier routes for the cdp module.
legacy query, maintained for REST API.
legacy query, maintained for REST API.
Querier routes for the cdp module.
Querier routes for the cdp module.
Querier routes for the cdp module.
Querier routes for the cdp module.
Querier routes for the cdp module.
Querier routes for the cdp module.
RouterKey Top level router key.
StoreKey Top level store key where all module items will be stored.

# Variables

KVStore key prefixes.
KVStore key prefixes.
KVStore key prefixes.
KVStore key prefixes.
KVStore key prefixes.
Parameter keys.
Parameter keys.
Parameter keys.
Parameter keys.
Parameter keys.
Parameter keys.
Parameter keys.
Parameter keys.
Parameter keys.
Parameter keys.
Parameter keys.
Parameter keys.
KVStore key prefixes.
ErrAccountNotFound error for when no account is found for an input address.
ErrBelowDebtFloor error for creating a cdp with debt below the minimum.
ErrCdpAlreadyExists error for duplicate cdps.
ErrCdpNotAvailable error for depositing to a CDP in liquidation.
ErrCdpNotFound error cdp not found.
ErrCollateralNotSupported error for unsupported collateral.
ErrDebtNotSupported error for unsupported debt.
ErrDenomPrefixNotFound error for denom prefix not found.
ErrDepositNotAvailable error for withdrawing deposits in liquidation.
ErrDepositNotFound error for deposit not found.
ErrExceedsDebtLimit error for attempted draws that exceed debt limit.
ErrInsufficientBalance error for when an account does not have enough funds.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ErrInvalidCollateral error for when the input collateral denom does not match the expected collateral denom.
ErrInvalidCollateralLength error for invalid collateral input length.
ErrInvalidCollateralRatio error for attempted draws that are below liquidation ratio.
ErrInvalidDebtRequest error for invalid principal input length.
ErrInvalidDeposit error for invalid deposit.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ErrInvalidPayment error for invalid payment.
ErrInvalidWithdrawAmount error for invalid withdrawal amount.
ErrLoadingAugmentedCDP error loading augmented cdp.
ErrNotLiquidatable error for when an cdp is not liquidatable.
ErrPricefeedDown error for when a price for the input denom is not found.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
KVStore key prefixes.
KVStore key prefixes.
Parameter keys.
Parameter keys.
Parameter keys.
Parameter keys.
Parameter keys.
Parameter keys.
Parameter keys.
Parameter keys.
MaxSortableDec largest sortable sdk.Dec.
No description provided by the author
KVStore key prefixes.
KVStore key prefixes.
KVStore key prefixes.

# Structs

AugmentedCDP provides additional information about an active CDP.
CDP defines the state of a single collateralized debt position.
CDPResponse defines the state of a single collateralized debt position.
CollateralParam defines governance parameters for each collateral type within the cdp module.
DebtParam defines governance params for debt assets.
Deposit defines an amount of coins deposited by an account to a cdp.
GenesisAccumulationTime defines the previous distribution time and its corresponding denom.
GenesisState defines the cdp module's genesis state.
GenesisTotalPrincipal defines the total principal and its corresponding collateral type.
MsgCreateCDP defines a message to create a new CDP.
MsgCreateCDPResponse defines the Msg/CreateCDP response type.
MsgDeposit defines a message to deposit to a CDP.
MsgDepositResponse defines the Msg/Deposit response type.
MsgDrawDebt defines a message to draw debt from a CDP.
MsgDrawDebtResponse defines the Msg/DrawDebt response type.
MsgLiquidate defines a message to attempt to liquidate a CDP whos collateralization ratio is under its liquidation ratio.
MsgLiquidateResponse defines the Msg/Liquidate response type.
MsgRepayDebt defines a message to repay debt from a CDP.
MsgRepayDebtResponse defines the Msg/RepayDebt response type.
MsgWithdraw defines a message to withdraw collateral from a CDP.
MsgWithdrawResponse defines the Msg/Withdraw response type.
OwnerCDPIndex defines the cdp ids for a single cdp owner.
Params defines the parameters for the cdp module.
QueryAccountsRequest defines the request type for the Query/Accounts RPC method.
QueryAccountsResponse defines the response type for the Query/Accounts RPC method.
QueryCdpDeposits params for query /cdp/deposits.
QueryCdpParams params for query /cdp/cdp.
QueryCdpRequest defines the request type for the Query/Cdp RPC method.
QueryCdpResponse defines the response type for the Query/Cdp RPC method.
QueryCdpsByCollateralTypeParams params for query /cdp/cdps/{denom}.
QueryCdpsByRatioParams params for query /cdp/cdps/ratio.
QueryCdpsParams is the params for a filtered CDP query.
QueryCdpsRequest is the params for a filtered CDP query, the request type for the Query/Cdps RPC method.
QueryCdpsResponse defines the response type for the Query/Cdps RPC method.
QueryDepositsRequest defines the request type for the Query/Deposits RPC method.
QueryDepositsResponse defines the response type for the Query/Deposits RPC method.
QueryGetTotalCollateralParams params for query /cdp/totalCollateral.
QueryGetTotalPrincipalParams params for query /cdp/totalPrincipal.
QueryParamsRequest defines the request type for the Query/Params RPC method.
QueryParamsResponse defines the response type for the Query/Params RPC method.
QueryTotalCollateralRequest defines the request type for the Query/TotalCollateral RPC method.
QueryTotalCollateralResponse defines the response type for the Query/TotalCollateral RPC method.
QueryTotalPrincipalRequest defines the request type for the Query/TotalPrincipal RPC method.
QueryTotalPrincipalResponse defines the response type for the Query/TotalPrincipal RPC method.
TotalCollateral defines the total collateral of a given collateral type.
TotalPrincipal defines the total principal of a given collateral type.
UnimplementedMsgServer can be embedded to have forward compatible implementations.
UnimplementedQueryServer can be embedded to have forward compatible implementations.

# Interfaces

AccountKeeper expected interface for the account keeper.
AuctionKeeper expected interface for the auction keeper.
BankKeeper defines the expected bank keeper for module accounts.
CDPHooks event hooks for other keepers to run code in response to CDP modifications.
MsgClient is the client API for Msg service.
MsgServer is the server API for Msg service.
PricefeedKeeper defines the expected interface for the pricefeed.
QueryClient is the client API for Query service.
QueryServer is the server API for Query service.

# Type aliases

AugmentedCDPs a collection of AugmentedCDP objects.
CDPResponses a collection of CDPResponse objects.
CDPs a collection of CDP objects.
CollateralParams array of CollateralParam.
DebtParams array of DebtParam.
Deposits a collection of Deposit objects.
GenesisAccumulationTimes slice of GenesisAccumulationTime.
GenesisTotalPrincipals slice of GenesisTotalPrincipal.
MultiCDPHooks combine multiple cdp hooks, all hook functions are run in array sequence.
TotalCollaterals a collection of TotalCollateral objects.
TotalPrincipals a collection of TotalPrincipal objects.