JS API Reference

Module: market/proposal/proposal-properties

Table of contents

Type Aliases

Type Aliases

GenericGolemProtocolPropertyType

Ƭ GenericGolemProtocolPropertyType: Record<string, string | number | string[] | number[] | boolean>

Describes the type representing properties from the perspective of Golem Market Protocol

Golem Protocol defines "properties" as a flat list of key/value pairs.

The protocol itself does not dictate what properties should or shouldn't be defined. Such details are left for the Provider and Requestor to agree upon outside the protocol.

The mentioned agreements can be done in a P2P manner between the involved entities, or both parties can decide to adhere to a specific "standard" which determines which properties are "mandatory".

Specific property definitions and requirements were provided in Golem standards and architecture proposals.

Link

https://github.com/golemfactory/golem-architecture/tree/master/standards Golem standards

Link

https://github.com/golemfactory/golem-architecture/tree/master/gaps Golem Architecture Proposals

Defined in

src/market/proposal/proposal-properties.ts:17


Gap3MidAgreementPaymentProps

Ƭ Gap3MidAgreementPaymentProps: Object

Properties defined by GAP-3

Link

https://github.com/golemfactory/golem-architecture/blob/master/gaps/gap-3_mid_agreement_payments/gap-3_mid_agreement_payments

Type declaration

NameType
golem.com.scheme.payu.debit-note.interval-sec??number
golem.com.scheme.payu.payment-timeout-sec??number

Defined in

src/market/proposal/proposal-properties.ts:23


StandardCommonProps

Ƭ StandardCommonProps: Object

Link

https://github.com/golemfactory/golem-architecture/tree/master/standards/0-commons

Type declaration

NameType
golem.activity.caps.transfer.protocol("http" | "https" | "gftp")[]
golem.inf.cpu.architecturestring
golem.inf.cpu.brandstring
golem.inf.cpu.capabilitiesstring[]
golem.inf.cpu.coresnumber
golem.inf.cpu.modelstring
golem.inf.cpu.threadsnumber
golem.inf.cpu.vendorstring
golem.inf.mem.gibnumber
golem.inf.storage.gibnumber
golem.runtime.capabilitiesstring[]
golem.runtime.namestring
golem.runtime.versionstring

Defined in

src/market/proposal/proposal-properties.ts:30


StandardNodeProps

Ƭ StandardNodeProps: Object

https://github.com/golemfactory/golem-architecture/blob/master/standards/2-service/srv

Type declaration

NameTypeDescription
golem.node.id.namestring-
golem.node.geo.country_code?stringDeprecated Do not rely on this, it's mentioned in the standard, but not implemented FIXME #yagna

Defined in

src/market/proposal/proposal-properties.ts:49


StandardCommercialProps

Ƭ StandardCommercialProps: Object

Link

https://github.com/golemfactory/golem-architecture/blob/master/standards/3-commercial/com

Type declaration

NameTypeDescription
golem.com.payment.debit-notes.accept-timeout?number-
golem.com.payment.chosen-platformstringExample ts "erc20-polygon-glm"
golem.com.payment.platform.erc20-polygon-glm.address?string-
golem.com.payment.platform.erc20-holesky-tglm.address?string-
golem.com.payment.platform.erc20-mumbai-tglm.address?string-
golem.com.payment.protocol.versionnumber-
golem.com.schemestringExample ts payu
golem.com.scheme.payu.interval_sec?numberDeprecated replaced by golem.com.scheme.payu.debit-note.interval-sec? in GAP-3
golem.com.pricing.model"linear"-
golem.com.pricing.model.linear.coeffsnumber[]-
golem.com.usage.vectorstring[]-

Defined in

src/market/proposal/proposal-properties.ts:58


StandardServiceProps

Ƭ StandardServiceProps: Object

Link

https://github.com/golemfactory/golem-architecture/blob/master/standards/2-service/srv

Type declaration

NameType
golem.srv.caps.multi-activityboolean

Defined in

src/market/proposal/proposal-properties.ts:78


StandardComputationPlatformProps

Ƭ StandardComputationPlatformProps: Object

Link

https://github.com/golemfactory/golem-architecture/blob/master/standards/2-service/srv/comp

Type declaration

NameType
golem.srv.comp.expirationnumber
golem.srv.comp.task_packagestring

Defined in

src/market/proposal/proposal-properties.ts:85


ProposalProperties

Ƭ ProposalProperties: GenericGolemProtocolPropertyType & StandardCommonProps & StandardNodeProps & StandardCommercialProps & StandardServiceProps & StandardComputationPlatformProps & Gap3MidAgreementPaymentProps & Partial<{ golem.node.debug.subnet: string ; golem.node.net.is-public: boolean ; golem.srv.caps.payload-manifest: boolean }>

Defined in

src/market/proposal/proposal-properties.ts:90