Skip to main content

Keeper

@nevermined-io/nevermined-sdk-js / Keeper

Class: Keeper

Interface with Nevermined contracts. Nevermined Keeper implementation where we put the following modules together:

  • TCRs: users create challenges and resolve them through voting to maintain registries.
  • Nevermined Tokens: the intrinsic tokens circulated inside Nevermined network, which is used in the voting of TCRs.
  • Marketplace: the core marketplace where people can transact with each other with Nevermined tokens.

Hierarchy

  • Instantiable

    Keeper

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

new Keeper()

Inherited from

Instantiable.constructor

Properties

agreementStoreManager

agreementStoreManager: AgreementStoreManager

Template store manager smart contract instance.

Defined in

src/keeper/Keeper.ts:316


conditionStoreManager

conditionStoreManager: ConditionStoreManager

Template store manager smart contract instance.

Defined in

src/keeper/Keeper.ts:321


conditions

conditions: Object

Conditions instances.

Type declaration

NameType
aaveBorrowConditionAaveBorrowCondition
aaveCollateralDepositConditionAaveCollateralDepositCondition
aaveCollateralWithdrawConditionAaveCollateralWithdrawCondition
aaveRepayConditionAaveRepayCondition
accessConditionAccessCondition
computeExecutionConditionComputeExecutionCondition
distributeNftCollateralConditionDistributeNFTCollateralCondition
escrowPaymentConditionEscrowPaymentCondition
lockPaymentConditionLockPaymentCondition
nft721HolderConditionNFT721HolderCondition
nft721LockConditionNFT721LockCondition
nftAccessConditionNFTAccessCondition
nftHolderConditionNFTHolderCondition
nftLockConditionNFTLockCondition
transferDidOwnershipConditionTransferDIDOwnershipCondition
transferNft721ConditionTransferNFT721Condition
transferNftConditionTransferNFTCondition

Defined in

src/keeper/Keeper.ts:326


conditionsList

conditionsList: ConditionSmall[]

Defined in

src/keeper/Keeper.ts:346


connected

connected: boolean = false

Is connected to the correct network or not.

Defined in

src/keeper/Keeper.ts:281


didRegistry

didRegistry: default

DID registry smart contract instance.

Defined in

src/keeper/Keeper.ts:301


dispenser

dispenser: default

Market smart contract instance.

Defined in

src/keeper/Keeper.ts:291


instances

Private instances: Object

Index signature

[contractRef: string]: ContractBase & any

Defined in

src/keeper/Keeper.ts:392


network

Protected network: Object

Network id loaded from web3

Type declaration

NameType
id?number
loadingboolean

Defined in

src/keeper/Keeper.ts:385


nftUpgradeable

nftUpgradeable: NFTUpgradeable

NFT upgradeable smart contract instance.

Defined in

src/keeper/Keeper.ts:306


nvmConfig

nvmConfig: default

Nevermined Config smart contract instance.

Defined in

src/keeper/Keeper.ts:296


rewardsDistributor

rewardsDistributor: RewardsDistributor

Defined in

src/keeper/Keeper.ts:368


royalties

royalties: Object

Type declaration

NameType
curveCurveRoyalties
standardStandardRoyalties

Defined in

src/keeper/Keeper.ts:363


templateList

templateList: GenericAccess[]

Defined in

src/keeper/Keeper.ts:347


templateStoreManager

templateStoreManager: TemplateStoreManager

Template store manager smart contract instance.

Defined in

src/keeper/Keeper.ts:311


templates

templates: Object

Templates instances.

Type declaration

NameType
aaveCreditTemplateAaveCreditTemplate
accessTemplateAccessTemplate
didSalesTemplateDIDSalesTemplate
escrowComputeExecutionTemplateEscrowComputeExecutionTemplate
nft721AccessTemplateNFT721AccessTemplate
nft721SalesTemplateNFT721SalesTemplate
nftAccessTemplateNFTAccessTemplate
nftSalesTemplateNFTSalesTemplate

Defined in

src/keeper/Keeper.ts:352


token

token: default

Nevermined Token smart contract instance.

Defined in

src/keeper/Keeper.ts:286


utils

utils: Object

Helpers for contracts.

Type declaration

NameType
eventHandlerEventHandler

Defined in

src/keeper/Keeper.ts:373


version

version: string

Version of the artifacts in use

Defined in

src/keeper/Keeper.ts:380

Accessors

artifactsFolder

Protected get artifactsFolder(): string

Returns

string

Inherited from

Instantiable.artifactsFolder

Defined in

src/Instantiable.abstract.ts:96


config

Protected get config(): Config

Returns

Config

Inherited from

Instantiable.config

Defined in

src/Instantiable.abstract.ts:80


instanceConfig

Protected get instanceConfig(): InstantiableConfig

Returns

InstantiableConfig

Inherited from

Instantiable.instanceConfig

Defined in

src/Instantiable.abstract.ts:100


instantiableConfig

Protected get instantiableConfig(): InstantiableConfig

Returns

InstantiableConfig

Inherited from

Instantiable.instantiableConfig

Defined in

src/Instantiable.abstract.ts:73


logger

Protected get logger(): Logger

Returns

Logger

Inherited from

Instantiable.logger

Defined in

src/Instantiable.abstract.ts:87


nevermined

Protected get nevermined(): Nevermined

Returns

Nevermined

Inherited from

Instantiable.nevermined

Defined in

src/Instantiable.abstract.ts:33


web3

Protected get web3(): JsonRpcProvider

Returns

JsonRpcProvider

Inherited from

Instantiable.web3

Defined in

src/Instantiable.abstract.ts:63

Methods

addresses

addresses(): Promise<string[]>

Returns

Promise<string[]>

Inherited from

Instantiable.addresses

Defined in

src/Instantiable.abstract.ts:129


checkExists

Protected checkExists(address): Promise<boolean>

Returns true of contract exists else it throws.

Parameters

NameType
addressstring

Returns

Promise<boolean>

true if the contract exists.

Inherited from

Instantiable.checkExists

Defined in

src/Instantiable.abstract.ts:44


findSigner

findSigner(from): Promise<Signer>

Parameters

NameType
fromstring

Returns

Promise<Signer>

Inherited from

Instantiable.findSigner

Defined in

src/Instantiable.abstract.ts:105


getAccessTemplateByName

getAccessTemplateByName(name): GenericAccess

Returns a Access template by name.

Parameters

NameTypeDescription
namestringTemplate name.

Returns

GenericAccess

Agreement template instance.

Defined in

src/keeper/Keeper.ts:419


getAllInstances

getAllInstances(): Object

Returns

Object

Defined in

src/keeper/Keeper.ts:459


getConditionByAddress

getConditionByAddress(address): ConditionSmall

Returns a condition by address.

Parameters

NameTypeDescription
addressstringAddress of deployed condition.

Returns

ConditionSmall

Condition instance.

Defined in

src/keeper/Keeper.ts:399


getNetworkId

getNetworkId(): Promise<number>

Returns the id of the network.

Returns

Promise<number>

Network ID.

Defined in

src/keeper/Keeper.ts:446


getNetworkName

getNetworkName(): Promise<string>

Returns the network by name.

Returns

Promise<string>

Network name.

Defined in

src/keeper/Keeper.ts:438


getTemplateByAddress

getTemplateByAddress(address): AccessTemplate | EscrowComputeExecutionTemplate | DIDSalesTemplate | NFTAccessTemplate | NFT721AccessTemplate | NFTSalesTemplate | NFT721SalesTemplate | AaveCreditTemplate

Returns a template by address.

Parameters

NameTypeDescription
addressstringTemplate address.

Returns

AccessTemplate | EscrowComputeExecutionTemplate | DIDSalesTemplate | NFTAccessTemplate | NFT721AccessTemplate | NFTSalesTemplate | NFT721SalesTemplate | AaveCreditTemplate

Agreement template instance.

Defined in

src/keeper/Keeper.ts:428


getTemplateByName

getTemplateByName(name): AccessTemplate | EscrowComputeExecutionTemplate | DIDSalesTemplate | NFTAccessTemplate | NFT721AccessTemplate | NFTSalesTemplate | NFT721SalesTemplate | AaveCreditTemplate

Returns a template by name.

Parameters

NameTypeDescription
namestringTemplate name.

Returns

AccessTemplate | EscrowComputeExecutionTemplate | DIDSalesTemplate | NFTAccessTemplate | NFT721AccessTemplate | NFTSalesTemplate | NFT721SalesTemplate | AaveCreditTemplate

Agreement template instance.

Defined in

src/keeper/Keeper.ts:408


init

init(): Promise<void>

Returns

Promise<void>

Defined in

src/keeper/Keeper.ts:74


setInstanceConfig

Protected setInstanceConfig(config): void

Parameters

NameType
configInstantiableConfig

Returns

void

Inherited from

Instantiable.setInstanceConfig

Defined in

src/Instantiable.abstract.ts:171


addressesStatic

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

Parameters

NameType
configConfig
web3JsonRpcProvider

Returns

Promise<string[]>

Inherited from

Instantiable.addressesStatic

Defined in

src/Instantiable.abstract.ts:142


findSignerStatic

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

Parameters

NameType
configConfig
web3JsonRpcProvider
fromstring

Returns

Promise<Signer>

Inherited from

Instantiable.findSignerStatic

Defined in

src/Instantiable.abstract.ts:115


getInstance

Static getInstance(config): Promise<Keeper>

Returns Keeper instance.

Parameters

NameType
configInstantiableConfig

Returns

Promise<Keeper>

Keeper

Overrides

Instantiable.getInstance

Defined in

src/keeper/Keeper.ts:68


setInstanceConfig

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

Type parameters

NameType
Textends Instantiable<T>

Parameters

NameType
instanceT
instantiableConfigInstantiableConfig

Returns

void

Inherited from

Instantiable.setInstanceConfig

Defined in

src/Instantiable.abstract.ts:162