Merge pull request #3 from code-payments/payments-with-relationship-accounts

Integrate relationship accounts more broadly into payment flows

Author: jeffyanta

generated/go/account/v1/account_service.pb.go

@@ -5,7 +5,7 @@
 
 import type { BinaryReadOptions, FieldList, JsonReadOptions, JsonValue, PartialMessage, PlainMessage } from "@bufbuild/protobuf";
 import { Message, proto3, protoInt64 } from "@bufbuild/protobuf";
-import { AccountType, Signature, SolanaAccountId } from "../../common/v1/model_pb";
+import { AccountType, Relationship, Signature, SolanaAccountId } from "../../common/v1/model_pb";
 import { ExchangeData } from "../../transaction/v2/transaction_service_pb";
 
 /**
@@ -366,6 +366,14 @@ export class TokenAccountInfo extends Message<TokenAccountInfo> {
    */
   mintDisplayName = "";
 
+  /**
+   * The relationship with a third party that this account has established with.
+   * This only applies to relevant account types (eg. RELATIONSHIP).
+   *
+   * @generated from field: code.common.v1.Relationship relationship = 16;
+   */
+  relationship?: Relationship;
+
   constructor(data?: PartialMessage<TokenAccountInfo>) {
     super();
     proto3.util.initPartial(data, this);
@@ -389,6 +397,7 @@ export class TokenAccountInfo extends Message<TokenAccountInfo> {
     { no: 13, name: "mint", kind: "message", T: SolanaAccountId },
     { no: 14, name: "mint_decimals", kind: "scalar", T: 13 /* ScalarType.UINT32 */ },
     { no: 15, name: "mint_display_name", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 16, name: "relationship", kind: "message", T: Relationship },
   ]);
 
   static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): TokenAccountInfo {

generated/go/account/v1/account_service.pb.validate.go

@@ -1697,11 +1697,21 @@ export class SendPrivatePaymentMetadata extends Message<SendPrivatePaymentMetada
  *
  * Action Spec:
  *
- * actions = [NoPrivacyTransferAction(PRIMARY, destination, ExchangeData.Quarks)]
+ * source = PRIMARY or RELATIONSHIP
+ * actions = [NoPrivacyTransferAction(source, destination, ExchangeData.Quarks)]
  *
  * @generated from message code.transaction.v2.SendPublicPaymentMetadata
  */
 export class SendPublicPaymentMetadata extends Message<SendPublicPaymentMetadata> {
+  /**
+   * The primary or relatinship account where funds will be sent from. The primary
+   * account is assumed if this field is not set for backwards compatibility with
+   * old clients.
+   *
+   * @generated from field: code.common.v1.SolanaAccountId source = 4;
+   */
+  source?: SolanaAccountId;
+
   /**
    * The destination token account to send funds to. This cannot be a Code
    * temporary account.
@@ -1732,6 +1742,7 @@ export class SendPublicPaymentMetadata extends Message<SendPublicPaymentMetadata
   static readonly runtime: typeof proto3 = proto3;
   static readonly typeName = "code.transaction.v2.SendPublicPaymentMetadata";
   static readonly fields: FieldList = proto3.util.newFieldList(() => [
+    { no: 4, name: "source", kind: "message", T: SolanaAccountId },
     { no: 1, name: "destination", kind: "message", T: SolanaAccountId },
     { no: 2, name: "exchange_data", kind: "message", T: ExchangeData },
     { no: 3, name: "is_withdrawal", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
@@ -1781,19 +1792,20 @@ export class SendPublicPaymentMetadata extends Message<SendPublicPaymentMetadata
  *
  * Action Spec (Deposit):
  *
+ * source = PRIMARY or RELATIONSHIP
  * actions = [
- *   TemporaryPrivacyTransferAction(PRIMARY, BUCKET_X_KIN, multiple * bucketSize),
+ *   TemporaryPrivacyTransferAction(source, BUCKET_X_KIN, multiple * bucketSize),
  *   TemporaryPrivacyExchangeAction(BUCKET_X_KIN, BUCKET_X_KIN, multiple * bucketSize),
  *   ...,
- *   TemporaryPrivacyTransferAction(PRIMARY, BUCKET_X_KIN, multiple * bucketSize),
+ *   TemporaryPrivacyTransferAction(source, BUCKET_X_KIN, multiple * bucketSize),
  *   TemporaryPrivacyExchangeAction(BUCKET_X_KIN, BUCKET_X_KIN, multiple * bucketSize),
  * ]
  *
  * @generated from message code.transaction.v2.ReceivePaymentsPrivatelyMetadata
  */
 export class ReceivePaymentsPrivatelyMetadata extends Message<ReceivePaymentsPrivatelyMetadata> {
   /**
-   * The temporary incoming or primary account to receive funds from
+   * The temporary incoming, primary or relationship account to receive funds from
    *
    * @generated from field: code.common.v1.SolanaAccountId source = 1;
    */
@@ -1807,9 +1819,9 @@ export class ReceivePaymentsPrivatelyMetadata extends Message<ReceivePaymentsPri
   quarks = protoInt64.zero;
 
   /**
-   * Is the receipt of funds from a deposti? If true, the source account must
-   * be the primary account. Otherwise, it must be from a temporary incoming
-   * account.
+   * Is the receipt of funds from a deposit? If true, the source account must
+   * be a primary or relationship account. Otherwise, it must be from a temporary
+   * incoming account.
    *
    * @generated from field: bool is_deposit = 3;
    */

generated/go/transaction/v2/transaction_service.pb.go

@@ -182,4 +182,8 @@ message TokenAccountInfo {
 
     // User-friendly display name for the mint
     string mint_display_name = 15 [(validate.rules).string.max_len = 32];
+
+    // The relationship with a third party that this account has established with.
+    // This only applies to relevant account types (eg. RELATIONSHIP).
+    common.v1.Relationship relationship = 16;
 }

generated/go/transaction/v2/transaction_service.pb.validate.go

@@ -504,8 +504,14 @@ message SendPrivatePaymentMetadata {
 //
 // Action Spec:
 //
-// actions = [NoPrivacyTransferAction(PRIMARY, destination, ExchangeData.Quarks)]
+// source = PRIMARY or RELATIONSHIP
+// actions = [NoPrivacyTransferAction(source, destination, ExchangeData.Quarks)]
 message SendPublicPaymentMetadata {
+    // The primary or relatinship account where funds will be sent from. The primary
+    // account is assumed if this field is not set for backwards compatibility with
+    // old clients.
+    common.v1.SolanaAccountId source = 4;
+
     // The destination token account to send funds to. This cannot be a Code
     // temporary account.
     common.v1.SolanaAccountId destination = 1 [(validate.rules).message.required = true];
@@ -514,7 +520,7 @@ message SendPublicPaymentMetadata {
     ExchangeData exchange_data = 2 [(validate.rules).message.required = true];
 
     // Is the payment a withdrawal? Currently, this is always true.
-    bool is_withdrawal = 3 [(validate.rules).bool.const = true];;
+    bool is_withdrawal = 3 [(validate.rules).bool.const = true];
 }
 
 // Receive funds into an organizer with initial temporary privacy. Clients should
@@ -543,23 +549,24 @@ message SendPublicPaymentMetadata {
 //
 // Action Spec (Deposit):
 //
+// source = PRIMARY or RELATIONSHIP
 // actions = [
-//   TemporaryPrivacyTransferAction(PRIMARY, BUCKET_X_KIN, multiple * bucketSize),
+//   TemporaryPrivacyTransferAction(source, BUCKET_X_KIN, multiple * bucketSize),
 //   TemporaryPrivacyExchangeAction(BUCKET_X_KIN, BUCKET_X_KIN, multiple * bucketSize),
 //   ...,
-//   TemporaryPrivacyTransferAction(PRIMARY, BUCKET_X_KIN, multiple * bucketSize),
+//   TemporaryPrivacyTransferAction(source, BUCKET_X_KIN, multiple * bucketSize),
 //   TemporaryPrivacyExchangeAction(BUCKET_X_KIN, BUCKET_X_KIN, multiple * bucketSize),
 // ]
 message ReceivePaymentsPrivatelyMetadata {
-    // The temporary incoming or primary account to receive funds from
+    // The temporary incoming, primary or relationship account to receive funds from
     common.v1.SolanaAccountId source = 1 [(validate.rules).message.required = true];
 
     // The exact amount of Kin in quarks being received
     uint64 quarks = 2 [(validate.rules).uint64.gt = 0];
 
-    // Is the receipt of funds from a deposti? If true, the source account must
-    // be the primary account. Otherwise, it must be from a temporary incoming
-    // account.
+    // Is the receipt of funds from a deposit? If true, the source account must
+    // be a primary or relationship account. Otherwise, it must be from a temporary
+    // incoming account.
     bool is_deposit = 3;
 }