Interface: GolemNetworkOptions
golem-network/golem-network.GolemNetworkOptions
Table of contents
Properties
Properties
logger
• Optional
logger: Logger
Logger instance to use for logging. If no logger is provided you can view debug logs by setting the DEBUG
environment variable to golem-js:*
.
Defined in
src/golem-network/golem-network.ts:80
api
• Optional
api: Object
Set the API key and URL for the Yagna API.
Type declaration
Name | Type |
---|---|
key? | string |
url? | string |
Defined in
src/golem-network/golem-network.ts:85
payment
• Optional
payment: Partial
<PaymentModuleOptions
>
Set payment-related options.
This is where you can specify the network, payment driver and more. By default, the network is set to the holesky
test network.
Defined in
src/golem-network/golem-network.ts:96
market
• Optional
market: Partial
<MarketModuleOptions
>
Set market related options.
This is where you can globally specify several options that determine how the SDK will interact with the market.
Defined in
src/golem-network/golem-network.ts:104
dataTransferProtocol
• Optional
dataTransferProtocol: DataTransferProtocol
Set the data transfer protocol to use for file transfers. Default is gftp
.
Defined in
src/golem-network/golem-network.ts:110
override
• Optional
override: Partial
<GolemServices
& { market
: InstanceOrFactory
<MarketModule
, never
[]> ; payment
: InstanceOrFactory
<PaymentModule
, never
[]> ; activity
: InstanceOrFactory
<ActivityModule
, never
[]> ; network
: InstanceOrFactory
<NetworkModule
, never
[]> ; rental
: InstanceOrFactory
<RentalModule
, never
[]> }>
Override some of the services used by the GolemNetwork instance. This is useful for testing or when you want to provide your own implementation of some services. Only set this if you know what you are doing. To override a module you can pass either an instance of an object or a factory function (that we can call new
on).