raiden-api-client
Version:
Raiden Network API TypeScript client
33 lines (32 loc) • 2.05 kB
TypeScript
import { Address, Channel, Channels, Connections, Events, Partners, Payment, Token, Tokens, Transfers } from "../models/v1";
export declare class RaidenClient {
private apiUrl;
/**
* Default client that can be constructed for interacting with the Etherscan API.
*
* @param baseUrl base url of the API endpoint (e.g; http://localhost:5001/api)
* @param version version of the API (e.g; v1)
*/
constructor(baseUrl: string, version?: string);
getClientAddress(): Promise<Address>;
registerToken(tokenAddress: string): Promise<Token>;
getChannels(): Promise<Channels>;
getChannelsForTokenAddress(tokenAddress: string): Promise<Channels>;
getChannelsForTokenAddressAndPartnerAddress(tokenAddress: string, partnerAddress: string): Promise<Channels>;
createChannel(partnerAddress: string, tokenAddress: string, totalDeposit: number, settleTimeout: number): Promise<Channel>;
closeChannel(tokenAddress: string, partnerAddress: string): Promise<Channel>;
depositChannel(tokenAddress: string, partnerAddress: string): Promise<Channel>;
withdrawChannel(tokenAddress: string, partnerAddress: string): Promise<Channel>;
getTokens(): Promise<Tokens>;
getTokenNetworkForTokenAddress(tokenAddress: string): Promise<string>;
getPartnersForTokenAddress(tokenAddress: string): Promise<Partners>;
getPendingTransfers(): Promise<Transfers>;
getPendingTransfersForTokenAddress(tokenAddress: string): Promise<Partners>;
getPendingTransfersForTokenAddressAndPartner(tokenAddress: string, partnerAddress: string): Promise<Partners>;
getConnections(): Promise<Connections>;
joinTokenNetwork(tokenAddress: string, funds: number, channelTarget?: number, fundsTarget?: number): Promise<string>;
leaveTokenNetwork(tokenAddress: string): Promise<string[]>;
initiatePayment(tokenAddress: string, targetAddress: string, amount: number, identifier: number): Promise<Payment>;
queryEvents(tokenAddress: string, targetAddress: string): Promise<Events>;
private call;
}