AgreementTemplate

@nevermined-io/nevermined-sdk-js / AgreementTemplate

Class: AgreementTemplate<Params>

Type parameters

Name
Params

Hierarchy

• ContractBase

  ↳ AgreementTemplate

  ↳↳ BaseTemplate

Table of contents

Constructors

• constructor

Properties

• contract
• contractName
• events
• version

Accessors

• address
• artifactsFolder
• config
• instanceConfig
• instantiableConfig
• logger
• nevermined
• web3

Methods

• addresses
• agreementId
• call
• checkExists
• createAgreement
• createAgreementAndPay
• createAgreementFromDDO
• createAgreementWithPaymentFromDDO
• findSigner
• getAddress
• getAgreementCreatedEvent
• getAgreementIdsFromDDO
• getAgreementStatus
• getAgreementsForDID
• getConditionTypes
• getConditions
• getContract
• getFromAddress
• getInputsOfMethod
• getServiceAgreementTemplate
• getServiceAgreementTemplateConditionByRef
• getServiceAgreementTemplateConditions
• getServiceAgreementTemplateDependencies
• getSignatureOfMethod
• init
• instanceFromDDO
• lockConditionIndex
• lockTokens
• params
• paymentData
• printAgreementStatus
• send
• sendFrom
• service
• setInstanceConfig
• standardContext
• addressesStatic
• findSignerStatic
• getInstance
• setInstanceConfig

Constructors

constructor

• Protected new AgreementTemplate<Params>(contractName)

Type parameters

Name
Params

Parameters

Name	Type
contractName	string

Overrides

ContractBase.constructor

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:75

Properties

contract

• contract: Contract = null

Inherited from

ContractBase.contract

Defined in

src/keeper/contracts/ContractBase.ts:24

---

contractName

• contractName: string

Inherited from

ContractBase.contractName

Defined in

src/keeper/contracts/ContractBase.ts:23

---

events

• events: ContractEvent | SubgraphEvent = null

Inherited from

ContractBase.events

Defined in

src/keeper/contracts/ContractBase.ts:25

---

version

• version: string

Inherited from

ContractBase.version

Defined in

src/keeper/contracts/ContractBase.ts:26

Accessors

address

• get address(): string

Returns

string

Inherited from

ContractBase.address

Defined in

src/keeper/contracts/ContractBase.ts:28

---

artifactsFolder

• Protected get artifactsFolder(): string

Returns

string

Inherited from

ContractBase.artifactsFolder

Defined in

src/Instantiable.abstract.ts:96

---

config

• Protected get config(): Config

Returns

Config

Inherited from

ContractBase.config

Defined in

src/Instantiable.abstract.ts:80

---

instanceConfig

• Protected get instanceConfig(): InstantiableConfig

Returns

InstantiableConfig

Inherited from

ContractBase.instanceConfig

Defined in

src/Instantiable.abstract.ts:100

---

instantiableConfig

• Protected get instantiableConfig(): InstantiableConfig

Returns

InstantiableConfig

Inherited from

ContractBase.instantiableConfig

Defined in

src/Instantiable.abstract.ts:73

---

logger

• Protected get logger(): Logger

Returns

Logger

Inherited from

ContractBase.logger

Defined in

src/Instantiable.abstract.ts:87

---

nevermined

• Protected get nevermined(): Nevermined

Returns

Nevermined

Inherited from

ContractBase.nevermined

Defined in

src/Instantiable.abstract.ts:33

---

web3

• Protected get web3(): JsonRpcProvider

Returns

JsonRpcProvider

Inherited from

ContractBase.web3

Defined in

src/Instantiable.abstract.ts:63

Methods

addresses

▸ addresses(): Promise<string[]>

Returns

Promise<string[]>

Inherited from

ContractBase.addresses

Defined in

src/Instantiable.abstract.ts:129

---

agreementId

▸ agreementId(agreementIdSeed, creator): Promise<string>

Parameters

Name	Type
agreementIdSeed	string
creator	string

Returns

Promise<string>

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:213

---

call

▸ call<T>(name, args, from?): Promise<T>

Type parameters

Name
T

Parameters

Name	Type
name	string
args	any[]
from?	string

Returns

Promise<T>

Inherited from

ContractBase.call

Defined in

src/keeper/contracts/ContractBase.ts:244

---

checkExists

▸ Protected checkExists(address): Promise<boolean>

Returns true of contract exists else it throws.

Parameters

Name	Type
address	string

Returns

Promise<boolean>

true if the contract exists.

Inherited from

ContractBase.checkExists

Defined in

src/Instantiable.abstract.ts:44

---

createAgreement

▸ createAgreement(agreementId, did, conditionIds, timeLocks, timeOuts, extraArgs, from?, params?): Promise<ContractReceipt>

Parameters

Name	Type
agreementId	string
did	string
conditionIds	string[]
timeLocks	number[]
timeOuts	number[]
extraArgs	any[]
from?	Account
params?	TxParameters

Returns

Promise<ContractReceipt>

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:99

---

createAgreementAndPay

▸ createAgreementAndPay(agreementId, did, conditionIds, timeLocks, timeOuts, accessConsumer, condIdx, rewardAddress, tokenAddress, amounts, receivers, from?, params?): Promise<ContractReceipt>

Parameters

Name	Type
agreementId	string
did	string
conditionIds	string[]
timeLocks	number[]
timeOuts	number[]
accessConsumer	string
condIdx	number
rewardAddress	string
tokenAddress	string
amounts	default[]
receivers	string[]
from?	Account
params?	TxParameters

Returns

Promise<ContractReceipt>

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:124

---

createAgreementFromDDO

▸ createAgreementFromDDO(agreementIdSeed, ddo, parameters, consumer, from, timeOuts?, params?): Promise<string>

Create a new agreement using the data of a DDO.

Parameters

Name	Type	Description
agreementIdSeed	string	-
ddo	DDO	DDO.
parameters	Params
consumer	Account	-
from	Account	-
timeOuts?	number[]	-
params?	TxParameters	-

Returns

Promise<string>

true if the call was successful.

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:225

---

createAgreementWithPaymentFromDDO

▸ createAgreementWithPaymentFromDDO(agreementIdSeed, ddo, parameters, consumer, from, timeOuts?, txParams?, observer?): Promise<string>

Parameters

Name	Type
agreementIdSeed	string
ddo	DDO
parameters	Params
consumer	Account
from	Account
timeOuts?	number[]
txParams?	TxParameters
observer?	(OrderProgressStep: any) => void

Returns

Promise<string>

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:255

---

findSigner

▸ findSigner(from): Promise<Signer>

Parameters

Name	Type
from	string

Returns

Promise<Signer>

Inherited from

ContractBase.findSigner

Defined in

src/Instantiable.abstract.ts:105

---

getAddress

▸ getAddress(): string

Returns

string

Inherited from

ContractBase.getAddress

Defined in

src/keeper/contracts/ContractBase.ts:41

---

getAgreementCreatedEvent

▸ getAgreementCreatedEvent(agreementId): Promise<any[]>

Generates and returns the agreement creation event.

Parameters

Name	Type	Description
agreementId	string	Agreement ID.

Returns

Promise<any[]>

Agreement created event.

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:469

---

getAgreementIdsFromDDO

▸ getAgreementIdsFromDDO(agreementId, ddo, creator, params): Promise<string[]>

Get agreement conditions IDs.

Parameters

Name	Type	Description
agreementId	string	Agreement ID.
ddo	DDO	DDO.
creator	string	-
params	Params	-

Returns

Promise<string[]>

The condition IDs.

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:183

---

getAgreementStatus

▸ getAgreementStatus(agreementId): Promise<false | AgreementConditionsStatus>

Returns the status of the conditions.

Parameters

Name	Type	Description
agreementId	string	Agreement ID.

Returns

Promise<false | AgreementConditionsStatus>

The conditions status.

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:343

---

getAgreementsForDID

▸ getAgreementsForDID(did): Promise<string[]>

Parameters

Name	Type
did	string

Returns

Promise<string[]>

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:496

---

getConditionTypes

▸ getConditionTypes(): Promise<string[]>

Conditions address list.

Returns

Promise<string[]>

A list of condition addresses.

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:163

---

getConditions

▸ getConditions(): Promise<ConditionSmall[]>

List of condition contracts.

Returns

Promise<ConditionSmall[]>

A list of condition contracts.

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:171

---

getContract

▸ getContract(): Contract

Returns

Contract

Inherited from

ContractBase.getContract

Defined in

src/keeper/contracts/ContractBase.ts:37

---

getFromAddress

▸ Protected getFromAddress(from?): Promise<string>

Parameters

Name	Type
from?	string

Returns

Promise<string>

Inherited from

ContractBase.getFromAddress

Defined in

src/keeper/contracts/ContractBase.ts:90

---

getInputsOfMethod

▸ getInputsOfMethod(methodName): any[]

Parameters

Name	Type
methodName	string

Returns

any[]

Inherited from

ContractBase.getInputsOfMethod

Defined in

src/keeper/contracts/ContractBase.ts:50

---

getServiceAgreementTemplate

▸ Abstract getServiceAgreementTemplate(): Promise<ServiceAgreementTemplate>

Returns

Promise<ServiceAgreementTemplate>

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:317

---

getServiceAgreementTemplateConditionByRef

▸ getServiceAgreementTemplateConditionByRef(ref): Promise<ConditionSmall>

Parameters

Name	Type
ref	string

Returns

Promise<ConditionSmall>

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:324

---

getServiceAgreementTemplateConditions

▸ getServiceAgreementTemplateConditions(): Promise<ServiceAgreementTemplateCondition[]>

Returns

Promise<ServiceAgreementTemplateCondition[]>

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:319

---

getServiceAgreementTemplateDependencies

▸ getServiceAgreementTemplateDependencies(): Promise<{ [condition: string]: string[]; }>

Returns

Promise<{ [condition: string]: string[]; }>

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:333

---

getSignatureOfMethod

▸ getSignatureOfMethod(methodName, args?): string

Parameters

Name	Type	Default value
methodName	string	undefined
args	any[]	[]

Returns

string

Inherited from

ContractBase.getSignatureOfMethod

Defined in

src/keeper/contracts/ContractBase.ts:45

---

init

▸ Protected init(config, optional?): Promise<void>

Parameters

Name	Type	Default value
config	InstantiableConfig	undefined
optional	boolean	false

Returns

Promise<void>

Inherited from

ContractBase.init

Defined in

src/keeper/contracts/ContractBase.ts:55

---

instanceFromDDO

▸ Optional Abstract instanceFromDDO(agreementIdSeed, ddo, creator, parameters): Promise<AgreementInstance<Params>>

Parameters

Name	Type
agreementIdSeed	string
ddo	DDO
creator	string
parameters	Params

Returns

Promise<AgreementInstance<Params>>

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:198

---

lockConditionIndex

▸ lockConditionIndex(): number

Returns

number

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:81

---

lockTokens

▸ lockTokens(tokenAddress, amounts, from, txParams): Promise<void>

Parameters

Name	Type
tokenAddress	any
amounts	any
from	Account
txParams	TxParameters

Returns

Promise<void>

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:398

---

params

▸ Abstract params(...args): Params

Parameters

Name	Type
...args	any[]

Returns

Params

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:79

---

paymentData

▸ paymentData(service): PaymentData

Parameters

Name	Type
service	ServiceCommon

Returns

PaymentData

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:85

---

printAgreementStatus

▸ printAgreementStatus(agreementId): Promise<void>

Prints the agreement status.

Parameters

Name	Type	Description
agreementId	string	Agreement ID.

Returns

Promise<void>

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:439

---

send

▸ send(name, from, args, params?): Promise<ContractReceipt>

Parameters

Name	Type
name	string
from	string
args	any[]
params	TxParameters

Returns

Promise<ContractReceipt>

Inherited from

ContractBase.send

Defined in

src/keeper/contracts/ContractBase.ts:117

---

sendFrom

▸ sendFrom(name, args, from?, value?): Promise<ContractReceipt>

Parameters

Name	Type
name	string
args	any[]
from?	Account
value?	TxParameters

Returns

Promise<ContractReceipt>

Inherited from

ContractBase.sendFrom

Defined in

src/keeper/contracts/ContractBase.ts:97

---

service

▸ Abstract service(): ServiceType

Returns

ServiceType

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:205

---

setInstanceConfig

▸ Protected setInstanceConfig(config): void

Parameters

Name	Type
config	InstantiableConfig

Returns

void

Inherited from

ContractBase.setInstanceConfig

Defined in

src/Instantiable.abstract.ts:171

---

standardContext

▸ standardContext(ddo, creator): ConditionContext

Parameters

Name	Type
ddo	DDO
creator	string

Returns

ConditionContext

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:207

---

addressesStatic

▸ Static addressesStatic(config, web3): Promise<string[]>

Parameters

Name	Type
config	Config
web3	JsonRpcProvider

Returns

Promise<string[]>

Inherited from

ContractBase.addressesStatic

Defined in

src/Instantiable.abstract.ts:142

---

findSignerStatic

▸ Static findSignerStatic(config, web3, from): Promise<Signer>

Parameters

Name	Type
config	Config
web3	JsonRpcProvider
from	string

Returns

Promise<Signer>

Inherited from

ContractBase.findSignerStatic

Defined in

src/Instantiable.abstract.ts:115

---

getInstance

▸ Static getInstance<Params>(config, templateContractName, templateClass, optional?): Promise<any>

Type parameters

Name
Params

Parameters

Name	Type	Default value
config	InstantiableConfig	undefined
templateContractName	string	undefined
templateClass	any	undefined
optional	boolean	false

Returns

Promise<any>

Overrides

ContractBase.getInstance

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:62

---

setInstanceConfig

▸ Static Protected setInstanceConfig<T>(instance, instantiableConfig): void

Type parameters

Name	Type
T	extends Instantiable<T>

Parameters

Name	Type
instance	T
instantiableConfig	InstantiableConfig

Returns

void

Inherited from

ContractBase.setInstanceConfig

Defined in

src/Instantiable.abstract.ts:162