Skip to content

Latest commit

 

History

History
195 lines (113 loc) · 7.12 KB

response.md

File metadata and controls

195 lines (113 loc) · 7.12 KB

@metamask-institutional/defi-adapters / response

Module: response

Table of contents

Type Aliases

Type Aliases

GetEventsRequestInput

Ƭ GetEventsRequestInput: Object

Type declaration

Name Type
userAddress string
fromBlock number
toBlock number
protocolTokenAddress string
protocolId Protocol
chainId Chain
productId string
tokenId? string

Defined in

response.ts:19


AdapterErrorResponse

Ƭ AdapterErrorResponse: Object

Type declaration

Name Type
error { message: string ; details?: any }
error.message string
error.details? any

Defined in

response.ts:30


AdapterResponse

Ƭ AdapterResponse<ProtocolResponse>: ProtocolDetails & ProtocolResponse & { success: true } | AdapterErrorResponse & { success: false } | AdapterErrorResponse & { success: false }

Type parameters

Name
ProtocolResponse

Defined in

response.ts:38


DefiPositionResponse

Ƭ DefiPositionResponse: AdapterResponse<{ tokens: DisplayPosition<ProtocolPosition>[] }>

Defined in

response.ts:46


DisplayPosition

Ƭ DisplayPosition<PositionBalance>: Omit<PositionBalance, "tokens"> & { balance: string ; tokens?: DisplayPosition<Underlying>[] } & PositionBalance["type"] extends typeof Underlying | typeof UnderlyingClaimable ? { iconUrl: string } : Record<string, never>

Type parameters

Name Type
PositionBalance extends TokenBalance & { type: TokenType ; tokens?: Underlying[] }

Defined in

response.ts:50


DefiProfitsResponse

Ƭ DefiProfitsResponse: AdapterResponse<ProfitsWithRange>

Defined in

response.ts:64


PricePerShareResponse

Ƭ PricePerShareResponse: AdapterResponse<{ tokens: DisplayProtocolTokenUnderlyingRate[] }>

Defined in

response.ts:66


DisplayProtocolTokenUnderlyingRate

Ƭ DisplayProtocolTokenUnderlyingRate: Omit<ProtocolTokenUnderlyingRate, "tokens"> & { tokens?: UnderlyingTokenRate & { underlyingRate: string ; iconUrl: string }[] }

Defined in

response.ts:70


APRResponse

Ƭ APRResponse: AdapterResponse<{ tokens: ProtocolTokenApr[] }>

Defined in

response.ts:77


APYResponse

Ƭ APYResponse: AdapterResponse<{ tokens: ProtocolTokenApy[] }>

Defined in

response.ts:81


TotalValueLockResponse

Ƭ TotalValueLockResponse: AdapterResponse<{ tokens: DisplayProtocolTokenTvl[] }>

Defined in

response.ts:85


DisplayProtocolTokenTvl

Ƭ DisplayProtocolTokenTvl: Omit<ProtocolTokenTvl, "tokens"> & { totalSupply: string ; tokens?: UnderlyingTokenTvl & { totalSupply: string ; iconUrl: string }[] }

Defined in

response.ts:89


DefiMovementsResponse

Ƭ DefiMovementsResponse: AdapterResponse<{ movements: DisplayMovementsByBlock[] }>

Defined in

response.ts:94


DisplayMovementsByBlock

Ƭ DisplayMovementsByBlock: Omit<MovementsByBlock, "tokens"> & { tokens?: Underlying & { balance: string }[] }

Defined in

response.ts:98