mirror of
https://github.com/bitcoin/bips.git
synced 2024-11-19 09:50:06 +01:00
8bb63058fd
- Remove status_code and status_message from individual Payment Protocol messages - Remove EncryptedInvoiceRequest, EncryptedPaymentRequest, EncryptedPayment and EncryptedPaymentACK messages from protobuf definition file - Add ProtocolMessageType enum and ProtocolMessageType and EncryptedProtocolMesssage messages to bip-0075/paymentrequest.proto definition file - Update BIP75 text to remove old individual message encryption paths and include new encapsulating messages for self-contained PaymentProtocol communication (including errors) over various transport layers - Add initial list of status codes - Update BIP75 to use AES-256-GCM and remove message hash as GCM mode provides authenticated encryption - Update ECDH calculation to use SHA256 hash of ECDH's X point instead of the raw X point itself
84 lines
4.8 KiB
Protocol Buffer
84 lines
4.8 KiB
Protocol Buffer
//
|
|
// Simple Bitcoin Payment Protocol messages
|
|
//
|
|
// Use fields 1000+ for extensions;
|
|
// to avoid conflicts, register extensions via pull-req at
|
|
// https://github.com/bitcoin/bips/bip-0070/extensions.mediawiki
|
|
//
|
|
|
|
package payments;
|
|
option java_package = "org.bitcoin.protocols.payments";
|
|
option java_outer_classname = "Protos";
|
|
|
|
// Generalized form of "send payment to this/these bitcoin addresses"
|
|
message Output {
|
|
optional uint64 amount = 1 [default = 0]; // amount is integer-number-of-satoshis
|
|
required bytes script = 2; // usually one of the standard Script forms
|
|
}
|
|
message PaymentDetails {
|
|
optional string network = 1 [default = "main"]; // "main" or "test"
|
|
repeated Output outputs = 2; // Where payment should be sent
|
|
required uint64 time = 3; // Timestamp; when payment request created
|
|
optional uint64 expires = 4; // Timestamp; when this request should be considered invalid
|
|
optional string memo = 5; // Human-readable description of request for the customer
|
|
optional string payment_url = 6; // URL to send Payment and get PaymentACK
|
|
optional bytes merchant_data = 7; // Arbitrary data to include in the Payment message
|
|
}
|
|
message PaymentRequest {
|
|
optional uint32 payment_details_version = 1 [default = 1];
|
|
optional string pki_type = 2 [default = "none"]; // none / x509+sha256 / x509+sha1
|
|
optional bytes pki_data = 3; // depends on pki_type
|
|
required bytes serialized_payment_details = 4; // PaymentDetails
|
|
optional bytes signature = 5; // pki-dependent signature
|
|
}
|
|
message X509Certificates {
|
|
repeated bytes certificate = 1; // DER-encoded X.509 certificate chain
|
|
}
|
|
message Payment {
|
|
optional bytes merchant_data = 1; // From PaymentDetails.merchant_data
|
|
repeated bytes transactions = 2; // Signed transactions that satisfy PaymentDetails.outputs
|
|
repeated Output refund_to = 3; // Where to send refunds, if a refund is necessary
|
|
optional string memo = 4; // Human-readable message for the merchant
|
|
}
|
|
message PaymentACK {
|
|
required Payment payment = 1; // Payment message that triggered this ACK
|
|
optional string memo = 2; // Human-readable message for customer
|
|
}
|
|
|
|
// BIP-IR Extensions
|
|
message InvoiceRequest {
|
|
required bytes sender_public_key = 1; // Sender's DER-Encoded EC Public Key
|
|
optional uint64 amount = 3 [default = 0]; // amount is integer-number-of-satoshis
|
|
optional string pki_type = 4 [default = "none"]; // none / x509+sha256
|
|
optional bytes pki_data = 5; // Depends on pki_type
|
|
optional string memo = 6; // Human-readable description of invoice request for the receiver
|
|
optional string notification_url = 7; // URL to notify on EncryptedPaymentRequest ready
|
|
optional bytes signature = 8; // PKI-dependent signature
|
|
}
|
|
|
|
enum ProtocolMessageType {
|
|
INVOICE_REQUEST = 0;
|
|
PAYMENT_REQUEST = 1;
|
|
PAYMENT = 2;
|
|
PAYMENT_ACK = 3;
|
|
}
|
|
|
|
message ProtocolMessage {
|
|
required ProtocolMessageType message_type = 1; // Message Type of serialized_message
|
|
required bytes serialized_message = 2; // Serialized Payment Protocol Message
|
|
optional uint64 status_code = 3; // Payment Protocol Status Code
|
|
optional string status_message = 4; // Human-readable Payment Protocol status message
|
|
optional bytes identifier = 5; // Unique key to identify this entire exchange on the server. SHA256 of initial serialized InvoiceRequest SHOULD be used by default
|
|
}
|
|
|
|
message EncryptedProtocolMessage {
|
|
required ProtocolMessageType message_type = 1; // Message Type of Decrypted encrypted_message
|
|
required bytes encrypted_message = 2; // AES-256-GCM Encrypted (as defined in BIP75) Payment Protocol Message
|
|
required bytes receiver_public_key = 3; // Receiver's DER-encoded EC Public Key
|
|
required bytes sender_public_key = 4; // Sender's DER-encoded EC Public Key
|
|
required uint64 nonce = 5; // Microseconds since epoch
|
|
optional bytes signature = 6; // Signature over the full EncryptedProtocolMessage with EC Key Belonging to Sender / Receiver, respectively
|
|
optional bytes identifier = 7; // Unique key to identify this entire exchange on the server. SHA256 of initial serialized InvoiceRequest SHOULD be used by default
|
|
optional uint64 status_code = 8; // Payment Protocol Status Code
|
|
optional string status_message = 9; // Human-readable Payment Protocol status message
|
|
} |