Class ChannelsClient

Raiden sub-client for Channels.

Hierarchy

BaseClient
- ChannelsClient

Index

Constructors

constructor

Methods

Constructors

constructor

new ChannelsClient(config: ClientConfig): ChannelsClient

- Defined in client/channels/channels-client.ts:11
Constructor for ChannelsClient

Parameters
- config: ClientConfig
Returns ChannelsClient

Methods

close

close(tokenAddress: string, partnerAddress: string): Promise<Channel>

- Defined in client/channels/channels-client.ts:39
This request is used to close a channel.

Parameters
- tokenAddress: string
- partnerAddress: string
Returns Promise<Channel>

closeRequestUrl

closeRequestUrl(tokenAddress: string, partnerAddress: string): string

- Defined in client/channels/channels-client.ts:70
Url for close request.

Parameters
- tokenAddress: string
- partnerAddress: string
Returns string

depositRequestUrl

depositRequestUrl(tokenAddress: string, partnerAddress: string): string

- Defined in client/channels/channels-client.ts:86
Url for deposit request.

Parameters
- tokenAddress: string
- partnerAddress: string
Returns string

increaseDeposit

increaseDeposit(tokenAddress: string, partnerAddress: string, deposit: number): Promise<Channel>

- Defined in client/channels/channels-client.ts:27
This request is used to increase the deposit in it.

Parameters
- tokenAddress: string
- partnerAddress: string
- deposit: number
Returns Promise<Channel>

open

open(tokenAddress: string, partnerAddress: string, deposit: number, settleTimeout: number): Promise<Channel>

- Defined in client/channels/channels-client.ts:55
Opens (i. e. creates) a channel.

Parameters
- tokenAddress: string
- partnerAddress: string
- deposit: number
- settleTimeout: number
Returns Promise<Channel>

openRequestUrl

openRequestUrl(): string

- Defined in client/channels/channels-client.ts:77
Url for open request

Returns string

Generated using TypeDoc