Class ConnectionsClient

Raiden sub-client for Connections

Hierarchy

BaseClient
- ConnectionsClient

Implements

ILister<Connection>

Index

Constructors

constructor

Methods

Constructors

constructor

new ConnectionsClient(config: ClientConfig): ConnectionsClient

- Defined in client/connections/connections-client.ts:14
Constructor for ConnectionsClient

Parameters
- config: ClientConfig
Returns ConnectionsClient

Methods

joinRequestUrl

joinRequestUrl(tokenAddress: string): string

- Defined in client/connections/connections-client.ts:73
Url for join request

Parameters
- tokenAddress: string
Returns string

joinTokenNetwork

joinTokenNetwork(tokenAddress: string, joinConfig: Partial<JoinConfig>): Promise<any>

- Defined in client/connections/connections-client.ts:46
Automatically join a token network. The request will only return once all blockchain calls for opening and/or depositing to a channel have completed.

Parameters
- tokenAddress: string
- joinConfig: Partial<JoinConfig>
Returns Promise<any>

leaveTokenNetwork

leaveTokenNetwork(tokenAddress: string): Promise<string[]>

- Defined in client/connections/connections-client.ts:56
Leave a token network. The request will only return once all blockchain calls for closing/settling a channel have completed.

Parameters
- tokenAddress: string
Returns Promise<string[]>

list

list(): Promise<Connection[]>

- Defined in client/connections/connections-client.ts:28
Query details of all joined token networks. The request will return a JSON object where each key is a token address for which you have open channels.

Returns Promise<Connection[]>

listRequestUrl

listRequestUrl(): string

- Defined in client/connections/connections-client.ts:65
Url for list request.

Returns string

Generated using TypeDoc