Skip to content

API ReferenceVaults, collateral, and riskFunction

getCollateralToken()

function getCollateralToken(ctx, params): Promise<CollateralToken | undefined>;

Fetches the CollateralToken uniquely identified by the provided address, if one exists.

Parameters

ParameterTypeDescription
ctxSDKContextThe SDK context.
paramsGetCollateralTokenParamsThe params including the unique identifier(s).

Returns

Promise<CollateralToken | undefined>

The collateral token if it exists, otherwise undefined.