channel_authorize
(PayChan Amendmentが有効になっている必要があります。)
channel_authorize
メソッドは、特定額のXRPをPayment Channelから清算するときに使用できる署名を作成します。
リクエストのフォーマット
リクエストのフォーマットの例:
{ "id": "channel_authorize_example_id1", "command": "channel_authorize", "channel_id": "5DB01B7FFED6B67E6B0414DED11E051D2EE2B7619CE0EAA6286D67A3A4D5BDB3", "seed": "s████████████████████████████", "key_type": "secp256k1", "amount": "1000000", }
リクエストには以下のパラメーターが含まれます。
フィールド | 型 | 説明 |
---|---|---|
channel_id | 文字列 | Payment Channelが使用する一意のID。 |
secret | 文字列 | (省略可) クレームへの署名に使用する秘密鍵。これは、Channelに指定されている公開鍵と同じキーペアである必要があります。seed 、seed_hex 、passphrase と同時に使用することはできません。 |
seed | 文字列 | (省略可) クレームへの署名に使用する秘密シード。これは、Channelに指定されている公開鍵と同じキーペアである必要があります。XRP Ledgerのbase58フォーマットにする必要があります。指定する場合は、key_type も指定する必要があります。secret 、seed_hex 、passphrase と同時に使用することはできません。 |
seed_hex | 文字列 | (省略可) クレームへの署名に使用する秘密シード。これは、Channelに指定されている公開鍵と同じキーペアである必要があります。16進フォーマットにする必要があります。指定する場合は、key_type も指定する必要があります。secret 、seed 、passphrase と同時に使用することはできません。 |
passphrase | 文字列 | (省略可) クレームへの署名に使用する文字列パスフレーズ。これは、Channelに指定されている公開鍵と同じキーペアである必要があります。このパスフレーズから導出した鍵は、チャネルで指定された公開鍵と一致する必要があります。指定する場合は、key_type も指定する必要があります。secret 、seed 、seed_hex と同時に使用することはできません。 |
key_type | 文字列 | (省略可) 指定された暗号化キーペアの署名アルゴリズム。有効な種類は、secp256k1 またはed25519 です。デフォルトはsecp256k1 です。 |
amount | 文字列 | 承認するXRPの累積額(drop数)送金先がこのChannelからすでに受領しているXRPの額がこのフィールドの額よりも少ない場合、このメソッドで作成される署名を使用して差額を清算できます。 |
リクエストでは、secret
、seed
、seed_hex
、passphrase
のうち1つだけを指定する必要があります。
警告: 信頼できないサーバに対して、またはセキュリティが確保されていないネットワーク接続を通じて秘密鍵を送信しないでください。(これには、このリクエストのsecret
、seed
、seed_hex
、またはpassphrase
フィールドも含まれます)このメソッドは、自身が実行するサーバ、または資金を預けている十分に信頼できるサーバへの、安全で暗号化されたネットワーク接続でのみ使用してください。そうでない場合、盗聴者があなたの秘密鍵を使用してクレームに署名し、同じキーペアを使用してこのPayment Channelなどから資金をすべて持ち出す可能性があります。手順については、安全な署名の設定をご覧ください。
レスポンスのフォーマット
処理が成功したレスポンスの例:
{ "id": "channel_authorize_example_id1", "status": "success", "result": { "signature": "304402204EF0AFB78AC23ED1C472E74F4299C0C21F1B21D07EFC0A3838A420F76D783A400220154FB11B6F54320666E4C36CA7F686C16A3A0456800BBC43746F34AF50290064", } }
このレスポンスは標準フォーマットに従っており、正常に完了した場合は結果に次のフィールドが含まれます。
フィールド | 型 | 説明 |
---|---|---|
signature | 文字列 | このクレームの署名(16進値)。このクレームを処理するには、Payment Channelの送金先アカウントがこの署名、正確なChannel ID、XRPの額、およびChannelの公開鍵が指定されたPaymentChannelClaimトランザクションを送信する必要があります。 |