@orionprotocol/contracts
Version:
Orion Protocol contracts typings
110 lines (109 loc) • 6.63 kB
TypeScript
/// <reference types="node" />
import type BN from "bn.js";
import type { ContractOptions } from "web3-eth-contract";
import type { EventLog } from "web3-core";
import type { EventEmitter } from "events";
import type { Callback, NonPayableTransactionObject, BlockType, ContractEventLog, BaseContract } from "./types";
export interface EventOptions {
filter?: object;
fromBlock?: BlockType;
topics?: string[];
}
export type PoolAdded = ContractEventLog<{
pool: string;
rate_method_id: string;
0: string;
1: string;
}>;
export type PoolRemoved = ContractEventLog<{
pool: string;
0: string;
}>;
export interface CurveRegistry extends BaseContract {
constructor(jsonInterface: any[], address?: string, options?: ContractOptions): CurveRegistry;
clone(): CurveRegistry;
methods: {
"find_pool_for_coins(address,address)"(_from: string, _to: string): NonPayableTransactionObject<string>;
"find_pool_for_coins(address,address,uint256)"(_from: string, _to: string, i: number | string | BN): NonPayableTransactionObject<string>;
get_n_coins(_pool: string): NonPayableTransactionObject<string[]>;
get_coins(_pool: string): NonPayableTransactionObject<string[]>;
get_underlying_coins(_pool: string): NonPayableTransactionObject<string[]>;
get_decimals(_pool: string): NonPayableTransactionObject<string[]>;
get_underlying_decimals(_pool: string): NonPayableTransactionObject<string[]>;
get_rates(_pool: string): NonPayableTransactionObject<string[]>;
get_gauges(_pool: string): NonPayableTransactionObject<{
0: string[];
1: string[];
}>;
get_balances(_pool: string): NonPayableTransactionObject<string[]>;
get_underlying_balances(_pool: string): NonPayableTransactionObject<string[]>;
get_virtual_price_from_lp_token(_token: string): NonPayableTransactionObject<string>;
get_A(_pool: string): NonPayableTransactionObject<string>;
get_parameters(_pool: string): NonPayableTransactionObject<{
A: string;
future_A: string;
fee: string;
admin_fee: string;
future_fee: string;
future_admin_fee: string;
future_owner: string;
initial_A: string;
initial_A_time: string;
future_A_time: string;
0: string;
1: string;
2: string;
3: string;
4: string;
5: string;
6: string;
7: string;
8: string;
9: string;
}>;
get_fees(_pool: string): NonPayableTransactionObject<string[]>;
get_admin_balances(_pool: string): NonPayableTransactionObject<string[]>;
get_coin_indices(_pool: string, _from: string, _to: string): NonPayableTransactionObject<{
0: string;
1: string;
2: boolean;
}>;
estimate_gas_used(_pool: string, _from: string, _to: string): NonPayableTransactionObject<string>;
is_meta(_pool: string): NonPayableTransactionObject<boolean>;
get_pool_name(_pool: string): NonPayableTransactionObject<string>;
get_coin_swap_count(_coin: string): NonPayableTransactionObject<string>;
get_coin_swap_complement(_coin: string, _index: number | string | BN): NonPayableTransactionObject<string>;
get_pool_asset_type(_pool: string): NonPayableTransactionObject<string>;
add_pool(_pool: string, _n_coins: number | string | BN, _lp_token: string, _rate_info: string | number[], _decimals: number | string | BN, _underlying_decimals: number | string | BN, _has_initial_A: boolean, _is_v1: boolean, _name: string): NonPayableTransactionObject<void>;
add_pool_without_underlying(_pool: string, _n_coins: number | string | BN, _lp_token: string, _rate_info: string | number[], _decimals: number | string | BN, _use_rates: number | string | BN, _has_initial_A: boolean, _is_v1: boolean, _name: string): NonPayableTransactionObject<void>;
"add_metapool(address,uint256,address,uint256,string)"(_pool: string, _n_coins: number | string | BN, _lp_token: string, _decimals: number | string | BN, _name: string): NonPayableTransactionObject<void>;
"add_metapool(address,uint256,address,uint256,string,address)"(_pool: string, _n_coins: number | string | BN, _lp_token: string, _decimals: number | string | BN, _name: string, _base_pool: string): NonPayableTransactionObject<void>;
remove_pool(_pool: string): NonPayableTransactionObject<void>;
set_pool_gas_estimates(_addr: string[], _amount: (number | string | BN)[][]): NonPayableTransactionObject<void>;
set_coin_gas_estimates(_addr: string[], _amount: (number | string | BN)[]): NonPayableTransactionObject<void>;
set_gas_estimate_contract(_pool: string, _estimator: string): NonPayableTransactionObject<void>;
set_liquidity_gauges(_pool: string, _liquidity_gauges: string[]): NonPayableTransactionObject<void>;
set_pool_asset_type(_pool: string, _asset_type: number | string | BN): NonPayableTransactionObject<void>;
batch_set_pool_asset_type(_pools: string[], _asset_types: (number | string | BN)[]): NonPayableTransactionObject<void>;
address_provider(): NonPayableTransactionObject<string>;
gauge_controller(): NonPayableTransactionObject<string>;
pool_list(arg0: number | string | BN): NonPayableTransactionObject<string>;
pool_count(): NonPayableTransactionObject<string>;
coin_count(): NonPayableTransactionObject<string>;
get_coin(arg0: number | string | BN): NonPayableTransactionObject<string>;
get_pool_from_lp_token(arg0: string): NonPayableTransactionObject<string>;
get_lp_token(arg0: string): NonPayableTransactionObject<string>;
last_updated(): NonPayableTransactionObject<string>;
};
events: {
PoolAdded(cb?: Callback<PoolAdded>): EventEmitter;
PoolAdded(options?: EventOptions, cb?: Callback<PoolAdded>): EventEmitter;
PoolRemoved(cb?: Callback<PoolRemoved>): EventEmitter;
PoolRemoved(options?: EventOptions, cb?: Callback<PoolRemoved>): EventEmitter;
allEvents(options?: EventOptions, cb?: Callback<EventLog>): EventEmitter;
};
once(event: "PoolAdded", cb: Callback<PoolAdded>): void;
once(event: "PoolAdded", options: EventOptions, cb: Callback<PoolAdded>): void;
once(event: "PoolRemoved", cb: Callback<PoolRemoved>): void;
once(event: "PoolRemoved", options: EventOptions, cb: Callback<PoolRemoved>): void;
}