@yfi/sdk
Version:
Interaction framework for the yearn protocol
51 lines (50 loc) • 1.47 kB
TypeScript
export declare class CustomError extends Error {
error_type: string;
constructor(message: string, error_type: string);
}
/**
* Generic SDK error. Wrapped errors are:
*
* - ethers.js errors
* - http request errors
*/
export declare class SdkError extends CustomError {
error_code?: string;
static NO_SLIPPAGE: string;
constructor(message: string, error_code?: string);
}
/**
* Type alias for an address type.
*/
export declare type Address = string;
/**
* Type for anything that has an address property.
*/
export declare type Addressable = {
address: Address;
};
/**
* Type alias for a stringified big number. SDK tries to be bignumber-lib
* agnostic so integer values are returned as strings.
*/
export declare type Integer = string;
/**
* Utility type to help distinguish [[Integer]]s that represent a USDC (6 dec)
* value.
*/
export declare type Usdc = string;
/**
* Utility type to help distinguish [[Integer]]s that represents an already
* normalized value with the corresponding decimals from their Integer form.
*/
export declare type Unit = string;
/**
* Utility type to describe a map of predefined keys with the same value.
*/
export declare type TypedMap<K extends string | number | symbol, V> = {
[key in K]: V;
};
/**
* Accepted locales.
*/
export declare type Locale = "de" | "el" | "en" | "es" | "fr" | "hi" | "id" | "ja" | "pt" | "ru" | "tr" | "vi" | "zh";