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
- agreementStoreManager
- conditionStoreManager
- conditions
- conditionsList
- connected
- didRegistry
- dispenser
- instances
- network
- nftUpgradeable
- nvmConfig
- rewardsDistributor
- royalties
- templateList
- templateStoreManager
- templates
- token
- utils
- version
Accessors
Methods
- addresses
- checkExists
- findSigner
- getAccessTemplateByName
- getAllInstances
- getConditionByAddress
- getNetworkId
- getNetworkName
- getTemplateByAddress
- getTemplateByName
- init
- setInstanceConfig
- addressesStatic
- findSignerStatic
- getInstance
- setInstanceConfig
Constructors
constructor
• new Keeper()
Inherited from
Instantiable.constructor
Properties
agreementStoreManager
• agreementStoreManager: AgreementStoreManager
Template store manager smart contract instance.
Defined in
conditionStoreManager
• conditionStoreManager: ConditionStoreManager
Template store manager smart contract instance.
Defined in
conditions
• conditions: Object
Conditions instances.
Type declaration
Name | Type |
---|---|
aaveBorrowCondition | AaveBorrowCondition |
aaveCollateralDepositCondition | AaveCollateralDepositCondition |
aaveCollateralWithdrawCondition | AaveCollateralWithdrawCondition |
aaveRepayCondition | AaveRepayCondition |
accessCondition | AccessCondition |
computeExecutionCondition | ComputeExecutionCondition |
distributeNftCollateralCondition | DistributeNFTCollateralCondition |
escrowPaymentCondition | EscrowPaymentCondition |
lockPaymentCondition | LockPaymentCondition |
nft721HolderCondition | NFT721HolderCondition |
nft721LockCondition | NFT721LockCondition |
nftAccessCondition | NFTAccessCondition |
nftHolderCondition | NFTHolderCondition |
nftLockCondition | NFTLockCondition |
transferDidOwnershipCondition | TransferDIDOwnershipCondition |
transferNft721Condition | TransferNFT721Condition |
transferNftCondition | TransferNFTCondition |
Defined in
conditionsList
• conditionsList: ConditionSmall
[]
Defined in
connected
• connected: boolean
= false
Is connected to the correct network or not.
Defined in
didRegistry
• didRegistry: default
DID registry smart contract instance.
Defined in
dispenser
• dispenser: default
Market smart contract instance.
Defined in
instances
• Private
instances: Object
Index signature
▪ [contractRef: string
]: ContractBase
& any
Defined in
network
• Protected
network: Object
Network id loaded from web3
Type declaration
Name | Type |
---|---|
id? | number |
loading | boolean |
Defined in
nftUpgradeable
• nftUpgradeable: NFTUpgradeable
NFT upgradeable smart contract instance.
Defined in
nvmConfig
• nvmConfig: default
Nevermined Config smart contract instance.
Defined in
rewardsDistributor
• rewardsDistributor: RewardsDistributor
Defined in
royalties
• royalties: Object
Type declaration
Name | Type |
---|---|
curve | CurveRoyalties |
standard | StandardRoyalties |
Defined in
templateList
• templateList: GenericAccess
[]
Defined in
templateStoreManager
• templateStoreManager: TemplateStoreManager
Template store manager smart contract instance.
Defined in
templates
• templates: Object
Templates instances.
Type declaration
Name | Type |
---|---|
aaveCreditTemplate | AaveCreditTemplate |
accessTemplate | AccessTemplate |
didSalesTemplate | DIDSalesTemplate |
escrowComputeExecutionTemplate | EscrowComputeExecutionTemplate |
nft721AccessTemplate | NFT721AccessTemplate |
nft721SalesTemplate | NFT721SalesTemplate |
nftAccessTemplate | NFTAccessTemplate |
nftSalesTemplate | NFTSalesTemplate |
Defined in
token
• token: default
Nevermined Token smart contract instance.
Defined in
utils
• utils: Object
Helpers for contracts.
Type declaration
Name | Type |
---|---|
eventHandler | EventHandler |
Defined in
version
• version: string
Version of the artifacts in use
Defined in
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
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
Inherited from
Instantiable.logger
Defined in
src/Instantiable.abstract.ts:87
nevermined
• Protected
get
nevermined(): Nevermined
Returns
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
Name | Type |
---|---|
address | string |
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
Name | Type |
---|---|
from | string |
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
Name | Type | Description |
---|---|---|
name | string | Template name. |
Returns
GenericAccess
Agreement template instance.
Defined in
getAllInstances
▸ getAllInstances(): Object
Returns
Object
Defined in
getConditionByAddress
▸ getConditionByAddress(address
): ConditionSmall
Returns a condition by address.
Parameters
Name | Type | Description |
---|---|---|
address | string | Address of deployed condition. |
Returns
Condition instance.
Defined in
getNetworkId
▸ getNetworkId(): Promise
<number
>
Returns the id of the network.
Returns
Promise
<number
>
Network ID.
Defined in
getNetworkName
▸ getNetworkName(): Promise
<string
>
Returns the network by name.
Returns
Promise
<string
>
Network name.
Defined in
getTemplateByAddress
▸ getTemplateByAddress(address
): AccessTemplate
| EscrowComputeExecutionTemplate
| DIDSalesTemplate
| NFTAccessTemplate
| NFT721AccessTemplate
| NFTSalesTemplate
| NFT721SalesTemplate
| AaveCreditTemplate
Returns a template by address.
Parameters
Name | Type | Description |
---|---|---|
address | string | Template address. |
Returns
AccessTemplate
| EscrowComputeExecutionTemplate
| DIDSalesTemplate
| NFTAccessTemplate
| NFT721AccessTemplate
| NFTSalesTemplate
| NFT721SalesTemplate
| AaveCreditTemplate
Agreement template instance.
Defined in
getTemplateByName
▸ getTemplateByName(name
): AccessTemplate
| EscrowComputeExecutionTemplate
| DIDSalesTemplate
| NFTAccessTemplate
| NFT721AccessTemplate
| NFTSalesTemplate
| NFT721SalesTemplate
| AaveCreditTemplate
Returns a template by name.
Parameters
Name | Type | Description |
---|---|---|
name | string | Template name. |
Returns
AccessTemplate
| EscrowComputeExecutionTemplate
| DIDSalesTemplate
| NFTAccessTemplate
| NFT721AccessTemplate
| NFTSalesTemplate
| NFT721SalesTemplate
| AaveCreditTemplate
Agreement template instance.
Defined in
init
▸ init(): Promise
<void
>
Returns
Promise
<void
>
Defined in
setInstanceConfig
▸ Protected
setInstanceConfig(config
): void
Parameters
Name | Type |
---|---|
config | InstantiableConfig |
Returns
void
Inherited from
Instantiable.setInstanceConfig
Defined in
src/Instantiable.abstract.ts:171
addressesStatic
▸ Static
addressesStatic(config
, web3
): Promise
<string
[]>
Parameters
Name | Type |
---|---|
config | Config |
web3 | JsonRpcProvider |
Returns
Promise
<string
[]>
Inherited from
Instantiable.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
Instantiable.findSignerStatic
Defined in
src/Instantiable.abstract.ts:115
getInstance
▸ Static
getInstance(config
): Promise
<Keeper
>
Returns Keeper instance.
Parameters
Name | Type |
---|---|
config | InstantiableConfig |
Returns
Promise
<Keeper
>
Overrides
Instantiable.getInstance
Defined in
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
Instantiable.setInstanceConfig