Class: ReputationSystem

experimental/reputation/system.ReputationSystem

Reputation system client.

This class is responsible for fetching and applying reputation data to Golem SDK's market management class.

Currently, it includes a proposal filter you can use to filter out providers with low reputation scores.

Reputation data is gathered by the following project: https://github.com/golemfactory/reputation-auditor

You can adjust the weights used to calculate the score for proposals by using the setProposalWeights method.

NOTE: This class is currently experimental and subject to change.

NOTE: Only providers from polygon network are being tested, so using this class on testnet will not work.

• constructor

• paymentNetwork

• create
• usePreset
• setData
• getData
• fetchData
• setProposalWeights
• getProposalWeights
• setAgreementWeights
• getAgreementWeights
• getProviderScores
• offerProposalFilter
• offerProposalSelector
• calculateScore
• calculateProviderPool
• sortCandidatesByScore

• new ReputationSystem(config?): ReputationSystem

ReputationSystem

src/experimental/reputation/system.ts:187

• Readonly paymentNetwork: string

The payment network currently used.

src/experimental/reputation/system.ts:136

▸ create(config?): Promise<ReputationSystem>

Create a new reputation system client and fetch the reputation data.

Promise<ReputationSystem>

src/experimental/reputation/system.ts:181

▸ usePreset(presetName): void

Apply preset to current reputation system configuration.

void

src/experimental/reputation/system.ts:209

▸ setData(data): void

Set reputation data.

This is useful if you want to cache the date locally, or you have an alternative source of data.

void

src/experimental/reputation/system.ts:241

▸ getData(): ReputationData

Returns current reputation data.

ReputationData

src/experimental/reputation/system.ts:263

▸ fetchData(): Promise<void>

Fetch data from the reputation service.

Promise<void>

src/experimental/reputation/system.ts:270

▸ setProposalWeights(weights): void

Set weights used to calculate the score for proposals.

void

src/experimental/reputation/system.ts:297

▸ getProposalWeights(): Partial<ReputationProviderScores>

Returns current proposal weights.

Partial<ReputationProviderScores>

src/experimental/reputation/system.ts:304

▸ setAgreementWeights(weights): void

Set weights used to calculate the score for agreements.

void

src/experimental/reputation/system.ts:311

▸ getAgreementWeights(): Partial<ReputationProviderScores>

Returns current agreement weights.

Partial<ReputationProviderScores>

src/experimental/reputation/system.ts:318

▸ getProviderScores(providerId): undefined | ReputationProviderScores

Returns scores for a provider or undefined if the provider is unlisted.

undefined | ReputationProviderScores

src/experimental/reputation/system.ts:326

▸ offerProposalFilter(opts?): OfferProposalFilter

Returns a proposal filter that can be used to filter out providers with low reputation scores.

OfferProposalFilter

src/experimental/reputation/system.ts:334

▸ offerProposalSelector(opts?): OfferProposalSelector

Returns an agreement selector that can be used to select providers based on their reputation scores.

The outcome of this function is determined by current provider scores and the agreement weights set.

For best results, make sure you test the performance or stability of your workload using different weights.

OfferProposalSelector

See

setAgreementWeights

src/experimental/reputation/system.ts:398

▸ calculateScore(scores, weights): number

Calculate a normalized score based on the given scores and weights.

number

src/experimental/reputation/system.ts:428

▸ calculateProviderPool(opts?): ReputationProviderEntry[]

Based on the current reputation data, calculate a list of providers that meet the minimum score requirement.

This method is useful to validate you filter and weights vs the available provider market.

ReputationProviderEntry[]

src/experimental/reputation/system.ts:451

▸ sortCandidatesByScore(proposals, scoresMap): OfferProposal[]

OfferProposal[]

src/experimental/reputation/system.ts:459