Interface: IMarketApi

market/api.IMarketApi

• MarketApiAdapter

• publishDemandSpecification
• unpublishDemand
• collectMarketProposalEvents
• collectAgreementEvents
• counterProposal
• rejectProposal
• getPaymentRelatedDemandDecorations
• getAgreement
• createAgreement
• proposeAgreement
• confirmAgreement
• terminateAgreement
• getAgreementState
• scan

▸ publishDemandSpecification(specification): Promise<Demand>

Creates a new demand based on the given specification and publishes it to the market. Keep in mind that the demand lasts for a limited time and needs to be refreshed periodically (see refreshDemand method). Use unpublishDemand to remove the demand from the market.

Promise<Demand>

src/market/api.ts:48

▸ unpublishDemand(demand): Promise<void>

Remove the given demand from the market.

Promise<void>

src/market/api.ts:53

▸ collectMarketProposalEvents(demand): Observable<MarketProposalEvent>

"Publishes" the demand on the network and stats to listen (event polling) for the events representing the feedback

The feedback can fall into four categories:

• (Initial) We will receive initial offer proposals that were matched by the yagna node which we're using
• (Negotiations) We will receive responses from providers with draft offer proposals if we decided to counter the initial proposal
• (Negotiations) We will receive an event representing rejection of our counter-proposal by the provider
• (Negotiations) We will receive a question from the provider about a certain property as part of the negotiation process (protocol piece not by yagna 0.15)

Observable<MarketProposalEvent>

A complex object that allows subscribing to these categories of feedback mentioned above

src/market/api.ts:69

▸ collectAgreementEvents(): Observable<AgreementEvent>

Start looking at the Agreement related events

Observable<AgreementEvent>

src/market/api.ts:74

▸ counterProposal(receivedProposal, specification): Promise<OfferCounterProposal>

Sends a counter-proposal to the given proposal. Returns the newly created counter-proposal.

Promise<OfferCounterProposal>

src/market/api.ts:79

▸ rejectProposal(receivedProposal, reason): Promise<void>

Sends a "reject" response for the proposal that was received from the Provider as part of the negotiation process

On the protocol level this means that no further counter-proposals will be generated by the Requestor

Promise<void>

src/market/api.ts:89

▸ getPaymentRelatedDemandDecorations(allocationId): Promise<DemandBodyPrototype>

Fetches payment related decorations, based on the given allocation ID.

Promise<DemandBodyPrototype>

src/market/api.ts:97

▸ getAgreement(id): Promise<Agreement>

Retrieves an agreement based on the provided ID.

Promise<Agreement>

src/market/api.ts:102

▸ createAgreement(proposal, options?): Promise<Agreement>

Request creating an agreement from the provided proposal

Use this method if you want to decide what should happen with the agreement after it is created

Promise<Agreement>

An agreement that's in a "Proposal" state (not yet usable for activity creation)

src/market/api.ts:111

▸ proposeAgreement(proposal, options?): Promise<Agreement>

Request creating an agreement from the provided proposal, send it to the Provider and wait for approval

Use this method when you want to quickly finalize the deal with the Provider, but be ready for a rejection

Promise<Agreement>

An agreement that's already in an "Approved" state and can be used to create activities on the Provider

src/market/api.ts:120

▸ confirmAgreement(agreement, options?): Promise<Agreement>

Confirms the agreement with the provider

Promise<Agreement>

src/market/api.ts:125

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

Terminates an agreement.

Promise<Agreement>

src/market/api.ts:130

▸ getAgreementState(id): Promise<AgreementState>

Retrieves the state of an agreement based on the provided agreement ID.

Promise<AgreementState>

src/market/api.ts:135

▸ scan(scanSpecification): Observable<ScannedOffer>

Scan the market for offers that match the given specification.

Observable<ScannedOffer>

src/market/api.ts:140