The Paych methods are for interacting with and managing payment channels
PaychAllocateLane
Perms: sign
Inputs:
Response: 42
PaychAvailableFunds
Perms: sign
Inputs:
Response:
Copy {
"Channel" : "f01234" ,
"From" : "f01234" ,
"To" : "f01234" ,
"ConfirmedAmt" : "0" ,
"PendingAmt" : "0" ,
"NonReservedAmt" : "0" ,
"PendingAvailableAmt" : "0" ,
"PendingWaitSentinel" : {
"/" : "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
} ,
"QueuedAmt" : "0" ,
"VoucherReedeemedAmt" : "0"
}
PaychAvailableFundsByFromTo
Perms: sign
Inputs:
Response:
Copy {
"Channel" : "f01234" ,
"From" : "f01234" ,
"To" : "f01234" ,
"ConfirmedAmt" : "0" ,
"PendingAmt" : "0" ,
"NonReservedAmt" : "0" ,
"PendingAvailableAmt" : "0" ,
"PendingWaitSentinel" : {
"/" : "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
} ,
"QueuedAmt" : "0" ,
"VoucherReedeemedAmt" : "0"
}
PaychCollect
Perms: sign
Inputs:
Response:
Copy {
"/" : "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}
PaychFund
PaychFund gets or creates a payment channel between address pair. The specified amount will be added to the channel through on-chain send for future use
Perms: sign
Inputs:
Copy [ "f01234" , "f01234" , "0" ]
Response:
Copy {
"Channel" : "f01234" ,
"WaitSentinel" : {
"/" : "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}
}
PaychGet
PaychGet gets or creates a payment channel between address pair The specified amount will be reserved for use. If there aren't enough non-reserved funds available, funds will be added through an on-chain message.
When opts.OffChain is true, this call will not cause any messages to be sent to the chain (no automatic channel creation/funds adding). If the operation can't be performed without sending a message an error will be returned. Note that even when this option is specified, this call can be blocked by previous operations on the channel waiting for on-chain operations.
Perms: sign
Inputs:
Copy [
"f01234" ,
"f01234" ,
"0" ,
{
"OffChain" : true
}
]
Response:
Copy {
"Channel" : "f01234" ,
"WaitSentinel" : {
"/" : "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}
}
PaychGetWaitReady
Perms: sign
Inputs:
Copy [
{
"/" : "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}
]
Response: "f01234"
PaychList
Perms: read
Inputs: null
Response:
PaychNewPayment
Perms: sign
Inputs:
Copy [
"f01234" ,
"f01234" ,
[
{
"Amount" : "0" ,
"TimeLockMin" : 10101 ,
"TimeLockMax" : 10101 ,
"MinSettle" : 10101 ,
"Extra" : {
"Actor" : "f01234" ,
"Method" : 1 ,
"Data" : "Ynl0ZSBhcnJheQ=="
}
}
]
]
Response:
Copy {
"Channel" : "f01234" ,
"WaitSentinel" : {
"/" : "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
} ,
"Vouchers" : [
{
"ChannelAddr" : "f01234" ,
"TimeLockMin" : 10101 ,
"TimeLockMax" : 10101 ,
"SecretHash" : "Ynl0ZSBhcnJheQ==" ,
"Extra" : {
"Actor" : "f01234" ,
"Method" : 1 ,
"Data" : "Ynl0ZSBhcnJheQ=="
} ,
"Lane" : 42 ,
"Nonce" : 42 ,
"Amount" : "0" ,
"MinSettleHeight" : 10101 ,
"Merges" : [
{
"Lane" : 42 ,
"Nonce" : 42
}
] ,
"Signature" : {
"Type" : 2 ,
"Data" : "Ynl0ZSBhcnJheQ=="
}
}
]
}
PaychSettle
Perms: sign
Inputs:
Response:
Copy {
"/" : "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}
PaychStatus
Perms: read
Inputs:
Response:
Copy {
"ControlAddr" : "f01234" ,
"Direction" : 1
}
PaychVoucherAdd
Perms: write
Inputs:
Copy [
"f01234" ,
{
"ChannelAddr" : "f01234" ,
"TimeLockMin" : 10101 ,
"TimeLockMax" : 10101 ,
"SecretHash" : "Ynl0ZSBhcnJheQ==" ,
"Extra" : {
"Actor" : "f01234" ,
"Method" : 1 ,
"Data" : "Ynl0ZSBhcnJheQ=="
} ,
"Lane" : 42 ,
"Nonce" : 42 ,
"Amount" : "0" ,
"MinSettleHeight" : 10101 ,
"Merges" : [
{
"Lane" : 42 ,
"Nonce" : 42
}
] ,
"Signature" : {
"Type" : 2 ,
"Data" : "Ynl0ZSBhcnJheQ=="
}
} ,
"Ynl0ZSBhcnJheQ==" ,
"0"
]
Response: "0"
PaychVoucherCheckSpendable
Perms: read
Inputs:
Copy [
"f01234" ,
{
"ChannelAddr" : "f01234" ,
"TimeLockMin" : 10101 ,
"TimeLockMax" : 10101 ,
"SecretHash" : "Ynl0ZSBhcnJheQ==" ,
"Extra" : {
"Actor" : "f01234" ,
"Method" : 1 ,
"Data" : "Ynl0ZSBhcnJheQ=="
} ,
"Lane" : 42 ,
"Nonce" : 42 ,
"Amount" : "0" ,
"MinSettleHeight" : 10101 ,
"Merges" : [
{
"Lane" : 42 ,
"Nonce" : 42
}
] ,
"Signature" : {
"Type" : 2 ,
"Data" : "Ynl0ZSBhcnJheQ=="
}
} ,
"Ynl0ZSBhcnJheQ==" ,
"Ynl0ZSBhcnJheQ=="
]
Response: true
PaychVoucherCheckValid
Perms: read
Inputs:
Copy [
"f01234" ,
{
"ChannelAddr" : "f01234" ,
"TimeLockMin" : 10101 ,
"TimeLockMax" : 10101 ,
"SecretHash" : "Ynl0ZSBhcnJheQ==" ,
"Extra" : {
"Actor" : "f01234" ,
"Method" : 1 ,
"Data" : "Ynl0ZSBhcnJheQ=="
} ,
"Lane" : 42 ,
"Nonce" : 42 ,
"Amount" : "0" ,
"MinSettleHeight" : 10101 ,
"Merges" : [
{
"Lane" : 42 ,
"Nonce" : 42
}
] ,
"Signature" : {
"Type" : 2 ,
"Data" : "Ynl0ZSBhcnJheQ=="
}
}
]
Response: {}
PaychVoucherCreate
Perms: sign
Inputs:
Response:
Copy {
"Voucher" : {
"ChannelAddr" : "f01234" ,
"TimeLockMin" : 10101 ,
"TimeLockMax" : 10101 ,
"SecretHash" : "Ynl0ZSBhcnJheQ==" ,
"Extra" : {
"Actor" : "f01234" ,
"Method" : 1 ,
"Data" : "Ynl0ZSBhcnJheQ=="
} ,
"Lane" : 42 ,
"Nonce" : 42 ,
"Amount" : "0" ,
"MinSettleHeight" : 10101 ,
"Merges" : [
{
"Lane" : 42 ,
"Nonce" : 42
}
] ,
"Signature" : {
"Type" : 2 ,
"Data" : "Ynl0ZSBhcnJheQ=="
}
} ,
"Shortfall" : "0"
}
PaychVoucherList
Perms: write
Inputs:
Response:
Copy [
{
"ChannelAddr" : "f01234" ,
"TimeLockMin" : 10101 ,
"TimeLockMax" : 10101 ,
"SecretHash" : "Ynl0ZSBhcnJheQ==" ,
"Extra" : {
"Actor" : "f01234" ,
"Method" : 1 ,
"Data" : "Ynl0ZSBhcnJheQ=="
} ,
"Lane" : 42 ,
"Nonce" : 42 ,
"Amount" : "0" ,
"MinSettleHeight" : 10101 ,
"Merges" : [
{
"Lane" : 42 ,
"Nonce" : 42
}
] ,
"Signature" : {
"Type" : 2 ,
"Data" : "Ynl0ZSBhcnJheQ=="
}
}
]
PaychVoucherSubmit
Perms: sign
Inputs:
Copy [
"f01234" ,
{
"ChannelAddr" : "f01234" ,
"TimeLockMin" : 10101 ,
"TimeLockMax" : 10101 ,
"SecretHash" : "Ynl0ZSBhcnJheQ==" ,
"Extra" : {
"Actor" : "f01234" ,
"Method" : 1 ,
"Data" : "Ynl0ZSBhcnJheQ=="
} ,
"Lane" : 42 ,
"Nonce" : 42 ,
"Amount" : "0" ,
"MinSettleHeight" : 10101 ,
"Merges" : [
{
"Lane" : 42 ,
"Nonce" : 42
}
] ,
"Signature" : {
"Type" : 2 ,
"Data" : "Ynl0ZSBhcnJheQ=="
}
} ,
"Ynl0ZSBhcnJheQ==" ,
"Ynl0ZSBhcnJheQ=="
]
Response:
Copy {
"/" : "bafy2bzacea3wsdh6y3a36tb3skempjoxqpuyompjbmfeyf34fi3uy6uue42v4"
}