Add PaymentRequest and Payment messages

protocol/payment.go

@@ -0,0 +1,395 @@
+package protocol
+
+import (
+	"encoding/json"
+	"fmt"
+
+	"github.com/iden3/go-schema-processor/v2/verifiable"
+	"github.com/pkg/errors"
+
+	"github.com/iden3/iden3comm/v2"
+)
+
+const (
+	// PaymentRequestMessageType is a Iden3PaymentMessage payment type
+	PaymentRequestMessageType iden3comm.ProtocolMessage = iden3comm.Iden3Protocol + "credentials/0.1/payment-request"
+
+	// PaymentMessageType is a Iden3PaymentMessage payment type
+	PaymentMessageType iden3comm.ProtocolMessage = iden3comm.Iden3Protocol + "credentials/0.1/payment"
+
+	// Iden3PaymentRequestCryptoV1Type is a Iden3PaymentRequestCryptoV1 payment type
+	Iden3PaymentRequestCryptoV1Type = "Iden3PaymentRequestCryptoV1"
+
+	// Iden3PaymentRailsRequestV1Type is a Iden3PaymentRailsRequestV1 payment type
+	Iden3PaymentRailsRequestV1Type = "Iden3PaymentRailsRequestV1"
+
+	// Iden3PaymentCryptoV1Type is a Iden3PaymentCryptoV1 payment type
+	Iden3PaymentCryptoV1Type = "Iden3PaymentCryptoV1"
+
+	// Iden3PaymentRailsV1Type is a Iden3PaymentRailsV1 payment type
+	Iden3PaymentRailsV1Type = "Iden3PaymentRailsV1"
+)
+
+// PaymentRequestMessage represents Iden3message for payment request.
+type PaymentRequestMessage struct {
+	ID       string                    `json:"id"`
+	Typ      iden3comm.MediaType       `json:"typ,omitempty"`
+	Type     iden3comm.ProtocolMessage `json:"type"`
+	ThreadID string                    `json:"thid,omitempty"`
+
+	Body PaymentRequestMessageBody `json:"body,omitempty"`
+
+	From string `json:"from,omitempty"`
+	To   string `json:"to,omitempty"`
+}
+
+// PaymentRequestMessageBody represents the body of the PaymentRequestMessage.
+type PaymentRequestMessageBody struct {
+	Agent    string               `json:"agent"`
+	Payments []PaymentRequestInfo `json:"payments"`
+}
+
+// PaymentRequestInfo represents the payments request information.
+type PaymentRequestInfo struct {
+	Type        string                          `json:"type,omitempty"`
+	Credentials []PaymentRequestInfoCredentials `json:"credentials"`
+	Description string                          `json:"description"`
+	Data        PaymentRequestInfoData          `json:"data"`
+}
+
+// PaymentRequestInfoData is a union type for field Data in PaymentRequestInfo.
+// Only one of the fields can be set at a time.
+type PaymentRequestInfoData struct {
+	crypto []Iden3PaymentRequestCryptoV1
+	rails  []Iden3PaymentRailsRequestV1
+}
+
+// NewPaymentRequestInfoDataCrypto creates a new PaymentRequestInfoData with Iden3PaymentRequestCryptoV1 data.
+func NewPaymentRequestInfoDataCrypto(data Iden3PaymentRequestCryptoV1) PaymentRequestInfoData {
+	return PaymentRequestInfoData{
+		rails:  nil,
+		crypto: []Iden3PaymentRequestCryptoV1{data},
+	}
+}
+
+// NewPaymentRequestInfoDataRails creates a new PaymentRequestInfoData with Iden3PaymentRailsRequestV1 data.
+func NewPaymentRequestInfoDataRails(data Iden3PaymentRailsRequestV1) PaymentRequestInfoData {
+	return PaymentRequestInfoData{
+		rails:  []Iden3PaymentRailsRequestV1{data},
+		crypto: nil,
+	}
+}
+
+// Type returns the type of the data in the union. You can use Data() to get the data.
+func (p *PaymentRequestInfoData) Type() string {
+	if len(p.crypto) != 0 {
+		return Iden3PaymentRequestCryptoV1Type
+	}
+	if len(p.rails) != 0 {
+		return Iden3PaymentRailsRequestV1Type
+	}
+	return ""
+}
+
+// Data returns the data in the union. You can use Type() to determine the type of the data.
+func (p *PaymentRequestInfoData) Data() interface{} {
+	if len(p.crypto) != 0 {
+		return p.crypto
+	}
+	if len(p.rails) != 0 {
+		return p.rails
+	}
+	return nil
+}
+
+// MarshalJSON marshals the PaymentRequestInfoData into JSON.
+func (p PaymentRequestInfoData) MarshalJSON() ([]byte, error) {
+	if len(p.crypto) != 0 {
+		return json.Marshal(p.crypto[0])
+	}
+	if len(p.rails) != 0 {
+		return json.Marshal(p.rails)
+	}
+	return nil, errors.New("failed to marshal not initialized PaymentRequestInfoData")
+}
+
+// UnmarshalJSON unmarshal the PaymentRequestInfoData from JSON.
+func (p *PaymentRequestInfoData) UnmarshalJSON(data []byte) error {
+	var crypto Iden3PaymentRequestCryptoV1
+	var cryptoCol []Iden3PaymentRequestCryptoV1
+	var rails Iden3PaymentRailsRequestV1
+	var railsCol []Iden3PaymentRailsRequestV1
+
+	if err := json.Unmarshal(data, &crypto); err == nil {
+		if crypto.Type == Iden3PaymentRequestCryptoV1Type {
+			p.crypto = append(p.crypto, crypto)
+			return nil
+		}
+	}
+	if err := json.Unmarshal(data, &cryptoCol); err == nil {
+		if len(cryptoCol) != 0 {
+			if cryptoCol[0].Type == Iden3PaymentRequestCryptoV1Type {
+				p.crypto = append(p.crypto, cryptoCol...)
+				return nil
+			}
+		}
+	}
+	if err := json.Unmarshal(data, &rails); err == nil {
+		if rails.Type == Iden3PaymentRailsRequestV1Type {
+			p.rails = append(p.rails, rails)
+			return nil
+		}
+	}
+	if err := json.Unmarshal(data, &railsCol); err == nil {
+		if len(railsCol) != 0 {
+			if railsCol[0].Type == Iden3PaymentRailsRequestV1Type {
+				p.rails = append(p.rails, railsCol...)
+				return nil
+			}
+		}
+	}
+	return errors.Errorf("failed to unmarshal PaymentRequestInfoData: %s", string(data))
+}
+
+// Iden3PaymentRequestCryptoV1 represents the Iden3PaymentRequestCryptoV1 payment request data.
+type Iden3PaymentRequestCryptoV1 struct {
+	Type       string `json:"type"`
+	ID         string `json:"id"`
+	Context    string `json:"@context,omitempty"`
+	ChainID    string `json:"chainId"`
+	Address    string `json:"address"`
+	Amount     string `json:"amount"`
+	Currency   string `json:"currency"`
+	Expiration string `json:"expiration,omitempty"`
+}
+
+// Iden3PaymentRailsRequestV1 represents the Iden3PaymentRailsRequestV1 payment request data.
+type Iden3PaymentRailsRequestV1 struct {
+	Nonce          string                         `json:"nonce"`
+	Type           string                         `json:"type"`
+	Context        PaymentContext                 `json:"@context"`
+	Recipient      string                         `json:"recipient"`
+	Amount         string                         `json:"amount"` // Not negative number
+	ExpirationDate string                         `json:"expirationDate"`
+	Proof          EthereumEip712Signature2021Col `json:"proof"`
+	Metadata       string                         `json:"metadata"`
+	Currency       string                         `json:"currency"`
+}
+
+// EthereumEip712Signature2021Col is a list of EthereumEip712Signature2021.
+type EthereumEip712Signature2021Col []EthereumEip712Signature2021
+
+// UnmarshalJSON unmarshal the PaymentRequestInfoData from JSON.
+func (p *EthereumEip712Signature2021Col) UnmarshalJSON(data []byte) error {
+	var col []EthereumEip712Signature2021
+	if err := json.Unmarshal(data, &col); err != nil {
+		var single EthereumEip712Signature2021
+		if err := json.Unmarshal(data, &single); err != nil {
+			return fmt.Errorf("failed to unmarshal EthereumEip712Signature2021Col: %w", err)
+		}
+		col = append(col, single)
+	}
+	*p = col
+	return nil
+}
+
+// EthereumEip712Signature2021 represents the Ethereum EIP712 signature.
+type EthereumEip712Signature2021 struct {
+	Type               verifiable.ProofType `json:"type"`
+	ProofPurpose       string               `json:"proofPurpose"`
+	ProofValue         string               `json:"proofValue"`
+	VerificationMethod string               `json:"verificationMethod"`
+	Created            string               `json:"created"`
+	Eip712             Eip712Data           `json:"eip712"`
+}
+
+// Eip712Data represents the EIP712 data.
+type Eip712Data struct {
+	Types       string       `json:"types"`
+	PrimaryType string       `json:"primaryType"`
+	Domain      Eip712Domain `json:"domain"`
+}
+
+// Eip712Domain represents the EIP712 domain.
+type Eip712Domain struct {
+	Name              string `json:"name"`
+	Version           string `json:"version"`
+	ChainID           string `json:"chainId"`
+	VerifyingContract string `json:"verifyingContract"`
+	Salt              string `json:"salt"`
+}
+
+// PaymentRequestInfoCredentials represents the payment request credentials.
+type PaymentRequestInfoCredentials struct {
+	Context string `json:"context,omitempty"`
+	Type    string `json:"type,omitempty"`
+}
+
+// PaymentMessage represents Iden3message for payment.
+type PaymentMessage struct {
+	ID       string                    `json:"id"`
+	Typ      iden3comm.MediaType       `json:"typ,omitempty"`
+	Type     iden3comm.ProtocolMessage `json:"type"`
+	ThreadID string                    `json:"thid,omitempty"`
+
+	Body PaymentMessageBody `json:"body,omitempty"`
+
+	From string `json:"from,omitempty"`
+	To   string `json:"to,omitempty"`
+}
+
+// PaymentMessageBody represents the body of the PaymentMessage.
+type PaymentMessageBody struct {
+	Payments []Payment `json:"payments"`
+}
+
+// Payment is a union type for field Payments in PaymentMessageBody.
+// Only one of the fields can be set at a time.
+type Payment struct {
+	crypto *Iden3PaymentCryptoV1
+	rails  *Iden3PaymentRailsV1
+}
+
+// Type returns the type of the data in the union. You can use Data() to get the data.
+func (p *Payment) Type() string {
+	if p.crypto != nil {
+		return Iden3PaymentCryptoV1Type
+	}
+	if p.rails != nil {
+		return Iden3PaymentRailsV1Type
+	}
+	return ""
+}
+
+// Data returns the data in the union. You can use Type() to determine the type of the data.
+func (p *Payment) Data() interface{} {
+	if p.crypto != nil {
+		return p.crypto
+	}
+	if p.rails != nil {
+		return p.rails
+	}
+	return nil
+}
+
+// UnmarshalJSON unmarshal the Payment from JSON.
+func (p *Payment) UnmarshalJSON(bytes []byte) error {
+	var crypto Iden3PaymentCryptoV1
+	var rails Iden3PaymentRailsV1
+	if json.Unmarshal(bytes, &crypto) == nil {
+		if crypto.Type == Iden3PaymentCryptoV1Type {
+			p.crypto = &crypto
+			return nil
+		}
+	}
+	if json.Unmarshal(bytes, &rails) == nil {
+		if rails.Type == Iden3PaymentRailsV1Type {
+			p.rails = &rails
+			return nil
+		}
+	}
+	return errors.Errorf("failed to unmarshal PaymentRequestInfoData: %s", string(bytes))
+}
+
+// MarshalJSON marshals the Payment into JSON.
+func (p Payment) MarshalJSON() ([]byte, error) {
+	if p.crypto != nil {
+		return json.Marshal(p.crypto)
+	}
+	if p.rails != nil {
+		return json.Marshal(p.rails)
+	}
+	return nil, errors.New("failed to marshal not initialized Payment")
+}
+
+// Iden3PaymentCryptoV1 represents the Iden3PaymentCryptoV1 payment data.
+type Iden3PaymentCryptoV1 struct {
+	ID          string         `json:"id"`
+	Type        string         `json:"type"`
+	Context     PaymentContext `json:"@context,omitempty"`
+	PaymentData struct {
+		TxID string `json:"txId"`
+	} `json:"paymentData"`
+}
+
+// Iden3PaymentRailsV1 represents the Iden3PaymentRailsV1 payment data.
+type Iden3PaymentRailsV1 struct {
+	Nonce       string         `json:"nonce"`
+	Type        string         `json:"type"`
+	Context     PaymentContext `json:"@context,omitempty"`
+	PaymentData struct {
+		TxID    string `json:"txId"`
+		ChainID string `json:"chainId"`
+	} `json:"paymentData"`
+}
+
+// PaymentContext represents the payment context.
+type PaymentContext struct {
+	str     *string
+	strCol  []string
+	itemCol []interface{}
+}
+
+// NewPaymentContextString creates a new PaymentContext with a string.
+func NewPaymentContextString(str string) PaymentContext {
+	return PaymentContext{str: &str}
+}
+
+// NewPaymentContextStringCol creates a new PaymentContext with a string collection.
+func NewPaymentContextStringCol(strCol []string) PaymentContext {
+	return PaymentContext{strCol: strCol}
+}
+
+// NewPaymentContextItemCol creates a new PaymentContext with an interface{} collection.
+func NewPaymentContextItemCol(itemCol []interface{}) PaymentContext {
+	return PaymentContext{itemCol: itemCol}
+}
+
+// MarshalJSON marshals the PaymentContext into JSON.
+func (p PaymentContext) MarshalJSON() ([]byte, error) {
+	if p.str != nil {
+		return json.Marshal(p.str)
+	}
+	if len(p.strCol) != 0 {
+		return json.Marshal(p.strCol)
+	}
+	if len(p.itemCol) != 0 {
+		return json.Marshal(p.itemCol)
+	}
+	return nil, errors.New("failed to marshal not initialized PaymentContext")
+}
+
+// UnmarshalJSON unmarshal the PaymentContext from JSON.
+func (p *PaymentContext) UnmarshalJSON(data []byte) error {
+	var str string
+	var strCol []string
+	var itemCol []interface{}
+
+	if err := json.Unmarshal(data, &str); err == nil {
+		p.str = &str
+		return nil
+	}
+	if err := json.Unmarshal(data, &strCol); err == nil {
+		p.strCol = strCol
+		return nil
+	}
+	if err := json.Unmarshal(data, &itemCol); err == nil {
+		p.itemCol = itemCol
+		return nil
+	}
+	return errors.Errorf("failed to unmarshal PaymentContext: %s", string(data))
+}
+
+// Data returns the data in the union.
+func (p PaymentContext) Data() interface{} {
+	if p.str != nil {
+		return p.str
+	}
+	if len(p.strCol) != 0 {
+		return p.strCol
+	}
+	if len(p.itemCol) != 0 {
+		return p.itemCol
+	}
+	return nil
+}