Add signature memos [#3454]

pkg/build/parser.go

@@ -73,16 +73,24 @@ func (p *parser) parseDataEntry(v ...any) protocol.DataEntry {
 	return &protocol.AccumulateDataEntry{Data: p.parseDataEntryParts(v...)}
 }
 
+func (p *parser) parseBytes(v any) []byte {
+	switch v := v.(type) {
+	case string:
+		return []byte(v)
+	case []byte:
+		return v
+	case [32]byte:
+		return v[:]
+	default:
+		p.errorf(errors.BadRequest, "cannot convert %T to bytes", v)
+	}
+	return nil
+}
+
 func (p *parser) parseDataEntryParts(v ...any) [][]byte {
 	var parts [][]byte
 	for _, v := range v {
 		switch v := v.(type) {
-		case string:
-			parts = append(parts, []byte(v))
-		case []byte:
-			parts = append(parts, v)
-		case [32]byte:
-			parts = append(parts, v[:])
 		case []string:
 			for _, v := range v {
 				parts = append(parts, []byte(v))
@@ -95,8 +103,7 @@ func (p *parser) parseDataEntryParts(v ...any) [][]byte {
 				parts = append(parts, v[:])
 			}
 		default:
-			p.errorf(errors.BadRequest, "cannot convert %T to bytes", v)
-			return nil
+			parts = append(parts, p.parseBytes(v))
 		}
 	}
 	return parts

pkg/build/signature.go

@@ -100,6 +100,16 @@ func (b SignatureBuilder) Signer(signer any) SignatureBuilder {
 	return b
 }
 
+func (b SignatureBuilder) Memo(s string) SignatureBuilder {
+	b.signer.Memo = s
+	return b
+}
+
+func (b SignatureBuilder) Metadata(v any) SignatureBuilder {
+	b.signer.Data = b.parseBytes(v)
+	return b
+}
+
 func (b SignatureBuilder) PrivateKey(key []byte) SignatureBuilder {
 	b.signer.Signer = signing.PrivateKey(key)
 	return b

pkg/client/signing/builder.go

@@ -31,6 +31,8 @@ type Builder struct {
 	Version    uint64
 	Vote       protocol.VoteType
 	Timestamp  Timestamp
+	Memo       string
+	Data       []byte
 
 	// Ignore64Byte (when set) stops the signature builder from automatically
 	// correcting a transaction header or body that marshals to 64 bytes.
@@ -49,22 +51,32 @@ func (s *Builder) Import(sig protocol.Signature) (*Builder, error) {
 		s.Url = sig.Signer
 		s.Version = sig.SignerVersion
 		s.Timestamp = TimestampFromValue(sig.Timestamp)
+		s.Memo = sig.Memo
+		s.Data = sig.Data
 	case *protocol.RCD1Signature:
 		s.Url = sig.Signer
 		s.Version = sig.SignerVersion
 		s.Timestamp = TimestampFromValue(sig.Timestamp)
+		s.Memo = sig.Memo
+		s.Data = sig.Data
 	case *protocol.BTCSignature:
 		s.Url = sig.Signer
 		s.Version = sig.SignerVersion
 		s.Timestamp = TimestampFromValue(sig.Timestamp)
+		s.Memo = sig.Memo
+		s.Data = sig.Data
 	case *protocol.BTCLegacySignature:
 		s.Url = sig.Signer
 		s.Version = sig.SignerVersion
 		s.Timestamp = TimestampFromValue(sig.Timestamp)
+		s.Memo = sig.Memo
+		s.Data = sig.Data
 	case *protocol.ETHSignature:
 		s.Url = sig.Signer
 		s.Version = sig.SignerVersion
 		s.Timestamp = TimestampFromValue(sig.Timestamp)
+		s.Memo = sig.Memo
+		s.Data = sig.Data
 	case *protocol.DelegatedSignature:
 		_, err := s.Import(sig.Signature)
 		if err != nil {
@@ -220,6 +232,8 @@ func (s *Builder) prepare(init bool) (protocol.KeySignature, error) {
 		sig.SignerVersion = s.Version
 		sig.Timestamp = timestamp
 		sig.Vote = s.Vote
+		sig.Memo = s.Memo
+		sig.Data = s.Data
 		return sig, s.Signer.SetPublicKey(sig)
 
 	case protocol.SignatureTypeRCD1:
@@ -228,6 +242,8 @@ func (s *Builder) prepare(init bool) (protocol.KeySignature, error) {
 		sig.SignerVersion = s.Version
 		sig.Timestamp = timestamp
 		sig.Vote = s.Vote
+		sig.Memo = s.Memo
+		sig.Data = s.Data
 		return sig, s.Signer.SetPublicKey(sig)
 
 	case protocol.SignatureTypeBTC:
@@ -236,6 +252,8 @@ func (s *Builder) prepare(init bool) (protocol.KeySignature, error) {
 		sig.SignerVersion = s.Version
 		sig.Timestamp = timestamp
 		sig.Vote = s.Vote
+		sig.Memo = s.Memo
+		sig.Data = s.Data
 		return sig, s.Signer.SetPublicKey(sig)
 
 	case protocol.SignatureTypeBTCLegacy:
@@ -244,6 +262,8 @@ func (s *Builder) prepare(init bool) (protocol.KeySignature, error) {
 		sig.SignerVersion = s.Version
 		sig.Timestamp = timestamp
 		sig.Vote = s.Vote
+		sig.Memo = s.Memo
+		sig.Data = s.Data
 		return sig, s.Signer.SetPublicKey(sig)
 
 	case protocol.SignatureTypeETH:
@@ -252,6 +272,8 @@ func (s *Builder) prepare(init bool) (protocol.KeySignature, error) {
 		sig.SignerVersion = s.Version
 		sig.Timestamp = timestamp
 		sig.Vote = s.Vote
+		sig.Memo = s.Memo
+		sig.Data = s.Data
 		return sig, s.Signer.SetPublicKey(sig)
 
 	default:

protocol/signatures.yml

@@ -44,6 +44,12 @@ RCD1Signature:
     - name: TransactionHash
       type: hash
       optional: true
+    - name: Memo
+      type: string
+      optional: true
+    - name: Data
+      type: bytes
+      optional: true
 
 ED25519Signature:
   union: { type: signature }
@@ -67,6 +73,12 @@ ED25519Signature:
     - name: TransactionHash
       type: hash
       optional: true
+    - name: Memo
+      type: string
+      optional: true
+    - name: Data
+      type: bytes
+      optional: true
 
 BTCSignature:
   union: { type: signature }
@@ -90,6 +102,12 @@ BTCSignature:
     - name: TransactionHash
       type: hash
       optional: true
+    - name: Memo
+      type: string
+      optional: true
+    - name: Data
+      type: bytes
+      optional: true
 
 BTCLegacySignature:
   union: { type: signature }
@@ -113,6 +131,12 @@ BTCLegacySignature:
     - name: TransactionHash
       type: hash
       optional: true
+    - name: Memo
+      type: string
+      optional: true
+    - name: Data
+      type: bytes
+      optional: true
 
 ETHSignature:
   union: { type: signature }
@@ -136,6 +160,12 @@ ETHSignature:
     - name: TransactionHash
       type: hash
       optional: true
+    - name: Memo
+      type: string
+      optional: true
+    - name: Data
+      type: bytes
+      optional: true
 
 ReceiptSignature:
   union: { type: signature }