PayChannel
（PayChan Amendmentが必要です。）
PayChannelオブジェクトタイプは、Payment Channelを表します。Payment Channelにより、レジャー外で少額のXRPを迅速に支払うことができます。このような支払は、コンセンサスレジャーにより後日調整できます。Payment Channelは、このChannelが閉鎖されるまでは、特定の宛先アドレスに対してのみ支払可能なXRPの残高を保有します。Channelの閉鎖時に、未使用のXRPはChannelの所有者（Channelを作成し、資金を供給した支払元アドレス）に返金されます。
PaymentChannelCreateトランザクションタイプは、PayChannelオブジェクトを作成します。PaymentChannelFundトランザクションタイプとPaymentChannelClaimトランザクションタイプは、既存のPayChannelオブジェクトを変更します。
有効期限切れになったPayment Channelは、まずレジャーに残ります。これは、レジャーの内容を変更できるのは新しいトランザクションだけであるためです。有効期限の経過後にトランザクションがPayment Channelにアクセスすると、トランザクション処理によりそのPayment Channelは自動的に閉鎖されます。有効期限切れのChannelを閉鎖して未使用のXRPを所有者に返金するには、一部のアドレスがそのChannelにアクセスする新しいPaymentChannelClaimトランザクションまたはPaymentChannelFundトランザクションを送信する必要があります。
Payment Channelの使用例については、Payment Channelのチュートリアルを参照してください。
PayChannel JSONの例
{
"Account": "rBqb89MRQJnMPq8wTwEbtz4kvxrEDfcYvt",
"Destination": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"Amount": "4325800",
"Balance": "2323423",
"PublicKey": "32D2471DB72B27E3310F355BB33E339BF26F8392D5A93D3BC0FC3B566612DA0F0A",
"SettleDelay": 3600,
"Expiration": 536027313,
"CancelAfter": 536891313,
"SourceTag": 0,
"DestinationTag": 1002341,
"Flags": 0,
"LedgerEntryType": "PayChannel",
"OwnerNode": "0000000000000000",
"PreviousTxnID": "F0AB71E777B2DA54B86231E19B82554EF1F8211F92ECA473121C655BFC5329BF",
"PreviousTxnLgrSeq": 14524914,
"index": "96F76F27D8A327FC48753167EC04A46AA0E382E6F57F32FD12274144D00F1797"
}
PayChannelフィールド
PayChannelオブジェクトのフィールドは次のとおりです。
| 名前 | JSONの型 | 内部の型 | 説明 |
|---|---|---|---|
LedgerEntryType |
文字列 | UInt16 | 値0x0078が文字列PayChannelにマッピングされている場合は、このオブジェクトがPayment Channelオブジェクトであることを示します。 |
Account |
文字列 | AccountID | このPayment Channelを所有する支払元アドレス。これは、Channelを作成したトランザクションの送信側アドレスから取得されます。 |
Destination |
文字列 | AccountID | このPayment Channelの宛先アドレス。Payment Channelが開いている場合、このアドレスは、このChannelからXRPを受領できる唯一のアドレスです。これは、Channelを作成したトランザクションのDestinationフィールドから取得されます。 |
Amount |
文字列 | Amount | このChannelに割り当てられている XRP、drop単位の合計です。これには宛先アドレスに支払われたXRPも含まれます。最初にChannelを作成したトランザクションにより設定され、支払元アドレスがPaymentChannelFundトランザクションを送信する場合に増加できます。 |
Balance |
文字列 | Amount | このChannelがすでに支払ったXRP、drop単位の合計。この値とAmountフィールドの差異は、PaymentChannelClaimトランザクションの宛先アドレスに対して支払うことができるXRPの量を示します。Channelが閉鎖すると、残りの差額は支払元アドレスに返されます。 |
PublicKey |
文字列 | PubKey | このChannelに対するクレームの署名に使用できるキーペアの公開鍵（16進数）。有効なsecp256k1公開鍵またはEd25519公開鍵を指定できます。Channelを作成したトランザクションによって設定されます。Channelに対するクレームに使用される公開鍵と一致している必要があります。Channelの支払元アドレスは、署名付きクレームなしでこのChannelから宛先にXRPを送金することもできます。 |
SettleDelay |
数値 | UInt32 | ChannelにXRPがまだある場合に、支払元アドレスがそのChannelを閉鎖するまでに待機する秒数。値が小さい場合、支払元アドレスがChannelの閉鎖を要求した後で、宛先アドレスが未処理のクレームを精算できる時間が短くなります。32ビットの符号なし整数に収まる値（0～2^32-1）であれば任意の値を指定できます。これは、Channelを作成するトランザクションにより設定されます。 |
OwnerNode |
文字列 | UInt64 | 支払元アドレスの所有者のディレクトリが複数ページで構成されている場合に、このオブジェクトにリンクしているページを示すヒントです。 |
PreviousTxnID |
文字列 | Hash256 | 最後にこのオブジェクトを変更したトランザクションの識別用ハッシュ。 |
PreviousTxnLgrSeq |
数値 | UInt32 | 最後にこのオブジェクトを変更したトランザクションが記録されたレジャーインデックス。 |
Flags |
数値 | UInt32 | このPayment Channelに対して有効になっているブールフラグのビットマップ。現在、プロトコルではPayChannel オブジェクトのフラグは定義されていません。 |
Expiration |
数値 | UInt32 | （省略可） このPayment Channelの変更可能な有効期限（Rippleエポック以降の経過秒数）。この値が指定されており、前のレジャーのclose_timeフィールドよりも小さい場合、Channelは有効期限切れです。詳細は、Channel有効期限の設定を参照してください。 |
CancelAfter |
数値 | UInt32 | （省略可） このPayment Channelの不変の有効期限（Rippleエポック以降の経過秒数）。この値が指定されており、前のレジャーのclose_timeフィールドよりも小さい場合、Channelは有効期限切れです。これは、Channelを作成するトランザクションによりオプションで設定され、変更できません。 |
SourceTag |
数値 | UInt32 | （省略可） このPayment Channelの支払元（所有者のアドレスのホスティングされている受取人など） を詳しく指定するための任意のタグ。 |
DestinationTag |
数値 | UInt32 | （省略可） このPayment Channelの宛先（宛先アドレスのホスティングされている受取人など） を詳しく指定するための任意のタグ。 |
Channel有効期限の設定
Payment ChannelのExpirationフィールドは、CancelAfterフィールドが表す不変の有効期限とは対照的な変更可能な有効期限です。Channelの有効期限は常に、前のレジャーのclose_timeフィールドを基準にしているものとみなされます。PayChannelオブジェクトの作成時には、Expirationフィールドが省略されます。PayChannelオブジェクトのExpirationフィールドはさまざまな方法で更新できます。要約すると、Channelが最初の閉鎖試行操作の後、SettleDelay秒以上常に開いたままであれば、Channelの支払元アドレスはChannelのExpirationを自由に設定できます。
支払元アドレス
支払元アドレスは、PaymentChannelFundトランザクションタイプを使用して直接Expirationを設定できます。新しい値は、以下の早い方の値よりも前であってはなりません。
- 現在の
Expiration値（設定されている場合） - 前のレジャーの閉鎖時刻にChannelの
SettleDelayを加算した値
つまり、有効期限がすでに設定されている場合、支払元アドレスは常にExpirationを遅らせることができます。支払元は、設定する新しい値がSettleDelayの秒数以上の値である限り、Expirationを早い値にするか、またはExpirationがまだ設定されていない場合にこれを設定することができます。支払元アドレスが無効なExpirationの日付を設定しようとすると、トランザクションはエラーコードtemBAD_EXPIRATIONで失敗します。
支払元アドレスはPaymentChannelClaimトランザクションタイプのtfCloseフラグを使用してExpirationを設定することもできます。このフラグが有効な場合、レジャーは自動的にExpirationを以下のいずれかの早い方の値に設定します。
- 現在の
Expiration値（設定されている場合） - 前のレジャーの閉鎖時刻にChannelの
SettleDelayを加算した値
支払元アドレスはPaymentChannelClaimトランザクションタイプのtfRenewフラグを使用してExpirationを削除できます。
宛先アドレス
宛先アドレスは Expirationフィールドを設定できません。ただし、宛先アドレスはPaymentChannelClaimのtfCloseフラグを使用してChannelを即時に閉鎖できます。
その他のアドレス
その他のアドレスがExpirationフィールドを設定しようとすると、トランザクションはエラーコードtecNO_PERMISSIONで失敗します。ただし、Channelがすでに有効期限切れになっている場合、このトランザクションでChannelが閉鎖し、その結果はtesSUCCESSになります。
PayChannel IDのフォーマット
PayChannelオブジェクトのIDは、以下の値がこの順序で連結されているSHA-512ハーフです。
- PayChannelスペースキー（
0x0078） - 支払元アカウントのAccountID
- 宛先アカウントのAccountID
- Channelを作成したトランザクションのシーケンス番号