Add thirdPartyAddress to the Attribute's shareInfo

packages/consumption/src/modules/attributes/AttributesController.ts

@@ -340,7 +340,8 @@ export class AttributesController extends ConsumptionBaseController {
         const shareInfo = LocalAttributeShareInfo.from({
             peer: parsedParams.peer,
             requestReference: parsedParams.requestReference,
-            sourceAttribute: parsedParams.sourceAttributeId
+            sourceAttribute: parsedParams.sourceAttributeId,
+            thirdPartyAddress: sourceAttribute.shareInfo?.peer
         });
 
         const sharedLocalAttributeCopy = await LocalAttribute.fromAttribute(sourceAttribute.content, undefined, shareInfo, parsedParams.attributeId);
@@ -353,7 +354,8 @@ export class AttributesController extends ConsumptionBaseController {
     public async createSharedLocalAttribute(params: ICreateSharedLocalAttributeParams): Promise<LocalAttribute> {
         const shareInfo = LocalAttributeShareInfo.from({
             peer: params.peer,
-            requestReference: params.requestReference
+            requestReference: params.requestReference,
+            thirdPartyAddress: params.thirdPartyAddress
         });
         const peerLocalAttribute = LocalAttribute.from({
             id: params.id ?? (await ConsumptionIds.attribute.generate()),

packages/consumption/src/modules/attributes/local/CreateSharedLocalAttributeParams.ts

@@ -7,13 +7,15 @@ export interface CreateSharedLocalAttributeParamsJSON {
     content: IdentityAttributeJSON | RelationshipAttributeJSON;
     requestReferece: string;
     peer: string;
+    thirdPartyAddress?: string;
 }
 
 export interface ICreateSharedLocalAttributeParams extends ISerializable {
     id?: ICoreId; // needs to be optional because sometimes (e.g. when accepting a CreateAttributeRequestItem) the id is not known yet
     content: IIdentityAttribute | IRelationshipAttribute;
     requestReference: ICoreId;
     peer: ICoreAddress;
+    thirdPartyAddress?: ICoreAddress;
 }
 
 export class CreateSharedLocalAttributeParams extends Serializable implements ICreateSharedLocalAttributeParams {
@@ -33,6 +35,10 @@ export class CreateSharedLocalAttributeParams extends Serializable implements IC
     @validate()
     public peer: CoreAddress;
 
+    @serialize()
+    @validate({ nullable: true })
+    public thirdPartyAddress?: CoreAddress;
+
     public static from(value: ICreateSharedLocalAttributeParams | CreateSharedLocalAttributeParamsJSON): CreateSharedLocalAttributeParams {
         return this.fromAny(value);
     }

packages/consumption/src/modules/attributes/local/LocalAttribute.ts

@@ -50,6 +50,12 @@ export type OwnSharedRelationshipAttribute = LocalAttribute & {
     isDefault: undefined;
 };
 
+export type OwnSharedThirdPartyRelationshipAttribute = OwnSharedRelationshipAttribute & {
+    shareInfo: OwnSharedRelationshipAttribute["shareInfo"] & {
+        thirdPartyAddress: CoreAddress;
+    };
+};
+
 export type PeerSharedIdentityAttribute = LocalAttribute & {
     content: IdentityAttribute;
     shareInfo: LocalAttributeShareInfo & { sourceAttribute: undefined };
@@ -62,9 +68,17 @@ export type PeerSharedRelationshipAttribute = LocalAttribute & {
     isDefault: undefined;
 };
 
+export type PeerSharedThirdPartyRelationshipAttribute = PeerSharedRelationshipAttribute & {
+    shareInfo: PeerSharedRelationshipAttribute["shareInfo"] & {
+        thirdPartyAddress: CoreAddress;
+    };
+};
+
 export type ThirdPartyOwnedRelationshipAttribute = LocalAttribute & {
     content: RelationshipAttribute;
-    shareInfo: LocalAttributeShareInfo;
+    shareInfo: LocalAttribute["shareInfo"] & {
+        thirdPartyAddress: CoreAddress;
+    };
     isDefault: undefined;
 };
 
@@ -166,6 +180,18 @@ export class LocalAttribute extends CoreSynchronizable implements ILocalAttribut
         return isPeerSharedAttribute;
     }
 
+    public isOwnSharedThirdPartyRelationshipAttribute(ownAddress: CoreAddress): this is OwnSharedThirdPartyRelationshipAttribute {
+        const isThirdPartyAttribute = this.shareInfo?.thirdPartyAddress !== undefined;
+        const isOwnShared = this.isOwnedBy(ownAddress);
+        return isThirdPartyAttribute && isOwnShared;
+    }
+
+    public isPeerSharedThirdPartyRelationshipAttribute(peerAddress: CoreAddress): this is PeerSharedThirdPartyRelationshipAttribute {
+        const isThirdPartyAttribute = this.shareInfo?.thirdPartyAddress !== undefined;
+        const isPeerShared = this.isOwnedBy(peerAddress);
+        return isThirdPartyAttribute && isPeerShared;
+    }
+
     public isThirdPartyOwnedAttribute(ownAddress: CoreAddress, thirdPartyAddress?: CoreAddress): this is ThirdPartyOwnedRelationshipAttribute {
         let isThirdPartyOwnedAttribute = this.isShared() && !this.isOwnedBy(ownAddress) && !this.isOwnedBy(this.shareInfo.peer);
 

packages/consumption/src/modules/attributes/local/LocalAttributeShareInfo.ts

@@ -3,22 +3,22 @@ import { CoreAddress, CoreId, ICoreAddress, ICoreId } from "@nmshd/core-types";
 import { nameof } from "ts-simple-nameof";
 import { ConsumptionError } from "../../../consumption/ConsumptionError";
 
-/* Either of requestReference or noticicationReference must be set, but not both. */
+/* Either of requestReference or notificationReference must be set, but not both. */
 export interface LocalAttributeShareInfoJSON {
     requestReference?: string;
     notificationReference?: string;
-
     peer: string;
     sourceAttribute?: string;
+    thirdPartyAddress?: string;
 }
 
-/* Either of requestReference or noticicationReference must be set, but not both. */
+/* Either of requestReference or notificationReference must be set, but not both. */
 export interface ILocalAttributeShareInfo extends ISerializable {
     requestReference?: ICoreId;
     notificationReference?: ICoreId;
-
     peer: ICoreAddress;
     sourceAttribute?: ICoreId;
+    thirdPartyAddress?: ICoreAddress;
 }
 
 export class LocalAttributeShareInfo extends Serializable implements ILocalAttributeShareInfo {
@@ -38,6 +38,10 @@ export class LocalAttributeShareInfo extends Serializable implements ILocalAttri
     @validate({ nullable: true })
     public sourceAttribute?: CoreId;
 
+    @serialize()
+    @validate({ nullable: true })
+    public thirdPartyAddress?: CoreAddress;
+
     public static from(value: ILocalAttributeShareInfo | LocalAttributeShareInfoJSON): LocalAttributeShareInfo {
         return super.fromAny(value) as LocalAttributeShareInfo;
     }

packages/consumption/src/modules/requests/itemProcessors/readAttribute/ReadAttributeRequestItemProcessor.ts

@@ -230,7 +230,8 @@ export class ReadAttributeRequestItemProcessor extends GenericRequestItemProcess
                 return ReadAttributeAcceptResponseItem.from({
                     result: ResponseItemResult.Accepted,
                     attributeId: sharedLocalAttribute.id,
-                    attribute: sharedLocalAttribute.content
+                    attribute: sharedLocalAttribute.content,
+                    thirdPartyAddress: sharedLocalAttribute.shareInfo?.thirdPartyAddress
                 });
             }
 
@@ -306,25 +307,31 @@ export class ReadAttributeRequestItemProcessor extends GenericRequestItemProcess
     }
 
     private async performOwnSharedThirdPartyRelationshipAttributeSuccession(sharedPredecessorId: CoreId, sourceSuccessor: LocalAttribute, requestInfo: LocalRequestInfo) {
+        const predecessor = await this.consumptionController.attributes.getLocalAttribute(sharedPredecessorId);
+
         const successorParams = {
             content: sourceSuccessor.content,
             shareInfo: LocalAttributeShareInfo.from({
                 peer: requestInfo.peer,
                 requestReference: requestInfo.id,
-                sourceAttribute: sourceSuccessor.id
+                sourceAttribute: sourceSuccessor.id,
+                thirdPartyAddress: predecessor?.shareInfo?.thirdPartyAddress
             })
         };
         const { successor } = await this.consumptionController.attributes.succeedOwnSharedRelationshipAttribute(sharedPredecessorId, successorParams);
         return successor;
     }
 
     private async performThirdPartyOwnedRelationshipAttributeSuccession(sharedPredecessorId: CoreId, sourceSuccessor: LocalAttribute, requestInfo: LocalRequestInfo) {
+        const predecessor = await this.consumptionController.attributes.getLocalAttribute(sharedPredecessorId);
+
         const successorParams = {
             content: sourceSuccessor.content,
             shareInfo: LocalAttributeShareInfo.from({
                 peer: requestInfo.peer,
                 requestReference: requestInfo.id,
-                sourceAttribute: sourceSuccessor.id
+                sourceAttribute: sourceSuccessor.id,
+                thirdPartyAddress: predecessor?.shareInfo?.thirdPartyAddress
             })
         };
         const { successor } = await this.consumptionController.attributes.succeedThirdPartyOwnedRelationshipAttribute(sharedPredecessorId, successorParams);
@@ -361,7 +368,8 @@ export class ReadAttributeRequestItemProcessor extends GenericRequestItemProcess
                 id: responseItem.attributeId,
                 content: responseItem.attribute,
                 peer: requestInfo.peer,
-                requestReference: requestInfo.id
+                requestReference: requestInfo.id,
+                thirdPartyAddress: responseItem.thirdPartyAddress
             });
         }
 
@@ -378,7 +386,13 @@ export class ReadAttributeRequestItemProcessor extends GenericRequestItemProcess
             if (responseItem.successorContent instanceof IdentityAttribute) {
                 const { predecessor, successor } = await this.consumptionController.attributes.succeedPeerSharedIdentityAttribute(responseItem.predecessorId, successorParams);
                 return new PeerSharedAttributeSucceededEvent(this.currentIdentityAddress.toString(), predecessor, successor);
-            } else if (responseItem.successorContent.owner === requestInfo.peer) {
+            }
+            const predecessor = await this.consumptionController.attributes.getLocalAttribute(responseItem.predecessorId);
+
+            if (successorParams.shareInfo) {
+                successorParams.shareInfo.thirdPartyAddress = predecessor?.shareInfo?.thirdPartyAddress;
+            }
+            if (responseItem.successorContent.owner === requestInfo.peer) {
                 await this.consumptionController.attributes.succeedPeerSharedRelationshipAttribute(responseItem.predecessorId, successorParams);
             } else {
                 await this.consumptionController.attributes.succeedThirdPartyOwnedRelationshipAttribute(responseItem.predecessorId, successorParams);

packages/consumption/src/modules/requests/itemProcessors/shareAttribute/ShareAttributeRequestItemProcessor.ts

@@ -130,6 +130,18 @@ export class ShareAttributeRequestItemProcessor extends GenericRequestItemProces
             if (nonPendingRelationshipsToPeer.length === 0) {
                 return ValidationResult.error(ConsumptionCoreErrors.requests.cannotShareRelationshipAttributeOfPendingRelationship());
             }
+
+            if (!requestItem.thirdPartyAddress) {
+                return ValidationResult.error(
+                    ConsumptionCoreErrors.requests.invalidRequestItem(
+                        "The source attribute provided is a RelationshipAttribute. You must provide a third party address that is the original peer when sharing with a third party."
+                    )
+                );
+            }
+
+            if (!requestItem.thirdPartyAddress.equals(foundAttribute.shareInfo.peer)) {
+                return ValidationResult.error(ConsumptionCoreErrors.requests.invalidRequestItem("The third party address must be the peer of the RelationshipAttribute."));
+            }
         }
 
         if (requestItem.attribute instanceof IdentityAttribute) {
@@ -172,7 +184,8 @@ export class ShareAttributeRequestItemProcessor extends GenericRequestItemProces
         const localAttribute = await this.consumptionController.attributes.createSharedLocalAttribute({
             content: requestItem.attribute,
             peer: requestInfo.peer,
-            requestReference: requestInfo.id
+            requestReference: requestInfo.id,
+            thirdPartyAddress: requestItem.thirdPartyAddress
         });
 
         return ShareAttributeAcceptResponseItem.from({

packages/consumption/test/modules/attributes/AttributesController.test.ts

@@ -336,8 +336,38 @@ describe("AttributesController", function () {
 
             mockEventBus.expectLastPublishedEvent(AttributeCreatedEvent);
         });
-    });
 
+        test("should add a third party address when creating a shared copy of a relationship attribute", async function () {
+            const thirdPartyAddress = CoreAddress.from("thirdParty");
+            const peerAddress = CoreAddress.from("peerAddress");
+
+            const relationshipAttribute = await consumptionController.attributes.createAttributeUnsafe({
+                content: RelationshipAttribute.from({
+                    key: "customerId",
+                    value: {
+                        "@type": "ProprietaryString",
+                        value: "0815",
+                        title: "Customer ID"
+                    },
+                    owner: CoreAddress.from("thirdPartyAddress"),
+                    confidentiality: RelationshipAttributeConfidentiality.Public
+                }),
+                shareInfo: {
+                    peer: thirdPartyAddress,
+                    requestReference: CoreId.from("reqRefA")
+                }
+            });
+
+            const thirdPartyLocalAttributeCopy = await consumptionController.attributes.createSharedLocalAttributeCopy({
+                peer: peerAddress,
+                requestReference: CoreId.from("reqRefB"),
+                sourceAttributeId: relationshipAttribute.id,
+                attributeId: CoreId.from("ATTthirdParty")
+            });
+
+            expect(thirdPartyLocalAttributeCopy.shareInfo?.thirdPartyAddress?.toString()).toBe(thirdPartyAddress.toString());
+        });
+    });
     describe("query Attributes", function () {
         test("should allow to query relationship attributes with empty owner", async function () {
             const relationshipAttributeParams: ICreateSharedLocalAttributeParams = {
@@ -2361,7 +2391,8 @@ describe("AttributesController", function () {
                     shareInfo: {
                         peer: CoreAddress.from("peerAddress"),
                         requestReference: CoreId.from("reqRefA"),
-                        sourceAttribute: CoreId.from("ATT0")
+                        sourceAttribute: CoreId.from("ATT0"),
+                        thirdPartyAddress: CoreAddress.from("thirdPartyAddress")
                     }
                 });
                 const successorParams: IAttributeSuccessorParams = {
@@ -2378,7 +2409,8 @@ describe("AttributesController", function () {
                     shareInfo: {
                         peer: CoreAddress.from("peerAddress"),
                         requestReference: CoreId.from("reqRefB"),
-                        sourceAttribute: CoreId.from("ATT1")
+                        sourceAttribute: CoreId.from("ATT1"),
+                        thirdPartyAddress: CoreAddress.from("thirdPartyAddress")
                     }
                 };
 

packages/consumption/test/modules/attributes/LocalAttributeShareInfo.test.ts

@@ -20,6 +20,18 @@ describe("LocalAttributeShareInfo", function () {
         {
             notificationReference: "notificationReferenceId",
             peer: "peerAddress"
+        },
+        {
+            notificationReference: "notificationReferenceId",
+            peer: "peerAddress",
+            sourceAttribute: "sourceAttributeId",
+            thirdPartyAddress: "thirdPartyAddress"
+        },
+        {
+            requestReference: "requestReferenceId",
+            peer: "peerAddress",
+            sourceAttribute: "sourceAttributeId",
+            thirdPartyAddress: "thirdPartyAddress"
         }
     ];
     test.each(validShareInfoJsonParams)("should create objects from valid parameters using from()", function (shareInfoParams: LocalAttributeShareInfoJSON) {