Paych

The Paych methods are for interacting with and managing payment channels,

• paychAllocateLane
• paychAvailableFunds
• paychAvailableFundsByFromTo
• paychCollect
• paychGet
• paychGetWaitReady
• paychList
• paychNewPayment
• paychSettle
• paychStatus
• paychVoucherAdd
• paychVoucherCheckSpendable
• paychVoucherCheckValid
• paychVoucherCreate
• paychVoucherList
• paychVoucherSubmit

paychAllocateLane

paychAllocateLane (address: string): Promise<number>

Parameters:

• address: string

Returns:

Promise<number>

Source: index.d.ts, line 521, character 19

paychAvailableFunds

paychAvailableFunds (address: string): Promise<ChannelAvailableFunds>

Parameters:

• address: string

Returns:

Promise<ChannelAvailableFunds>

Source: index.d.ts, line 522, character 21

paychAvailableFundsByFromTo

paychAvailableFundsByFromTo (address: string, address1: string): Promise<ChannelAvailableFunds>

Parameters:

• address: string
• address1: string

Returns:

Promise<ChannelAvailableFunds>

Source: index.d.ts, line 523, character 29

paychCollect

paychCollect (address: string): Promise<Cid>

Parameters:

• address: string

Returns:

Promise<Cid>

Source: index.d.ts, line 524, character 14

paychGet

paychGet (address: string, address1: string, bigInt: string): Promise<ChannelInfo>

Parameters:

• address: string
• address1: string
• bigInt: string

Returns:

Promise<ChannelInfo>

Source: index.d.ts, line 525, character 10

paychGetWaitReady

paychGetWaitReady (cid: Cid): Promise<string>

Parameters:

• cid: Cid

Returns:

Promise<string>

Source: index.d.ts, line 526, character 19

paychList

paychList (): Promise<Array<string>>

Returns:

Promise<Array<string>>

Source: index.d.ts, line 527, character 11

paychNewPayment

paychNewPayment (address: string, address1: string, voucherSpec: Array<VoucherSpec>): Promise<PaymentInfo>

Parameters:

• address: string
• address1: string
• voucherSpec: Array<VoucherSpec>

Returns:

Promise<PaymentInfo>

Source: index.d.ts, line 528, character 17

paychSettle

paychSettle (address: string): Promise<Cid>

Parameters:

• address: string

Returns:

Promise<Cid>

Source: index.d.ts, line 529, character 13

paychStatus

paychStatus (address: string): Promise<PaychStatus>

Parameters:

• address: string

Returns:

Promise<PaychStatus>

Source: index.d.ts, line 530, character 13

paychVoucherAdd

paychVoucherAdd (address: string, signedVoucher: SignedVoucher, bytes: string, bigInt: string): Promise<string>

Parameters:

• address: string
• signedVoucher: SignedVoucher
• bytes: string
• bigInt: string

Returns:

Promise<string>

Source: index.d.ts, line 531, character 17

paychVoucherCheckSpendable

paychVoucherCheckSpendable (address: string, signedVoucher: SignedVoucher, bytes: string, bytes1: string): Promise<boolean>

Parameters:

• address: string
• signedVoucher: SignedVoucher
• bytes: string
• bytes1: string

Returns:

Promise<boolean>

Source: index.d.ts, line 532, character 28

paychVoucherCheckValid

paychVoucherCheckValid (address: string, signedVoucher: SignedVoucher): Promise<void>

Parameters:

• address: string
• signedVoucher: SignedVoucher

Returns:

Promise<void>

Source: index.d.ts, line 533, character 24

paychVoucherCreate

paychVoucherCreate (address: string, bigInt: string, uint: number): Promise<VoucherCreateResult>

Parameters:

• address: string
• bigInt: string
• uint: number

Returns:

Promise<VoucherCreateResult>

Source: index.d.ts, line 534, character 20

paychVoucherList

paychVoucherList (address: string): Promise<Array<SignedVoucher>>

Parameters:

• address: string

Returns:

Promise<Array<SignedVoucher>>

Source: index.d.ts, line 535, character 18

paychVoucherSubmit

paychVoucherSubmit (address: string, signedVoucher: SignedVoucher, bytes: string, bytes1: string): Promise<Cid>

Parameters:

• address: string
• signedVoucher: SignedVoucher
• bytes: string
• bytes1: string

Returns:

Promise<Cid>

Source: index.d.ts, line 536, character 20