PoolTokensAsset
PoolTokensAsset
NotGoListed
error NotGoListed(address owner)
Thrown when trying to harvest a pool token when not go-listed
AssetType
enum CapitalAssetType AssetType
isType
function isType(contract Context context, address assetAddress) internal view returns (bool)
Get the type of asset that this contract adapts.
Return Values
| Name | Type | Description |
|---|---|---|
| [0] | bool | the asset type |
isValid
function isValid(contract Context context, uint256 assetTokenId) internal view returns (bool)
Get whether or not the given asset is valid
Return Values
| Name | Type | Description |
|---|---|---|
| [0] | bool | true if the represented tranche is or may be drawn down (so true if assets are doing work) |
getUsdcEquivalent
function getUsdcEquivalent(contract Context context, uint256 assetTokenId) internal view returns (uint256)
Get the point-in-time USDC equivalent value of the Pool Token asset. This specifically attempts to return the "principle" or "at-risk" USDC value of the asset and does not include rewards, interest, or other benefits.
Parameters
| Name | Type | Description |
|---|---|---|
| context | contract Context | goldfinch context for routing |
| assetTokenId | uint256 | tokenId of the Pool Token to evaluate |
Return Values
| Name | Type | Description |
|---|---|---|
| [0] | uint256 | USDC equivalent value |
harvest
function harvest(contract Context context, address owner, uint256 assetTokenId) internal
Harvest GFI rewards and redeemable interest and principal on PoolToken with id
assetTokenId and send the harvested assets to owner.
Parameters
| Name | Type | Description |
|---|---|---|
| context | contract Context | goldfinch context for routing |
| owner | address | address to send the harvested assets to |
| assetTokenId | uint256 | id of the position to harvest |
getAllowedUIDs
function getAllowedUIDs(address poolAddress) private view returns (uint256[] allowedUIDs)