Skip to main content

conditions.NFT721LockCondition

@nevermined-io/nevermined-sdk-js / conditions / NFT721LockCondition

Class: NFT721LockCondition

conditions.NFT721LockCondition

Implementation of the NFT Lock Condition

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

new NFT721LockCondition(contractName)

Parameters

NameType
contractNamestring

Inherited from

ProviderCondition.constructor

Defined in

src/keeper/contracts/ContractBase.ts:32

Properties

contract

contract: Contract = null

Inherited from

ProviderCondition.contract

Defined in

src/keeper/contracts/ContractBase.ts:24


contractName

contractName: string

Inherited from

ProviderCondition.contractName

Defined in

src/keeper/contracts/ContractBase.ts:23


events

events: ContractEvent | SubgraphEvent = null

Inherited from

ProviderCondition.events

Defined in

src/keeper/contracts/ContractBase.ts:25


version

version: string

Inherited from

ProviderCondition.version

Defined in

src/keeper/contracts/ContractBase.ts:26

Accessors

address

get address(): string

Returns

string

Inherited from

ProviderCondition.address

Defined in

src/keeper/contracts/ContractBase.ts:28


artifactsFolder

Protected get artifactsFolder(): string

Returns

string

Inherited from

ProviderCondition.artifactsFolder

Defined in

src/Instantiable.abstract.ts:96


config

Protected get config(): Config

Returns

Config

Inherited from

ProviderCondition.config

Defined in

src/Instantiable.abstract.ts:80


instanceConfig

Protected get instanceConfig(): InstantiableConfig

Returns

InstantiableConfig

Inherited from

ProviderCondition.instanceConfig

Defined in

src/Instantiable.abstract.ts:100


instantiableConfig

Protected get instantiableConfig(): InstantiableConfig

Returns

InstantiableConfig

Inherited from

ProviderCondition.instantiableConfig

Defined in

src/Instantiable.abstract.ts:73


logger

Protected get logger(): Logger

Returns

Logger

Inherited from

ProviderCondition.logger

Defined in

src/Instantiable.abstract.ts:87


nevermined

Protected get nevermined(): Nevermined

Returns

Nevermined

Inherited from

ProviderCondition.nevermined

Defined in

src/Instantiable.abstract.ts:33


web3

Protected get web3(): JsonRpcProvider

Returns

JsonRpcProvider

Inherited from

ProviderCondition.web3

Defined in

src/Instantiable.abstract.ts:63

Methods

abortByTimeOut

abortByTimeOut(agreementId, from?, params?): Promise<ContractReceipt>

Parameters

NameType
agreementIdstring
from?Account
params?TxParameters

Returns

Promise<ContractReceipt>

Inherited from

ProviderCondition.abortByTimeOut

Defined in

src/keeper/contracts/conditions/Condition.abstract.ts:97


addresses

addresses(): Promise<string[]>

Returns

Promise<string[]>

Inherited from

ProviderCondition.addresses

Defined in

src/Instantiable.abstract.ts:129


call

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

Type parameters

Name
T

Parameters

NameType
namestring
argsany[]
from?string

Returns

Promise<T>

Inherited from

ProviderCondition.call

Defined in

src/keeper/contracts/ContractBase.ts:244


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

ProviderCondition.checkExists

Defined in

src/Instantiable.abstract.ts:44


findSigner

findSigner(from): Promise<Signer>

Parameters

NameType
fromstring

Returns

Promise<Signer>

Inherited from

ProviderCondition.findSigner

Defined in

src/Instantiable.abstract.ts:105


fulfill

fulfill(agreementId, did, lockAddress, amount, nftContractAddress, from?): Promise<ContractReceipt>

Fulfill requires valid NFT transfer in order to lock the amount of DID NFTs based on SEA.

Parameters

NameTypeDescription
agreementIdstringSEA agreement identifier.
didstringAsset Decentralized identifier.
lockAddressstringThe contract address where the NFT is locked.
amountnumberThe amount of tokens to be locked.
nftContractAddressstringThe NFT721 contract address
from?Account

Returns

Promise<ContractReceipt>

Condition state.

Overrides

ProviderCondition.fulfill

Defined in

src/keeper/contracts/defi/NFT721LockCondition.ts:72


fulfillGateway

fulfillGateway(cond, additionalParams, from?, params?): Promise<ContractReceipt>

Parameters

NameType
condConditionInstance<Record<string, unknown>>
additionalParamsRecord<string, unknown>
from?Account
params?TxParameters

Returns

Promise<ContractReceipt>

Inherited from

ProviderCondition.fulfillGateway

Defined in

src/keeper/contracts/conditions/Condition.abstract.ts:204


fulfillInstance

fulfillInstance(cond, additionalParams, from?, params?, method?): Promise<ContractReceipt>

Parameters

NameTypeDefault value
condConditionInstance<Record<string, unknown>>undefined
additionalParamsRecord<string, unknown>undefined
from?Accountundefined
params?TxParametersundefined
methodConditionMethod'fulfill'

Returns

Promise<ContractReceipt>

Inherited from

ProviderCondition.fulfillInstance

Defined in

src/keeper/contracts/conditions/Condition.abstract.ts:162


fulfillPlain

fulfillPlain(agreementId, args, from?, params?, method?): Promise<ContractReceipt>

Parameters

NameTypeDefault value
agreementIdstringundefined
argsany[]undefined
from?Accountundefined
params?TxParametersundefined
methodConditionMethod'fulfill'

Returns

Promise<ContractReceipt>

Inherited from

ProviderCondition.fulfillPlain

Defined in

src/keeper/contracts/conditions/Condition.abstract.ts:69


gatewayMethod

gatewayMethod(): ConditionMethod

Returns

ConditionMethod

Inherited from

ProviderCondition.gatewayMethod

Defined in

src/keeper/contracts/conditions/Condition.abstract.ts:221


generateId

generateId(agreementId, valueHash): Promise<string>

Parameters

NameType
agreementIdstring
valueHashstring

Returns

Promise<string>

Inherited from

ProviderCondition.generateId

Defined in

src/keeper/contracts/conditions/Condition.abstract.ts:83


generateIdHash

generateIdHash(agreementId, ...values): Promise<string>

Parameters

NameType
agreementIdstring
...valuesany[]

Returns

Promise<string>

Inherited from

ProviderCondition.generateIdHash

Defined in

src/keeper/contracts/conditions/Condition.abstract.ts:79


generateIdWithSeed

generateIdWithSeed(agreementId, valueHash): Promise<[string, string]>

Parameters

NameType
agreementIdstring
valueHashstring

Returns

Promise<[string, string]>

Inherited from

ProviderCondition.generateIdWithSeed

Defined in

src/keeper/contracts/conditions/Condition.abstract.ts:87


getAddress

getAddress(): string

Returns

string

Inherited from

ProviderCondition.getAddress

Defined in

src/keeper/contracts/ContractBase.ts:41


getConditionFulfilledEvent

getConditionFulfilledEvent(agreementId): EventResult

Parameters

NameType
agreementIdstring

Returns

EventResult

Inherited from

ProviderCondition.getConditionFulfilledEvent

Defined in

src/keeper/contracts/conditions/Condition.abstract.ts:101


getContract

getContract(): Contract

Returns

Contract

Inherited from

ProviderCondition.getContract

Defined in

src/keeper/contracts/ContractBase.ts:37


getFromAddress

Protected getFromAddress(from?): Promise<string>

Parameters

NameType
from?string

Returns

Promise<string>

Inherited from

ProviderCondition.getFromAddress

Defined in

src/keeper/contracts/ContractBase.ts:90


getInputsOfMethod

getInputsOfMethod(methodName): any[]

Parameters

NameType
methodNamestring

Returns

any[]

Inherited from

ProviderCondition.getInputsOfMethod

Defined in

src/keeper/contracts/ContractBase.ts:50


getSignatureOfMethod

getSignatureOfMethod(methodName, args?): string

Parameters

NameTypeDefault value
methodNamestringundefined
argsany[][]

Returns

string

Inherited from

ProviderCondition.getSignatureOfMethod

Defined in

src/keeper/contracts/ContractBase.ts:45


hashValues

hashValues(...args): Promise<string>

Parameters

NameType
...argsany[]

Returns

Promise<string>

Inherited from

ProviderCondition.hashValues

Defined in

src/keeper/contracts/conditions/Condition.abstract.ts:141


hashValuesPlain

hashValuesPlain(...args): Promise<string>

Parameters

NameType
...argsany[]

Returns

Promise<string>

Inherited from

ProviderCondition.hashValuesPlain

Defined in

src/keeper/contracts/conditions/Condition.abstract.ts:145


init

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

Parameters

NameTypeDefault value
configInstantiableConfigundefined
optionalbooleanfalse

Returns

Promise<void>

Inherited from

ProviderCondition.init

Defined in

src/keeper/contracts/ContractBase.ts:55


instance

instance(agreementId, params): Promise<ConditionInstance<Record<string, unknown>>>

Parameters

NameType
agreementIdstring
paramsConditionParameters<Record<string, unknown>>

Returns

Promise<ConditionInstance<Record<string, unknown>>>

Inherited from

ProviderCondition.instance

Defined in

src/keeper/contracts/conditions/Condition.abstract.ts:184


instanceFromDDO

instanceFromDDO(agreementId, ctx, ...args): Promise<ConditionInstance<Record<string, unknown>>>

Parameters

NameType
agreementIdstring
ctxNFT721LockConditionContext
...argsConditionInstanceSmall[]

Returns

Promise<ConditionInstance<Record<string, unknown>>>

Inherited from

ProviderCondition.instanceFromDDO

Defined in

src/keeper/contracts/conditions/Condition.abstract.ts:154


params

params(did, lockAddress, amount, nftContractAddress): ConditionParameters<Record<string, unknown>>

Generates the hash of condition inputs.

Parameters

NameTypeDescription
didstringThe DID of the asset with NFTs attached to lock.
lockAddressstringthe address to lock the NFT to (vault address)
amountnumberThe amount of locked tokens.
nftContractAddressstringThe NFT721 contract address

Returns

ConditionParameters<Record<string, unknown>>

Hash of all the values.

Overrides

ProviderCondition.params

Defined in

src/keeper/contracts/defi/NFT721LockCondition.ts:39


paramsFromDDO

paramsFromDDO(__namedParameters): Promise<ConditionParameters<Record<string, unknown>>>

Parameters

NameType
__namedParametersNFT721LockConditionContext

Returns

Promise<ConditionParameters<Record<string, unknown>>>

Overrides

ProviderCondition.paramsFromDDO

Defined in

src/keeper/contracts/defi/NFT721LockCondition.ts:53


send

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

Parameters

NameType
namestring
fromstring
argsany[]
paramsTxParameters

Returns

Promise<ContractReceipt>

Inherited from

ProviderCondition.send

Defined in

src/keeper/contracts/ContractBase.ts:117


sendFrom

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

Parameters

NameType
namestring
argsany[]
from?Account
value?TxParameters

Returns

Promise<ContractReceipt>

Inherited from

ProviderCondition.sendFrom

Defined in

src/keeper/contracts/ContractBase.ts:97


setInstanceConfig

Protected setInstanceConfig(config): void

Parameters

NameType
configInstantiableConfig

Returns

void

Inherited from

ProviderCondition.setInstanceConfig

Defined in

src/Instantiable.abstract.ts:171


addressesStatic

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

Parameters

NameType
configConfig
web3JsonRpcProvider

Returns

Promise<string[]>

Inherited from

ProviderCondition.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

ProviderCondition.findSignerStatic

Defined in

src/Instantiable.abstract.ts:115


getInstance

Static getInstance(config): Promise<NFT721LockCondition>

Parameters

NameType
configInstantiableConfig

Returns

Promise<NFT721LockCondition>

Overrides

ProviderCondition.getInstance

Defined in

src/keeper/contracts/defi/NFT721LockCondition.ts:20


setInstanceConfig

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

Type parameters

NameType
Textends Instantiable<T>

Parameters

NameType
instanceT
instantiableConfigInstantiableConfig

Returns

void

Inherited from

ProviderCondition.setInstanceConfig

Defined in

src/Instantiable.abstract.ts:162