Class: YagnaApi

shared/yagna/yagnaApi.YagnaApi

Utility class that groups various Yagna APIs under a single wrapper

This class has the following responsibilities:

• selectively exposes services from ya-ts-client in a more user-friendly manner
• implements an event reader that collects events from Yagna endpoints and allows subscribing to them as Observables for agreements, debit notes and invoices. These observables emit ya-ts-client types on outputs

End users of the SDK should not use this class and make use of golem-network/golem-network.GolemNetwork instead. This class is designed for SDK developers to use.

• constructor

• appSessionId
• yagnaOptions
• basePath
• identity
• market
• activity
• net
• payment
• gsb
• version
• debitNoteEvents$
• invoiceEvents$
• agreementEvents$

• connect
• disconnect
• getVersion

• new YagnaApi(options?): YagnaApi

YagnaApi

src/shared/yagna/yagnaApi.ts:85

• Readonly appSessionId: string

src/shared/yagna/yagnaApi.ts:51

• Readonly yagnaOptions: YagnaOptions

src/shared/yagna/yagnaApi.ts:53

• Readonly basePath: string

Base path used to build paths to Yagna's API

Example

http://localhost:7465

src/shared/yagna/yagnaApi.ts:59

• Readonly identity: DefaultService

src/shared/yagna/yagnaApi.ts:61

• market: RequestorService

src/shared/yagna/yagnaApi.ts:62

• activity: Object

src/shared/yagna/yagnaApi.ts:63

• net: RequestorService

src/shared/yagna/yagnaApi.ts:68

• payment: RequestorService

src/shared/yagna/yagnaApi.ts:69

• gsb: RequestorService

src/shared/yagna/yagnaApi.ts:70

• version: DefaultService

src/shared/yagna/yagnaApi.ts:71

• debitNoteEvents$: Subject<{}>

src/shared/yagna/yagnaApi.ts:73

• invoiceEvents$: Subject<{}>

src/shared/yagna/yagnaApi.ts:76

• agreementEvents$: Subject<{} & {}>

src/shared/yagna/yagnaApi.ts:79

▸ connect(): Promise<{}>

Effectively starts the Yagna API client including subscribing to events exposed via rxjs subjects

Promise<{}>

src/shared/yagna/yagnaApi.ts:181

▸ disconnect(): Promise<void>

Terminates the Yagna API related activities

Promise<void>

src/shared/yagna/yagnaApi.ts:198

▸ getVersion(): Promise<string>

Promise<string>

src/shared/yagna/yagnaApi.ts:204