Skip to main content

Smart Contracts

Account Module​

Functions​

getAccountPermissions​

function getAccountPermissions(uint128 accountId) external view returns (struct IAccountModule.AccountPermissions[])

Returns an array of AccountPermission for the provided accountId.

| Name | Type | Description | |accountId|uint128|The id of the account whose permissions are being retrieved.|

| Name | Type | Description | |[0]|struct IAccountModule.AccountPermissions[]|An array of AccountPermission objects describing the permissions granted to the account.|

createAccount​

function createAccount(uint128 requestedAccountId) external

Mints an account token with id requestedAccountId to msg.sender.

| Name | Type | Description | |requestedAccountId|uint128|The id requested for the account being created. Reverts if id already exists. Requirements: - requestedAccountId must not already be minted. Emits a {AccountCreated} event.|

notifyAccountTransfer​

function notifyAccountTransfer(address to, uint128 accountId) external

Called by AccountTokenModule to notify the system when the account token is transferred.

Resets user permissions and assigns ownership of the account token to the new holder.

| Name | Type | Description | |to|address|The new holder of the account NFT.| |accountId|uint128|The id of the account that was just transferred. Requirements: - msg.sender must be the account token.|

grantPermission​

function grantPermission(uint128 accountId, bytes32 permission, address user) external

Grants permission to user for account accountId.

| Name | Type | Description | |accountId|uint128|The id of the account that granted the permission.| |permission|bytes32|The bytes32 identifier of the permission.| |user|address|The target address that received the permission. Requirements: - msg.sender must own the account token with ID accountId or have the "admin" permission. Emits a {PermissionGranted} event.|

revokePermission​

function revokePermission(uint128 accountId, bytes32 permission, address user) external

Revokes permission from user for account accountId.

| Name | Type | Description | |accountId|uint128|The id of the account that revoked the permission.| |permission|bytes32|The bytes32 identifier of the permission.| |user|address|The target address that no longer has the permission. Requirements: - msg.sender must own the account token with ID accountId or have the "admin" permission. Emits a {PermissionRevoked} event.|

renouncePermission​

function renouncePermission(uint128 accountId, bytes32 permission) external

Revokes permission from msg.sender for account accountId.

| Name | Type | Description | |accountId|uint128|The id of the account whose permission was renounced.| |permission|bytes32|The bytes32 identifier of the permission. Emits a {PermissionRevoked} event.|

hasPermission​

function hasPermission(uint128 accountId, bytes32 permission, address user) external view returns (bool)

Returns true if user has been granted permission for account accountId.

| Name | Type | Description | |accountId|uint128|The id of the account whose permission is being queried.| |permission|bytes32|The bytes32 identifier of the permission.| |user|address|The target address whose permission is being queried.|

| Name | Type | Description | |[0]|bool|A boolean with the response of the query.|

isAuthorized​

function isAuthorized(uint128 accountId, bytes32 permission, address target) external view returns (bool)

Returns true if target is authorized to permission for account accountId.

| Name | Type | Description | |accountId|uint128|The id of the account whose permission is being queried.| |permission|bytes32|The bytes32 identifier of the permission.| |target|address|The target address whose permission is being queried.|

| Name | Type | Description | |[0]|bool|A boolean with the response of the query.|

getAccountTokenAddress​

function getAccountTokenAddress() external view returns (address)

Returns the address for the account token used by the module.

| Name | Type | Description | |[0]|address|The address of the account token.|

getAccountOwner​

function getAccountOwner(uint128 accountId) external view returns (address)

Returns the address that owns a given account, as recorded by the system.

| Name | Type | Description | |accountId|uint128|The account id whose owner is being retrieved.|

| Name | Type | Description | |[0]|address|The owner of the given account id.|

Events​

AccountCreated​

event AccountCreated(uint128 accountId, address owner)

Emitted when an account token with id accountId is minted to sender.

| Name | Type | Description | |accountId|uint128|The id of the account.| |owner|address|The address that owns the created account.|

PermissionGranted​

event PermissionGranted(uint128 accountId, bytes32 permission, address user, address sender)

Emitted when user is granted permission by sender for account accountId.

| Name | Type | Description | |accountId|uint128|The id of the account that granted the permission.| |permission|bytes32|The bytes32 identifier of the permission.| |user|address|The target address to whom the permission was granted.| |sender|address|The Address that granted the permission.|

PermissionRevoked​

event PermissionRevoked(uint128 accountId, bytes32 permission, address user, address sender)

Emitted when user has permission renounced or revoked by sender for account accountId.

| Name | Type | Description | |accountId|uint128|The id of the account that has had the permission revoked.| |permission|bytes32|The bytes32 identifier of the permission.| |user|address|The target address for which the permission was revoked.| |sender|address|The address that revoked the permission.|

Account Token Module​

Functions​

isInitialized​

function isInitialized() external returns (bool)

Returns wether the token has been initialized.

| Name | Type | Description | |[0]|bool|A boolean with the result of the query.|

initialize​

function initialize(string tokenName, string tokenSymbol, string uri) external

Initializes the token with name, symbol, and uri.

mint​

function mint(address to, uint256 tokenId) external

Allows the owner to mint tokens.

| Name | Type | Description | |to|address|The address to receive the newly minted tokens.| |tokenId|uint256|The ID of the newly minted token|

burn​

function burn(uint256 tokenId) external

Allows the owner to burn tokens.

| Name | Type | Description | |tokenId|uint256|The token to burn|

setAllowance​

function setAllowance(uint256 tokenId, address spender) external

Allows an address that holds tokens to provide allowance to another.

| Name | Type | Description | |tokenId|uint256|The token which should be allowed to spender| |spender|address|The address that is given allowance.|

totalSupply​

function totalSupply() external view returns (uint256)

Returns the total amount of tokens stored by the contract.

tokenOfOwnerByIndex​

function tokenOfOwnerByIndex(address owner, uint256 index) external view returns (uint256)

Returns a token ID owned by owner at a given index of its token list. Use along with {balanceOf} to enumerate all of owner's tokens.

Requirements:

  • owner must be a valid address
  • index must be less than the balance of the tokens for the owner

tokenByIndex​

function tokenByIndex(uint256 index) external view returns (uint256)

Returns a token ID at a given index of all the tokens stored by the contract. Use along with {totalSupply} to enumerate all tokens.

Requirements:

  • index must be less than the total supply of the tokens

balanceOf​

function balanceOf(address owner) external view returns (uint256 balance)

Returns the number of tokens in owner's account.

Requirements:

  • owner must be a valid address

ownerOf​

function ownerOf(uint256 tokenId) external view returns (address owner)

Returns the owner of the tokenId token.

Requirements:

  • tokenId must exist.

safeTransferFrom​

function safeTransferFrom(address from, address to, uint256 tokenId, bytes data) external

Safely transfers tokenId token from from to to.

Requirements:

  • from cannot be the zero address.
  • to cannot be the zero address.
  • tokenId token must exist and be owned by from.
  • If the caller is not from, it must be approved to move this token by either {approve} or {setApprovalForAll}.
  • If to refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer.

Emits a {Transfer} event.

safeTransferFrom​

function safeTransferFrom(address from, address to, uint256 tokenId) external

Safely transfers tokenId token from from to to, checking first that contract recipients are aware of the ERC721 protocol to prevent tokens from being forever locked.

Requirements:

  • from cannot be the zero address.
  • to cannot be the zero address.
  • tokenId token must exist and be owned by from.
  • If the caller is not from, it must have been allowed to move this token by either {approve} or {setApprovalForAll}.
  • If to refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer.

Emits a {Transfer} event.

transferFrom​

function transferFrom(address from, address to, uint256 tokenId) external

Transfers tokenId token from from to to.

WARNING: Usage of this method is discouraged, use {safeTransferFrom} whenever possible.

Requirements:

  • from cannot be the zero address.
  • to cannot be the zero address.
  • tokenId token must be owned by from.
  • If the caller is not from, it must be approved to move this token by either {approve} or {setApprovalForAll}.

Emits a {Transfer} event.

approve​

function approve(address to, uint256 tokenId) external

Gives permission to to to transfer tokenId token to another account. The approval is cleared when the token is transferred.

Only a single account can be approved at a time, so approving the zero address clears previous approvals.

Requirements:

  • The caller must own the token or be an approved operator.
  • tokenId must exist.

Emits an {Approval} event.

setApprovalForAll​

function setApprovalForAll(address operator, bool approved) external

Approve or remove operator as an operator for the caller. Operators can call {transferFrom} or {safeTransferFrom} for any token owned by the caller.

Requirements:

  • The operator cannot be the caller.

Emits an {ApprovalForAll} event.

getApproved​

function getApproved(uint256 tokenId) external view returns (address operator)

Returns the account approved for tokenId token.

Requirements:

  • tokenId must exist.

isApprovedForAll​

function isApprovedForAll(address owner, address operator) external view returns (bool)

Returns if the operator is allowed to manage all of the assets of owner.

See {setApprovalForAll}

Events​

Transfer​

event Transfer(address from, address to, uint256 tokenId)

Emitted when tokenId token is transferred from from to to.

Approval​

event Approval(address owner, address approved, uint256 tokenId)

Emitted when owner enables approved to manage the tokenId token.

ApprovalForAll​

event ApprovalForAll(address owner, address operator, bool approved)

Emitted when owner enables or disables (approved) operator to manage all of its assets.

Associate Debt Module​

Functions​

associateDebt​

function associateDebt(uint128 marketId, uint128 poolId, address collateralType, uint128 accountId, uint256 amount) external returns (int256)

Allows a market to associate debt with a specific position.

| Name | Type | Description | |marketId|uint128|The id of the market to which debt was associated.| |poolId|uint128|The id of the pool associated to the target market.| |collateralType|address|The address of the collateral type that acts as collateral in the corresponding pool.| |accountId|uint128|The id of the account whose debt is being associated.| |amount|uint256|The amount of debt being associated with the specified account, denominated with 18 decimals of precision.|

| Name | Type | Description | |[0]|int256|The updated debt of the position, denominated with 18 decimals of precision.|

Events​

DebtAssociated​

event DebtAssociated(uint128 marketId, uint128 poolId, address collateralType, uint128 accountId, uint256 amount, int256 updatedDebt)

Emitted when associateDebt is called.

| Name | Type | Description | |marketId|uint128|The id of the market to which debt was associated.| |poolId|uint128|The id of the pool associated to the target market.| |collateralType|address|The address of the collateral type that acts as collateral in the corresponding pool.| |accountId|uint128|The id of the account whose debt is being associated.| |amount|uint256|The amount of debt being associated with the specified account, denominated with 18 decimals of precision.| |updatedDebt|int256|The total updated debt of the account, denominated with 18 decimals of precision|

IssueUSD Module​

Functions​

mintUsd​

function mintUsd(uint128 accountId, uint128 poolId, address collateralType, uint256 amount) external

Mints {amount} of snxUSD with the specified liquidity position.

| Name | Type | Description | |accountId|uint128|The id of the account that is minting snxUSD.| |poolId|uint128|The id of the pool whose collateral will be used to back up the mint.| |collateralType|address|The address of the collateral that will be used to back up the mint.| |amount|uint256|The amount of snxUSD to be minted, denominated with 18 decimals of precision. Requirements: - msg.sender must be the owner of the account, have the ADMIN permission, or have the MINT permission. - After minting, the collateralization ratio of the liquidity position must not be below the target collateralization ratio for the corresponding collateral type. Emits a {UsdMinted} event.|

burnUsd​

function burnUsd(uint128 accountId, uint128 poolId, address collateralType, uint256 amount) external

Burns {amount} of snxUSD with the specified liquidity position.

| Name | Type | Description | |accountId|uint128|The id of the account that is burning snxUSD.| |poolId|uint128|The id of the pool whose collateral was used to back up the snxUSD.| |collateralType|address|The address of the collateral that was used to back up the snxUSD.| |amount|uint256|The amount of snxUSD to be burnt, denominated with 18 decimals of precision. Emits a {UsdMinted} event.|

Events​

UsdMinted​

event UsdMinted(uint128 accountId, uint128 poolId, address collateralType, uint256 amount, address sender)

Emitted when {sender} mints {amount} of snxUSD with the specified liquidity position.

| Name | Type | Description | |accountId|uint128|The id of the account for which snxUSD was emitted.| |poolId|uint128|The id of the pool whose collateral was used to emit the snxUSD.| |collateralType|address|The address of the collateral that is backing up the emitted snxUSD.| |amount|uint256|The amount of snxUSD emitted, denominated with 18 decimals of precision.| |sender|address|The address that triggered the operation.|

UsdBurned​

event UsdBurned(uint128 accountId, uint128 poolId, address collateralType, uint256 amount, address sender)

Emitted when {sender} burns {amount} of snxUSD with the specified liquidity position.

| Name | Type | Description | |accountId|uint128|The id of the account for which snxUSD was burned.| |poolId|uint128|The id of the pool whose collateral was used to emit the snxUSD.| |collateralType|address|The address of the collateral that was backing up the emitted snxUSD.| |amount|uint256|The amount of snxUSD burned, denominated with 18 decimals of precision.| |sender|address|The address that triggered the operation.|

Liquidation Module​

Functions​

liquidate​

function liquidate(uint128 accountId, uint128 poolId, address collateralType, uint128 liquidateAsAccountId) external returns (struct ILiquidationModule.LiquidationData)

Liquidates a position by distributing its debt and collateral among other positions in its vault.

| Name | Type | Description | |accountId|uint128|The id of the account whose position is to be liquidated.| |poolId|uint128|The id of the pool which holds the position that is to be liquidated.| |collateralType|address|The address of the collateral being used in the position that is to be liquidated.| |liquidateAsAccountId|uint128|Account id that will receive the rewards from the liquidation.|

| Name | Type | Description | |[0]|struct ILiquidationModule.LiquidationData|Information about the position that was liquidated.|

liquidateVault​

function liquidateVault(uint128 poolId, address collateralType, uint128 liquidateAsAccountId, uint256 maxUsd) external returns (struct ILiquidationModule.LiquidationData liquidationData)

Liquidates an entire vault.

Can only be done if the vault itself is under collateralized. LiquidateAsAccountId determines which account to deposit the seized collateral into (this is necessary particularly if the collateral in the vault is vesting). Will only liquidate a portion of the debt for the vault if maxUsd is supplied.

| Name | Type | Description | |poolId|uint128|The id of the pool whose vault is being liquidated.| |collateralType|address|The address of the collateral whose vault is being liquidated.| |liquidateAsAccountId|uint128|| |maxUsd|uint256|The maximum amount of USD that the liquidator is willing to provide for the liquidation, denominated with 18 decimals of precision.|

| Name | Type | Description | |liquidationData|struct ILiquidationModule.LiquidationData|Information about the vault that was liquidated.|

isPositionLiquidatable​

function isPositionLiquidatable(uint128 accountId, uint128 poolId, address collateralType) external returns (bool)

Determines whether a specified position is liquidatable.

| Name | Type | Description | |accountId|uint128|The id of the account whose position is being queried for liquidation.| |poolId|uint128|The id of the pool whose position is being queried for liquidation.| |collateralType|address|The address of the collateral backing up the position being queried for liquidation.|

| Name | Type | Description | |[0]|bool|A boolean with the response to the query.|

isVaultLiquidatable​

function isVaultLiquidatable(uint128 poolId, address collateralType) external returns (bool)

Determines whether a specified vault is liquidatable.

| Name | Type | Description | |poolId|uint128|The id of the pool that owns the vault that is being queried for liquidation.| |collateralType|address|The address of the collateral being held at the vault that is being queried for liquidation.|

| Name | Type | Description | |[0]|bool|A boolean with the response to the query.|

Events​

Liquidation​

event Liquidation(uint128 accountId, uint128 poolId, address collateralType, struct ILiquidationModule.LiquidationData liquidationData, uint128 liquidateAsAccountId, address sender)

Emitted when an account is liquidated.

| Name | Type | Description | |accountId|uint128|The id of the account that was liquidated.| |poolId|uint128|The pool id of the position that was liquidated.| |collateralType|address|The collateral type used in the position that was liquidated.| |liquidationData|struct ILiquidationModule.LiquidationData|The amount of collateral liquidated, debt liquidated, and collateral awarded to the liquidator.| |liquidateAsAccountId|uint128|Account id that will receive the rewards from the liquidation.| |sender|address|The address of the account that is triggering the liquidation.|

VaultLiquidation​

event VaultLiquidation(uint128 poolId, address collateralType, struct ILiquidationModule.LiquidationData liquidationData, uint128 liquidateAsAccountId, address sender)

Emitted when a vault is liquidated.

| Name | Type | Description | |poolId|uint128|The id of the pool whose vault was liquidated.| |collateralType|address|The collateral address of the vault that was liquidated.| |liquidationData|struct ILiquidationModule.LiquidationData|The amount of collateral liquidated, debt liquidated, and collateral awarded to the liquidator.| |liquidateAsAccountId|uint128|Account id that will receive the rewards from the liquidation.| |sender|address|The address of the account that is triggering the liquidation.|

Market Manager Module​

Functions​

registerMarket​

function registerMarket(address market) external returns (uint128)

Connects an external market to the system.

Creates a Market object to track the external market, and returns the newly created market id.

| Name | Type | Description | |market|address|The address of the external market that is to be registered in the system.|

| Name | Type | Description | |[0]|uint128|The id with which the market will be registered in the system.|

depositMarketUsd​

function depositMarketUsd(uint128 marketId, address target, uint256 amount) external

Allows an external market connected to the system to deposit USD in the system.

The system burns the incoming USD, increases the market's credit capacity, and reduces its issuance. See IMarket.

| Name | Type | Description | |marketId|uint128|The id of the market in which snxUSD will be deposited.| |target|address|The address of the account on who's behalf the deposit will be made.| |amount|uint256|The amount of snxUSD to be deposited, denominated with 18 decimals of precision.|

withdrawMarketUsd​

function withdrawMarketUsd(uint128 marketId, address target, uint256 amount) external

Allows an external market connected to the system to withdraw snxUSD from the system.

The system mints the requested snxUSD (provided that the market has sufficient credit), reduces the market's credit capacity, and increases its net issuance. See IMarket.

| Name | Type | Description | |marketId|uint128|The id of the market from which snxUSD will be withdrawn.| |target|address|The address of the account that will receive the withdrawn snxUSD.| |amount|uint256|The amount of snxUSD to be withdraw, denominated with 18 decimals of precision.|

getWithdrawableMarketUsd​

function getWithdrawableMarketUsd(uint128 marketId) external view returns (uint256)

Returns the total withdrawable snxUSD amount for the specified market.

| Name | Type | Description | |marketId|uint128|The id of the market whose withdrawable USD amount is being queried.|

| Name | Type | Description | |[0]|uint256|The total amount of snxUSD that the market could withdraw at the time of the query, denominated with 18 decimals of precision.|

getMarketNetIssuance​

function getMarketNetIssuance(uint128 marketId) external view returns (int128)

Returns the net issuance of the specified market (snxUSD withdrawn - snxUSD deposited).

| Name | Type | Description | |marketId|uint128|The id of the market whose net issuance is being queried.|

| Name | Type | Description | |[0]|int128|The net issuance of the market, denominated with 18 decimals of precision.|

getMarketReportedDebt​

function getMarketReportedDebt(uint128 marketId) external view returns (uint256)

Returns the reported debt of the specified market.

| Name | Type | Description | |marketId|uint128|The id of the market whose reported debt is being queried.|

| Name | Type | Description | |[0]|uint256|The market's reported debt, denominated with 18 decimals of precision.|

getMarketTotalDebt​

function getMarketTotalDebt(uint128 marketId) external view returns (int256)

Returns the total debt of the specified market.

| Name | Type | Description | |marketId|uint128|The id of the market whose debt is being queried.|

| Name | Type | Description | |[0]|int256|The total debt of the market, denominated with 18 decimals of precision.|

getMarketCollateral​

function getMarketCollateral(uint128 marketId) external view returns (uint256)

Returns the total snxUSD value of the collateral for the specified market.

| Name | Type | Description | |marketId|uint128|The id of the market whose collateral is being queried.|

| Name | Type | Description | |[0]|uint256|The market's total snxUSD value of collateral, denominated with 18 decimals of precision.|

getMarketDebtPerShare​

function getMarketDebtPerShare(uint128 marketId) external returns (int256)

Returns the value per share of the debt of the specified market.

This is not a view function, and actually updates the entire debt distribution chain.

| Name | Type | Description | |marketId|uint128|The id of the market whose debt per share is being queried.|

| Name | Type | Description | |[0]|int256|The market's debt per share value, denominated with 18 decimals of precision.|

isMarketCapacityLocked​

function isMarketCapacityLocked(uint128 marketId) external view returns (bool)

Returns wether the capacity of the specified market is locked.

| Name | Type | Description | |marketId|uint128|The id of the market whose capacity is being queried.|

| Name | Type | Description | |[0]|bool|A boolean that is true if the market's capacity is locked at the time of the query.|

distributeDebtToPools​

function distributeDebtToPools(uint128 marketId, uint256 maxIter) external returns (bool)

Update a market's current debt registration with the system. This function is provided as an escape hatch for pool griefing, preventing overwhelming the system with a series of very small pools and creating high gas costs to update an account.

| Name | Type | Description | |marketId|uint128|the id of the market that needs pools bumped| |maxIter|uint256||

| Name | Type | Description | |[0]|bool|whether or not all bumpable pools have been bumped|

Events​

MarketRegistered​

event MarketRegistered(address market, uint128 marketId, address sender)

Emitted when a new market is registered in the system.

| Name | Type | Description | |market|address|The address of the external market that was registered in the system.| |marketId|uint128|The id with which the market was registered in the system.| |sender|address|The account that trigger the registration of the market.|

MarketUsdDeposited​

event MarketUsdDeposited(uint128 marketId, address target, uint256 amount, address market)

Emitted when a market deposits snxUSD in the system.

| Name | Type | Description | |marketId|uint128|The id of the market that deposited snxUSD in the system.| |target|address|The address of the account that provided the snxUSD in the deposit.| |amount|uint256|The amount of snxUSD deposited in the system, denominated with 18 decimals of precision.| |market|address|The address of the external market that is depositing.|

MarketUsdWithdrawn​

event MarketUsdWithdrawn(uint128 marketId, address target, uint256 amount, address market)

Emitted when a market withdraws snxUSD from the system.

| Name | Type | Description | |marketId|uint128|The id of the market that withdrew snxUSD from the system.| |target|address|The address of the account that received the snxUSD in the withdrawal.| |amount|uint256|The amount of snxUSD withdrawn from the system, denominated with 18 decimals of precision.| |market|address|The address of the external market that is withdrawing.|

Pool Module​

Functions​

createPool​

function createPool(uint128 requestedPoolId, address owner) external

Creates a pool with the requested pool id.

| Name | Type | Description | |requestedPoolId|uint128|The requested id for the new pool. Reverts if the id is not available.| |owner|address|The address that will own the newly created pool.|

setPoolConfiguration​

function setPoolConfiguration(uint128 poolId, struct MarketConfiguration.Data[] marketDistribution) external

Allows the pool owner to configure the pool.

The pool's configuration is composed of an array of MarketConfiguration objects, which describe which markets the pool provides liquidity to, in what proportion, and to what extent. Incoming market ids need to be provided in ascending order.

| Name | Type | Description | |poolId|uint128|The id of the pool whose configuration is being set.| |marketDistribution|struct MarketConfiguration.Data[]|The array of market configuration objects that define the list of markets that are connected to the system.|

getPoolConfiguration​

function getPoolConfiguration(uint128 poolId) external view returns (struct MarketConfiguration.Data[] markets)

Retrieves the MarketConfiguration of the specified pool.

| Name | Type | Description | |poolId|uint128|The id of the pool whose configuration is being queried.|

| Name | Type | Description | |markets|struct MarketConfiguration.Data[]|The array of MarketConfiguration objects that describe the pool's configuration.|

setPoolName​

function setPoolName(uint128 poolId, string name) external

Allows the owner of the pool to set the pool's name.

| Name | Type | Description | |poolId|uint128|The id of the pool whose name is being set.| |name|string|The new name to give to the pool.|

getPoolName​

function getPoolName(uint128 poolId) external view returns (string poolName)

Returns the pool's name.

| Name | Type | Description | |poolId|uint128|The id of the pool whose name is being queried.|

| Name | Type | Description | |poolName|string|The current name of the pool.|

nominatePoolOwner​

function nominatePoolOwner(address nominatedOwner, uint128 poolId) external

Allows the current pool owner to nominate a new owner.

| Name | Type | Description | |nominatedOwner|address|The address to nominate os the new pool owner.| |poolId|uint128|The id whose ownership is being transferred.|

acceptPoolOwnership​

function acceptPoolOwnership(uint128 poolId) external

After a new pool owner has been nominated, allows it to accept the nomination and thus ownership of the pool.

| Name | Type | Description | |poolId|uint128|The id of the pool for which the caller is to accept ownership.|

revokePoolNomination​

function revokePoolNomination(uint128 poolId) external

After a new pool owner has been nominated, allows it to reject the nomination.

| Name | Type | Description | |poolId|uint128|The id of the pool for which the new owner nomination is to be revoked.|

renouncePoolNomination​

function renouncePoolNomination(uint128 poolId) external

Allows the current nominated owner to renounce the nomination.

| Name | Type | Description | |poolId|uint128|The id of the pool for which the caller is renouncing ownership nomination.|

getPoolOwner​

function getPoolOwner(uint128 poolId) external view returns (address)

Returns the current pool owner.

| Name | Type | Description | |poolId|uint128|The id of the pool whose ownership is being queried.|

| Name | Type | Description | |[0]|address|The current owner of the pool.|

getNominatedPoolOwner​

function getNominatedPoolOwner(uint128 poolId) external view returns (address)

Returns the current nominated pool owner.

| Name | Type | Description | |poolId|uint128|The id of the pool whose nominated owner is being queried.|

| Name | Type | Description | |[0]|address|The current nominated owner of the pool.|

setMinLiquidityRatio​

function setMinLiquidityRatio(uint256 minLiquidityRatio) external

Allows the system owner (not the pool owner) to set the system-wide minimum liquidity ratio.

| Name | Type | Description | |minLiquidityRatio|uint256|The new system-wide minimum liquidity ratio, denominated with 18 decimals of precision.|

getMinLiquidityRatio​

function getMinLiquidityRatio() external view returns (uint256)

Retrieves the system-wide minimum liquidity ratio.

| Name | Type | Description | |[0]|uint256|The current system-wide minimum liquidity ratio, denominated with 18 decimals of precision.|

Events​

PoolCreated​

event PoolCreated(uint128 poolId, address owner, address sender)

Gets fired when pool will be created.

| Name | Type | Description | |poolId|uint128|The id of the newly created pool.| |owner|address|The owner of the newly created pool.| |sender|address|The address that triggered the creation of the pool.|

PoolOwnerNominated​

event PoolOwnerNominated(uint128 poolId, address nominatedOwner, address owner)

Gets fired when pool owner proposes a new owner.

| Name | Type | Description | |poolId|uint128|The id of the pool for which the nomination ocurred.| |nominatedOwner|address|The address that was nominated as the new owner of the pool.| |owner|address|The address of the current owner of the pool.|

PoolOwnershipAccepted​

event PoolOwnershipAccepted(uint128 poolId, address owner)

Gets fired when pool nominee accepts nomination.

| Name | Type | Description | |poolId|uint128|The id of the pool for which the owner nomination was accepted.| |owner|address|The address of the new owner of the pool, which accepted the nomination.|

PoolNominationRevoked​

event PoolNominationRevoked(uint128 poolId, address owner)

Gets fired when pool owner revokes nomination.

| Name | Type | Description | |poolId|uint128|The id of the pool in which the nomination was revoked.| |owner|address|The current owner of the pool.|

PoolNominationRenounced​

event PoolNominationRenounced(uint128 poolId, address owner)

Gets fired when pool nominee renounces nomination.

| Name | Type | Description | |poolId|uint128|The id of the pool for which the owner nomination was renounced.| |owner|address|The current owner of the pool.|

PoolNameUpdated​

event PoolNameUpdated(uint128 poolId, string name, address sender)

Gets fired when pool name changes.

| Name | Type | Description | |poolId|uint128|The id of the pool whose name was updated.| |name|string|The new name of the pool.| |sender|address|The address that triggered the rename of the pool.|

PoolConfigurationSet​

event PoolConfigurationSet(uint128 poolId, struct MarketConfiguration.Data[] markets, address sender)

Gets fired when pool gets configured.

| Name | Type | Description | |poolId|uint128|The id of the pool whose configuration was set.| |markets|struct MarketConfiguration.Data[]|Array of configuration data of the markets that were connected to the pool.| |sender|address|The address that triggered the pool configuration.|

USD Token Module​

Functions​

burnWithAllowance​

function burnWithAllowance(address from, address spender, uint256 amount) external

Allows the core system to burn snxUSD held by the from address, provided that it has given allowance to spender.

| Name | Type | Description | |from|address|The address that holds the snxUSD to be burned.| |spender|address|The address to which the holder has given allowance to.| |amount|uint256|The amount of snxUSD to be burned, denominated with 18 decimals of precision.|

transferCrossChain​

function transferCrossChain(uint256 destChainId, address to, uint256 amount) external returns (uint256 feesPaid)

Allows users to transfer tokens cross-chain using CCIP. This is disabled until _CCIP_CHAINLINK_SEND is set in UtilsModule. This is currently included for testing purposes. Functionality will change, including fee collection, as CCIP continues development.

| Name | Type | Description | |destChainId|uint256|The id of the chain where tokens are to be transferred to.| |to|address|The destination address in the target chain.| |amount|uint256|The amount of tokens to be transferred, denominated with 18 decimals of precision.|

| Name | Type | Description | |feesPaid|uint256|The amount of fees paid in the cross-chain transfer, denominated with 18 decimals of precision.|

isInitialized​

function isInitialized() external returns (bool)

Returns wether the token has been initialized.

| Name | Type | Description | |[0]|bool|A boolean with the result of the query.|

initialize​

function initialize(string tokenName, string tokenSymbol, uint8 tokenDecimals) external

Initializes the token with name, symbol, and decimals.

mint​

function mint(address to, uint256 amount) external

Allows the owner to mint tokens.

| Name | Type | Description | |to|address|The address to receive the newly minted tokens.| |amount|uint256|The amount of tokens to mint.|

burn​

function burn(address to, uint256 amount) external

Allows the owner to burn tokens.

| Name | Type | Description | |to|address|The address whose tokens will be burnt.| |amount|uint256|The amount of tokens to burn.|

setAllowance​

function setAllowance(address from, address spender, uint256 amount) external

Allows an address that holds tokens to provide allowance to another.

| Name | Type | Description | |from|address|The address that is providing allowance.| |spender|address|The address that is given allowance.| |amount|uint256|The amount of allowance being given.|

name​

function name() external view returns (string)

Retrieves the name of the token, e.g. "Synthetix Network Token".

| Name | Type | Description | |[0]|string|A string with the name of the token.|

symbol​

function symbol() external view returns (string)

Retrieves the symbol of the token, e.g. "SNX".

| Name | Type | Description | |[0]|string|A string with the symbol of the token.|

decimals​

function decimals() external view returns (uint8)

Retrieves the number of decimals used by the token. The default is 18.

| Name | Type | Description | |[0]|uint8|The number of decimals.|

totalSupply​

function totalSupply() external view returns (uint256)

Returns the total number of tokens in circulation (minted - burnt).

| Name | Type | Description | |[0]|uint256|The total number of tokens.|

balanceOf​

function balanceOf(address owner) external view returns (uint256)

Returns the balance of a user.

| Name | Type | Description | |owner|address|The address whose balance is being retrieved.|

| Name | Type | Description | |[0]|uint256|The number of tokens owned by the user.|

allowance​

function allowance(address owner, address spender) external view returns (uint256)

Returns how many tokens a user has allowed another user to transfer on its behalf.

| Name | Type | Description | |owner|address|The user who has given the allowance.| |spender|address|The user who was given the allowance.|

| Name | Type | Description | |[0]|uint256|The amount of tokens spender can transfer on owner's behalf.|

transfer​

function transfer(address to, uint256 amount) external returns (bool)

Transfer tokens from one address to another.

| Name | Type | Description | |to|address|The address that will receive the tokens.| |amount|uint256|The amount of tokens to be transferred.|

| Name | Type | Description | |[0]|bool|A boolean which is true if the operation succeeded.|

approve​

function approve(address spender, uint256 amount) external returns (bool)

Allows users to provide allowance to other users so that they can transfer tokens on their behalf.

| Name | Type | Description | |spender|address|The address that is receiving the allowance.| |amount|uint256|The amount of tokens that are being added to the allowance.|

| Name | Type | Description | |[0]|bool|A boolean which is true if the operation succeeded.|

increaseAllowance​

function increaseAllowance(address spender, uint256 addedValue) external returns (bool)

Atomically increases the allowance granted to spender by the caller.

This is an alternative to {approve} that can be used as a mitigation for problems described in {IERC20-approve}.

Emits an {Approval} event indicating the updated allowance.

Requirements:

  • spender cannot be the zero address.

decreaseAllowance​

function decreaseAllowance(address spender, uint256 subtractedValue) external returns (bool)

Atomically decreases the allowance granted to spender by the caller.

This is an alternative to {approve} that can be used as a mitigation for problems described in {IERC20-approve}.

Emits an {Approval} event indicating the updated allowance.

Requirements:

  • spender cannot be the zero address.
  • spender must have allowance for the caller of at least subtractedValue.

transferFrom​

function transferFrom(address from, address to, uint256 amount) external returns (bool)

Allows a user who has been given allowance to transfer tokens on another user's behalf.

| Name | Type | Description | |from|address|The address that owns the tokens that are being transferred.| |to|address|The address that will receive the tokens.| |amount|uint256|The number of tokens to transfer.|

| Name | Type | Description | |[0]|bool|A boolean which is true if the operation succeeded.|

Events​

Transfer​

event Transfer(address from, address to, uint256 amount)

Emitted when tokens have been transferred.

| Name | Type | Description | |from|address|The address that originally owned the tokens.| |to|address|The address that received the tokens.| |amount|uint256|The number of tokens that were transferred.|

Approval​

event Approval(address owner, address spender, uint256 amount)

Emitted when a user has provided allowance to another user for transferring tokens on its behalf.

| Name | Type | Description | |owner|address|The address that is providing the allowance.| |spender|address|The address that received the allowance.| |amount|uint256|The number of tokens that were added to spender's allowance.|

Collateral Configuration Module​

Functions​

configureCollateral​

function configureCollateral(struct CollateralConfiguration.Data config) external

Creates or updates the configuration for the given collateralType.

| Name | Type | Description | |config|struct CollateralConfiguration.Data|The CollateralConfiguration object describing the new configuration. Requirements: - msg.sender must be the owner of the system. Emits a {CollateralConfigured} event.|

getCollateralConfigurations​

function getCollateralConfigurations(bool hideDisabled) external view returns (struct CollateralConfiguration.Data[] collaterals)

Returns a list of detailed information pertaining to all collateral types registered in the system.

Optionally returns only those that are currently enabled.

| Name | Type | Description | |hideDisabled|bool|Wether to hide disabled collaterals or just return the full list of collaterals in the system.|

| Name | Type | Description | |collaterals|struct CollateralConfiguration.Data[]|The list of collateral configuration objects set in the system.|

getCollateralConfiguration​

function getCollateralConfiguration(address collateralType) external view returns (struct CollateralConfiguration.Data collateral)

Returns detailed information pertaining the specified collateral type.

| Name | Type | Description | |collateralType|address|The address for the collateral whose configuration is being queried.|

| Name | Type | Description | |collateral|struct CollateralConfiguration.Data|The configuration object describing the given collateral.|

getCollateralPrice​

function getCollateralPrice(address collateralType) external view returns (uint256)

Returns the current value of a specified collateral type.

| Name | Type | Description | |collateralType|address|The address for the collateral whose price is being queried.|

| Name | Type | Description | |[0]|uint256|The price of the given collateral, denominated with 18 decimals of precision.|

Events​

CollateralConfigured​

event CollateralConfigured(address collateralType, struct CollateralConfiguration.Data config)

Emitted when a collateral type’s configuration is created or updated.

| Name | Type | Description | |collateralType|address|The address of the collateral type that was just configured.| |config|struct CollateralConfiguration.Data|The object with the newly configured details.|

Collateral Module​

Functions​

deposit​

function deposit(uint128 accountId, address collateralType, uint256 tokenAmount) external

Deposits tokenAmount of collateral of type collateralType into account accountId.

Anyone can deposit into anyone's active account without restriction.

| Name | Type | Description | |accountId|uint128|The id of the account that is making the deposit.| |collateralType|address|The address of the token to be deposited.| |tokenAmount|uint256|The amount being deposited, denominated in the token's native decimal representation. Emits a {Deposited} event.|

withdraw​

function withdraw(uint128 accountId, address collateralType, uint256 tokenAmount) external

Withdraws tokenAmount of collateral of type collateralType from account accountId.

| Name | Type | Description | |accountId|uint128|The id of the account that is making the withdrawal.| |collateralType|address|The address of the token to be withdrawn.| |tokenAmount|uint256|The amount being withdrawn, denominated in the token's native decimal representation. Requirements: - msg.sender must be the owner of the account, have the ADMIN permission, or have the WITHDRAW permission. Emits a {Withdrawn} event.|

getAccountCollateral​

function getAccountCollateral(uint128 accountId, address collateralType) external view returns (uint256 totalDeposited, uint256 totalAssigned, uint256 totalLocked)

Returns the total values pertaining to account accountId for collateralType.

| Name | Type | Description | |accountId|uint128|The id of the account whose collateral is being queried.| |collateralType|address|The address of the collateral type whose amount is being queried.|

| Name | Type | Description | |totalDeposited|uint256|The total collateral deposited in the account, denominated with 18 decimals of precision.| |totalAssigned|uint256|The amount of collateral in the account that is delegated to pools, denominated with 18 decimals of precision.| |totalLocked|uint256|The amount of collateral in the account that cannot currently be undelegated from a pool, denominated with 18 decimals of precision.|

getAccountAvailableCollateral​

function getAccountAvailableCollateral(uint128 accountId, address collateralType) external view returns (uint256)

Returns the amount of collateral of type collateralType deposited with account accountId that can be withdrawn or delegated to pools.

| Name | Type | Description | |accountId|uint128|The id of the account whose collateral is being queried.| |collateralType|address|The address of the collateral type whose amount is being queried.|

| Name | Type | Description | |[0]|uint256|The amount of collateral that is available for withdrawal or delegation, denominated with 18 decimals of precision.|

cleanExpiredLocks​

function cleanExpiredLocks(uint128 accountId, address collateralType, uint256 offset, uint256 items) external

Clean expired locks from locked collateral arrays for an account/collateral type. It includes offset and items to prevent gas exhaustion. If both, offset and items, are 0 it will traverse the whole array (unlimited).

| Name | Type | Description | |accountId|uint128|The id of the account whose locks are being cleared.| |collateralType|address|The address of the collateral type to clean locks for.| |offset|uint256|The index of the first lock to clear.| |items|uint256|The number of locks to clear.|

createLock​

function createLock(uint128 accountId, address collateralType, uint256 amount, uint64 expireTimestamp) external

Create a new lock on the given account. you must have admin permission on the specified account to create a lock.

Collateral can be withdrawn from the system if it is not assigned or delegated to a pool. Collateral locks are an additional restriction that applies on top of that. I.e. if collateral is not assigned to a pool, but has a lock, it cannot be withdrawn. Collateral locks are initially intended for the Synthetix v2 to v3 migration, but may be used in the future by the Spartan Council, for example, to create and hand off accounts whose withdrawals from the system are locked for a given amount of time.

| Name | Type | Description | |accountId|uint128|The id of the account for which a lock is to be created.| |collateralType|address|The address of the collateral type for which the lock will be created.| |amount|uint256|The amount of collateral tokens to wrap in the lock being created, denominated with 18 decimals of precision.| |expireTimestamp|uint64|The date in which the lock will become clearable.|

Events​

Deposited​

event Deposited(uint128 accountId, address collateralType, uint256 tokenAmount, address sender)

Emitted when tokenAmount of collateral of type collateralType is deposited to account accountId by sender.

| Name | Type | Description | |accountId|uint128|The id of the account that deposited collateral.| |collateralType|address|The address of the collateral that was deposited.| |tokenAmount|uint256|The amount of collateral that was deposited, denominated in the token's native decimal representation.| |sender|address|The address of the account that triggered the deposit.|

Withdrawn​

event Withdrawn(uint128 accountId, address collateralType, uint256 tokenAmount, address sender)

Emitted when tokenAmount of collateral of type collateralType is withdrawn from account accountId by sender.

| Name | Type | Description | |accountId|uint128|The id of the account that withdrew collateral.| |collateralType|address|The address of the collateral that was withdrawn.| |tokenAmount|uint256|The amount of collateral that was withdrawn, denominated in the token's native decimal representation.| |sender|address|The address of the account that triggered the withdrawal.|

Market Collateral Module​

Functions​

depositMarketCollateral​

function depositMarketCollateral(uint128 marketId, address collateralType, uint256 amount) external

Allows a market to deposit collateral.

| Name | Type | Description | |marketId|uint128|The id of the market in which the collateral was directly deposited.| |collateralType|address|The address of the collateral that was deposited in the market.| |amount|uint256|The amount of collateral that was deposited, denominated in the token's native decimal representation.|

withdrawMarketCollateral​

function withdrawMarketCollateral(uint128 marketId, address collateralType, uint256 amount) external

Allows a market to withdraw collateral that it has previously deposited.

| Name | Type | Description | |marketId|uint128|The id of the market from which the collateral was withdrawn.| |collateralType|address|The address of the collateral that was withdrawn from the market.| |amount|uint256|The amount of collateral that was withdrawn, denominated in the token's native decimal representation.|

configureMaximumMarketCollateral​

function configureMaximumMarketCollateral(uint128 marketId, address collateralType, uint256 amount) external

Allow the system owner to configure the maximum amount of a given collateral type that a specified market is allowed to deposit.

| Name | Type | Description | |marketId|uint128|The id of the market for which the maximum is to be configured.| |collateralType|address|The address of the collateral for which the maximum is to be applied.| |amount|uint256|The amount that is to be set as the new maximum, denominated with 18 decimals of precision.|

getMaximumMarketCollateral​

function getMaximumMarketCollateral(uint128 marketId, address collateralType) external returns (uint256)

Return the total maximum amount of a given collateral type that a specified market is allowed to deposit.

| Name | Type | Description | |marketId|uint128|The id of the market for which the maximum is being queried.| |collateralType|address|The address of the collateral for which the maximum is being queried.|

| Name | Type | Description | |[0]|uint256|The maximum amount of collateral set for the market, denominated with 18 decimals of precision.|

getMarketCollateralAmount​

function getMarketCollateralAmount(uint128 marketId, address collateralType) external returns (uint256)

Return the total amount of a given collateral type that a specified market has deposited.

| Name | Type | Description | |marketId|uint128|The id of the market for which the directly deposited collateral amount is being queried.| |collateralType|address|The address of the collateral for which the amount is being queried.|

| Name | Type | Description | |[0]|uint256|The total amount of collateral of this type delegated to the market, denominated with 18 decimals of precision.|

getMarketCollateralValue​

function getMarketCollateralValue(uint128 marketId) external returns (uint256)

Return the total value of collateral that a specified market has deposited.

| Name | Type | Description | |marketId|uint128|The id of the market for which the directly deposited collateral amount is being queried.|

| Name | Type | Description | |[0]|uint256|The total value of collateral deposited by the market, denominated with 18 decimals of precision.|

Events​

MarketCollateralDeposited​

event MarketCollateralDeposited(uint128 marketId, address collateralType, uint256 tokenAmount, address sender)

Emitted when amount of collateral of type collateralType is deposited to market marketId by sender.

| Name | Type | Description | |marketId|uint128|The id of the market in which collateral was deposited.| |collateralType|address|The address of the collateral that was directly deposited in the market.| |tokenAmount|uint256|The amount of tokens that were deposited, denominated in the token's native decimal representation.| |sender|address|The address that triggered the deposit.|

MarketCollateralWithdrawn​

event MarketCollateralWithdrawn(uint128 marketId, address collateralType, uint256 tokenAmount, address sender)

Emitted when amount of collateral of type collateralType is withdrawn from market marketId by sender.

| Name | Type | Description | |marketId|uint128|The id of the market from which collateral was withdrawn.| |collateralType|address|The address of the collateral that was withdrawn from the market.| |tokenAmount|uint256|The amount of tokens that were withdrawn, denominated in the token's native decimal representation.| |sender|address|The address that triggered the withdrawal.|

MaximumMarketCollateralConfigured​

event MaximumMarketCollateralConfigured(uint128 marketId, address collateralType, uint256 systemAmount, address owner)

Emitted when the system owner specifies the maximum depositable collateral of a given type in a given market.

| Name | Type | Description | |marketId|uint128|The id of the market for which the maximum was configured.| |collateralType|address|The address of the collateral for which the maximum was configured.| |systemAmount|uint256|The amount to which the maximum was set, denominated with 18 decimals of precision.| |owner|address|The owner of the system, which triggered the configuration change.|

Multicall Module​

Functions​

multicall​

function multicall(bytes[] data) external payable returns (bytes[] results)

Executes multiple transaction payloads in a single transaction.

Each transaction is executed using delegatecall, and targets the system address.

| Name | Type | Description | |data|bytes[]|Array of calldata objects, one for each function that is to be called in the system.|

| Name | Type | Description | |results|bytes[]|Array of each delegatecall's response corresponding to the incoming calldata array.|

Events​

Pool Configuration Module​

Functions​

setPreferredPool​

function setPreferredPool(uint128 poolId) external

Sets the unique system preferred pool.

Note: The preferred pool does not receive any special treatment. It is only signaled as preferred here.

| Name | Type | Description | |poolId|uint128|The id of the pool that is to be set as preferred.|

addApprovedPool​

function addApprovedPool(uint128 poolId) external

Marks a pool as approved by the system owner.

Approved pools do not receive any special treatment. They are only signaled as approved here.

| Name | Type | Description | |poolId|uint128|The id of the pool that is to be approved.|

removeApprovedPool​

function removeApprovedPool(uint128 poolId) external

Un-marks a pool as preferred by the system owner.

| Name | Type | Description | |poolId|uint128|The id of the pool that is to be no longer approved.|

getPreferredPool​

function getPreferredPool() external view returns (uint256)

Retrieves the unique system preferred pool.

| Name | Type | Description | |[0]|uint256|The id of the pool that is currently set as preferred in the system.|

getApprovedPools​

function getApprovedPools() external view returns (uint256[])

Retrieves the pool that are approved by the system owner.

| Name | Type | Description | |[0]|uint256[]|An array with all of the pool ids that are approved in the system.|

Events​

PreferredPoolSet​

event PreferredPoolSet(uint256 poolId)

Emitted when the system owner sets the preferred pool.

| Name | Type | Description | |poolId|uint256|The id of the pool that was set as preferred.|

PoolApprovedAdded​

event PoolApprovedAdded(uint256 poolId)

Emitted when the system owner adds an approved pool.

| Name | Type | Description | |poolId|uint256|The id of the pool that was approved.|

PoolApprovedRemoved​

event PoolApprovedRemoved(uint256 poolId)

Emitted when the system owner removes an approved pool.

| Name | Type | Description | |poolId|uint256|The id of the pool that is no longer approved.|

Rewards Manager Module​

Functions​

registerRewardsDistributor​

function registerRewardsDistributor(uint128 poolId, address collateralType, address distributor) external

Called by pool owner to register rewards for vault participants.

| Name | Type | Description | |poolId|uint128|The id of the pool whose rewards are to be managed by the specified distributor.| |collateralType|address|The address of the collateral used in the pool's rewards.| |distributor|address|The address of the reward distributor to be registered.|

removeRewardsDistributor​

function removeRewardsDistributor(uint128 poolId, address collateralType, address distributor) external

Called by pool owner to remove a registered rewards distributor for vault participants.

| Name | Type | Description | |poolId|uint128|The id of the pool whose rewards are to be managed by the specified distributor.| |collateralType|address|The address of the collateral used in the pool's rewards.| |distributor|address|The address of the reward distributor to be registered.|

distributeRewards​

function distributeRewards(uint128 poolId, address collateralType, uint256 amount, uint64 start, uint32 duration) external

Called by a registered distributor to set up rewards for vault participants.

Will revert if the caller is not a registered distributor.

| Name | Type | Description | |poolId|uint128|The id of the pool to distribute rewards to.| |collateralType|address|The address of the collateral used in the pool's rewards.| |amount|uint256|The amount of rewards to be distributed.| |start|uint64|The date at which the rewards will begin to be claimable.| |duration|uint32|The period after which all distributed rewards will be claimable.|

claimRewards​

function claimRewards(uint128 accountId, uint128 poolId, address collateralType, address distributor) external returns (uint256)

Allows a user with appropriate permissions to claim rewards associated with a position.

| Name | Type | Description | |accountId|uint128|The id of the account that is to claim the rewards.| |poolId|uint128|The id of the pool to claim rewards on.| |collateralType|address|The address of the collateral used in the pool's rewards.| |distributor|address|The address of the rewards distributor associated with the rewards being claimed.|

| Name | Type | Description | |[0]|uint256|The amount of rewards that were available for the account and thus claimed.|

updateRewards​

function updateRewards(uint128 poolId, address collateralType, uint128 accountId) external returns (uint256[], address[])

For a given position, return the rewards that can currently be claimed.

| Name | Type | Description | |poolId|uint128|The id of the pool being queried.| |collateralType|address|The address of the collateral used in the pool's rewards.| |accountId|uint128|The id of the account whose available rewards are being queried.|

| Name | Type | Description | |[0]|uint256[]|An array of ids of the reward entries that are claimable by the position.| |[1]|address[]|An array with the addresses of the reward distributors associated with the claimable rewards.|

getRewardRate​

function getRewardRate(uint128 poolId, address collateralType, address distributor) external view returns (uint256)

Returns the number of individual units of amount emitted per second per share for the given poolId, collateralType, distributor vault.

| Name | Type | Description | |poolId|uint128|The id of the pool being queried.| |collateralType|address|The address of the collateral used in the pool's rewards.| |distributor|address|The address of the rewards distributor associated with the rewards in question.|

| Name | Type | Description | |[0]|uint256|The queried rewards rate.|

Events​

RewardsDistributed​

event RewardsDistributed(uint128 poolId, address collateralType, address distributor, uint256 amount, uint256 start, uint256 duration)

Emitted when the pool owner or an existing reward distributor sets up rewards for vault participants.

| Name | Type | Description | |poolId|uint128|The id of the pool on which rewards were distributed.| |collateralType|address|The collateral type of the pool on which rewards were distributed.| |distributor|address|The reward distributor associated to the rewards that were distributed.| |amount|uint256|The amount of rewards that were distributed.| |start|uint256|The date one which the rewards will begin to be claimable.| |duration|uint256|The time in which all of the distributed rewards will be claimable.|

RewardsClaimed​

event RewardsClaimed(uint128 accountId, uint128 poolId, address collateralType, address distributor, uint256 amount)

Emitted when a vault participant claims rewards.

| Name | Type | Description | |accountId|uint128|The id of the account that claimed the rewards.| |poolId|uint128|The id of the pool where the rewards were claimed.| |collateralType|address|The address of the collateral used in the pool's rewards.| |distributor|address|The address of the rewards distributor associated with these rewards.| |amount|uint256|The amount of rewards that were claimed.|

RewardsDistributorRegistered​

event RewardsDistributorRegistered(uint128 poolId, address collateralType, address distributor)

Emitted when a new rewards distributor is registered.

| Name | Type | Description | |poolId|uint128|The id of the pool whose reward distributor was registered.| |collateralType|address|The address of the collateral used in the pool's rewards.| |distributor|address|The address of the newly registered reward distributor.|

RewardsDistributorRemoved​

event RewardsDistributorRemoved(uint128 poolId, address collateralType, address distributor)

Emitted when an already registered rewards distributor is removed.

| Name | Type | Description | |poolId|uint128|The id of the pool whose reward distributor was registered.| |collateralType|address|The address of the collateral used in the pool's rewards.| |distributor|address|The address of the registered reward distributor.|

Vault Module​

Functions​

delegateCollateral​

function delegateCollateral(uint128 accountId, uint128 poolId, address collateralType, uint256 amount, uint256 leverage) external

Updates an account's delegated collateral amount for the specified pool and collateral type pair.

| Name | Type | Description | |accountId|uint128|The id of the account associated with the position that will be updated.| |poolId|uint128|The id of the pool associated with the position.| |collateralType|address|The address of the collateral used in the position.| |amount|uint256|The new amount of collateral delegated in the position, denominated with 18 decimals of precision.| |leverage|uint256|The new leverage amount used in the position, denominated with 18 decimals of precision. Requirements: - msg.sender must be the owner of the account, have the ADMIN permission, or have the DELEGATE permission. - If increasing the amount delegated, it must not exceed the available collateral (getAccountAvailableCollateral) associated with the account. - If decreasing the amount delegated, the liquidity position must have a collateralization ratio greater than the target collateralization ratio for the corresponding collateral type. Emits a {DelegationUpdated} event.|

getPositionCollateralizationRatio​

function getPositionCollateralizationRatio(uint128 accountId, uint128 poolId, address collateralType) external returns (uint256)

Returns the collateralization ratio of the specified liquidity position. If debt is negative, this function will return 0.

Call this function using callStatic to treat it as a view function. The return value is a percentage with 18 decimals places.

| Name | Type | Description | |accountId|uint128|The id of the account whose collateralization ratio is being queried.| |poolId|uint128|The id of the pool in which the account's position is held.| |collateralType|address|The address of the collateral used in the queried position.|

| Name | Type | Description | |[0]|uint256|The collateralization ratio of the position (collateral / debt), denominated with 18 decimals of precision.|

getPositionDebt​

function getPositionDebt(uint128 accountId, uint128 poolId, address collateralType) external returns (int256)

Returns the debt of the specified liquidity position. Credit is expressed as negative debt.

This is not a view function, and actually updates the entire debt distribution chain. Call this function using callStatic to treat it as a view function.

| Name | Type | Description | |accountId|uint128|The id of the account being queried.| |poolId|uint128|The id of the pool in which the account's position is held.| |collateralType|address|The address of the collateral used in the queried position.|

| Name | Type | Description | |[0]|int256|The amount of debt held by the position, denominated with 18 decimals of precision.|

getPositionCollateral​

function getPositionCollateral(uint128 accountId, uint128 poolId, address collateralType) external view returns (uint256 collateralAmount, uint256 collateralValue)

Returns the amount and value of the collateral associated with the specified liquidity position.

Call this function using callStatic to treat it as a view function. collateralAmount is represented as an integer with 18 decimals. collateralValue is represented as an integer with the number of decimals specified by the collateralType.

| Name | Type | Description | |accountId|uint128|The id of the account being queried.| |poolId|uint128|The id of the pool in which the account's position is held.| |collateralType|address|The address of the collateral used in the queried position.|

| Name | Type | Description | |collateralAmount|uint256|The amount of collateral used in the position, denominated with 18 decimals of precision.| |collateralValue|uint256|The value of collateral used in the position, denominated with 18 decimals of precision.|

getPosition​

function getPosition(uint128 accountId, uint128 poolId, address collateralType) external returns (uint256 collateralAmount, uint256 collateralValue, int256 debt, uint256 collateralizationRatio)

Returns all information pertaining to a specified liquidity position in the vault module.

| Name | Type | Description | |accountId|uint128|The id of the account being queried.| |poolId|uint128|The id of the pool in which the account's position is held.| |collateralType|address|The address of the collateral used in the queried position.|

| Name | Type | Description | |collateralAmount|uint256|The amount of collateral used in the position, denominated with 18 decimals of precision.| |collateralValue|uint256|The value of the collateral used in the position, denominated with 18 decimals of precision.| |debt|int256|The amount of debt held in the position, denominated with 18 decimals of precision.| |collateralizationRatio|uint256|The collateralization ratio of the position (collateral / debt), denominated with 18 decimals of precision.|

getVaultDebt​

function getVaultDebt(uint128 poolId, address collateralType) external returns (int256)

Returns the total debt (or credit) that the vault is responsible for. Credit is expressed as negative debt.

This is not a view function, and actually updates the entire debt distribution chain. Call this function using callStatic to treat it as a view function.

| Name | Type | Description | |poolId|uint128|The id of the pool that owns the vault whose debt is being queried.| |collateralType|address|The address of the collateral of the associated vault.|

| Name | Type | Description | |[0]|int256|The overall debt of the vault, denominated with 18 decimals of precision.|

getVaultCollateral​

function getVaultCollateral(uint128 poolId, address collateralType) external returns (uint256 collateralAmount, uint256 collateralValue)

Returns the amount and value of the collateral held by the vault.

Call this function using callStatic to treat it as a view function. collateralAmount is represented as an integer with 18 decimals. collateralValue is represented as an integer with the number of decimals specified by the collateralType.

| Name | Type | Description | |poolId|uint128|The id of the pool that owns the vault whose collateral is being queried.| |collateralType|address|The address of the collateral of the associated vault.|

| Name | Type | Description | |collateralAmount|uint256|The collateral amount of the vault, denominated with 18 decimals of precision.| |collateralValue|uint256|The collateral value of the vault, denominated with 18 decimals of precision.|

getVaultCollateralRatio​

function getVaultCollateralRatio(uint128 poolId, address collateralType) external returns (uint256)

Returns the collateralization ratio of the vault. If debt is negative, this function will return 0.

Call this function using callStatic to treat it as a view function. The return value is a percentage with 18 decimals places.

| Name | Type | Description | |poolId|uint128|The id of the pool that owns the vault whose collateralization ratio is being queried.| |collateralType|address|The address of the collateral of the associated vault.|

| Name | Type | Description | |[0]|uint256|The collateralization ratio of the vault, denominated with 18 decimals of precision.|

Events​

DelegationUpdated​

event DelegationUpdated(uint128 accountId, uint128 poolId, address collateralType, uint256 amount, uint256 leverage, address sender)

Emitted when {sender} updates the delegation of collateral in the specified liquidity position.

| Name | Type | Description | |accountId|uint128|The id of the account whose position was updated.| |poolId|uint128|The id of the pool in which the position was updated.| |collateralType|address|The address of the collateral associated to the position.| |amount|uint256|The new amount of the position, denominated with 18 decimals of precision.| |leverage|uint256|The new leverage value of the position, denominated with 18 decimals of precision.| |sender|address|The address that triggered the update of the position.|