Wallet address field in payment events (#749)

feat(events): added provider info (including wallet address) to the event details

BREAKING CHANGE: Replacing the providerId and providerName event fields
with an object of the ProviderInfo type (with walletAddress)
In Invoice/Debit Note Received events, the amount field has been changed
from string to number

src/agreement/agreement.ts

@@ -1,18 +1,15 @@
-import { Logger } from "../utils";
+import { Logger, YagnaApi } from "../utils";
 import { Agreement as AgreementModel } from "ya-ts-client/dist/ya-market/src/models";
 import { YagnaOptions } from "../executor";
 import { AgreementFactory } from "./factory";
 import { AgreementConfig } from "./config";
 import { Events } from "../events";
-import { YagnaApi } from "../utils/yagna/yagna";
 import { GolemError } from "../error/golem-error";
 
-/**
- * @hidden
- */
 export interface ProviderInfo {
   name: string;
   id: string;
+  walletAddress: string;
 }
 
 /**
@@ -69,7 +66,7 @@ export class Agreement {
 
   /**
    * Create agreement for given proposal ID
-   * @param proposalId - proposal ID
+   * @param proposal
    * @param yagnaApi
    * @param agreementOptions - {@link AgreementOptions}
    * @return Agreement
@@ -110,13 +107,11 @@ export class Agreement {
       await this.yagnaApi.market.confirmAgreement(this.id, appSessionId);
       await this.yagnaApi.market.waitForApproval(this.id, this.options.agreementWaitingForApprovalTimeout);
       this.logger?.debug(`Agreement ${this.id} approved`);
-      this.options.eventTarget?.dispatchEvent(
-        new Events.AgreementConfirmed({ id: this.id, providerId: this.provider.id }),
-      );
+      this.options.eventTarget?.dispatchEvent(new Events.AgreementConfirmed({ id: this.id, provider: this.provider }));
     } catch (error) {
       this.logger?.debug(`Unable to confirm agreement with provider ${this.provider.name}. ${error}`);
       this.options.eventTarget?.dispatchEvent(
-        new Events.AgreementRejected({ id: this.id, providerId: this.provider.id, reason: error.toString() }),
+        new Events.AgreementRejected({ id: this.id, provider: this.provider, reason: error.toString() }),
       );
       throw error;
     }
@@ -146,7 +141,7 @@ export class Agreement {
           timeout: this.options.agreementRequestTimeout,
         });
       this.options.eventTarget?.dispatchEvent(
-        new Events.AgreementTerminated({ id: this.id, providerId: this.provider.id, reason: reason.message }),
+        new Events.AgreementTerminated({ id: this.id, provider: this.provider, reason: reason.message }),
       );
       this.logger?.debug(`Agreement ${this.id} terminated`);
     } catch (error) {

src/agreement/factory.ts

@@ -1,8 +1,7 @@
 import { Agreement, AgreementOptions } from "./agreement";
-import { Logger } from "../utils";
+import { Logger, YagnaApi } from "../utils";
 import { AgreementConfig } from "./config";
 import { Events } from "../events";
-import { YagnaApi } from "../utils/yagna/yagna";
 import { GolemError } from "../error/golem-error";
 import { ProposalProperties } from "../market/proposal";
 
@@ -43,17 +42,21 @@ export class AgreementFactory {
         timeout: this.options.agreementRequestTimeout,
       });
       const { data } = await this.yagnaApi.market.getAgreement(agreementId);
+      const offerProperties: ProposalProperties = data.offer.properties as ProposalProperties;
+      const demandProperties: ProposalProperties = data.demand.properties as ProposalProperties;
+      const chosenPaymentPlatform = demandProperties["golem.com.payment.chosen-platform"];
+      console.log({ chosenPaymentPlatform });
       const provider = {
-        name: (data.offer.properties as ProposalProperties)["golem.node.id.name"],
+        name: offerProperties["golem.node.id.name"],
         id: data.offer.providerId,
+        walletAddress: offerProperties[`golem.com.payment.platform.${chosenPaymentPlatform}.address`] as string,
       };
       if (!provider.id || !provider.name) throw new GolemError("Unable to get provider info");
       const agreement = new Agreement(agreementId, provider, this.yagnaApi, this.options);
       this.options.eventTarget?.dispatchEvent(
         new Events.AgreementCreated({
           id: agreementId,
-          providerId: provider.id,
-          providerName: provider.name,
+          provider,
           validTo: data?.validTo,
           proposalId,
         }),

src/events/events.ts

@@ -1,8 +1,9 @@
-import { ProposalDetails } from "../market/proposal";
+import { ProposalDetails } from "../market";
 import { PackageDetails } from "../package/package";
 import { DemandDetails } from "../market/demand";
 
 import { RequireAtLeastOne } from "../utils/types";
+import { ProviderInfo } from "../agreement";
 /**
  * Global Event Type with which all API events will be emitted. It should be used on all listeners that would like to handle events.
  */
@@ -45,8 +46,7 @@ export class TaskStarted extends BaseEvent<{
   id: string;
   agreementId: string;
   activityId: string;
-  providerId: string;
-  providerName: string;
+  provider: ProviderInfo;
 }> {}
 
 /**
@@ -55,8 +55,7 @@ export class TaskStarted extends BaseEvent<{
 export class TaskRedone extends BaseEvent<{
   id: string;
   agreementId: string;
-  providerId: string;
-  providerName: string;
+  provider: ProviderInfo;
   retriesCount: number;
   /**
    * The activity that was involved
@@ -74,8 +73,8 @@ export class TaskRedone extends BaseEvent<{
 export class TaskRejected extends BaseEvent<{
   id: string;
   agreementId: string;
-  providerId: string;
-  providerName: string;
+
+  provider: ProviderInfo;
   /**
    * The activity that was involved when the rejection took place
    *
@@ -92,28 +91,28 @@ export class DemandUnsubscribed extends BaseEvent<{ id: string }> {}
 export class CollectFailed extends BaseEvent<{ id: string; reason?: string }> {}
 export class ProposalReceived extends BaseEvent<{
   id: string;
-  providerId: string;
+  provider: ProviderInfo;
   parentId: string | null;
   details: ProposalDetails;
 }> {}
 export class ProposalRejected extends BaseEvent<{
   id: string;
-  providerId?: string;
+  provider: ProviderInfo;
   reason?: string;
   parentId: string | null;
 }> {}
 export class ProposalResponded extends BaseEvent<{
   id: string;
-  providerId: string;
+  provider: ProviderInfo;
   counteringProposalId: string;
 }> {}
 export class ProposalFailed extends BaseEvent<{
   id: string;
-  providerId: string;
+  provider: ProviderInfo;
   parentId: string | null;
   reason?: string;
 }> {}
-export class ProposalConfirmed extends BaseEvent<{ id: string; providerId: string }> {}
+export class ProposalConfirmed extends BaseEvent<{ id: string; provider: ProviderInfo }> {}
 export class PackageCreated extends BaseEvent<{
   packageReference: RequireAtLeastOne<{
     imageHash: string;
@@ -124,37 +123,37 @@ export class PackageCreated extends BaseEvent<{
 }> {}
 export class AgreementCreated extends BaseEvent<{
   id: string;
-  providerId: string;
-  providerName: string;
+  provider: ProviderInfo;
   proposalId: string;
   validTo?: string;
 }> {}
-export class AgreementConfirmed extends BaseEvent<{ id: string; providerId: string }> {}
-export class AgreementRejected extends BaseEvent<{ id: string; providerId: string; reason?: string }> {}
-export class AgreementTerminated extends BaseEvent<{ id: string; providerId: string; reason?: string }> {}
+export class AgreementConfirmed extends BaseEvent<{ id: string; provider: ProviderInfo }> {}
+export class AgreementRejected extends BaseEvent<{ id: string; provider: ProviderInfo; reason?: string }> {}
+export class AgreementTerminated extends BaseEvent<{ id: string; provider: ProviderInfo; reason?: string }> {}
 export class InvoiceReceived extends BaseEvent<{
   id: string;
-  providerId: string;
+  provider: ProviderInfo;
   agreementId: string;
-  amount: string; // It is coming as a string
+  amount: number;
 }> {}
 export class DebitNoteReceived extends BaseEvent<{
   id: string;
   agreementId: string;
   activityId: string;
-  amount: string; // It is coming as a string
+  amount: number;
+  provider: ProviderInfo;
 }> {}
 export class PaymentAccepted extends BaseEvent<{
   id: string;
-  providerId: string;
   agreementId: string;
-  amount: string; // It is coming as a string
+  amount: number;
+  provider: ProviderInfo;
 }> {}
 export class DebitNoteAccepted extends BaseEvent<{
   id: string;
-  providerId: string;
   agreementId: string;
-  amount: string; // It is coming as a string
+  amount: number;
+  provider: ProviderInfo;
 }> {}
 export class PaymentFailed extends BaseEvent<{ id: string; agreementId: string; reason?: string }> {}
 export class ActivityCreated extends BaseEvent<{ id: string; agreementId: string }> {}

src/market/demand.ts

@@ -2,7 +2,7 @@ import { Package } from "../package";
 import { Allocation } from "../payment";
 import { YagnaOptions } from "../executor";
 import { DemandFactory } from "./factory";
-import { Proposal } from "./proposal";
+import { Proposal, ProposalProperties } from "./proposal";
 import { Logger, sleep, YagnaApi } from "../utils";
 import { DemandConfig } from "./config";
 import { Events } from "../events";
@@ -135,13 +135,15 @@ export class Demand extends EventTarget {
   /**
    * @param id - demand ID
    * @param demandRequest - {@link DemandOfferBase}
+   * @param allocation - {@link Allocation}
    * @param yagnaApi - {@link YagnaApi}
    * @param options - {@link DemandConfig}
    * @hidden
    */
   constructor(
     public readonly id: string,
     private demandRequest: DemandOfferBase,
+    private allocation: Allocation,
     private yagnaApi: YagnaApi,
     private options: DemandConfig,
   ) {
@@ -188,11 +190,19 @@ export class Demand extends EventTarget {
         for (const event of events as Array<ProposalEvent & ProposalRejectedEvent>) {
           if (event.eventType === "ProposalRejectedEvent") {
             this.logger?.debug(`Proposal rejected. Reason: ${event.reason?.message}`);
+            const proposalProperties = event.proposal.properties as ProposalProperties;
             this.options.eventTarget?.dispatchEvent(
               new Events.ProposalRejected({
                 id: event.proposalId,
                 parentId: this.findParentProposal(event.proposalId),
                 reason: event.reason?.message,
+                provider: {
+                  id: event.proposal.issuerId,
+                  name: proposalProperties["golem.node.id.name"],
+                  walletAddress: proposalProperties[
+                    `golem.com.payment.platform.${this.allocation.paymentPlatform}.address`
+                  ] as string,
+                },
               }),
             );
             continue;
@@ -204,14 +214,15 @@ export class Demand extends EventTarget {
             this.yagnaApi.market,
             event.proposal,
             this.demandRequest,
+            this.allocation.paymentPlatform,
             this.options.eventTarget,
           );
           this.dispatchEvent(new DemandEvent(DEMAND_EVENT_TYPE, proposal));
           this.options.eventTarget?.dispatchEvent(
             new Events.ProposalReceived({
               id: proposal.id,
               parentId: this.findParentProposal(event.proposal.prevProposalId),
-              providerId: proposal.issuerId,
+              provider: proposal.provider,
               details: proposal.details,
             }),
           );

src/market/factory.ts

@@ -37,7 +37,7 @@ export class DemandFactory {
       }),
     );
     this.options.logger?.info(`Demand published on the market`);
-    return new Demand(id, demandRequest, this.yagnaApi, this.options);
+    return new Demand(id, demandRequest, this.allocation, this.yagnaApi, this.options);
   }
 
   private async getDecorations(): Promise<MarketDecoration[]> {

src/market/proposal.test.ts

@@ -30,6 +30,7 @@ const buildTestProposal = (props: Partial<ProposalProperties>): Proposal => {
     mockApi,
     model,
     mockDemand,
+    "testPaymentPlatform",
   );
 
   return proposal;

src/market/proposal.ts

@@ -3,6 +3,7 @@ import { RequestorApi } from "ya-ts-client/dist/ya-market/api";
 import { DemandOfferBase } from "ya-ts-client/dist/ya-market";
 import { Events } from "../events";
 import { GolemError } from "../error/golem-error";
+import { ProviderInfo } from "../agreement";
 
 export type PricingInfo = {
   cpuSec: number;
@@ -58,7 +59,6 @@ export interface ProposalDetails {
   cpuThreads: number;
   memory: number;
   storage: number;
-  providerName: string;
   publicNet: boolean;
   runtimeCapabilities: string[];
   runtimeName: string;
@@ -71,7 +71,7 @@ export interface ProposalDetails {
 export class Proposal {
   id: string;
   readonly issuerId: string;
-  readonly provider: { id: string; name: string };
+  readonly provider: ProviderInfo;
   readonly properties: ProposalProperties;
   readonly constraints: string;
   readonly timestamp: string;
@@ -88,6 +88,7 @@ export class Proposal {
    * @param api - {@link RequestorApi}
    * @param model - {@link ProposalModel}
    * @param demandRequest - {@link DemandOfferBase}
+   * @param paymentPlatform
    * @param eventTarget - {@link EventTarget}
    */
   constructor(
@@ -97,6 +98,7 @@ export class Proposal {
     private readonly api: RequestorApi,
     model: ProposalModel,
     private readonly demandRequest: DemandOfferBase,
+    private readonly paymentPlatform: string,
     private eventTarget?: EventTarget,
   ) {
     this.id = model.proposalId;
@@ -107,7 +109,7 @@ export class Proposal {
     this.prevProposalId = model.prevProposalId;
     this.timestamp = model.timestamp;
     this.counteringProposalId = null;
-    this.provider = { id: this.issuerId, name: this.details.providerName };
+    this.provider = this.getProviderInfo();
 
     // Run validation to ensure that the Proposal is in a complete and correct state
     this.validate();
@@ -122,7 +124,6 @@ export class Proposal {
       cpuThreads: this.properties["golem.inf.cpu.threads"],
       memory: this.properties["golem.inf.mem.gib"],
       storage: this.properties["golem.inf.storage.gib"],
-      providerName: this.properties["golem.node.id.name"],
       publicNet: this.properties["golem.node.net.is-public"],
       runtimeCapabilities: this.properties["golem.runtime.capabilities"],
       runtimeName: this.properties["golem.runtime.name"],
@@ -204,7 +205,7 @@ export class Proposal {
     this.eventTarget?.dispatchEvent(
       new Events.ProposalRejected({
         id: this.id,
-        providerId: this.issuerId,
+        provider: this.provider,
         parentId: this.id,
         reason,
       }),
@@ -220,7 +221,7 @@ export class Proposal {
         this.eventTarget?.dispatchEvent(
           new Events.ProposalFailed({
             id: this.id,
-            providerId: this.issuerId,
+            provider: this.provider,
             parentId: this.id,
             reason,
           }),
@@ -234,7 +235,7 @@ export class Proposal {
     this.eventTarget?.dispatchEvent(
       new Events.ProposalResponded({
         id: this.id,
-        providerId: this.issuerId,
+        provider: this.provider,
         counteringProposalId: counteringProposalId,
       }),
     );
@@ -252,4 +253,12 @@ export class Proposal {
         .map((prop) => prop.split(".")[4]) || []
     );
   }
+
+  private getProviderInfo(): ProviderInfo {
+    return {
+      id: this.issuerId,
+      name: this.properties["golem.node.id.name"],
+      walletAddress: this.properties[`golem.com.payment.platform.${this.paymentPlatform}.address`] as string,
+    };
+  }
 }