feat(market): added config options for setting the ProposalFilter

examples/advanced/proposal-filter.ts

@@ -0,0 +1,51 @@
+import { MarketOrderSpec, GolemNetwork, ProposalFilter } from "@golem-sdk/golem-js";
+import { pinoPrettyLogger } from "@golem-sdk/pino-logger";
+
+/**
+ * Example demonstrating how to write a custom proposal filter.
+ * In this case the proposal must include VPN access and must not be from "bad-provider"
+ */
+const myFilter: ProposalFilter = (proposal) => {
+  return (
+    proposal.provider.name !== "bad-provider" && proposal.properties["golem.runtime.capabilities"]?.includes("vpn")
+  );
+};
+
+const order: MarketOrderSpec = {
+  demand: {
+    workload: { imageTag: "golem/alpine:latest" },
+  },
+  market: {
+    maxAgreements: 1,
+    rentHours: 0.5,
+    pricing: {
+      model: "linear",
+      maxStartPrice: 0.5,
+      maxCpuPerHourPrice: 1.0,
+      maxEnvPerHourPrice: 0.5,
+    },
+    proposalFilter: myFilter,
+  },
+};
+
+(async () => {
+  const glm = new GolemNetwork({
+    logger: pinoPrettyLogger({
+      level: "info",
+    }),
+  });
+
+  try {
+    await glm.connect();
+    const lease = await glm.oneOf(order);
+    await lease
+      .getExeUnit()
+      .then((exe) => exe.run(`echo [provider:${exe.provider.name}] Hello, Golem! 👋`))
+      .then((res) => console.log(res.stdout));
+    await lease.finalize();
+  } catch (err) {
+    console.error("Failed to run the example", err);
+  } finally {
+    await glm.disconnect();
+  }
+})().catch(console.error);

examples/advanced/proposal-predefined-filter.ts

@@ -0,0 +1,48 @@
+import { MarketOrderSpec, GolemNetwork, ProposalFilterFactory } from "@golem-sdk/golem-js";
+import { pinoPrettyLogger } from "@golem-sdk/pino-logger";
+
+/**
+ * Example showing how to use a proposal filter using the predefined filter `disallowProvidersByName`,
+ * which blocks any proposal from a provider whose name is in the array of
+ */
+
+const blackListProvidersNames = ["provider-1", "bad-provider", "slow-provider"];
+
+const order: MarketOrderSpec = {
+  demand: {
+    workload: { imageTag: "golem/alpine:latest" },
+  },
+  market: {
+    maxAgreements: 1,
+    rentHours: 0.5,
+    pricing: {
+      model: "linear",
+      maxStartPrice: 0.5,
+      maxCpuPerHourPrice: 1.0,
+      maxEnvPerHourPrice: 0.5,
+    },
+    proposalFilter: ProposalFilterFactory.disallowProvidersByName(blackListProvidersNames),
+  },
+};
+
+(async () => {
+  const glm = new GolemNetwork({
+    logger: pinoPrettyLogger({
+      level: "info",
+    }),
+  });
+
+  try {
+    await glm.connect();
+    const lease = await glm.oneOf(order);
+    await lease
+      .getExeUnit()
+      .then((exe) => exe.run(`echo [provider:${exe.provider.name}] Hello, Golem! 👋`))
+      .then((res) => console.log(res.stdout));
+    await lease.finalize();
+  } catch (err) {
+    console.error("Failed to run the example", err);
+  } finally {
+    await glm.disconnect();
+  }
+})().catch(console.error);

examples/package.json

@@ -12,6 +12,8 @@
     "advanced-hello-world": "tsx advanced/hello-world.ts",
     "advanced-manual-pools": "tsx advanced/manual-pools.ts",
     "advanced-payment-filters": "tsx advanced/payment-filters.ts",
+    "advanced-proposal-filters": "tsx advanced/proposal-filter.ts",
+    "advanced-proposal-predefined-filter": "tsx advanced/proposal-predefined-filter.ts",
     "local-image": "tsx advanced/local-image/serveLocalGvmi.ts",
     "deployment": "tsx experimental/deployment/new-api.ts",
     "market-scan": "tsx market/scan.ts",

src/experimental/deployment/deployment.ts

@@ -170,6 +170,7 @@ export class Deployment {
       const proposalSubscription = this.modules.market
         .startCollectingProposals({
           demandSpecification,
+          filter: pool.options.market.proposalFilter,
           bufferSize: 10,
         })
         .subscribe({

src/experimental/reputation/system.ts

@@ -1,4 +1,4 @@
-import { ProposalFilterNew, OfferProposal } from "../../market";
+import { ProposalFilter, OfferProposal } from "../../market";
 import { AgreementCandidate, AgreementSelector } from "../../market/agreement";
 import { GolemReputationError } from "./error";
 import {
@@ -332,7 +332,7 @@ export class ReputationSystem {
    * Returns a proposal filter that can be used to filter out providers with low reputation scores.
    * @param opts
    */
-  proposalFilter(opts?: ProposalFilterOptions): ProposalFilterNew {
+  proposalFilter(opts?: ProposalFilterOptions): ProposalFilter {
     return (proposal: OfferProposal) => {
       // Filter out rejected operators.
       const operatorEntry = this.rejectedOperatorsMap.get(proposal.provider.walletAddress);

src/golem-network/golem-network.ts

@@ -305,6 +305,7 @@ export class GolemNetwork {
 
     const proposal$ = this.market.startCollectingProposals({
       demandSpecification,
+      filter: order.market.proposalFilter,
     });
     const proposalSubscription = proposalPool.readFrom(proposal$);
 
@@ -389,6 +390,7 @@ export class GolemNetwork {
 
     const proposal$ = this.market.startCollectingProposals({
       demandSpecification,
+      filter: order.market.proposalFilter,
     });
     const subscription = proposalPool.readFrom(proposal$);
 

src/market/index.ts

@@ -1,4 +1,4 @@
-export { ProposalFilterNew } from "./offer-proposal";
+export { ProposalFilter } from "./offer-proposal";
 export { Demand, BasicDemandPropertyConfig, DemandSpecification } from "./demand";
 export { OfferProposal, ProposalDTO } from "./offer-proposal";
 export * as ProposalFilterFactory from "./strategy";

src/market/market.module.ts

@@ -11,7 +11,7 @@ import {
 import { defaultLogger, Logger, runOnNextEventLoopIteration, YagnaApi } from "../shared/utils";
 import { Allocation, IPaymentApi } from "../payment";
 import { bufferTime, catchError, filter, map, mergeMap, Observable, of, OperatorFunction, switchMap, tap } from "rxjs";
-import { IProposalRepository, OfferProposal, ProposalFilterNew } from "./offer-proposal";
+import { IProposalRepository, OfferProposal, ProposalFilter } from "./offer-proposal";
 import { DemandBodyBuilder } from "./demand/demand-body-builder";
 import { IAgreementApi } from "./agreement/agreement";
 import { BuildDemandOptions, DemandSpecification, IDemandRepository } from "./demand";
@@ -54,15 +54,8 @@ export interface MarketOptions {
         avgGlmPerHour: number;
       };
 
-  /**
-   * List of provider Golem Node IDs that should be considered
-   *
-   * If not provided, the list will be pulled from: https://provider-health.golem.network/v1/provider-whitelist
-   */
-  withProviders?: string[];
-  withoutProviders?: string[];
-  withOperators?: string[];
-  withoutOperators?: string[];
+  /** An optional filter that can filter proposals from the market before signing an agreement */
+  proposalFilter?: ProposalFilter;
 }
 
 export interface MarketModule {
@@ -149,7 +142,7 @@ export interface MarketModule {
    */
   startCollectingProposals(options: {
     demandSpecification: DemandSpecification;
-    filter?: ProposalFilterNew;
+    filter?: ProposalFilter;
     bufferSize?: number;
   }): Observable<OfferProposal[]>;
 
@@ -354,7 +347,7 @@ export class MarketModuleImpl implements MarketModule {
 
   startCollectingProposals(options: {
     demandSpecification: DemandSpecification;
-    filter?: ProposalFilterNew;
+    filter?: ProposalFilter;
     bufferSize?: number;
     bufferTimeout?: number;
     minProposalsBatchSize?: number;

src/market/offer-proposal.ts

@@ -3,7 +3,7 @@ import { GolemMarketError, MarketErrorCode } from "./error";
 import { ProviderInfo } from "./agreement";
 import { Demand } from "./demand";
 
-export type ProposalFilterNew = (proposal: OfferProposal) => boolean;
+export type ProposalFilter = (proposal: OfferProposal) => boolean;
 
 export type PricingInfo = {
   cpuSec: number;

tests/examples/examples.json

@@ -6,6 +6,8 @@
   { "cmd": "tsx", "path": "examples/advanced/hello-world.ts" },
   { "cmd": "tsx", "path": "examples/advanced/manual-pools.ts" },
   { "cmd": "tsx", "path": "examples/advanced/payment-filters.ts" },
+  { "cmd": "tsx", "path": "examples/advanced/proposal-filter.ts" },
+  { "cmd": "tsx", "path": "examples/advanced/proposal-predefined-filter.ts" },
   { "cmd": "tsx", "path": "examples/experimental/deployment/new-api.ts" },
   { "cmd": "tsx", "path": "examples/experimental/job/getJobById.ts" },
   { "cmd": "tsx", "path": "examples/experimental/job/waitForResults.ts" },