Interface: MarketModule

market/market.module.MarketModule

• MarketModuleImpl

• events

• buildDemandDetails
• buildScanSpecification
• publishAndRefreshDemand
• collectMarketProposalEvents
• collectAllOfferProposals
• negotiateProposal
• proposeAgreement
• terminateAgreement
• signAgreementFromPool
• collectDraftOfferProposals
• estimateBudget
• fetchAgreement
• scan

• events: EventEmitter<MarketEvents, any>

src/market/market.module.ts:84

▸ buildDemandDetails(demandOptions, orderOptions, allocation): Promise<DemandSpecification>

Build a DemandSpecification based on the given options and allocation. You can obtain an allocation using the payment module. The method returns a DemandSpecification that can be used to publish the demand to the market, for example using the publishDemand method.

Promise<DemandSpecification>

src/market/market.module.ts:92

▸ buildScanSpecification(options): ScanSpecification

Build a ScanSpecification that can be used to scan the market for offers. The difference between this method and buildDemandDetails is that this method does not require an allocation, doesn't inherit payment properties from GolemNetwork settings and doesn't provide any defaults. If you wish to set the payment platform, you need to specify it in the ScanOptions.

ScanSpecification

src/market/market.module.ts:104

▸ publishAndRefreshDemand(demandSpec): Observable<Demand>

Publishes the demand to the market and handles refreshing it when needed. Each time the demand is refreshed, a new demand is emitted by the observable. Keep in mind that since this method returns an observable, nothing will happen until you subscribe to it. Unsubscribing will remove the demand from the market.

Observable<Demand>

src/market/market.module.ts:112

▸ collectMarketProposalEvents(demand): Observable<MarketProposalEvent>

Return an observable that will emit values representing various events related to this demand

Observable<MarketProposalEvent>

src/market/market.module.ts:117

▸ collectAllOfferProposals(demand): Observable<OfferProposal>

Subscribes to the proposals for the given demand. If an error occurs, the observable will emit an error and complete. Keep in mind that since this method returns an observable, nothing will happen until you subscribe to it.

This method will just yield all the proposals that will be found for that demand without any additional logic.

The collectDraftOfferProposals is a more specialized variant of offer collection, which includes negotiations and demand re-subscription logic

Observable<OfferProposal>

src/market/market.module.ts:129

▸ negotiateProposal(receivedProposal, counterDemandSpec): Promise<OfferCounterProposal>

Sends a counter-offer to the provider. Note that to get the provider's response to your counter you should listen to events returned by collectDemandOfferEvents.

Promise<OfferCounterProposal>

The counter-proposal that the requestor made to the Provider

src/market/market.module.ts:137

▸ proposeAgreement(proposal): Promise<Agreement>

Internally

• ya-ts-client createAgreement
• ya-ts-client approveAgreement
• ya-ts-client "wait for approval"

Promise<Agreement>

Returns when the provider accepts the agreement, rejects otherwise. The resulting agreement is ready to create activities from.

src/market/market.module.ts:153

▸ terminateAgreement(agreement, reason?): Promise<Agreement>

Promise<Agreement>

The Agreement that has been terminated via Yagna

src/market/market.module.ts:158

▸ signAgreementFromPool(draftProposalPool, agreementOptions?, signalOrTimeout?): Promise<Agreement>

Acquire a proposal from the pool and sign an agreement with the provider. If signing the agreement fails, destroy the proposal and try again with another one. The method returns an agreement that's ready to be used. Optionally, you can provide a timeout in milliseconds or an AbortSignal that can be used to cancel the operation early. If the operation is cancelled, the method will throw an error. Note that this method will respect the acquire timeout set in the pool and will throw an error if no proposal is available within the specified time.

Promise<Agreement>

Example

const agreement = await marketModule.signAgreementFromPool(draftProposalPool, 10_000); // throws TimeoutError if the operation takes longer than 10 seconds

Example

const signal = AbortSignal.timeout(10_000);
const agreement = await marketModule.signAgreementFromPool(draftProposalPool, signal); // throws TimeoutError if the operation takes longer than 10 seconds

src/market/market.module.ts:181

▸ collectDraftOfferProposals(options): Observable<OfferProposal>

Creates a demand for the given package and allocation and starts collecting, filtering and negotiating proposals. The method returns an observable that emits a batch of draft proposals every time the buffer is full. The method will automatically negotiate the proposals until they are moved to the Draft state. Keep in mind that since this method returns an observable, nothing will happen until you subscribe to it. Unsubscribing from the observable will stop the process and remove the demand from the market.

Observable<OfferProposal>

src/market/market.module.ts:194

▸ estimateBudget(params): number

Estimate the budget for the given order and maximum numbers of agreemnets. Keep in mind that this is just an estimate and the actual cost may vary. The method returns the estimated budget in GLM.

number

src/market/market.module.ts:208

▸ fetchAgreement(agreementId): Promise<Agreement>

Fetch the most up-to-date agreement details from the yagna

Promise<Agreement>

src/market/market.module.ts:213

▸ scan(scanSpecification): Observable<ScannedOffer>

Scan the market for offers that match the given demand specification.

Observable<ScannedOffer>

src/market/market.module.ts:218