diff --git a/docs/api-reference/classes/AaveBorrowCondition.md b/docs/api-reference/classes/AaveBorrowCondition.md new file mode 100644 index 000000000..82bedc5ee --- /dev/null +++ b/docs/api-reference/classes/AaveBorrowCondition.md @@ -0,0 +1,968 @@ +[@nevermined-io/sdk](../code-reference.md) / AaveBorrowCondition + +# Class: AaveBorrowCondition + +## Hierarchy + +- [`ProviderCondition`](ProviderCondition.md)<`AaveBorrowConditionContext`\> + + ↳ **`AaveBorrowCondition`** + +## Table of contents + +### Constructors + +- [constructor](AaveBorrowCondition.md#constructor) + +### Properties + +- [address](AaveBorrowCondition.md#address) +- [contract](AaveBorrowCondition.md#contract) +- [contractName](AaveBorrowCondition.md#contractname) +- [events](AaveBorrowCondition.md#events) +- [version](AaveBorrowCondition.md#version) + +### Accessors + +- [artifactsFolder](AaveBorrowCondition.md#artifactsfolder) +- [circuitsFolder](AaveBorrowCondition.md#circuitsfolder) +- [config](AaveBorrowCondition.md#config) +- [instanceConfig](AaveBorrowCondition.md#instanceconfig) +- [instantiableConfig](AaveBorrowCondition.md#instantiableconfig) +- [logger](AaveBorrowCondition.md#logger) +- [nevermined](AaveBorrowCondition.md#nevermined) +- [web3](AaveBorrowCondition.md#web3) + +### Methods + +- [abortByTimeOut](AaveBorrowCondition.md#abortbytimeout) +- [call](AaveBorrowCondition.md#call) +- [fulfill](AaveBorrowCondition.md#fulfill) +- [fulfillInstance](AaveBorrowCondition.md#fulfillinstance) +- [fulfillPlain](AaveBorrowCondition.md#fulfillplain) +- [fulfillWithNode](AaveBorrowCondition.md#fulfillwithnode) +- [generateId](AaveBorrowCondition.md#generateid) +- [generateIdHash](AaveBorrowCondition.md#generateidhash) +- [generateIdWithSeed](AaveBorrowCondition.md#generateidwithseed) +- [getConditionFulfilledEvent](AaveBorrowCondition.md#getconditionfulfilledevent) +- [getFromAddress](AaveBorrowCondition.md#getfromaddress) +- [getInputsOfMethod](AaveBorrowCondition.md#getinputsofmethod) +- [getSignatureOfMethod](AaveBorrowCondition.md#getsignatureofmethod) +- [hashValues](AaveBorrowCondition.md#hashvalues) +- [hashValuesPlain](AaveBorrowCondition.md#hashvaluesplain) +- [init](AaveBorrowCondition.md#init) +- [instance](AaveBorrowCondition.md#instance) +- [instanceFromDDO](AaveBorrowCondition.md#instancefromddo) +- [nodeMethod](AaveBorrowCondition.md#nodemethod) +- [params](AaveBorrowCondition.md#params) +- [paramsFromDDO](AaveBorrowCondition.md#paramsfromddo) +- [send](AaveBorrowCondition.md#send) +- [sendFrom](AaveBorrowCondition.md#sendfrom) +- [setInstanceConfig](AaveBorrowCondition.md#setinstanceconfig) +- [getInstance](AaveBorrowCondition.md#getinstance) +- [setInstanceConfig](AaveBorrowCondition.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new AaveBorrowCondition**(`contractName`) + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[constructor](ProviderCondition.md#constructor) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L34) + +## Properties + +### address + +• **address**: `string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[address](ProviderCondition.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[contract](ProviderCondition.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[contractName](ProviderCondition.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[events](ProviderCondition.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[version](ProviderCondition.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ProviderCondition.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ProviderCondition.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +ProviderCondition.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ProviderCondition.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ProviderCondition.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +ProviderCondition.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +ProviderCondition.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +ProviderCondition.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### abortByTimeOut + +▸ **abortByTimeOut**(`conditionId`, `from?`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------------ | :---------------------------------------------- | +| `conditionId` | `string` | +| `from?` | [`Account`](Account.md) | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[abortByTimeOut](ProviderCondition.md#abortbytimeout) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L88) + +--- + +### 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 + +[ProviderCondition](ProviderCondition.md).[call](ProviderCondition.md#call) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### fulfill + +▸ **fulfill**(`agreementId`, `did`, `vaultAddress`, `assetToBorrow`, `amount`, `interestRateMode`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :----------------- | :---------------------------------------------- | +| `agreementId` | `string` | +| `did` | `string` | +| `vaultAddress` | `string` | +| `assetToBorrow` | `string` | +| `amount` | `string` | +| `interestRateMode` | `number` | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[fulfill](ProviderCondition.md#fulfill) + +#### Defined in + +[src/keeper/contracts/defi/AaveBorrowCondition.ts:45](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveBorrowCondition.ts#L45) + +--- + +### fulfillInstance + +▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `txParams?`, `method?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | Default value | +| :----------------- | :----------------------------------------------------------------------------------------- | :------------ | +| `cond` | [`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | +| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | +| `from?` | [`Account`](Account.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[fulfillInstance](ProviderCondition.md#fulfillinstance) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:150](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L150) + +--- + +### fulfillPlain + +▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `txParams?`, `method?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | Default value | +| :------------ | :-------------------------------------------------------- | :------------ | +| `agreementId` | `string` | `undefined` | +| `args` | `any`[] | `undefined` | +| `from?` | [`Account`](Account.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[fulfillPlain](ProviderCondition.md#fulfillplain) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L63) + +--- + +### fulfillWithNode + +▸ **fulfillWithNode**(`cond`, `additionalParams`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :----------------- | :----------------------------------------------------------------------------------------- | +| `cond` | [`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | +| `additionalParams` | `Record`<`string`, `unknown`\> | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[fulfillWithNode](ProviderCondition.md#fulfillwithnode) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:194](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L194) + +--- + +### generateId + +▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `valueHash` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[generateId](ProviderCondition.md#generateid) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L77) + +--- + +### generateIdHash + +▸ **generateIdHash**(`agreementId`, `...values`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `...values` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[generateIdHash](ProviderCondition.md#generateidhash) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L73) + +--- + +### generateIdWithSeed + +▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `valueHash` | `string` | + +#### Returns + +`Promise`<[`string`, `string`]\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[generateIdWithSeed](ProviderCondition.md#generateidwithseed) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L81) + +--- + +### getConditionFulfilledEvent + +▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../code-reference.md#eventresult) + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | + +#### Returns + +[`EventResult`](../code-reference.md#eventresult) + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getConditionFulfilledEvent](ProviderCondition.md#getconditionfulfilledevent) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L92) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getFromAddress](ProviderCondition.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getInputsOfMethod](ProviderCondition.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getSignatureOfMethod](ProviderCondition.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### hashValues + +▸ **hashValues**(`...args`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[hashValues](ProviderCondition.md#hashvalues) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L129) + +--- + +### hashValuesPlain + +▸ **hashValuesPlain**(`...args`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[hashValuesPlain](ProviderCondition.md#hashvaluesplain) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:133](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L133) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[init](ProviderCondition.md#init) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### instance + +▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :------------ | :--------------------------------------------------------------------------------------------- | +| `agreementId` | `string` | +| `params` | [`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | + +#### Returns + +`Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[instance](ProviderCondition.md#instance) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:174](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L174) + +--- + +### instanceFromDDO + +▸ **instanceFromDDO**(`agreementId`, `ctx`, `...args`): `Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------------------------------------------- | +| `agreementId` | `string` | +| `ctx` | `AaveBorrowConditionContext` | +| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | + +#### Returns + +`Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[instanceFromDDO](ProviderCondition.md#instancefromddo) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L142) + +--- + +### nodeMethod + +▸ **nodeMethod**(): [`ConditionMethod`](../code-reference.md#conditionmethod) + +#### Returns + +[`ConditionMethod`](../code-reference.md#conditionmethod) + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[nodeMethod](ProviderCondition.md#nodemethod) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:208](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L208) + +--- + +### params + +▸ **params**(`did`, `vaultAddress`, `assetToBorrow`, `amount`, `interestRateMode`): [`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> + +#### Parameters + +| Name | Type | +| :----------------- | :------- | +| `did` | `string` | +| `vaultAddress` | `string` | +| `assetToBorrow` | `string` | +| `amount` | `string` | +| `interestRateMode` | `number` | + +#### Returns + +[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[params](ProviderCondition.md#params) + +#### Defined in + +[src/keeper/contracts/defi/AaveBorrowCondition.ts:19](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveBorrowCondition.ts#L19) + +--- + +### paramsFromDDO + +▸ **paramsFromDDO**(`«destructured»`): `Promise`<[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :--------------- | :--------------------------- | +| `«destructured»` | `AaveBorrowConditionContext` | + +#### Returns + +`Promise`<[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[paramsFromDDO](ProviderCondition.md#paramsfromddo) + +#### Defined in + +[src/keeper/contracts/defi/AaveBorrowCondition.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveBorrowCondition.ts#L35) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[send](ProviderCondition.md#send) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[sendFrom](ProviderCondition.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[setInstanceConfig](ProviderCondition.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`): `Promise`<[`AaveBorrowCondition`](AaveBorrowCondition.md)\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`Promise`<[`AaveBorrowCondition`](AaveBorrowCondition.md)\> + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[getInstance](ProviderCondition.md#getinstance) + +#### Defined in + +[src/keeper/contracts/defi/AaveBorrowCondition.ts:15](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveBorrowCondition.ts#L15) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[setInstanceConfig](ProviderCondition.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/AaveCollateralDepositCondition.md b/docs/api-reference/classes/AaveCollateralDepositCondition.md new file mode 100644 index 000000000..63f380c9a --- /dev/null +++ b/docs/api-reference/classes/AaveCollateralDepositCondition.md @@ -0,0 +1,972 @@ +[@nevermined-io/sdk](../code-reference.md) / AaveCollateralDepositCondition + +# Class: AaveCollateralDepositCondition + +## Hierarchy + +- [`ProviderCondition`](ProviderCondition.md)<`AaveCollateralDepositConditionContext`\> + + ↳ **`AaveCollateralDepositCondition`** + +## Table of contents + +### Constructors + +- [constructor](AaveCollateralDepositCondition.md#constructor) + +### Properties + +- [address](AaveCollateralDepositCondition.md#address) +- [contract](AaveCollateralDepositCondition.md#contract) +- [contractName](AaveCollateralDepositCondition.md#contractname) +- [events](AaveCollateralDepositCondition.md#events) +- [version](AaveCollateralDepositCondition.md#version) + +### Accessors + +- [artifactsFolder](AaveCollateralDepositCondition.md#artifactsfolder) +- [circuitsFolder](AaveCollateralDepositCondition.md#circuitsfolder) +- [config](AaveCollateralDepositCondition.md#config) +- [instanceConfig](AaveCollateralDepositCondition.md#instanceconfig) +- [instantiableConfig](AaveCollateralDepositCondition.md#instantiableconfig) +- [logger](AaveCollateralDepositCondition.md#logger) +- [nevermined](AaveCollateralDepositCondition.md#nevermined) +- [web3](AaveCollateralDepositCondition.md#web3) + +### Methods + +- [abortByTimeOut](AaveCollateralDepositCondition.md#abortbytimeout) +- [call](AaveCollateralDepositCondition.md#call) +- [fulfill](AaveCollateralDepositCondition.md#fulfill) +- [fulfillInstance](AaveCollateralDepositCondition.md#fulfillinstance) +- [fulfillPlain](AaveCollateralDepositCondition.md#fulfillplain) +- [fulfillWithNode](AaveCollateralDepositCondition.md#fulfillwithnode) +- [generateId](AaveCollateralDepositCondition.md#generateid) +- [generateIdHash](AaveCollateralDepositCondition.md#generateidhash) +- [generateIdWithSeed](AaveCollateralDepositCondition.md#generateidwithseed) +- [getConditionFulfilledEvent](AaveCollateralDepositCondition.md#getconditionfulfilledevent) +- [getFromAddress](AaveCollateralDepositCondition.md#getfromaddress) +- [getInputsOfMethod](AaveCollateralDepositCondition.md#getinputsofmethod) +- [getSignatureOfMethod](AaveCollateralDepositCondition.md#getsignatureofmethod) +- [hashValues](AaveCollateralDepositCondition.md#hashvalues) +- [hashValuesPlain](AaveCollateralDepositCondition.md#hashvaluesplain) +- [init](AaveCollateralDepositCondition.md#init) +- [instance](AaveCollateralDepositCondition.md#instance) +- [instanceFromDDO](AaveCollateralDepositCondition.md#instancefromddo) +- [nodeMethod](AaveCollateralDepositCondition.md#nodemethod) +- [params](AaveCollateralDepositCondition.md#params) +- [paramsFromDDO](AaveCollateralDepositCondition.md#paramsfromddo) +- [send](AaveCollateralDepositCondition.md#send) +- [sendFrom](AaveCollateralDepositCondition.md#sendfrom) +- [setInstanceConfig](AaveCollateralDepositCondition.md#setinstanceconfig) +- [getInstance](AaveCollateralDepositCondition.md#getinstance) +- [setInstanceConfig](AaveCollateralDepositCondition.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new AaveCollateralDepositCondition**(`contractName`) + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[constructor](ProviderCondition.md#constructor) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L34) + +## Properties + +### address + +• **address**: `string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[address](ProviderCondition.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[contract](ProviderCondition.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[contractName](ProviderCondition.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[events](ProviderCondition.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[version](ProviderCondition.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ProviderCondition.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ProviderCondition.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +ProviderCondition.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ProviderCondition.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ProviderCondition.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +ProviderCondition.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +ProviderCondition.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +ProviderCondition.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### abortByTimeOut + +▸ **abortByTimeOut**(`conditionId`, `from?`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------------ | :---------------------------------------------- | +| `conditionId` | `string` | +| `from?` | [`Account`](Account.md) | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[abortByTimeOut](ProviderCondition.md#abortbytimeout) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L88) + +--- + +### 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 + +[ProviderCondition](ProviderCondition.md).[call](ProviderCondition.md#call) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### fulfill + +▸ **fulfill**(`agreementId`, `did`, `vaultAddress`, `collateralAsset`, `collateralAmount`, `delegatedAsset`, `delegatedAmount`, `interestRateMode`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :----------------- | :---------------------------------------------- | +| `agreementId` | `string` | +| `did` | `string` | +| `vaultAddress` | `string` | +| `collateralAsset` | `string` | +| `collateralAmount` | `string` | +| `delegatedAsset` | `string` | +| `delegatedAmount` | `string` | +| `interestRateMode` | `number` | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[fulfill](ProviderCondition.md#fulfill) + +#### Defined in + +[src/keeper/contracts/defi/AaveCollateralDepositCondition.ts:67](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveCollateralDepositCondition.ts#L67) + +--- + +### fulfillInstance + +▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `txParams?`, `method?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | Default value | +| :----------------- | :----------------------------------------------------------------------------------------- | :------------ | +| `cond` | [`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | +| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | +| `from?` | [`Account`](Account.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[fulfillInstance](ProviderCondition.md#fulfillinstance) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:150](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L150) + +--- + +### fulfillPlain + +▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `txParams?`, `method?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | Default value | +| :------------ | :-------------------------------------------------------- | :------------ | +| `agreementId` | `string` | `undefined` | +| `args` | `any`[] | `undefined` | +| `from?` | [`Account`](Account.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[fulfillPlain](ProviderCondition.md#fulfillplain) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L63) + +--- + +### fulfillWithNode + +▸ **fulfillWithNode**(`cond`, `additionalParams`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :----------------- | :----------------------------------------------------------------------------------------- | +| `cond` | [`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | +| `additionalParams` | `Record`<`string`, `unknown`\> | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[fulfillWithNode](ProviderCondition.md#fulfillwithnode) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:194](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L194) + +--- + +### generateId + +▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `valueHash` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[generateId](ProviderCondition.md#generateid) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L77) + +--- + +### generateIdHash + +▸ **generateIdHash**(`agreementId`, `...values`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `...values` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[generateIdHash](ProviderCondition.md#generateidhash) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L73) + +--- + +### generateIdWithSeed + +▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `valueHash` | `string` | + +#### Returns + +`Promise`<[`string`, `string`]\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[generateIdWithSeed](ProviderCondition.md#generateidwithseed) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L81) + +--- + +### getConditionFulfilledEvent + +▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../code-reference.md#eventresult) + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | + +#### Returns + +[`EventResult`](../code-reference.md#eventresult) + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getConditionFulfilledEvent](ProviderCondition.md#getconditionfulfilledevent) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L92) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getFromAddress](ProviderCondition.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getInputsOfMethod](ProviderCondition.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getSignatureOfMethod](ProviderCondition.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### hashValues + +▸ **hashValues**(`...args`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[hashValues](ProviderCondition.md#hashvalues) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L129) + +--- + +### hashValuesPlain + +▸ **hashValuesPlain**(`...args`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[hashValuesPlain](ProviderCondition.md#hashvaluesplain) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:133](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L133) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[init](ProviderCondition.md#init) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### instance + +▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :------------ | :--------------------------------------------------------------------------------------------- | +| `agreementId` | `string` | +| `params` | [`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | + +#### Returns + +`Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[instance](ProviderCondition.md#instance) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:174](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L174) + +--- + +### instanceFromDDO + +▸ **instanceFromDDO**(`agreementId`, `ctx`, `...args`): `Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------------------------------------------- | +| `agreementId` | `string` | +| `ctx` | `AaveCollateralDepositConditionContext` | +| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | + +#### Returns + +`Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[instanceFromDDO](ProviderCondition.md#instancefromddo) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L142) + +--- + +### nodeMethod + +▸ **nodeMethod**(): [`ConditionMethod`](../code-reference.md#conditionmethod) + +#### Returns + +[`ConditionMethod`](../code-reference.md#conditionmethod) + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[nodeMethod](ProviderCondition.md#nodemethod) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:208](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L208) + +--- + +### params + +▸ **params**(`did`, `vaultAddress`, `collateralAsset`, `collateralAmount`, `delegatedAsset`, `delegatedAmount`, `interestRateMode`): [`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> + +#### Parameters + +| Name | Type | +| :----------------- | :------- | +| `did` | `string` | +| `vaultAddress` | `string` | +| `collateralAsset` | `string` | +| `collateralAmount` | `string` | +| `delegatedAsset` | `string` | +| `delegatedAmount` | `string` | +| `interestRateMode` | `number` | + +#### Returns + +[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[params](ProviderCondition.md#params) + +#### Defined in + +[src/keeper/contracts/defi/AaveCollateralDepositCondition.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveCollateralDepositCondition.ts#L28) + +--- + +### paramsFromDDO + +▸ **paramsFromDDO**(`«destructured»`): `Promise`<[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :--------------- | :-------------------------------------- | +| `«destructured»` | `AaveCollateralDepositConditionContext` | + +#### Returns + +`Promise`<[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[paramsFromDDO](ProviderCondition.md#paramsfromddo) + +#### Defined in + +[src/keeper/contracts/defi/AaveCollateralDepositCondition.ts:47](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveCollateralDepositCondition.ts#L47) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[send](ProviderCondition.md#send) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[sendFrom](ProviderCondition.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[setInstanceConfig](ProviderCondition.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`): `Promise`<[`AaveCollateralDepositCondition`](AaveCollateralDepositCondition.md)\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`Promise`<[`AaveCollateralDepositCondition`](AaveCollateralDepositCondition.md)\> + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[getInstance](ProviderCondition.md#getinstance) + +#### Defined in + +[src/keeper/contracts/defi/AaveCollateralDepositCondition.ts:17](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveCollateralDepositCondition.ts#L17) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[setInstanceConfig](ProviderCondition.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/AaveCollateralWithdrawCondition.md b/docs/api-reference/classes/AaveCollateralWithdrawCondition.md new file mode 100644 index 000000000..a63bb373e --- /dev/null +++ b/docs/api-reference/classes/AaveCollateralWithdrawCondition.md @@ -0,0 +1,964 @@ +[@nevermined-io/sdk](../code-reference.md) / AaveCollateralWithdrawCondition + +# Class: AaveCollateralWithdrawCondition + +## Hierarchy + +- [`ProviderCondition`](ProviderCondition.md)<`AaveCollateralWithdrawConditionContext`\> + + ↳ **`AaveCollateralWithdrawCondition`** + +## Table of contents + +### Constructors + +- [constructor](AaveCollateralWithdrawCondition.md#constructor) + +### Properties + +- [address](AaveCollateralWithdrawCondition.md#address) +- [contract](AaveCollateralWithdrawCondition.md#contract) +- [contractName](AaveCollateralWithdrawCondition.md#contractname) +- [events](AaveCollateralWithdrawCondition.md#events) +- [version](AaveCollateralWithdrawCondition.md#version) + +### Accessors + +- [artifactsFolder](AaveCollateralWithdrawCondition.md#artifactsfolder) +- [circuitsFolder](AaveCollateralWithdrawCondition.md#circuitsfolder) +- [config](AaveCollateralWithdrawCondition.md#config) +- [instanceConfig](AaveCollateralWithdrawCondition.md#instanceconfig) +- [instantiableConfig](AaveCollateralWithdrawCondition.md#instantiableconfig) +- [logger](AaveCollateralWithdrawCondition.md#logger) +- [nevermined](AaveCollateralWithdrawCondition.md#nevermined) +- [web3](AaveCollateralWithdrawCondition.md#web3) + +### Methods + +- [abortByTimeOut](AaveCollateralWithdrawCondition.md#abortbytimeout) +- [call](AaveCollateralWithdrawCondition.md#call) +- [fulfill](AaveCollateralWithdrawCondition.md#fulfill) +- [fulfillInstance](AaveCollateralWithdrawCondition.md#fulfillinstance) +- [fulfillPlain](AaveCollateralWithdrawCondition.md#fulfillplain) +- [fulfillWithNode](AaveCollateralWithdrawCondition.md#fulfillwithnode) +- [generateId](AaveCollateralWithdrawCondition.md#generateid) +- [generateIdHash](AaveCollateralWithdrawCondition.md#generateidhash) +- [generateIdWithSeed](AaveCollateralWithdrawCondition.md#generateidwithseed) +- [getConditionFulfilledEvent](AaveCollateralWithdrawCondition.md#getconditionfulfilledevent) +- [getFromAddress](AaveCollateralWithdrawCondition.md#getfromaddress) +- [getInputsOfMethod](AaveCollateralWithdrawCondition.md#getinputsofmethod) +- [getSignatureOfMethod](AaveCollateralWithdrawCondition.md#getsignatureofmethod) +- [hashValues](AaveCollateralWithdrawCondition.md#hashvalues) +- [hashValuesPlain](AaveCollateralWithdrawCondition.md#hashvaluesplain) +- [init](AaveCollateralWithdrawCondition.md#init) +- [instance](AaveCollateralWithdrawCondition.md#instance) +- [instanceFromDDO](AaveCollateralWithdrawCondition.md#instancefromddo) +- [nodeMethod](AaveCollateralWithdrawCondition.md#nodemethod) +- [params](AaveCollateralWithdrawCondition.md#params) +- [paramsFromDDO](AaveCollateralWithdrawCondition.md#paramsfromddo) +- [send](AaveCollateralWithdrawCondition.md#send) +- [sendFrom](AaveCollateralWithdrawCondition.md#sendfrom) +- [setInstanceConfig](AaveCollateralWithdrawCondition.md#setinstanceconfig) +- [getInstance](AaveCollateralWithdrawCondition.md#getinstance) +- [setInstanceConfig](AaveCollateralWithdrawCondition.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new AaveCollateralWithdrawCondition**(`contractName`) + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[constructor](ProviderCondition.md#constructor) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L34) + +## Properties + +### address + +• **address**: `string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[address](ProviderCondition.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[contract](ProviderCondition.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[contractName](ProviderCondition.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[events](ProviderCondition.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[version](ProviderCondition.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ProviderCondition.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ProviderCondition.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +ProviderCondition.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ProviderCondition.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ProviderCondition.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +ProviderCondition.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +ProviderCondition.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +ProviderCondition.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### abortByTimeOut + +▸ **abortByTimeOut**(`conditionId`, `from?`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------------ | :---------------------------------------------- | +| `conditionId` | `string` | +| `from?` | [`Account`](Account.md) | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[abortByTimeOut](ProviderCondition.md#abortbytimeout) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L88) + +--- + +### 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 + +[ProviderCondition](ProviderCondition.md).[call](ProviderCondition.md#call) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### fulfill + +▸ **fulfill**(`agreementId`, `did`, `vaultAddress`, `collateralAsset`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :---------------- | :---------------------------------------------- | +| `agreementId` | `string` | +| `did` | `string` | +| `vaultAddress` | `string` | +| `collateralAsset` | `string` | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[fulfill](ProviderCondition.md#fulfill) + +#### Defined in + +[src/keeper/contracts/defi/AaveCollateralWithdrawCondition.ts:36](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveCollateralWithdrawCondition.ts#L36) + +--- + +### fulfillInstance + +▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `txParams?`, `method?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | Default value | +| :----------------- | :----------------------------------------------------------------------------------------- | :------------ | +| `cond` | [`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | +| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | +| `from?` | [`Account`](Account.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[fulfillInstance](ProviderCondition.md#fulfillinstance) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:150](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L150) + +--- + +### fulfillPlain + +▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `txParams?`, `method?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | Default value | +| :------------ | :-------------------------------------------------------- | :------------ | +| `agreementId` | `string` | `undefined` | +| `args` | `any`[] | `undefined` | +| `from?` | [`Account`](Account.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[fulfillPlain](ProviderCondition.md#fulfillplain) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L63) + +--- + +### fulfillWithNode + +▸ **fulfillWithNode**(`cond`, `additionalParams`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :----------------- | :----------------------------------------------------------------------------------------- | +| `cond` | [`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | +| `additionalParams` | `Record`<`string`, `unknown`\> | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[fulfillWithNode](ProviderCondition.md#fulfillwithnode) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:194](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L194) + +--- + +### generateId + +▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `valueHash` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[generateId](ProviderCondition.md#generateid) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L77) + +--- + +### generateIdHash + +▸ **generateIdHash**(`agreementId`, `...values`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `...values` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[generateIdHash](ProviderCondition.md#generateidhash) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L73) + +--- + +### generateIdWithSeed + +▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `valueHash` | `string` | + +#### Returns + +`Promise`<[`string`, `string`]\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[generateIdWithSeed](ProviderCondition.md#generateidwithseed) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L81) + +--- + +### getConditionFulfilledEvent + +▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../code-reference.md#eventresult) + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | + +#### Returns + +[`EventResult`](../code-reference.md#eventresult) + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getConditionFulfilledEvent](ProviderCondition.md#getconditionfulfilledevent) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L92) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getFromAddress](ProviderCondition.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getInputsOfMethod](ProviderCondition.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getSignatureOfMethod](ProviderCondition.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### hashValues + +▸ **hashValues**(`...args`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[hashValues](ProviderCondition.md#hashvalues) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L129) + +--- + +### hashValuesPlain + +▸ **hashValuesPlain**(`...args`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[hashValuesPlain](ProviderCondition.md#hashvaluesplain) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:133](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L133) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[init](ProviderCondition.md#init) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### instance + +▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :------------ | :--------------------------------------------------------------------------------------------- | +| `agreementId` | `string` | +| `params` | [`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | + +#### Returns + +`Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[instance](ProviderCondition.md#instance) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:174](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L174) + +--- + +### instanceFromDDO + +▸ **instanceFromDDO**(`agreementId`, `ctx`, `...args`): `Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------------------------------------------- | +| `agreementId` | `string` | +| `ctx` | `AaveCollateralWithdrawConditionContext` | +| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | + +#### Returns + +`Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[instanceFromDDO](ProviderCondition.md#instancefromddo) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L142) + +--- + +### nodeMethod + +▸ **nodeMethod**(): [`ConditionMethod`](../code-reference.md#conditionmethod) + +#### Returns + +[`ConditionMethod`](../code-reference.md#conditionmethod) + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[nodeMethod](ProviderCondition.md#nodemethod) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:208](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L208) + +--- + +### params + +▸ **params**(`did`, `vaultAddress`, `collateralAsset`): [`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> + +#### Parameters + +| Name | Type | +| :---------------- | :------- | +| `did` | `string` | +| `vaultAddress` | `string` | +| `collateralAsset` | `string` | + +#### Returns + +[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[params](ProviderCondition.md#params) + +#### Defined in + +[src/keeper/contracts/defi/AaveCollateralWithdrawCondition.ts:24](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveCollateralWithdrawCondition.ts#L24) + +--- + +### paramsFromDDO + +▸ **paramsFromDDO**(`«destructured»`): `Promise`<[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :--------------- | :--------------------------------------- | +| `«destructured»` | `AaveCollateralWithdrawConditionContext` | + +#### Returns + +`Promise`<[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[paramsFromDDO](ProviderCondition.md#paramsfromddo) + +#### Defined in + +[src/keeper/contracts/defi/AaveCollateralWithdrawCondition.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveCollateralWithdrawCondition.ts#L28) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[send](ProviderCondition.md#send) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[sendFrom](ProviderCondition.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[setInstanceConfig](ProviderCondition.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`): `Promise`<[`AaveCollateralWithdrawCondition`](AaveCollateralWithdrawCondition.md)\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`Promise`<[`AaveCollateralWithdrawCondition`](AaveCollateralWithdrawCondition.md)\> + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[getInstance](ProviderCondition.md#getinstance) + +#### Defined in + +[src/keeper/contracts/defi/AaveCollateralWithdrawCondition.ts:13](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveCollateralWithdrawCondition.ts#L13) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[setInstanceConfig](ProviderCondition.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/AaveCredit.md b/docs/api-reference/classes/AaveCredit.md new file mode 100644 index 000000000..4c1865de9 --- /dev/null +++ b/docs/api-reference/classes/AaveCredit.md @@ -0,0 +1,682 @@ +[@nevermined-io/sdk](../code-reference.md) / AaveCredit + +# Class: AaveCredit + +AaveCredit allows taking loans from Aave protocol using NFT tokens as collateral + +## Hierarchy + +- [`Instantiable`](Instantiable.md) + + ↳ **`AaveCredit`** + +## Table of contents + +### Constructors + +- [constructor](AaveCredit.md#constructor) + +### Properties + +- [aaveConfig](AaveCredit.md#aaveconfig) +- [serviceType](AaveCredit.md#servicetype) +- [template](AaveCredit.md#template) + +### Accessors + +- [artifactsFolder](AaveCredit.md#artifactsfolder) +- [circuitsFolder](AaveCredit.md#circuitsfolder) +- [config](AaveCredit.md#config) +- [instanceConfig](AaveCredit.md#instanceconfig) +- [instantiableConfig](AaveCredit.md#instantiableconfig) +- [logger](AaveCredit.md#logger) +- [nevermined](AaveCredit.md#nevermined) +- [web3](AaveCredit.md#web3) + +### Methods + +- [borrow](AaveCredit.md#borrow) +- [create](AaveCredit.md#create) +- [delegatedAmount](AaveCredit.md#delegatedamount) +- [depositCollateral](AaveCredit.md#depositcollateral) +- [getActualCreditDebt](AaveCredit.md#getactualcreditdebt) +- [getAssetPrice](AaveCredit.md#getassetprice) +- [getBorrowedAmount](AaveCredit.md#getborrowedamount) +- [getCreditAssetDebt](AaveCredit.md#getcreditassetdebt) +- [getTotalActualDebt](AaveCredit.md#gettotalactualdebt) +- [getVaultContract](AaveCredit.md#getvaultcontract) +- [lockNft](AaveCredit.md#locknft) +- [repayDebt](AaveCredit.md#repaydebt) +- [setInstanceConfig](AaveCredit.md#setinstanceconfig) +- [unlockNft](AaveCredit.md#unlocknft) +- [withdrawCollateral](AaveCredit.md#withdrawcollateral) +- [getInstance](AaveCredit.md#getinstance) +- [setInstanceConfig](AaveCredit.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new AaveCredit**() + +#### Inherited from + +[Instantiable](Instantiable.md).[constructor](Instantiable.md#constructor) + +## Properties + +### aaveConfig + +• **aaveConfig**: [`AaveConfig`](../interfaces/AaveConfig.md) + +#### Defined in + +[src/services/aave/AaveCredit.ts:22](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/aave/AaveCredit.ts#L22) + +--- + +### serviceType + +• **serviceType**: `"aave-credit"` + +#### Defined in + +[src/services/aave/AaveCredit.ts:23](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/aave/AaveCredit.ts#L23) + +--- + +### template + +• **template**: [`AaveCreditTemplate`](AaveCreditTemplate.md) + +#### Defined in + +[src/services/aave/AaveCredit.ts:21](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/aave/AaveCredit.ts#L21) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +Instantiable.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +Instantiable.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +Instantiable.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +Instantiable.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### borrow + +▸ **borrow**(`agreementId`, `delegatedAsset`, `delegatedAmount`, `interestRateMode`, `from`, `did?`, `vaultAddress?`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :----------------- | :---------------------- | +| `agreementId` | `string` | +| `delegatedAsset` | `string` | +| `delegatedAmount` | `number` | +| `interestRateMode` | `number` | +| `from` | [`Account`](Account.md) | +| `did?` | `string` | +| `vaultAddress?` | `string` | + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[src/services/aave/AaveCredit.ts:219](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/aave/AaveCredit.ts#L219) + +--- + +### create + +▸ **create**(`did`, `nftTokenContract`, `nftAmount`, `collateralToken`, `collateralAmount`, `delegatedToken`, `delegatedAmount`, `interestRateMode`, `borrower`, `lender`, `from`, `timeLocks?`, `timeOuts?`, `txParams?`): `Promise`<{ `agreementId`: `string` ; `data`: [`AgreementInstance`](../interfaces/AgreementInstance.md)<[`AaveCreditTemplateParams`](../interfaces/AaveCreditTemplateParams.md)\> }\> + +Create new Aave agreement where a borrower puts an NFT asset as collateral +and the lender uses their own Token as collateral to allow the borrower to +use Aave protocol to borrow some other token (the `delegatedToken`). All of +this is facilitated via the credit vault contract and the agreement conditions. +All interactions with the Aave protocol have to go through the credit vault. + +#### Parameters + +| Name | Type | Description | +| :----------------- | :---------------------------------------------- | :---------------------------------------------------------------------------------------------- | +| `did` | `string` | id of DDO/asset that represent the `nftToken`. This is the NFT token id | +| `nftTokenContract` | `string` | nft (ERC721) contract address of token to use as collateral by the borrower | +| `nftAmount` | `number` | the number of nft tokens | +| `collateralToken` | `string` | erc20 token address to use as loan-collateral by the lender to enable the borrower to take loan | +| `collateralAmount` | `number` | amount of `collateralToken` to lock in the vault | +| `delegatedToken` | `string` | address of erc20 token to be borrowed under this agreement | +| `delegatedAmount` | `number` | amount of `delegatedToken` that well be borrowed | +| `interestRateMode` | `number` | the type of interest rate to use when borrowing from Aave | +| `borrower` | `string` | wallet address of borrower | +| `lender` | `string` | wallet address of lender | +| `from` | [`Account`](Account.md) | account/wallet of borrower or lender creating this agreement | +| `timeLocks?` | `number`[] | list of time lock values for each agreement condition | +| `timeOuts?` | `number`[] | list of time out values for each agreement condition | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | extra transaction parameters can be included here | + +#### Returns + +`Promise`<{ `agreementId`: `string` ; `data`: [`AgreementInstance`](../interfaces/AgreementInstance.md)<[`AaveCreditTemplateParams`](../interfaces/AaveCreditTemplateParams.md)\> }\> + +#### Defined in + +[src/services/aave/AaveCredit.ts:59](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/aave/AaveCredit.ts#L59) + +--- + +### delegatedAmount + +▸ **delegatedAmount**(`agreementId`, `borrower`, `delegatedToken`, `interestRateMode`, `from`, `vaultAddress?`): `Promise`<`number`\> + +Returned value is already converted from Wei + +#### Parameters + +| Name | Type | +| :----------------- | :---------------------- | +| `agreementId` | `string` | +| `borrower` | `string` | +| `delegatedToken` | `string` | +| `interestRateMode` | `number` | +| `from` | [`Account`](Account.md) | +| `vaultAddress?` | `string` | + +#### Returns + +`Promise`<`number`\> + +#### Defined in + +[src/services/aave/AaveCredit.ts:498](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/aave/AaveCredit.ts#L498) + +--- + +### depositCollateral + +▸ **depositCollateral**(`agreementId`, `collateralAsset`, `collateralAmount`, `delegatedAsset`, `delegatedAmount`, `interestRateMode`, `from`, `useWethGateway?`, `did?`, `vaultAddress?`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | Default value | +| :----------------- | :---------------------- | :------------ | +| `agreementId` | `string` | `undefined` | +| `collateralAsset` | `string` | `undefined` | +| `collateralAmount` | `number` | `undefined` | +| `delegatedAsset` | `string` | `undefined` | +| `delegatedAmount` | `number` | `undefined` | +| `interestRateMode` | `number` | `undefined` | +| `from` | [`Account`](Account.md) | `undefined` | +| `useWethGateway` | `boolean` | `false` | +| `did?` | `string` | `undefined` | +| `vaultAddress?` | `string` | `undefined` | + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[src/services/aave/AaveCredit.ts:157](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/aave/AaveCredit.ts#L157) + +--- + +### getActualCreditDebt + +▸ **getActualCreditDebt**(`agreementId`, `from`, `vaultAddress?`): `Promise`<`number`\> + +Returned value is already converted from Wei + +#### Parameters + +| Name | Type | +| :-------------- | :---------------------- | +| `agreementId` | `string` | +| `from` | [`Account`](Account.md) | +| `vaultAddress?` | `string` | + +#### Returns + +`Promise`<`number`\> + +#### Defined in + +[src/services/aave/AaveCredit.ts:427](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/aave/AaveCredit.ts#L427) + +--- + +### getAssetPrice + +▸ **getAssetPrice**(`agreementId`, `tokenAddress`, `from`, `vaultAddress?`): `Promise`<`number`\> + +#### Parameters + +| Name | Type | +| :-------------- | :---------------------- | +| `agreementId` | `string` | +| `tokenAddress` | `string` | +| `from` | [`Account`](Account.md) | +| `vaultAddress?` | `string` | + +#### Returns + +`Promise`<`number`\> + +#### Defined in + +[src/services/aave/AaveCredit.ts:459](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/aave/AaveCredit.ts#L459) + +--- + +### getBorrowedAmount + +▸ **getBorrowedAmount**(`agreementId`, `from`, `vaultAddress?`): `Promise`<`number`\> + +Returned value is already converted from Wei + +#### Parameters + +| Name | Type | +| :-------------- | :---------------------- | +| `agreementId` | `string` | +| `from` | [`Account`](Account.md) | +| `vaultAddress?` | `string` | + +#### Returns + +`Promise`<`number`\> + +#### Defined in + +[src/services/aave/AaveCredit.ts:479](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/aave/AaveCredit.ts#L479) + +--- + +### getCreditAssetDebt + +▸ **getCreditAssetDebt**(`agreementId`, `from`, `vaultAddress?`): `Promise`<`number`\> + +Returned value is already converted from Wei + +#### Parameters + +| Name | Type | +| :-------------- | :---------------------- | +| `agreementId` | `string` | +| `from` | [`Account`](Account.md) | +| `vaultAddress?` | `string` | + +#### Returns + +`Promise`<`number`\> + +#### Defined in + +[src/services/aave/AaveCredit.ts:446](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/aave/AaveCredit.ts#L446) + +--- + +### getTotalActualDebt + +▸ **getTotalActualDebt**(`agreementId`, `from`, `vaultAddress?`): `Promise`<`number`\> + +Returned value is already converted from Wei + +#### Parameters + +| Name | Type | +| :-------------- | :---------------------- | +| `agreementId` | `string` | +| `from` | [`Account`](Account.md) | +| `vaultAddress?` | `string` | + +#### Returns + +`Promise`<`number`\> + +#### Defined in + +[src/services/aave/AaveCredit.ts:407](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/aave/AaveCredit.ts#L407) + +--- + +### getVaultContract + +▸ **getVaultContract**(`agreementId`, `from`, `vaultAddress?`): `Promise`<[`GenericContract`](GenericContract.md)\> + +#### Parameters + +| Name | Type | +| :-------------- | :------- | +| `agreementId` | `string` | +| `from` | `string` | +| `vaultAddress?` | `string` | + +#### Returns + +`Promise`<[`GenericContract`](GenericContract.md)\> + +#### Defined in + +[src/services/aave/AaveCredit.ts:390](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/aave/AaveCredit.ts#L390) + +--- + +### lockNft + +▸ **lockNft**(`agreementId`, `nftContractAddress`, `nftAmount`, `from?`, `did?`, `vaultAddress?`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------- | +| `agreementId` | `string` | +| `nftContractAddress` | `string` | +| `nftAmount` | `number` | +| `from?` | [`Account`](Account.md) | +| `did?` | `string` | +| `vaultAddress?` | `string` | + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[src/services/aave/AaveCredit.ts:115](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/aave/AaveCredit.ts#L115) + +--- + +### repayDebt + +▸ **repayDebt**(`agreementId`, `delegatedAsset`, `delegatedAmount`, `interestRateMode`, `from?`, `did?`, `vaultAddress?`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :----------------- | :---------------------- | +| `agreementId` | `string` | +| `delegatedAsset` | `string` | +| `delegatedAmount` | `number` | +| `interestRateMode` | `number` | +| `from?` | [`Account`](Account.md) | +| `did?` | `string` | +| `vaultAddress?` | `string` | + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[src/services/aave/AaveCredit.ts:257](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/aave/AaveCredit.ts#L257) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### unlockNft + +▸ **unlockNft**(`agreementId`, `nftContractAddress`, `from?`, `did?`, `vaultAddress?`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------- | +| `agreementId` | `string` | +| `nftContractAddress` | `string` | +| `from?` | [`Account`](Account.md) | +| `did?` | `string` | +| `vaultAddress?` | `string` | + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[src/services/aave/AaveCredit.ts:354](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/aave/AaveCredit.ts#L354) + +--- + +### withdrawCollateral + +▸ **withdrawCollateral**(`agreementId`, `collateralAsset`, `collateralAmount`, `delegatedAsset`, `delegatedAmount`, `interestRateMode`, `from?`, `did?`, `vaultAddress?`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :----------------- | :---------------------- | +| `agreementId` | `string` | +| `collateralAsset` | `string` | +| `collateralAmount` | `number` | +| `delegatedAsset` | `string` | +| `delegatedAmount` | `number` | +| `interestRateMode` | `number` | +| `from?` | [`Account`](Account.md) | +| `did?` | `string` | +| `vaultAddress?` | `string` | + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[src/services/aave/AaveCredit.ts:319](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/aave/AaveCredit.ts#L319) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`): `Promise`<[`AaveCredit`](AaveCredit.md)\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`Promise`<[`AaveCredit`](AaveCredit.md)\> + +#### Overrides + +[Instantiable](Instantiable.md).[getInstance](Instantiable.md#getinstance) + +#### Defined in + +[src/services/aave/AaveCredit.ts:25](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/aave/AaveCredit.ts#L25) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/AaveCreditTemplate.md b/docs/api-reference/classes/AaveCreditTemplate.md new file mode 100644 index 000000000..ba8a3e0fe --- /dev/null +++ b/docs/api-reference/classes/AaveCreditTemplate.md @@ -0,0 +1,1600 @@ +[@nevermined-io/sdk](../code-reference.md) / AaveCreditTemplate + +# Class: AaveCreditTemplate + +## Hierarchy + +- [`BaseTemplate`](BaseTemplate.md)<[`AaveCreditTemplateParams`](../interfaces/AaveCreditTemplateParams.md), [`ServiceAaveCredit`](../interfaces/ServiceAaveCredit.md)\> + + ↳ **`AaveCreditTemplate`** + +## Table of contents + +### Constructors + +- [constructor](AaveCreditTemplate.md#constructor) + +### Properties + +- [aaveConfig](AaveCreditTemplate.md#aaveconfig) +- [address](AaveCreditTemplate.md#address) +- [contract](AaveCreditTemplate.md#contract) +- [contractName](AaveCreditTemplate.md#contractname) +- [events](AaveCreditTemplate.md#events) +- [version](AaveCreditTemplate.md#version) + +### Accessors + +- [artifactsFolder](AaveCreditTemplate.md#artifactsfolder) +- [circuitsFolder](AaveCreditTemplate.md#circuitsfolder) +- [config](AaveCreditTemplate.md#config) +- [instanceConfig](AaveCreditTemplate.md#instanceconfig) +- [instantiableConfig](AaveCreditTemplate.md#instantiableconfig) +- [logger](AaveCreditTemplate.md#logger) +- [nevermined](AaveCreditTemplate.md#nevermined) +- [web3](AaveCreditTemplate.md#web3) + +### Methods + +- [\_createAgreement](AaveCreditTemplate.md#_createagreement) +- [accept](AaveCreditTemplate.md#accept) +- [agreementId](AaveCreditTemplate.md#agreementid) +- [call](AaveCreditTemplate.md#call) +- [conditions](AaveCreditTemplate.md#conditions) +- [createAgreement](AaveCreditTemplate.md#createagreement) +- [createAgreementAndDeployVault](AaveCreditTemplate.md#createagreementanddeployvault) +- [createAgreementAndPay](AaveCreditTemplate.md#createagreementandpay) +- [createAgreementFromDDO](AaveCreditTemplate.md#createagreementfromddo) +- [createAgreementWithPaymentFromDDO](AaveCreditTemplate.md#createagreementwithpaymentfromddo) +- [createService](AaveCreditTemplate.md#createservice) +- [deployVault](AaveCreditTemplate.md#deployvault) +- [description](AaveCreditTemplate.md#description) +- [extraGen](AaveCreditTemplate.md#extragen) +- [getAgreementCreatedEvent](AaveCreditTemplate.md#getagreementcreatedevent) +- [getAgreementData](AaveCreditTemplate.md#getagreementdata) +- [getAgreementDid](AaveCreditTemplate.md#getagreementdid) +- [getAgreementIdsFromDDO](AaveCreditTemplate.md#getagreementidsfromddo) +- [getAgreementStatus](AaveCreditTemplate.md#getagreementstatus) +- [getAgreementVaultAddress](AaveCreditTemplate.md#getagreementvaultaddress) +- [getAgreementsForDID](AaveCreditTemplate.md#getagreementsfordid) +- [getConditionTypes](AaveCreditTemplate.md#getconditiontypes) +- [getConditions](AaveCreditTemplate.md#getconditions) +- [getFromAddress](AaveCreditTemplate.md#getfromaddress) +- [getInputsOfMethod](AaveCreditTemplate.md#getinputsofmethod) +- [getServiceAgreementTemplate](AaveCreditTemplate.md#getserviceagreementtemplate) +- [getServiceAgreementTemplateConditionByRef](AaveCreditTemplate.md#getserviceagreementtemplateconditionbyref) +- [getServiceAgreementTemplateConditions](AaveCreditTemplate.md#getserviceagreementtemplateconditions) +- [getServiceAgreementTemplateDependencies](AaveCreditTemplate.md#getserviceagreementtemplatedependencies) +- [getSignatureOfMethod](AaveCreditTemplate.md#getsignatureofmethod) +- [init](AaveCreditTemplate.md#init) +- [instanceFromDDO](AaveCreditTemplate.md#instancefromddo) +- [lockConditionIndex](AaveCreditTemplate.md#lockconditionindex) +- [lockTokens](AaveCreditTemplate.md#locktokens) +- [name](AaveCreditTemplate.md#name) +- [params](AaveCreditTemplate.md#params) +- [paramsGen](AaveCreditTemplate.md#paramsgen) +- [paymentData](AaveCreditTemplate.md#paymentdata) +- [printAgreementStatus](AaveCreditTemplate.md#printagreementstatus) +- [process](AaveCreditTemplate.md#process) +- [send](AaveCreditTemplate.md#send) +- [sendFrom](AaveCreditTemplate.md#sendfrom) +- [service](AaveCreditTemplate.md#service) +- [serviceEndpoint](AaveCreditTemplate.md#serviceendpoint) +- [setInstanceConfig](AaveCreditTemplate.md#setinstanceconfig) +- [standardContext](AaveCreditTemplate.md#standardcontext) +- [track](AaveCreditTemplate.md#track) +- [validateAgreement](AaveCreditTemplate.md#validateagreement) +- [getInstance](AaveCreditTemplate.md#getinstance) +- [setInstanceConfig](AaveCreditTemplate.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• `Protected` **new AaveCreditTemplate**(`contractName`) + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[constructor](BaseTemplate.md#constructor) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:68](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L68) + +## Properties + +### aaveConfig + +• **aaveConfig**: [`AaveConfig`](../interfaces/AaveConfig.md) + +#### Defined in + +[src/keeper/contracts/defi/AaveCreditTemplate.ts:48](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveCreditTemplate.ts#L48) + +--- + +### address + +• **address**: `string` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[address](BaseTemplate.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[contract](BaseTemplate.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[contractName](BaseTemplate.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[events](BaseTemplate.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[version](BaseTemplate.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +BaseTemplate.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +BaseTemplate.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +BaseTemplate.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +BaseTemplate.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +BaseTemplate.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +BaseTemplate.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +BaseTemplate.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +BaseTemplate.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### \_createAgreement + +▸ `Private` **\_createAgreement**(`agreementIdSeed`, `ddo`, `vaultAddress`, `nftTokenContract`, `nftAmount`, `collateralToken`, `collateralAmount`, `delegatedToken`, `delegatedAmount`, `interestRateMode`, `timeLocks`, `timeOuts`, `txParams?`, `from?`): `Promise`<[`ContractTransactionReceipt`, [`AgreementInstance`](../interfaces/AgreementInstance.md)<[`AaveCreditTemplateParams`](../interfaces/AaveCreditTemplateParams.md)\>]\> + +#### Parameters + +| Name | Type | +| :----------------- | :---------------------------------------------- | +| `agreementIdSeed` | `string` | +| `ddo` | [`DDO`](DDO.md) | +| `vaultAddress` | `string` | +| `nftTokenContract` | `string` | +| `nftAmount` | `number` | +| `collateralToken` | `string` | +| `collateralAmount` | `number` | +| `delegatedToken` | `string` | +| `delegatedAmount` | `number` | +| `interestRateMode` | `number` | +| `timeLocks` | `number`[] | +| `timeOuts` | `number`[] | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| `from?` | [`Account`](Account.md) | + +#### Returns + +`Promise`<[`ContractTransactionReceipt`, [`AgreementInstance`](../interfaces/AgreementInstance.md)<[`AaveCreditTemplateParams`](../interfaces/AaveCreditTemplateParams.md)\>]\> + +#### Defined in + +[src/keeper/contracts/defi/AaveCreditTemplate.ts:96](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveCreditTemplate.ts#L96) + +--- + +### accept + +▸ **accept**(`_params`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :-------- | :------------------------------------------------------ | +| `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | + +#### Returns + +`Promise`<`boolean`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[accept](BaseTemplate.md#accept) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:98](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L98) + +--- + +### agreementId + +▸ **agreementId**(`agreementIdSeed`, `creator`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :---------------- | :------- | +| `agreementIdSeed` | `string` | +| `creator` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[agreementId](BaseTemplate.md#agreementid) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:213](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L213) + +--- + +### 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 + +[BaseTemplate](BaseTemplate.md).[call](BaseTemplate.md#call) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### conditions + +▸ **conditions**(): [[`NFT721LockCondition`](NFT721LockCondition.md), [`AaveCollateralDepositCondition`](AaveCollateralDepositCondition.md), [`AaveBorrowCondition`](AaveBorrowCondition.md), [`AaveRepayCondition`](AaveRepayCondition.md), [`AaveCollateralWithdrawCondition`](AaveCollateralWithdrawCondition.md), [`DistributeNFTCollateralCondition`](DistributeNFTCollateralCondition.md)] + +#### Returns + +[[`NFT721LockCondition`](NFT721LockCondition.md), [`AaveCollateralDepositCondition`](AaveCollateralDepositCondition.md), [`AaveBorrowCondition`](AaveBorrowCondition.md), [`AaveRepayCondition`](AaveRepayCondition.md), [`AaveCollateralWithdrawCondition`](AaveCollateralWithdrawCondition.md), [`DistributeNFTCollateralCondition`](DistributeNFTCollateralCondition.md)] + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[conditions](BaseTemplate.md#conditions) + +#### Defined in + +[src/keeper/contracts/defi/AaveCreditTemplate.ts:275](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveCreditTemplate.ts#L275) + +--- + +### createAgreement + +▸ **createAgreement**(`agreementId`, `did`, `conditionIds`, `timeLocks`, `timeOuts`, `extraArgs`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `agreementId` | `string` | +| `did` | `string` | +| `conditionIds` | `string`[] | +| `timeLocks` | `number`[] | +| `timeOuts` | `number`[] | +| `extraArgs` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[createAgreement](BaseTemplate.md#createagreement) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L90) + +--- + +### createAgreementAndDeployVault + +▸ **createAgreementAndDeployVault**(`agreementIdSeed`, `ddo`, `nftTokenContract`, `nftAmount`, `collateralToken`, `collateralAmount`, `delegatedToken`, `delegatedAmount`, `interestRateMode`, `borrower`, `lender`, `timeLocks`, `timeOuts`, `txParams?`, `from?`): `Promise`<[`ContractTransactionReceipt`, `string`, [`AgreementInstance`](../interfaces/AgreementInstance.md)<[`AaveCreditTemplateParams`](../interfaces/AaveCreditTemplateParams.md)\>]\> + +#### Parameters + +| Name | Type | +| :----------------- | :---------------------------------------------- | +| `agreementIdSeed` | `string` | +| `ddo` | [`DDO`](DDO.md) | +| `nftTokenContract` | `string` | +| `nftAmount` | `number` | +| `collateralToken` | `string` | +| `collateralAmount` | `number` | +| `delegatedToken` | `string` | +| `delegatedAmount` | `number` | +| `interestRateMode` | `number` | +| `borrower` | `string` | +| `lender` | `string` | +| `timeLocks` | `number`[] | +| `timeOuts` | `number`[] | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| `from?` | [`Account`](Account.md) | + +#### Returns + +`Promise`<[`ContractTransactionReceipt`, `string`, [`AgreementInstance`](../interfaces/AgreementInstance.md)<[`AaveCreditTemplateParams`](../interfaces/AaveCreditTemplateParams.md)\>]\> + +#### Defined in + +[src/keeper/contracts/defi/AaveCreditTemplate.ts:149](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveCreditTemplate.ts#L149) + +--- + +### createAgreementAndPay + +▸ **createAgreementAndPay**(`agreementId`, `did`, `conditionIds`, `timeLocks`, `timeOuts`, `accessConsumer`, `condIdx`, `rewardAddress`, `tokenAddress`, `amounts`, `receivers`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :--------------- | :---------------------------------------------- | +| `agreementId` | `string` | +| `did` | `string` | +| `conditionIds` | `string`[] | +| `timeLocks` | `number`[] | +| `timeOuts` | `number`[] | +| `accessConsumer` | `string` | +| `condIdx` | `number` | +| `rewardAddress` | `string` | +| `tokenAddress` | `string` | +| `amounts` | `bigint`[] | +| `receivers` | `string`[] | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[createAgreementAndPay](BaseTemplate.md#createagreementandpay) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L115) + +--- + +### createAgreementFromDDO + +▸ **createAgreementFromDDO**(`agreementIdSeed`, `ddo`, `parameters`, `consumer`, `from`, `timeOuts?`, `txParams?`): `Promise`<`string`\> + +Create a new agreement using the data of a DDO. + +#### Parameters + +| Name | Type | Description | +| :---------------- | :---------------------------------------------------------------------- | :---------- | +| `agreementIdSeed` | `string` | - | +| `ddo` | [`DDO`](DDO.md) | DDO. | +| `parameters` | [`AaveCreditTemplateParams`](../interfaces/AaveCreditTemplateParams.md) | | +| `consumer` | [`Account`](Account.md) | - | +| `from` | [`Account`](Account.md) | - | +| `timeOuts?` | `number`[] | - | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | + +#### Returns + +`Promise`<`string`\> + +true if the call was successful. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[createAgreementFromDDO](BaseTemplate.md#createagreementfromddo) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:222](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L222) + +--- + +### createAgreementWithPaymentFromDDO + +▸ **createAgreementWithPaymentFromDDO**(`agreementIdSeed`, `ddo`, `serviceReference`, `parameters`, `consumer`, `from`, `txParams?`, `observer?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :----------------- | :------------------------------------------------------------------------------------ | +| `agreementIdSeed` | `string` | +| `ddo` | [`DDO`](DDO.md) | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | +| `parameters` | [`AaveCreditTemplateParams`](../interfaces/AaveCreditTemplateParams.md) | +| `consumer` | [`Account`](Account.md) | +| `from` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| `observer?` | (`orderProgressStep`: [`OrderProgressStep`](../enums/OrderProgressStep.md)) => `void` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[createAgreementWithPaymentFromDDO](BaseTemplate.md#createagreementwithpaymentfromddo) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:252](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L252) + +--- + +### createService + +▸ **createService**(`publisher`, `metadata`, `serviceAttributes`, `nftAttributes?`, `priceData?`): [`ServiceAaveCredit`](../interfaces/ServiceAaveCredit.md) + +#### Parameters + +| Name | Type | +| :------------------ | :---------------------------------------------------------------------------- | +| `publisher` | [`Account`](Account.md) | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | +| `serviceAttributes` | [`ServiceAttributes`](../interfaces/ServiceAttributes.md) | +| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | +| `priceData?` | [`PricedMetadataInformation`](../code-reference.md#pricedmetadatainformation) | + +#### Returns + +[`ServiceAaveCredit`](../interfaces/ServiceAaveCredit.md) + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[createService](BaseTemplate.md#createservice) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L35) + +--- + +### deployVault + +▸ **deployVault**(`lendingPool`, `dataProvider`, `weth`, `agreementFee`, `treasuryAddress`, `borrower`, `lender`, `from`): `Promise`<`string`\> + +Deploy a new credit vault that is required to facilitate an Aave credit agreement + +#### Parameters + +| Name | Type | +| :---------------- | :------- | +| `lendingPool` | `string` | +| `dataProvider` | `string` | +| `weth` | `string` | +| `agreementFee` | `number` | +| `treasuryAddress` | `string` | +| `borrower` | `string` | +| `lender` | `string` | +| `from` | `string` | + +#### Returns + +`Promise`<`string`\> + +Agreement ID. + +#### Defined in + +[src/keeper/contracts/defi/AaveCreditTemplate.ts:201](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveCreditTemplate.ts#L201) + +--- + +### description + +▸ **description**(): `string` + +#### Returns + +`string` + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[description](BaseTemplate.md#description) + +#### Defined in + +[src/keeper/contracts/defi/AaveCreditTemplate.ts:45](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveCreditTemplate.ts#L45) + +--- + +### extraGen + +▸ **extraGen**(`_params`): `Promise`<`any`\> + +#### Parameters + +| Name | Type | +| :-------- | :------------------------------------------------------ | +| `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | + +#### Returns + +`Promise`<`any`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[extraGen](BaseTemplate.md#extragen) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:94](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L94) + +--- + +### 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. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getAgreementCreatedEvent](BaseTemplate.md#getagreementcreatedevent) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:459](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L459) + +--- + +### getAgreementData + +▸ **getAgreementData**(`agreementId`): `Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | + +#### Returns + +`Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getAgreementData](BaseTemplate.md#getagreementdata) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:21](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L21) + +--- + +### getAgreementDid + +▸ **getAgreementDid**(`agreementId`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/keeper/contracts/defi/AaveCreditTemplate.ts:305](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveCreditTemplate.ts#L305) + +--- + +### getAgreementIdsFromDDO + +▸ **getAgreementIdsFromDDO**(`agreementId`, `ddo`, `creator`, `params`): `Promise`<`string`[]\> + +Get agreement conditions IDs. + +#### Parameters + +| Name | Type | Description | +| :------------ | :---------------------------------------------------------------------- | :------------ | +| `agreementId` | `string` | Agreement ID. | +| `ddo` | [`DDO`](DDO.md) | DDO. | +| `creator` | `string` | - | +| `params` | [`AaveCreditTemplateParams`](../interfaces/AaveCreditTemplateParams.md) | - | + +#### Returns + +`Promise`<`string`[]\> + +The condition IDs. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getAgreementIdsFromDDO](BaseTemplate.md#getagreementidsfromddo) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:180](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L180) + +--- + +### getAgreementStatus + +▸ **getAgreementStatus**(`agreementId`): `Promise`<`false` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> + +Returns the status of the conditions. + +#### Parameters + +| Name | Type | Description | +| :------------ | :------- | :------------ | +| `agreementId` | `string` | Agreement ID. | + +#### Returns + +`Promise`<`false` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> + +The conditions status. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getAgreementStatus](BaseTemplate.md#getagreementstatus) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:346](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L346) + +--- + +### getAgreementVaultAddress + +▸ **getAgreementVaultAddress**(`agreementId`, `from`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `from` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/keeper/contracts/defi/AaveCreditTemplate.ts:301](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveCreditTemplate.ts#L301) + +--- + +### getAgreementsForDID + +▸ **getAgreementsForDID**(`did`): `Promise`<`string`[]\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `did` | `string` | + +#### Returns + +`Promise`<`string`[]\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getAgreementsForDID](BaseTemplate.md#getagreementsfordid) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:485](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L485) + +--- + +### getConditionTypes + +▸ **getConditionTypes**(): `Promise`<`string`[]\> + +Conditions address list. + +#### Returns + +`Promise`<`string`[]\> + +A list of condition addresses. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getConditionTypes](BaseTemplate.md#getconditiontypes) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L154) + +--- + +### getConditions + +▸ **getConditions**(): `Promise`<[`ConditionSmall`](ConditionSmall.md)[]\> + +List of condition contracts. + +#### Returns + +`Promise`<[`ConditionSmall`](ConditionSmall.md)[]\> + +A list of condition contracts. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getConditions](BaseTemplate.md#getconditions) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:165](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L165) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getFromAddress](BaseTemplate.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getInputsOfMethod](BaseTemplate.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getServiceAgreementTemplate + +▸ **getServiceAgreementTemplate**(): [`ServiceAgreementTemplate`](../interfaces/ServiceAgreementTemplate.md) + +#### Returns + +[`ServiceAgreementTemplate`](../interfaces/ServiceAgreementTemplate.md) + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[getServiceAgreementTemplate](BaseTemplate.md#getserviceagreementtemplate) + +#### Defined in + +[src/keeper/contracts/defi/AaveCreditTemplate.ts:92](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveCreditTemplate.ts#L92) + +--- + +### getServiceAgreementTemplateConditionByRef + +▸ **getServiceAgreementTemplateConditionByRef**(`ref`): `Promise`<[`ConditionSmall`](ConditionSmall.md)\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `ref` | `string` | + +#### Returns + +`Promise`<[`ConditionSmall`](ConditionSmall.md)\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getServiceAgreementTemplateConditionByRef](BaseTemplate.md#getserviceagreementtemplateconditionbyref) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:329](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L329) + +--- + +### getServiceAgreementTemplateConditions + +▸ **getServiceAgreementTemplateConditions**(): [`ServiceAgreementTemplateCondition`](../interfaces/ServiceAgreementTemplateCondition.md)[] + +#### Returns + +[`ServiceAgreementTemplateCondition`](../interfaces/ServiceAgreementTemplateCondition.md)[] + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getServiceAgreementTemplateConditions](BaseTemplate.md#getserviceagreementtemplateconditions) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:324](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L324) + +--- + +### getServiceAgreementTemplateDependencies + +▸ **getServiceAgreementTemplateDependencies**(): `Promise`<{ `[condition: string]`: `string`[]; }\> + +#### Returns + +`Promise`<{ `[condition: string]`: `string`[]; }\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getServiceAgreementTemplateDependencies](BaseTemplate.md#getserviceagreementtemplatedependencies) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:336](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L336) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getSignatureOfMethod](BaseTemplate.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[init](BaseTemplate.md#init) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### instanceFromDDO + +▸ **instanceFromDDO**(`agreementIdSeed`, `ddo`, `creator`, `parameters`): `Promise`<[`AgreementInstance`](../interfaces/AgreementInstance.md)<[`AaveCreditTemplateParams`](../interfaces/AaveCreditTemplateParams.md)\>\> + +#### Parameters + +| Name | Type | +| :---------------- | :---------------------------------------------------------------------- | +| `agreementIdSeed` | `string` | +| `ddo` | [`DDO`](DDO.md) | +| `creator` | `string` | +| `parameters` | [`AaveCreditTemplateParams`](../interfaces/AaveCreditTemplateParams.md) | + +#### Returns + +`Promise`<[`AgreementInstance`](../interfaces/AgreementInstance.md)<[`AaveCreditTemplateParams`](../interfaces/AaveCreditTemplateParams.md)\>\> + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[instanceFromDDO](BaseTemplate.md#instancefromddo) + +#### Defined in + +[src/keeper/contracts/defi/AaveCreditTemplate.ts:227](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveCreditTemplate.ts#L227) + +--- + +### lockConditionIndex + +▸ **lockConditionIndex**(): `number` + +#### Returns + +`number` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[lockConditionIndex](BaseTemplate.md#lockconditionindex) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:74](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L74) + +--- + +### lockTokens + +▸ **lockTokens**(`tokenAddress`, `amounts`, `from`, `txParams`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `tokenAddress` | `any` | +| `amounts` | `any` | +| `from` | [`Account`](Account.md) | +| `txParams` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[lockTokens](BaseTemplate.md#locktokens) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:393](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L393) + +--- + +### name + +▸ **name**(): `string` + +#### Returns + +`string` + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[name](BaseTemplate.md#name) + +#### Defined in + +[src/keeper/contracts/defi/AaveCreditTemplate.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveCreditTemplate.ts#L42) + +--- + +### params + +▸ **params**(`vaultAddress`, `nftContractAddress`, `nftAmount`, `collateralAsset`, `collateralAmount`, `delegatedAsset`, `delegatedAmount`, `interestRateMode`): [`AaveCreditTemplateParams`](../interfaces/AaveCreditTemplateParams.md) + +#### Parameters + +| Name | Type | +| :------------------- | :------- | +| `vaultAddress` | `string` | +| `nftContractAddress` | `string` | +| `nftAmount` | `number` | +| `collateralAsset` | `string` | +| `collateralAmount` | `string` | +| `delegatedAsset` | `string` | +| `delegatedAmount` | `string` | +| `interestRateMode` | `number` | + +#### Returns + +[`AaveCreditTemplateParams`](../interfaces/AaveCreditTemplateParams.md) + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[params](BaseTemplate.md#params) + +#### Defined in + +[src/keeper/contracts/defi/AaveCreditTemplate.ts:65](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveCreditTemplate.ts#L65) + +--- + +### paramsGen + +▸ **paramsGen**(`_params`): `Promise`<[`AaveCreditTemplateParams`](../interfaces/AaveCreditTemplateParams.md)\> + +Specialize params + +#### Parameters + +| Name | Type | Description | +| :-------- | :------------------------------------------------------ | :----------------- | +| `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | Generic parameters | + +#### Returns + +`Promise`<[`AaveCreditTemplateParams`](../interfaces/AaveCreditTemplateParams.md)\> + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[paramsGen](BaseTemplate.md#paramsgen) + +#### Defined in + +[src/keeper/contracts/defi/AaveCreditTemplate.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveCreditTemplate.ts#L39) + +--- + +### paymentData + +▸ **paymentData**(`service`): `Promise`<[`PaymentData`](../interfaces/PaymentData.md)\> + +#### Parameters + +| Name | Type | +| :-------- | :------------------------------------------------ | +| `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | + +#### Returns + +`Promise`<[`PaymentData`](../interfaces/PaymentData.md)\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[paymentData](BaseTemplate.md#paymentdata) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:78](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L78) + +--- + +### printAgreementStatus + +▸ **printAgreementStatus**(`agreementId`): `Promise`<`void`\> + +Prints the agreement status. + +#### Parameters + +| Name | Type | Description | +| :------------ | :------- | :------------ | +| `agreementId` | `string` | Agreement ID. | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[printAgreementStatus](BaseTemplate.md#printagreementstatus) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:429](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L429) + +--- + +### process + +▸ **process**(`params`, `from`, `txparams?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :---------- | :------------------------------------------------------ | +| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `from` | [`Account`](Account.md) | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[process](BaseTemplate.md#process) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:110](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L110) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[send](BaseTemplate.md#send) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[sendFrom](BaseTemplate.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### service + +▸ **service**(): [`ServiceType`](../code-reference.md#servicetype) + +#### Returns + +[`ServiceType`](../code-reference.md#servicetype) + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[service](BaseTemplate.md#service) + +#### Defined in + +[src/keeper/contracts/defi/AaveCreditTemplate.ts:61](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveCreditTemplate.ts#L61) + +--- + +### serviceEndpoint + +▸ **serviceEndpoint**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[serviceEndpoint](BaseTemplate.md#serviceendpoint) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L31) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[setInstanceConfig](BaseTemplate.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### standardContext + +▸ **standardContext**(`ddo`, `creator`, `serviceIndex?`): [`ConditionContext`](../interfaces/ConditionContext.md) + +#### Parameters + +| Name | Type | +| :-------------- | :-------------- | +| `ddo` | [`DDO`](DDO.md) | +| `creator` | `string` | +| `serviceIndex?` | `number` | + +#### Returns + +[`ConditionContext`](../interfaces/ConditionContext.md) + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[standardContext](BaseTemplate.md#standardcontext) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:200](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L200) + +--- + +### track + +▸ **track**(`_params`, `_from`, `_txparams?`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :----------- | :------------------------------------------------------ | +| `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `_from` | [`Account`](Account.md) | +| `_txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`boolean`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[track](BaseTemplate.md#track) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:102](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L102) + +--- + +### validateAgreement + +▸ **validateAgreement**(`agreement_id`, `did`, `params`, `from`, `extra?`, `txparams?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------------------------------- | +| `agreement_id` | `string` | +| `did` | `string` | +| `params` | [`AaveCreditTemplateParams`](../interfaces/AaveCreditTemplateParams.md) | +| `from` | [`Account`](Account.md) | +| `extra` | `any` | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[validateAgreement](BaseTemplate.md#validateagreement) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:125](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L125) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`): `Promise`<[`AaveCreditTemplate`](AaveCreditTemplate.md)\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`Promise`<[`AaveCreditTemplate`](AaveCreditTemplate.md)\> + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[getInstance](BaseTemplate.md#getinstance) + +#### Defined in + +[src/keeper/contracts/defi/AaveCreditTemplate.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveCreditTemplate.ts#L50) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[setInstanceConfig](BaseTemplate.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/AaveRepayCondition.md b/docs/api-reference/classes/AaveRepayCondition.md new file mode 100644 index 000000000..ca2972a08 --- /dev/null +++ b/docs/api-reference/classes/AaveRepayCondition.md @@ -0,0 +1,968 @@ +[@nevermined-io/sdk](../code-reference.md) / AaveRepayCondition + +# Class: AaveRepayCondition + +## Hierarchy + +- [`ProviderCondition`](ProviderCondition.md)<`AaveRepayConditionContext`\> + + ↳ **`AaveRepayCondition`** + +## Table of contents + +### Constructors + +- [constructor](AaveRepayCondition.md#constructor) + +### Properties + +- [address](AaveRepayCondition.md#address) +- [contract](AaveRepayCondition.md#contract) +- [contractName](AaveRepayCondition.md#contractname) +- [events](AaveRepayCondition.md#events) +- [version](AaveRepayCondition.md#version) + +### Accessors + +- [artifactsFolder](AaveRepayCondition.md#artifactsfolder) +- [circuitsFolder](AaveRepayCondition.md#circuitsfolder) +- [config](AaveRepayCondition.md#config) +- [instanceConfig](AaveRepayCondition.md#instanceconfig) +- [instantiableConfig](AaveRepayCondition.md#instantiableconfig) +- [logger](AaveRepayCondition.md#logger) +- [nevermined](AaveRepayCondition.md#nevermined) +- [web3](AaveRepayCondition.md#web3) + +### Methods + +- [abortByTimeOut](AaveRepayCondition.md#abortbytimeout) +- [call](AaveRepayCondition.md#call) +- [fulfill](AaveRepayCondition.md#fulfill) +- [fulfillInstance](AaveRepayCondition.md#fulfillinstance) +- [fulfillPlain](AaveRepayCondition.md#fulfillplain) +- [fulfillWithNode](AaveRepayCondition.md#fulfillwithnode) +- [generateId](AaveRepayCondition.md#generateid) +- [generateIdHash](AaveRepayCondition.md#generateidhash) +- [generateIdWithSeed](AaveRepayCondition.md#generateidwithseed) +- [getConditionFulfilledEvent](AaveRepayCondition.md#getconditionfulfilledevent) +- [getFromAddress](AaveRepayCondition.md#getfromaddress) +- [getInputsOfMethod](AaveRepayCondition.md#getinputsofmethod) +- [getSignatureOfMethod](AaveRepayCondition.md#getsignatureofmethod) +- [hashValues](AaveRepayCondition.md#hashvalues) +- [hashValuesPlain](AaveRepayCondition.md#hashvaluesplain) +- [init](AaveRepayCondition.md#init) +- [instance](AaveRepayCondition.md#instance) +- [instanceFromDDO](AaveRepayCondition.md#instancefromddo) +- [nodeMethod](AaveRepayCondition.md#nodemethod) +- [params](AaveRepayCondition.md#params) +- [paramsFromDDO](AaveRepayCondition.md#paramsfromddo) +- [send](AaveRepayCondition.md#send) +- [sendFrom](AaveRepayCondition.md#sendfrom) +- [setInstanceConfig](AaveRepayCondition.md#setinstanceconfig) +- [getInstance](AaveRepayCondition.md#getinstance) +- [setInstanceConfig](AaveRepayCondition.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new AaveRepayCondition**(`contractName`) + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[constructor](ProviderCondition.md#constructor) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L34) + +## Properties + +### address + +• **address**: `string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[address](ProviderCondition.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[contract](ProviderCondition.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[contractName](ProviderCondition.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[events](ProviderCondition.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[version](ProviderCondition.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ProviderCondition.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ProviderCondition.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +ProviderCondition.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ProviderCondition.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ProviderCondition.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +ProviderCondition.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +ProviderCondition.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +ProviderCondition.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### abortByTimeOut + +▸ **abortByTimeOut**(`conditionId`, `from?`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------------ | :---------------------------------------------- | +| `conditionId` | `string` | +| `from?` | [`Account`](Account.md) | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[abortByTimeOut](ProviderCondition.md#abortbytimeout) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L88) + +--- + +### 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 + +[ProviderCondition](ProviderCondition.md).[call](ProviderCondition.md#call) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### fulfill + +▸ **fulfill**(`agreementId`, `did`, `vaultAddress`, `assetToRepay`, `amountToRepay`, `interestRateMode`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :----------------- | :---------------------------------------------- | +| `agreementId` | `string` | +| `did` | `string` | +| `vaultAddress` | `string` | +| `assetToRepay` | `string` | +| `amountToRepay` | `string` | +| `interestRateMode` | `number` | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[fulfill](ProviderCondition.md#fulfill) + +#### Defined in + +[src/keeper/contracts/defi/AaveRepayCondition.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveRepayCondition.ts#L44) + +--- + +### fulfillInstance + +▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `txParams?`, `method?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | Default value | +| :----------------- | :----------------------------------------------------------------------------------------- | :------------ | +| `cond` | [`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | +| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | +| `from?` | [`Account`](Account.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[fulfillInstance](ProviderCondition.md#fulfillinstance) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:150](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L150) + +--- + +### fulfillPlain + +▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `txParams?`, `method?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | Default value | +| :------------ | :-------------------------------------------------------- | :------------ | +| `agreementId` | `string` | `undefined` | +| `args` | `any`[] | `undefined` | +| `from?` | [`Account`](Account.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[fulfillPlain](ProviderCondition.md#fulfillplain) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L63) + +--- + +### fulfillWithNode + +▸ **fulfillWithNode**(`cond`, `additionalParams`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :----------------- | :----------------------------------------------------------------------------------------- | +| `cond` | [`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | +| `additionalParams` | `Record`<`string`, `unknown`\> | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[fulfillWithNode](ProviderCondition.md#fulfillwithnode) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:194](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L194) + +--- + +### generateId + +▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `valueHash` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[generateId](ProviderCondition.md#generateid) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L77) + +--- + +### generateIdHash + +▸ **generateIdHash**(`agreementId`, `...values`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `...values` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[generateIdHash](ProviderCondition.md#generateidhash) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L73) + +--- + +### generateIdWithSeed + +▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `valueHash` | `string` | + +#### Returns + +`Promise`<[`string`, `string`]\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[generateIdWithSeed](ProviderCondition.md#generateidwithseed) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L81) + +--- + +### getConditionFulfilledEvent + +▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../code-reference.md#eventresult) + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | + +#### Returns + +[`EventResult`](../code-reference.md#eventresult) + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getConditionFulfilledEvent](ProviderCondition.md#getconditionfulfilledevent) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L92) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getFromAddress](ProviderCondition.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getInputsOfMethod](ProviderCondition.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getSignatureOfMethod](ProviderCondition.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### hashValues + +▸ **hashValues**(`...args`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[hashValues](ProviderCondition.md#hashvalues) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L129) + +--- + +### hashValuesPlain + +▸ **hashValuesPlain**(`...args`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[hashValuesPlain](ProviderCondition.md#hashvaluesplain) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:133](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L133) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[init](ProviderCondition.md#init) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### instance + +▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :------------ | :--------------------------------------------------------------------------------------------- | +| `agreementId` | `string` | +| `params` | [`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | + +#### Returns + +`Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[instance](ProviderCondition.md#instance) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:174](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L174) + +--- + +### instanceFromDDO + +▸ **instanceFromDDO**(`agreementId`, `ctx`, `...args`): `Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------------------------------------------- | +| `agreementId` | `string` | +| `ctx` | `AaveRepayConditionContext` | +| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | + +#### Returns + +`Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[instanceFromDDO](ProviderCondition.md#instancefromddo) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L142) + +--- + +### nodeMethod + +▸ **nodeMethod**(): [`ConditionMethod`](../code-reference.md#conditionmethod) + +#### Returns + +[`ConditionMethod`](../code-reference.md#conditionmethod) + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[nodeMethod](ProviderCondition.md#nodemethod) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:208](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L208) + +--- + +### params + +▸ **params**(`did`, `vaultAddress`, `assetToRepay`, `amountToRepay`, `interestRateMode`): [`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> + +#### Parameters + +| Name | Type | +| :----------------- | :------- | +| `did` | `string` | +| `vaultAddress` | `string` | +| `assetToRepay` | `string` | +| `amountToRepay` | `string` | +| `interestRateMode` | `number` | + +#### Returns + +[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[params](ProviderCondition.md#params) + +#### Defined in + +[src/keeper/contracts/defi/AaveRepayCondition.ts:19](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveRepayCondition.ts#L19) + +--- + +### paramsFromDDO + +▸ **paramsFromDDO**(`«destructured»`): `Promise`<[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :--------------- | :-------------------------- | +| `«destructured»` | `AaveRepayConditionContext` | + +#### Returns + +`Promise`<[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[paramsFromDDO](ProviderCondition.md#paramsfromddo) + +#### Defined in + +[src/keeper/contracts/defi/AaveRepayCondition.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveRepayCondition.ts#L34) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[send](ProviderCondition.md#send) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[sendFrom](ProviderCondition.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[setInstanceConfig](ProviderCondition.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`): `Promise`<[`AaveRepayCondition`](AaveRepayCondition.md)\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`Promise`<[`AaveRepayCondition`](AaveRepayCondition.md)\> + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[getInstance](ProviderCondition.md#getinstance) + +#### Defined in + +[src/keeper/contracts/defi/AaveRepayCondition.ts:15](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveRepayCondition.ts#L15) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[setInstanceConfig](ProviderCondition.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/AccessCondition.md b/docs/api-reference/classes/AccessCondition.md new file mode 100644 index 000000000..dfed1d69b --- /dev/null +++ b/docs/api-reference/classes/AccessCondition.md @@ -0,0 +1,1006 @@ +[@nevermined-io/sdk](../code-reference.md) / AccessCondition + +# Class: AccessCondition + +## Hierarchy + +- [`ProviderCondition`](ProviderCondition.md)<`AccessConditionContext`\> + + ↳ **`AccessCondition`** + +## Table of contents + +### Constructors + +- [constructor](AccessCondition.md#constructor) + +### Properties + +- [address](AccessCondition.md#address) +- [contract](AccessCondition.md#contract) +- [contractName](AccessCondition.md#contractname) +- [events](AccessCondition.md#events) +- [version](AccessCondition.md#version) + +### Accessors + +- [artifactsFolder](AccessCondition.md#artifactsfolder) +- [circuitsFolder](AccessCondition.md#circuitsfolder) +- [config](AccessCondition.md#config) +- [instanceConfig](AccessCondition.md#instanceconfig) +- [instantiableConfig](AccessCondition.md#instantiableconfig) +- [logger](AccessCondition.md#logger) +- [nevermined](AccessCondition.md#nevermined) +- [web3](AccessCondition.md#web3) + +### Methods + +- [abortByTimeOut](AccessCondition.md#abortbytimeout) +- [call](AccessCondition.md#call) +- [checkPermissions](AccessCondition.md#checkpermissions) +- [fulfill](AccessCondition.md#fulfill) +- [fulfillInstance](AccessCondition.md#fulfillinstance) +- [fulfillPlain](AccessCondition.md#fulfillplain) +- [fulfillWithNode](AccessCondition.md#fulfillwithnode) +- [generateId](AccessCondition.md#generateid) +- [generateIdHash](AccessCondition.md#generateidhash) +- [generateIdWithSeed](AccessCondition.md#generateidwithseed) +- [getConditionFulfilledEvent](AccessCondition.md#getconditionfulfilledevent) +- [getFromAddress](AccessCondition.md#getfromaddress) +- [getGrantedDidByConsumer](AccessCondition.md#getgranteddidbyconsumer) +- [getInputsOfMethod](AccessCondition.md#getinputsofmethod) +- [getSignatureOfMethod](AccessCondition.md#getsignatureofmethod) +- [hashValues](AccessCondition.md#hashvalues) +- [hashValuesPlain](AccessCondition.md#hashvaluesplain) +- [init](AccessCondition.md#init) +- [instance](AccessCondition.md#instance) +- [instanceFromDDO](AccessCondition.md#instancefromddo) +- [nodeMethod](AccessCondition.md#nodemethod) +- [params](AccessCondition.md#params) +- [paramsFromDDO](AccessCondition.md#paramsfromddo) +- [send](AccessCondition.md#send) +- [sendFrom](AccessCondition.md#sendfrom) +- [setInstanceConfig](AccessCondition.md#setinstanceconfig) +- [getInstance](AccessCondition.md#getinstance) +- [setInstanceConfig](AccessCondition.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new AccessCondition**(`contractName`) + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[constructor](ProviderCondition.md#constructor) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L34) + +## Properties + +### address + +• **address**: `string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[address](ProviderCondition.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[contract](ProviderCondition.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[contractName](ProviderCondition.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[events](ProviderCondition.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[version](ProviderCondition.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ProviderCondition.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ProviderCondition.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +ProviderCondition.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ProviderCondition.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ProviderCondition.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +ProviderCondition.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +ProviderCondition.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +ProviderCondition.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### abortByTimeOut + +▸ **abortByTimeOut**(`conditionId`, `from?`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------------ | :---------------------------------------------- | +| `conditionId` | `string` | +| `from?` | [`Account`](Account.md) | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[abortByTimeOut](ProviderCondition.md#abortbytimeout) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L88) + +--- + +### 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 + +[ProviderCondition](ProviderCondition.md).[call](ProviderCondition.md#call) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### checkPermissions + +▸ **checkPermissions**(`grantee`, `did`, `from?`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :-------- | :---------------------- | +| `grantee` | `string` | +| `did` | `string` | +| `from?` | [`Account`](Account.md) | + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[src/keeper/contracts/conditions/AccessCondition.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/AccessCondition.ts#L35) + +--- + +### fulfill + +▸ **fulfill**(`agreementId`, `did`, `grantee`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------------ | :---------------------------------------------- | +| `agreementId` | `string` | +| `did` | `string` | +| `grantee` | `string` | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[fulfill](ProviderCondition.md#fulfill) + +#### Defined in + +[src/keeper/contracts/conditions/AccessCondition.ts:25](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/AccessCondition.ts#L25) + +--- + +### fulfillInstance + +▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `txParams?`, `method?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | Default value | +| :----------------- | :----------------------------------------------------------------------------------------- | :------------ | +| `cond` | [`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | +| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | +| `from?` | [`Account`](Account.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[fulfillInstance](ProviderCondition.md#fulfillinstance) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:150](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L150) + +--- + +### fulfillPlain + +▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `txParams?`, `method?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | Default value | +| :------------ | :-------------------------------------------------------- | :------------ | +| `agreementId` | `string` | `undefined` | +| `args` | `any`[] | `undefined` | +| `from?` | [`Account`](Account.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[fulfillPlain](ProviderCondition.md#fulfillplain) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L63) + +--- + +### fulfillWithNode + +▸ **fulfillWithNode**(`cond`, `additionalParams`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :----------------- | :----------------------------------------------------------------------------------------- | +| `cond` | [`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | +| `additionalParams` | `Record`<`string`, `unknown`\> | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[fulfillWithNode](ProviderCondition.md#fulfillwithnode) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:194](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L194) + +--- + +### generateId + +▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `valueHash` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[generateId](ProviderCondition.md#generateid) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L77) + +--- + +### generateIdHash + +▸ **generateIdHash**(`agreementId`, `...values`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `...values` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[generateIdHash](ProviderCondition.md#generateidhash) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L73) + +--- + +### generateIdWithSeed + +▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `valueHash` | `string` | + +#### Returns + +`Promise`<[`string`, `string`]\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[generateIdWithSeed](ProviderCondition.md#generateidwithseed) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L81) + +--- + +### getConditionFulfilledEvent + +▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../code-reference.md#eventresult) + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | + +#### Returns + +[`EventResult`](../code-reference.md#eventresult) + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getConditionFulfilledEvent](ProviderCondition.md#getconditionfulfilledevent) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L92) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getFromAddress](ProviderCondition.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getGrantedDidByConsumer + +▸ **getGrantedDidByConsumer**(`consumer`): `Promise`<{ `agreementId`: `string` ; `did`: `string` }[]\> + +#### Parameters + +| Name | Type | +| :--------- | :------- | +| `consumer` | `string` | + +#### Returns + +`Promise`<{ `agreementId`: `string` ; `did`: `string` }[]\> + +#### Defined in + +[src/keeper/contracts/conditions/AccessCondition.ts:43](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/AccessCondition.ts#L43) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getInputsOfMethod](ProviderCondition.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getSignatureOfMethod](ProviderCondition.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### hashValues + +▸ **hashValues**(`...args`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[hashValues](ProviderCondition.md#hashvalues) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L129) + +--- + +### hashValuesPlain + +▸ **hashValuesPlain**(`...args`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[hashValuesPlain](ProviderCondition.md#hashvaluesplain) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:133](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L133) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[init](ProviderCondition.md#init) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### instance + +▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :------------ | :--------------------------------------------------------------------------------------------- | +| `agreementId` | `string` | +| `params` | [`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | + +#### Returns + +`Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[instance](ProviderCondition.md#instance) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:174](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L174) + +--- + +### instanceFromDDO + +▸ **instanceFromDDO**(`agreementId`, `ctx`, `...args`): `Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------------------------------------------- | +| `agreementId` | `string` | +| `ctx` | `AccessConditionContext` | +| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | + +#### Returns + +`Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[instanceFromDDO](ProviderCondition.md#instancefromddo) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L142) + +--- + +### nodeMethod + +▸ **nodeMethod**(): [`ConditionMethod`](../code-reference.md#conditionmethod) + +#### Returns + +[`ConditionMethod`](../code-reference.md#conditionmethod) + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[nodeMethod](ProviderCondition.md#nodemethod) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:208](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L208) + +--- + +### params + +▸ **params**(`did`, `grantee`): [`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `did` | `string` | +| `grantee` | `string` | + +#### Returns + +[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[params](ProviderCondition.md#params) + +#### Defined in + +[src/keeper/contracts/conditions/AccessCondition.ts:17](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/AccessCondition.ts#L17) + +--- + +### paramsFromDDO + +▸ **paramsFromDDO**(`«destructured»`): `Promise`<[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :--------------- | :----------------------- | +| `«destructured»` | `AccessConditionContext` | + +#### Returns + +`Promise`<[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[paramsFromDDO](ProviderCondition.md#paramsfromddo) + +#### Defined in + +[src/keeper/contracts/conditions/AccessCondition.ts:21](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/AccessCondition.ts#L21) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[send](ProviderCondition.md#send) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[sendFrom](ProviderCondition.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[setInstanceConfig](ProviderCondition.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`): `Promise`<[`AccessCondition`](AccessCondition.md)\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`Promise`<[`AccessCondition`](AccessCondition.md)\> + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[getInstance](ProviderCondition.md#getinstance) + +#### Defined in + +[src/keeper/contracts/conditions/AccessCondition.ts:13](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/AccessCondition.ts#L13) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[setInstanceConfig](ProviderCondition.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/AccessService.md b/docs/api-reference/classes/AccessService.md new file mode 100644 index 000000000..d500f57e8 --- /dev/null +++ b/docs/api-reference/classes/AccessService.md @@ -0,0 +1,402 @@ +[@nevermined-io/sdk](../code-reference.md) / AccessService + +# Class: AccessService + +## Hierarchy + +- [`Instantiable`](Instantiable.md) + + ↳ **`AccessService`** + +## Implements + +- [`ServicePlugin`](../interfaces/ServicePlugin.md)<[`ServiceAccess`](../interfaces/ServiceAccess.md)\> + +## Table of contents + +### Constructors + +- [constructor](AccessService.md#constructor) + +### Properties + +- [normal](AccessService.md#normal) + +### Accessors + +- [artifactsFolder](AccessService.md#artifactsfolder) +- [circuitsFolder](AccessService.md#circuitsfolder) +- [config](AccessService.md#config) +- [instanceConfig](AccessService.md#instanceconfig) +- [instantiableConfig](AccessService.md#instantiableconfig) +- [logger](AccessService.md#logger) +- [nevermined](AccessService.md#nevermined) +- [web3](AccessService.md#web3) + +### Methods + +- [accept](AccessService.md#accept) +- [createService](AccessService.md#createservice) +- [process](AccessService.md#process) +- [setInstanceConfig](AccessService.md#setinstanceconfig) +- [track](AccessService.md#track) +- [getInstance](AccessService.md#getinstance) +- [setInstanceConfig](AccessService.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new AccessService**(`config`, `normal`) + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | +| `normal` | [`AccessTemplate`](AccessTemplate.md) | + +#### Overrides + +[Instantiable](Instantiable.md).[constructor](Instantiable.md#constructor) + +#### Defined in + +[src/nevermined/AccessService.ts:33](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/AccessService.ts#L33) + +## Properties + +### normal + +• **normal**: [`AccessTemplate`](AccessTemplate.md) + +#### Defined in + +[src/nevermined/AccessService.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/AccessService.ts#L31) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +Instantiable.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +Instantiable.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +Instantiable.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +Instantiable.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### accept + +▸ **accept**(`params`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :------- | :------------------------------------------------------ | +| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | + +#### Returns + +`Promise`<`boolean`\> + +#### Implementation of + +[ServicePlugin](../interfaces/ServicePlugin.md).[accept](../interfaces/ServicePlugin.md#accept) + +#### Defined in + +[src/nevermined/AccessService.ts:62](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/AccessService.ts#L62) + +--- + +### createService + +▸ **createService**(`publisher`, `metadata`, `serviceAttributes`, `nftAttributes?`, `pricedData?`): [`ServiceAccess`](../interfaces/ServiceAccess.md) + +#### Parameters + +| Name | Type | +| :------------------ | :---------------------------------------------------------------------------- | +| `publisher` | [`Account`](Account.md) | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | +| `serviceAttributes` | [`ServiceAttributes`](../interfaces/ServiceAttributes.md) | +| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | +| `pricedData?` | [`PricedMetadataInformation`](../code-reference.md#pricedmetadatainformation) | + +#### Returns + +[`ServiceAccess`](../interfaces/ServiceAccess.md) + +#### Implementation of + +[ServicePlugin](../interfaces/ServicePlugin.md).[createService](../interfaces/ServicePlugin.md#createservice) + +#### Defined in + +[src/nevermined/AccessService.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/AccessService.ts#L39) + +--- + +### process + +▸ **process**(`params`, `from`, `txparams?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :---------- | :------------------------------------------------------ | +| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `from` | [`Account`](Account.md) | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`void`\> + +#### Implementation of + +[ServicePlugin](../interfaces/ServicePlugin.md).[process](../interfaces/ServicePlugin.md#process) + +#### Defined in + +[src/nevermined/AccessService.ts:55](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/AccessService.ts#L55) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### track + +▸ **track**(`params`, `from`, `txparams?`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :---------- | :------------------------------------------------------ | +| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `from` | [`Account`](Account.md) | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`boolean`\> + +#### Implementation of + +[ServicePlugin](../interfaces/ServicePlugin.md).[track](../interfaces/ServicePlugin.md#track) + +#### Defined in + +[src/nevermined/AccessService.ts:65](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/AccessService.ts#L65) + +--- + +### getInstance + +▸ `Static` **getInstance**(`..._args`): `any` + +#### Parameters + +| Name | Type | +| :--------- | :---- | +| `..._args` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[Instantiable](Instantiable.md).[getInstance](Instantiable.md#getinstance) + +#### Defined in + +[src/Instantiable.abstract.ts:86](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L86) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/AccessTemplate.md b/docs/api-reference/classes/AccessTemplate.md new file mode 100644 index 000000000..493813601 --- /dev/null +++ b/docs/api-reference/classes/AccessTemplate.md @@ -0,0 +1,1439 @@ +[@nevermined-io/sdk](../code-reference.md) / AccessTemplate + +# Class: AccessTemplate + +## Hierarchy + +- [`BaseTemplate`](BaseTemplate.md)<`AccessTemplateParams`, [`ServiceAccess`](../interfaces/ServiceAccess.md)\> + + ↳ **`AccessTemplate`** + +## Table of contents + +### Constructors + +- [constructor](AccessTemplate.md#constructor) + +### Properties + +- [address](AccessTemplate.md#address) +- [contract](AccessTemplate.md#contract) +- [contractName](AccessTemplate.md#contractname) +- [events](AccessTemplate.md#events) +- [version](AccessTemplate.md#version) + +### Accessors + +- [artifactsFolder](AccessTemplate.md#artifactsfolder) +- [circuitsFolder](AccessTemplate.md#circuitsfolder) +- [config](AccessTemplate.md#config) +- [instanceConfig](AccessTemplate.md#instanceconfig) +- [instantiableConfig](AccessTemplate.md#instantiableconfig) +- [logger](AccessTemplate.md#logger) +- [nevermined](AccessTemplate.md#nevermined) +- [web3](AccessTemplate.md#web3) + +### Methods + +- [accept](AccessTemplate.md#accept) +- [agreementId](AccessTemplate.md#agreementid) +- [call](AccessTemplate.md#call) +- [conditions](AccessTemplate.md#conditions) +- [createAgreement](AccessTemplate.md#createagreement) +- [createAgreementAndPay](AccessTemplate.md#createagreementandpay) +- [createAgreementFromDDO](AccessTemplate.md#createagreementfromddo) +- [createAgreementWithPaymentFromDDO](AccessTemplate.md#createagreementwithpaymentfromddo) +- [createService](AccessTemplate.md#createservice) +- [description](AccessTemplate.md#description) +- [extraGen](AccessTemplate.md#extragen) +- [getAgreementCreatedEvent](AccessTemplate.md#getagreementcreatedevent) +- [getAgreementData](AccessTemplate.md#getagreementdata) +- [getAgreementIdsFromDDO](AccessTemplate.md#getagreementidsfromddo) +- [getAgreementStatus](AccessTemplate.md#getagreementstatus) +- [getAgreementsForDID](AccessTemplate.md#getagreementsfordid) +- [getConditionTypes](AccessTemplate.md#getconditiontypes) +- [getConditions](AccessTemplate.md#getconditions) +- [getFromAddress](AccessTemplate.md#getfromaddress) +- [getInputsOfMethod](AccessTemplate.md#getinputsofmethod) +- [getServiceAgreementTemplate](AccessTemplate.md#getserviceagreementtemplate) +- [getServiceAgreementTemplateConditionByRef](AccessTemplate.md#getserviceagreementtemplateconditionbyref) +- [getServiceAgreementTemplateConditions](AccessTemplate.md#getserviceagreementtemplateconditions) +- [getServiceAgreementTemplateDependencies](AccessTemplate.md#getserviceagreementtemplatedependencies) +- [getSignatureOfMethod](AccessTemplate.md#getsignatureofmethod) +- [init](AccessTemplate.md#init) +- [instanceFromDDO](AccessTemplate.md#instancefromddo) +- [lockConditionIndex](AccessTemplate.md#lockconditionindex) +- [lockTokens](AccessTemplate.md#locktokens) +- [name](AccessTemplate.md#name) +- [params](AccessTemplate.md#params) +- [paramsGen](AccessTemplate.md#paramsgen) +- [paymentData](AccessTemplate.md#paymentdata) +- [printAgreementStatus](AccessTemplate.md#printagreementstatus) +- [process](AccessTemplate.md#process) +- [send](AccessTemplate.md#send) +- [sendFrom](AccessTemplate.md#sendfrom) +- [service](AccessTemplate.md#service) +- [serviceEndpoint](AccessTemplate.md#serviceendpoint) +- [setInstanceConfig](AccessTemplate.md#setinstanceconfig) +- [standardContext](AccessTemplate.md#standardcontext) +- [track](AccessTemplate.md#track) +- [validateAgreement](AccessTemplate.md#validateagreement) +- [getInstance](AccessTemplate.md#getinstance) +- [setInstanceConfig](AccessTemplate.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• `Protected` **new AccessTemplate**(`contractName`) + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[constructor](BaseTemplate.md#constructor) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:68](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L68) + +## Properties + +### address + +• **address**: `string` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[address](BaseTemplate.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[contract](BaseTemplate.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[contractName](BaseTemplate.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[events](BaseTemplate.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[version](BaseTemplate.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +BaseTemplate.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +BaseTemplate.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +BaseTemplate.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +BaseTemplate.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +BaseTemplate.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +BaseTemplate.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +BaseTemplate.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +BaseTemplate.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### accept + +▸ **accept**(`params`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :------- | :------------------------------------------------------ | +| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | + +#### Returns + +`Promise`<`boolean`\> + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[accept](BaseTemplate.md#accept) + +#### Defined in + +[src/keeper/contracts/templates/AccessTemplate.ts:98](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AccessTemplate.ts#L98) + +--- + +### agreementId + +▸ **agreementId**(`agreementIdSeed`, `creator`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :---------------- | :------- | +| `agreementIdSeed` | `string` | +| `creator` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[agreementId](BaseTemplate.md#agreementid) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:213](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L213) + +--- + +### 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 + +[BaseTemplate](BaseTemplate.md).[call](BaseTemplate.md#call) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### conditions + +▸ **conditions**(): [[`AccessCondition`](AccessCondition.md), [`LockPaymentCondition`](LockPaymentCondition.md), [`EscrowPaymentCondition`](EscrowPaymentCondition.md)] + +#### Returns + +[[`AccessCondition`](AccessCondition.md), [`LockPaymentCondition`](LockPaymentCondition.md), [`EscrowPaymentCondition`](EscrowPaymentCondition.md)] + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[conditions](BaseTemplate.md#conditions) + +#### Defined in + +[src/keeper/contracts/templates/AccessTemplate.ts:52](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AccessTemplate.ts#L52) + +--- + +### createAgreement + +▸ **createAgreement**(`agreementId`, `did`, `conditionIds`, `timeLocks`, `timeOuts`, `extraArgs`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `agreementId` | `string` | +| `did` | `string` | +| `conditionIds` | `string`[] | +| `timeLocks` | `number`[] | +| `timeOuts` | `number`[] | +| `extraArgs` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[createAgreement](BaseTemplate.md#createagreement) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L90) + +--- + +### createAgreementAndPay + +▸ **createAgreementAndPay**(`agreementId`, `did`, `conditionIds`, `timeLocks`, `timeOuts`, `accessConsumer`, `condIdx`, `rewardAddress`, `tokenAddress`, `amounts`, `receivers`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :--------------- | :---------------------------------------------- | +| `agreementId` | `string` | +| `did` | `string` | +| `conditionIds` | `string`[] | +| `timeLocks` | `number`[] | +| `timeOuts` | `number`[] | +| `accessConsumer` | `string` | +| `condIdx` | `number` | +| `rewardAddress` | `string` | +| `tokenAddress` | `string` | +| `amounts` | `bigint`[] | +| `receivers` | `string`[] | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[createAgreementAndPay](BaseTemplate.md#createagreementandpay) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L115) + +--- + +### createAgreementFromDDO + +▸ **createAgreementFromDDO**(`agreementIdSeed`, `ddo`, `parameters`, `consumer`, `from`, `timeOuts?`, `txParams?`): `Promise`<`string`\> + +Create a new agreement using the data of a DDO. + +#### Parameters + +| Name | Type | Description | +| :---------------- | :---------------------------------------------- | :---------- | +| `agreementIdSeed` | `string` | - | +| `ddo` | [`DDO`](DDO.md) | DDO. | +| `parameters` | `AccessTemplateParams` | | +| `consumer` | [`Account`](Account.md) | - | +| `from` | [`Account`](Account.md) | - | +| `timeOuts?` | `number`[] | - | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | + +#### Returns + +`Promise`<`string`\> + +true if the call was successful. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[createAgreementFromDDO](BaseTemplate.md#createagreementfromddo) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:222](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L222) + +--- + +### createAgreementWithPaymentFromDDO + +▸ **createAgreementWithPaymentFromDDO**(`agreementIdSeed`, `ddo`, `serviceReference`, `parameters`, `consumer`, `from`, `txParams?`, `observer?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :----------------- | :------------------------------------------------------------------------------------ | +| `agreementIdSeed` | `string` | +| `ddo` | [`DDO`](DDO.md) | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | +| `parameters` | `AccessTemplateParams` | +| `consumer` | [`Account`](Account.md) | +| `from` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| `observer?` | (`orderProgressStep`: [`OrderProgressStep`](../enums/OrderProgressStep.md)) => `void` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[createAgreementWithPaymentFromDDO](BaseTemplate.md#createagreementwithpaymentfromddo) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:252](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L252) + +--- + +### createService + +▸ **createService**(`publisher`, `metadata`, `serviceAttributes`, `nftAttributes?`, `priceData?`): [`ServiceAccess`](../interfaces/ServiceAccess.md) + +#### Parameters + +| Name | Type | +| :------------------ | :---------------------------------------------------------------------------- | +| `publisher` | [`Account`](Account.md) | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | +| `serviceAttributes` | [`ServiceAttributes`](../interfaces/ServiceAttributes.md) | +| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | +| `priceData?` | [`PricedMetadataInformation`](../code-reference.md#pricedmetadatainformation) | + +#### Returns + +[`ServiceAccess`](../interfaces/ServiceAccess.md) + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[createService](BaseTemplate.md#createservice) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L35) + +--- + +### description + +▸ **description**(): `string` + +#### Returns + +`string` + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[description](BaseTemplate.md#description) + +#### Defined in + +[src/keeper/contracts/templates/AccessTemplate.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AccessTemplate.ts#L28) + +--- + +### extraGen + +▸ **extraGen**(`_params`): `Promise`<`any`\> + +#### Parameters + +| Name | Type | +| :-------- | :------------------------------------------------------ | +| `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | + +#### Returns + +`Promise`<`any`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[extraGen](BaseTemplate.md#extragen) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:94](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L94) + +--- + +### 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. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getAgreementCreatedEvent](BaseTemplate.md#getagreementcreatedevent) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:459](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L459) + +--- + +### getAgreementData + +▸ **getAgreementData**(`agreementId`): `Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | + +#### Returns + +`Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getAgreementData](BaseTemplate.md#getagreementdata) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:21](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L21) + +--- + +### getAgreementIdsFromDDO + +▸ **getAgreementIdsFromDDO**(`agreementId`, `ddo`, `creator`, `params`): `Promise`<`string`[]\> + +Get agreement conditions IDs. + +#### Parameters + +| Name | Type | Description | +| :------------ | :--------------------- | :------------ | +| `agreementId` | `string` | Agreement ID. | +| `ddo` | [`DDO`](DDO.md) | DDO. | +| `creator` | `string` | - | +| `params` | `AccessTemplateParams` | - | + +#### Returns + +`Promise`<`string`[]\> + +The condition IDs. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getAgreementIdsFromDDO](BaseTemplate.md#getagreementidsfromddo) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:180](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L180) + +--- + +### getAgreementStatus + +▸ **getAgreementStatus**(`agreementId`): `Promise`<`false` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> + +Returns the status of the conditions. + +#### Parameters + +| Name | Type | Description | +| :------------ | :------- | :------------ | +| `agreementId` | `string` | Agreement ID. | + +#### Returns + +`Promise`<`false` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> + +The conditions status. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getAgreementStatus](BaseTemplate.md#getagreementstatus) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:346](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L346) + +--- + +### getAgreementsForDID + +▸ **getAgreementsForDID**(`did`): `Promise`<`string`[]\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `did` | `string` | + +#### Returns + +`Promise`<`string`[]\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getAgreementsForDID](BaseTemplate.md#getagreementsfordid) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:485](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L485) + +--- + +### getConditionTypes + +▸ **getConditionTypes**(): `Promise`<`string`[]\> + +Conditions address list. + +#### Returns + +`Promise`<`string`[]\> + +A list of condition addresses. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getConditionTypes](BaseTemplate.md#getconditiontypes) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L154) + +--- + +### getConditions + +▸ **getConditions**(): `Promise`<[`ConditionSmall`](ConditionSmall.md)[]\> + +List of condition contracts. + +#### Returns + +`Promise`<[`ConditionSmall`](ConditionSmall.md)[]\> + +A list of condition contracts. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getConditions](BaseTemplate.md#getconditions) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:165](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L165) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getFromAddress](BaseTemplate.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getInputsOfMethod](BaseTemplate.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getServiceAgreementTemplate + +▸ **getServiceAgreementTemplate**(): [`ServiceAgreementTemplate`](../interfaces/ServiceAgreementTemplate.md) + +#### Returns + +[`ServiceAgreementTemplate`](../interfaces/ServiceAgreementTemplate.md) + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[getServiceAgreementTemplate](BaseTemplate.md#getserviceagreementtemplate) + +#### Defined in + +[src/keeper/contracts/templates/AccessTemplate.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AccessTemplate.ts#L39) + +--- + +### getServiceAgreementTemplateConditionByRef + +▸ **getServiceAgreementTemplateConditionByRef**(`ref`): `Promise`<[`ConditionSmall`](ConditionSmall.md)\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `ref` | `string` | + +#### Returns + +`Promise`<[`ConditionSmall`](ConditionSmall.md)\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getServiceAgreementTemplateConditionByRef](BaseTemplate.md#getserviceagreementtemplateconditionbyref) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:329](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L329) + +--- + +### getServiceAgreementTemplateConditions + +▸ **getServiceAgreementTemplateConditions**(): [`ServiceAgreementTemplateCondition`](../interfaces/ServiceAgreementTemplateCondition.md)[] + +#### Returns + +[`ServiceAgreementTemplateCondition`](../interfaces/ServiceAgreementTemplateCondition.md)[] + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getServiceAgreementTemplateConditions](BaseTemplate.md#getserviceagreementtemplateconditions) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:324](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L324) + +--- + +### getServiceAgreementTemplateDependencies + +▸ **getServiceAgreementTemplateDependencies**(): `Promise`<{ `[condition: string]`: `string`[]; }\> + +#### Returns + +`Promise`<{ `[condition: string]`: `string`[]; }\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getServiceAgreementTemplateDependencies](BaseTemplate.md#getserviceagreementtemplatedependencies) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:336](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L336) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getSignatureOfMethod](BaseTemplate.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[init](BaseTemplate.md#init) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### instanceFromDDO + +▸ **instanceFromDDO**(`agreementIdSeed`, `ddo`, `creator`, `parameters`): `Promise`<[`AgreementInstance`](../interfaces/AgreementInstance.md)<`AccessTemplateParams`\>\> + +#### Parameters + +| Name | Type | +| :---------------- | :--------------------- | +| `agreementIdSeed` | `string` | +| `ddo` | [`DDO`](DDO.md) | +| `creator` | `string` | +| `parameters` | `AccessTemplateParams` | + +#### Returns + +`Promise`<[`AgreementInstance`](../interfaces/AgreementInstance.md)<`AccessTemplateParams`\>\> + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[instanceFromDDO](BaseTemplate.md#instancefromddo) + +#### Defined in + +[src/keeper/contracts/templates/AccessTemplate.ts:58](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AccessTemplate.ts#L58) + +--- + +### lockConditionIndex + +▸ **lockConditionIndex**(): `number` + +#### Returns + +`number` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[lockConditionIndex](BaseTemplate.md#lockconditionindex) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:74](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L74) + +--- + +### lockTokens + +▸ **lockTokens**(`tokenAddress`, `amounts`, `from`, `txParams`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `tokenAddress` | `any` | +| `amounts` | `any` | +| `from` | [`Account`](Account.md) | +| `txParams` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[lockTokens](BaseTemplate.md#locktokens) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:393](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L393) + +--- + +### name + +▸ **name**(): `string` + +#### Returns + +`string` + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[name](BaseTemplate.md#name) + +#### Defined in + +[src/keeper/contracts/templates/AccessTemplate.ts:25](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AccessTemplate.ts#L25) + +--- + +### params + +▸ **params**(`consumer`, `serviceType?`): `AccessTemplateParams` + +#### Parameters + +| Name | Type | Default value | +| :------------ | :------------------------------------------------ | :------------ | +| `consumer` | [`Account`](Account.md) | `undefined` | +| `serviceType` | [`ServiceType`](../code-reference.md#servicetype) | `'access'` | + +#### Returns + +`AccessTemplateParams` + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[params](BaseTemplate.md#params) + +#### Defined in + +[src/keeper/contracts/templates/AccessTemplate.ts:43](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AccessTemplate.ts#L43) + +--- + +### paramsGen + +▸ **paramsGen**(`«destructured»`): `Promise`<`AccessTemplateParams`\> + +Specialize params + +#### Parameters + +| Name | Type | Description | +| :--------------- | :------------------------------------------------------ | :----------------- | +| `«destructured»` | [`ValidationParams`](../interfaces/ValidationParams.md) | Generic parameters | + +#### Returns + +`Promise`<`AccessTemplateParams`\> + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[paramsGen](BaseTemplate.md#paramsgen) + +#### Defined in + +[src/keeper/contracts/templates/AccessTemplate.ts:17](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AccessTemplate.ts#L17) + +--- + +### paymentData + +▸ **paymentData**(`service`): `Promise`<[`PaymentData`](../interfaces/PaymentData.md)\> + +#### Parameters + +| Name | Type | +| :-------- | :------------------------------------------------ | +| `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | + +#### Returns + +`Promise`<[`PaymentData`](../interfaces/PaymentData.md)\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[paymentData](BaseTemplate.md#paymentdata) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:78](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L78) + +--- + +### printAgreementStatus + +▸ **printAgreementStatus**(`agreementId`): `Promise`<`void`\> + +Prints the agreement status. + +#### Parameters + +| Name | Type | Description | +| :------------ | :------- | :------------ | +| `agreementId` | `string` | Agreement ID. | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[printAgreementStatus](BaseTemplate.md#printagreementstatus) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:429](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L429) + +--- + +### process + +▸ **process**(`params`, `from`, `txparams?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :---------- | :------------------------------------------------------ | +| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `from` | [`Account`](Account.md) | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[process](BaseTemplate.md#process) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:110](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L110) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[send](BaseTemplate.md#send) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[sendFrom](BaseTemplate.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### service + +▸ **service**(): [`ServiceType`](../code-reference.md#servicetype) + +#### Returns + +[`ServiceType`](../code-reference.md#servicetype) + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[service](BaseTemplate.md#service) + +#### Defined in + +[src/keeper/contracts/templates/AccessTemplate.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AccessTemplate.ts#L35) + +--- + +### serviceEndpoint + +▸ **serviceEndpoint**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[serviceEndpoint](BaseTemplate.md#serviceendpoint) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L31) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[setInstanceConfig](BaseTemplate.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### standardContext + +▸ **standardContext**(`ddo`, `creator`, `serviceIndex?`): [`ConditionContext`](../interfaces/ConditionContext.md) + +#### Parameters + +| Name | Type | +| :-------------- | :-------------- | +| `ddo` | [`DDO`](DDO.md) | +| `creator` | `string` | +| `serviceIndex?` | `number` | + +#### Returns + +[`ConditionContext`](../interfaces/ConditionContext.md) + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[standardContext](BaseTemplate.md#standardcontext) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:200](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L200) + +--- + +### track + +▸ **track**(`_params`, `_from`, `_txparams?`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :----------- | :------------------------------------------------------ | +| `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `_from` | [`Account`](Account.md) | +| `_txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`boolean`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[track](BaseTemplate.md#track) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:102](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L102) + +--- + +### validateAgreement + +▸ **validateAgreement**(`agreement_id`, `did`, `params`, `from`, `extra?`, `txparams?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `agreement_id` | `string` | +| `did` | `string` | +| `params` | `AccessTemplateParams` | +| `from` | [`Account`](Account.md) | +| `extra` | `any` | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[validateAgreement](BaseTemplate.md#validateagreement) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:125](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L125) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`): `Promise`<[`AccessTemplate`](AccessTemplate.md)\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`Promise`<[`AccessTemplate`](AccessTemplate.md)\> + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[getInstance](BaseTemplate.md#getinstance) + +#### Defined in + +[src/keeper/contracts/templates/AccessTemplate.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AccessTemplate.ts#L31) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[setInstanceConfig](BaseTemplate.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/Account.md b/docs/api-reference/classes/Account.md index 3b5bf9634..6d8bc94cd 100644 --- a/docs/api-reference/classes/Account.md +++ b/docs/api-reference/classes/Account.md @@ -6,7 +6,7 @@ Account information. ## Hierarchy -- `Instantiable` +- [`Instantiable`](Instantiable.md) ↳ **`Account`** @@ -23,11 +23,12 @@ Account information. - [babyY](Account.md#babyy) - [id](Account.md#id) - [password](Account.md#password) -- [token](Account.md#token) +- [zeroDevSigner](Account.md#zerodevsigner) ### Accessors - [artifactsFolder](Account.md#artifactsfolder) +- [circuitsFolder](Account.md#circuitsfolder) - [config](Account.md#config) - [instanceConfig](Account.md#instanceconfig) - [instantiableConfig](Account.md#instantiableconfig) @@ -37,25 +38,18 @@ Account information. ### Methods -- [addresses](Account.md#addresses) -- [authenticate](Account.md#authenticate) -- [checkExists](Account.md#checkexists) -- [findSigner](Account.md#findsigner) - [getBalance](Account.md#getbalance) - [getEtherBalance](Account.md#getetherbalance) - [getId](Account.md#getid) - [getNeverminedBalance](Account.md#getneverminedbalance) - [getPassword](Account.md#getpassword) - [getPublic](Account.md#getpublic) -- [getToken](Account.md#gettoken) -- [isTokenStored](Account.md#istokenstored) +- [isZeroDev](Account.md#iszerodev) - [requestTokens](Account.md#requesttokens) - [setId](Account.md#setid) - [setInstanceConfig](Account.md#setinstanceconfig) - [setPassword](Account.md#setpassword) -- [setToken](Account.md#settoken) -- [addressesStatic](Account.md#addressesstatic) -- [findSignerStatic](Account.md#findsignerstatic) +- [fromZeroDevSigner](Account.md#fromzerodevsigner) - [getInstance](Account.md#getinstance) - [setInstanceConfig](Account.md#setinstanceconfig-1) @@ -67,18 +61,18 @@ Account information. #### Parameters -| Name | Type | Default value | -| :-------- | :------------------- | :------------ | -| `id` | `string` | `'0x0'` | -| `config?` | `InstantiableConfig` | `undefined` | +| Name | Type | Default value | +| :-------- | :---------------------------------------------------------- | :------------ | +| `id` | `string` | `'0x0'` | +| `config?` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | #### Overrides -Instantiable.constructor +[Instantiable](Instantiable.md).[constructor](Instantiable.md#constructor) #### Defined in -[src/nevermined.ts:20](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined.ts#L20) +[src/nevermined/Account.ts:19](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Account.ts#L19) ## Properties @@ -88,7 +82,7 @@ Instantiable.constructor #### Defined in -[src/nevermined.ts:18](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined.ts#L18) +[src/nevermined/Account.ts:16](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Account.ts#L16) --- @@ -98,7 +92,7 @@ Instantiable.constructor #### Defined in -[src/nevermined.ts:16](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined.ts#L16) +[src/nevermined/Account.ts:14](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Account.ts#L14) --- @@ -108,7 +102,7 @@ Instantiable.constructor #### Defined in -[src/nevermined.ts:17](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined.ts#L17) +[src/nevermined/Account.ts:15](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Account.ts#L15) --- @@ -118,7 +112,7 @@ Instantiable.constructor #### Defined in -[src/nevermined.ts:20](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined.ts#L20) +[src/nevermined/Account.ts:19](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Account.ts#L19) --- @@ -128,17 +122,17 @@ Instantiable.constructor #### Defined in -[src/nevermined.ts:12](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined.ts#L12) +[src/nevermined/Account.ts:13](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Account.ts#L13) --- -### token +### zeroDevSigner -• `Private` `Optional` **token**: `string` +• **zeroDevSigner**: `ZeroDevAccountSigner`<`"ECDSA"`\> #### Defined in -[src/nevermined.ts:14](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined.ts#L14) +[src/nevermined/Account.ts:17](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Account.ts#L17) ## Accessors @@ -156,17 +150,35 @@ Instantiable.artifactsFolder #### Defined in -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) --- ### config -• `Protected` `get` **config**(): [`Config`](Config.md) +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) #### Returns -[`Config`](Config.md) +[`NeverminedOptions`](NeverminedOptions.md) #### Inherited from @@ -174,17 +186,17 @@ Instantiable.config #### Defined in -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) --- ### instanceConfig -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) #### Returns -`InstantiableConfig` +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) #### Inherited from @@ -192,17 +204,17 @@ Instantiable.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) --- ### instantiableConfig -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) #### Returns -`InstantiableConfig` +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) #### Inherited from @@ -210,17 +222,17 @@ Instantiable.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) --- ### logger -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) +• `Protected` `get` **logger**(): `Logger` #### Returns -[`Logger`](utils.Logger.md) +`Logger` #### Inherited from @@ -228,7 +240,7 @@ Instantiable.logger #### Defined in -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) --- @@ -246,17 +258,17 @@ Instantiable.nevermined #### Defined in -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) --- ### web3 -• `Protected` `get` **web3**(): `JsonRpcProvider` +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` #### Returns -`JsonRpcProvider` +`JsonRpcProvider` \| `BrowserProvider` #### Inherited from @@ -264,125 +276,39 @@ Instantiable.web3 #### Defined in -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) ## Methods -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -Instantiable.addresses - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - ---- - -### authenticate - -▸ **authenticate**(): `Promise`<`void`\> - -Authenticate the account. - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[src/nevermined.ts:82](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined.ts#L82) - ---- - -### 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](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - ---- - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -Instantiable.findSigner - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - ---- - ### getBalance -▸ **getBalance**(): `Promise`<`default`\> +▸ **getBalance**(): `Promise`<[`Balance`](../interfaces/Balance.md)\> Balances of Ether and Nevermined Token. #### Returns -`Promise`<`default`\> +`Promise`<[`Balance`](../interfaces/Balance.md)\> #### Defined in -[src/nevermined.ts:108](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined.ts#L108) +[src/nevermined/Account.ts:93](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Account.ts#L93) --- ### getEtherBalance -▸ **getEtherBalance**(): `Promise`<`default`\> +▸ **getEtherBalance**(): `Promise`<`bigint`\> Balance of Ether. #### Returns -`Promise`<`default`\> +`Promise`<`bigint`\> #### Defined in -[src/nevermined.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined.ts#L100) +[src/nevermined/Account.ts:85](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Account.ts#L85) --- @@ -396,23 +322,23 @@ Balance of Ether. #### Defined in -[src/nevermined.ts:27](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined.ts#L27) +[src/nevermined/Account.ts:43](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Account.ts#L43) --- ### getNeverminedBalance -▸ **getNeverminedBalance**(): `Promise`<`default`\> +▸ **getNeverminedBalance**(): `Promise`<`bigint`\> Balance of Nevermined Token. #### Returns -`Promise`<`default`\> +`Promise`<`bigint`\> #### Defined in -[src/nevermined.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined.ts#L90) +[src/nevermined/Account.ts:75](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Account.ts#L75) --- @@ -430,7 +356,7 @@ The account password. #### Defined in -[src/nevermined.ts:51](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined.ts#L51) +[src/nevermined/Account.ts:67](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Account.ts#L67) --- @@ -444,58 +370,36 @@ The account password. #### Defined in -[src/nevermined.ts:35](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined.ts#L35) - ---- - -### getToken - -▸ **getToken**(): `Promise`<`string`\> - -Returns account token. - -#### Returns - -`Promise`<`string`\> - -Account token. - -#### Defined in - -[src/nevermined.ts:67](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined.ts#L67) +[src/nevermined/Account.ts:51](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Account.ts#L51) --- -### isTokenStored +### isZeroDev -▸ **isTokenStored**(): `Promise`<`boolean`\> - -Returns if account token is stored. +▸ **isZeroDev**(): `boolean` #### Returns -`Promise`<`boolean`\> - -true if the token is stored. +`boolean` #### Defined in -[src/nevermined.ts:75](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined.ts#L75) +[src/nevermined/Account.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Account.ts#L39) --- ### requestTokens -▸ **requestTokens**(`amount`, `params?`): `Promise`<`string`\> +▸ **requestTokens**(`amount`, `txParams?`): `Promise`<`string`\> Request Nevermined Tokens. #### Parameters -| Name | Type | Description | -| :-------- | :-------------------------------- | :---------------------- | -| `amount` | `string` \| `number` \| `default` | Tokens to be requested. | -| `params?` | `TxParameters` | - | +| Name | Type | Description | +| :---------- | :-------------------------------------------------- | :---------------------- | +| `amount` | [`BigNumberish`](../code-reference.md#bignumberish) | Tokens to be requested. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | #### Returns @@ -503,7 +407,7 @@ Request Nevermined Tokens. #### Defined in -[src/nevermined.ts:120](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined.ts#L120) +[src/nevermined/Account.ts:106](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Account.ts#L106) --- @@ -523,7 +427,7 @@ Request Nevermined Tokens. #### Defined in -[src/nevermined.ts:31](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined.ts#L31) +[src/nevermined/Account.ts:47](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Account.ts#L47) --- @@ -533,9 +437,9 @@ Request Nevermined Tokens. #### Parameters -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -543,11 +447,11 @@ Request Nevermined Tokens. #### Inherited from -Instantiable.setInstanceConfig +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig) #### Defined in -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) --- @@ -569,86 +473,37 @@ Set account password. #### Defined in -[src/nevermined.ts:43](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined.ts#L43) +[src/nevermined/Account.ts:59](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Account.ts#L59) --- -### setToken +### fromZeroDevSigner -▸ **setToken**(`token`): `void` +▸ `Static` **fromZeroDevSigner**(`signer`): `Promise`<[`Account`](Account.md)\> -Set account token. +Returns a nevermined Account from a zerodev signer #### Parameters -| Name | Type | Description | -| :------ | :------- | :----------------- | -| `token` | `string` | Token for account. | +| Name | Type | Description | +| :------- | :--------------------------------- | :----------------------- | +| `signer` | `ZeroDevAccountSigner`<`"ECDSA"`\> | A zerodev account signer | #### Returns -`void` - -#### Defined in - -[src/nevermined.ts:59](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined.ts#L59) - ---- - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -Instantiable.addressesStatic - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - ---- - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from +`Promise`<[`Account`](Account.md)\> -Instantiable.findSignerStatic +The nevermined account #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) +[src/nevermined/Account.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Account.ts#L32) --- ### getInstance -▸ `Static` **getInstance**(...`_args`): `any` +▸ `Static` **getInstance**(`..._args`): `any` #### Parameters @@ -662,11 +517,11 @@ Instantiable.findSignerStatic #### Inherited from -Instantiable.getInstance +[Instantiable](Instantiable.md).[getInstance](Instantiable.md#getinstance) #### Defined in -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L158) +[src/Instantiable.abstract.ts:86](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L86) --- @@ -676,16 +531,16 @@ Instantiable.getInstance #### Type parameters -| Name | Type | -| :--- | :--------------------------- | -| `T` | extends `Instantiable`<`T`\> | +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :------------------- | -| `instance` | `T` | -| `instantiableConfig` | `InstantiableConfig` | +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -693,8 +548,8 @@ Instantiable.getInstance #### Inherited from -Instantiable.setInstanceConfig +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig-1) #### Defined in -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/Accounts.md b/docs/api-reference/classes/Accounts.md deleted file mode 100644 index e4ff6d7bb..000000000 --- a/docs/api-reference/classes/Accounts.md +++ /dev/null @@ -1,489 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / Accounts - -# Class: Accounts - -Account submodule of Nevermined. - -## Hierarchy - -- `Instantiable` - - ↳ **`Accounts`** - -## Table of contents - -### Constructors - -- [constructor](Accounts.md#constructor) - -### Accessors - -- [artifactsFolder](Accounts.md#artifactsfolder) -- [config](Accounts.md#config) -- [instanceConfig](Accounts.md#instanceconfig) -- [instantiableConfig](Accounts.md#instantiableconfig) -- [logger](Accounts.md#logger) -- [nevermined](Accounts.md#nevermined) -- [web3](Accounts.md#web3) - -### Methods - -- [addresses](Accounts.md#addresses) -- [balance](Accounts.md#balance) -- [checkExists](Accounts.md#checkexists) -- [findSigner](Accounts.md#findsigner) -- [list](Accounts.md#list) -- [requestEthFromFaucet](Accounts.md#requestethfromfaucet) -- [requestList](Accounts.md#requestlist) -- [requestTokens](Accounts.md#requesttokens) -- [setInstanceConfig](Accounts.md#setinstanceconfig) -- [addressesStatic](Accounts.md#addressesstatic) -- [findSignerStatic](Accounts.md#findsignerstatic) -- [getInstance](Accounts.md#getinstance) -- [setInstanceConfig](Accounts.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new Accounts**() - -#### Inherited from - -Instantiable.constructor - -## Accessors - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -Instantiable.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - ---- - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -Instantiable.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - ---- - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -Instantiable.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - ---- - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -Instantiable.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - ---- - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -Instantiable.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - ---- - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -Instantiable.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - ---- - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -Instantiable.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -Instantiable.addresses - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - ---- - -### balance - -▸ **balance**(`account`): `Promise`<`default`\> - -Return account balance. - -#### Parameters - -| Name | Type | Description | -| :-------- | :---------------------- | :---------------- | -| `account` | [`Account`](Account.md) | Account instance. | - -#### Returns - -`Promise`<`default`\> - -Ether and Nevermined Token balance. - -#### Defined in - -[src/nevermineds.ts:47](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermineds.ts#L47) - ---- - -### 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](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - ---- - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -Instantiable.findSigner - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - ---- - -### list - -▸ **list**(): `Promise`<[`Account`](Account.md)[]\> - -Returns the list of accounts. - -#### Returns - -`Promise`<[`Account`](Account.md)[]\> - -The list of accounts. - -#### Defined in - -[src/nevermineds.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermineds.ts#L26) - ---- - -### requestEthFromFaucet - -▸ **requestEthFromFaucet**(`address`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :-------- | :------- | -| `address` | `string` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -[src/nevermineds.ts:70](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermineds.ts#L70) - ---- - -### requestList - -▸ **requestList**(): `Promise`<[`Account`](Account.md)[]\> - -Returns the list of accounts including the addresses not controlled by the node, -only can be used by providers like metamask, Status or Trustwallet but not by default -provider - -#### Returns - -`Promise`<[`Account`](Account.md)[]\> - -#### Defined in - -[src/nevermineds.ts:38](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermineds.ts#L38) - ---- - -### requestTokens - -▸ **requestTokens**(`account`, `amount`, `params?`): `Promise`<`boolean`\> - -Request tokens for an account. - -#### Parameters - -| Name | Type | Description | -| :-------- | :---------------------- | :---------------- | -| `account` | [`Account`](Account.md) | Account instance. | -| `amount` | `number` | Token amount. | -| `params?` | `TxParameters` | - | - -#### Returns - -`Promise`<`boolean`\> - -true if the call was successful. false otherwise. - -#### Defined in - -[src/nevermineds.ts:57](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermineds.ts#L57) - ---- - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -Instantiable.setInstanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - ---- - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -Instantiable.addressesStatic - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - ---- - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -Instantiable.findSignerStatic - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - ---- - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`Accounts`](Accounts.md)\> - -Returns the instance of Accounts. - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`Accounts`](Accounts.md)\> - -[Accounts](Accounts.md) - -#### Overrides - -Instantiable.getInstance - -#### Defined in - -[src/nevermineds.ts:14](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermineds.ts#L14) - ---- - -### 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 - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/api-reference/classes/AccountsApi.md b/docs/api-reference/classes/AccountsApi.md new file mode 100644 index 000000000..baeb7cfd0 --- /dev/null +++ b/docs/api-reference/classes/AccountsApi.md @@ -0,0 +1,434 @@ +[@nevermined-io/sdk](../code-reference.md) / AccountsApi + +# Class: AccountsApi + +Nevermined Accounts API. It allows execute operations related with Ethereum accounts. + +## Hierarchy + +- [`Instantiable`](Instantiable.md) + + ↳ **`AccountsApi`** + +## Table of contents + +### Constructors + +- [constructor](AccountsApi.md#constructor) + +### Accessors + +- [artifactsFolder](AccountsApi.md#artifactsfolder) +- [circuitsFolder](AccountsApi.md#circuitsfolder) +- [config](AccountsApi.md#config) +- [instanceConfig](AccountsApi.md#instanceconfig) +- [instantiableConfig](AccountsApi.md#instantiableconfig) +- [logger](AccountsApi.md#logger) +- [nevermined](AccountsApi.md#nevermined) +- [web3](AccountsApi.md#web3) + +### Methods + +- [addresses](AccountsApi.md#addresses) +- [balance](AccountsApi.md#balance) +- [findSigner](AccountsApi.md#findsigner) +- [findSignerStatic](AccountsApi.md#findsignerstatic) +- [getAccount](AccountsApi.md#getaccount) +- [list](AccountsApi.md#list) +- [requestTokens](AccountsApi.md#requesttokens) +- [setInstanceConfig](AccountsApi.md#setinstanceconfig) +- [getInstance](AccountsApi.md#getinstance) +- [setInstanceConfig](AccountsApi.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new AccountsApi**(`config`) + +Creates a new AccountsApi + +#### Parameters + +| Name | Type | Description | +| :------- | :---------------------------------------------------------- | :--------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | Configuration of the Nevermined instance | + +#### Overrides + +[Instantiable](Instantiable.md).[constructor](Instantiable.md#constructor) + +#### Defined in + +[src/nevermined/api/AccountsApi.ts:16](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AccountsApi.ts#L16) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +Instantiable.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +Instantiable.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +Instantiable.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +Instantiable.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### addresses + +▸ **addresses**(): `Promise`<`string`[]\> + +#### Returns + +`Promise`<`string`[]\> + +#### Defined in + +[src/nevermined/api/AccountsApi.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AccountsApi.ts#L90) + +--- + +### balance + +▸ **balance**(`account`): `Promise`<[`Balance`](../interfaces/Balance.md)\> + +Return account balance. + +#### Parameters + +| Name | Type | Description | +| :-------- | :---------------------- | :---------------- | +| `account` | [`Account`](Account.md) | Account instance. | + +#### Returns + +`Promise`<[`Balance`](../interfaces/Balance.md)\> + +Ether and Nevermined Token balance. + +#### Defined in + +[src/nevermined/api/AccountsApi.ts:46](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AccountsApi.ts#L46) + +--- + +### findSigner + +▸ **findSigner**(`from`): `Promise`<`Signer`\> + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `from` | `string` | + +#### Returns + +`Promise`<`Signer`\> + +#### Defined in + +[src/nevermined/api/AccountsApi.ts:70](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AccountsApi.ts#L70) + +--- + +### findSignerStatic + +▸ **findSignerStatic**(`from`): `Promise`<`Signer`\> + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `from` | `string` | + +#### Returns + +`Promise`<`Signer`\> + +#### Defined in + +[src/nevermined/api/AccountsApi.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AccountsApi.ts#L80) + +--- + +### getAccount + +▸ **getAccount**(`address`): [`Account`](Account.md) + +Returns an account initialized with existing web3 provider + +#### Parameters + +| Name | Type | Description | +| :-------- | :------- | :------------------ | +| `address` | `string` | The account address | + +#### Returns + +[`Account`](Account.md) + +The account + +#### Defined in + +[src/nevermined/api/AccountsApi.ts:37](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AccountsApi.ts#L37) + +--- + +### list + +▸ **list**(): `Promise`<[`Account`](Account.md)[]\> + +Returns the list of accounts including the addresses not controlled by the node, +only can be used by providers like metamask, Status or Trustwallet but not by default +provider + +#### Returns + +`Promise`<[`Account`](Account.md)[]\> + +The list of accounts. + +#### Defined in + +[src/nevermined/api/AccountsApi.ts:27](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AccountsApi.ts#L27) + +--- + +### requestTokens + +▸ **requestTokens**(`account`, `amount`, `params?`): `Promise`<`boolean`\> + +Request tokens for an account. + +#### Parameters + +| Name | Type | Description | +| :-------- | :---------------------------------------------- | :---------------- | +| `account` | [`Account`](Account.md) | Account instance. | +| `amount` | `number` | Token amount. | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | - | + +#### Returns + +`Promise`<`boolean`\> + +true if the call was successful. false otherwise. + +#### Defined in + +[src/nevermined/api/AccountsApi.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AccountsApi.ts#L57) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### getInstance + +▸ `Static` **getInstance**(`..._args`): `any` + +#### Parameters + +| Name | Type | +| :--------- | :---- | +| `..._args` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[Instantiable](Instantiable.md).[getInstance](Instantiable.md#getinstance) + +#### Defined in + +[src/Instantiable.abstract.ts:86](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L86) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/AgreementStoreManager.md b/docs/api-reference/classes/AgreementStoreManager.md new file mode 100644 index 000000000..572644364 --- /dev/null +++ b/docs/api-reference/classes/AgreementStoreManager.md @@ -0,0 +1,705 @@ +[@nevermined-io/sdk](../code-reference.md) / AgreementStoreManager + +# Class: AgreementStoreManager + +## Hierarchy + +- [`ContractBase`](ContractBase.md) + + ↳ **`AgreementStoreManager`** + +## Table of contents + +### Constructors + +- [constructor](AgreementStoreManager.md#constructor) + +### Properties + +- [address](AgreementStoreManager.md#address) +- [contract](AgreementStoreManager.md#contract) +- [contractName](AgreementStoreManager.md#contractname) +- [events](AgreementStoreManager.md#events) +- [templates](AgreementStoreManager.md#templates) +- [version](AgreementStoreManager.md#version) + +### Accessors + +- [artifactsFolder](AgreementStoreManager.md#artifactsfolder) +- [circuitsFolder](AgreementStoreManager.md#circuitsfolder) +- [config](AgreementStoreManager.md#config) +- [instanceConfig](AgreementStoreManager.md#instanceconfig) +- [instantiableConfig](AgreementStoreManager.md#instantiableconfig) +- [logger](AgreementStoreManager.md#logger) +- [nevermined](AgreementStoreManager.md#nevermined) +- [web3](AgreementStoreManager.md#web3) + +### Methods + +- [addTemplate](AgreementStoreManager.md#addtemplate) +- [agreementId](AgreementStoreManager.md#agreementid) +- [call](AgreementStoreManager.md#call) +- [createAgreement](AgreementStoreManager.md#createagreement) +- [getAgreement](AgreementStoreManager.md#getagreement) +- [getAgreements](AgreementStoreManager.md#getagreements) +- [getFromAddress](AgreementStoreManager.md#getfromaddress) +- [getInputsOfMethod](AgreementStoreManager.md#getinputsofmethod) +- [getOwner](AgreementStoreManager.md#getowner) +- [getSignatureOfMethod](AgreementStoreManager.md#getsignatureofmethod) +- [init](AgreementStoreManager.md#init) +- [send](AgreementStoreManager.md#send) +- [sendFrom](AgreementStoreManager.md#sendfrom) +- [setInstanceConfig](AgreementStoreManager.md#setinstanceconfig) +- [setTemplates](AgreementStoreManager.md#settemplates) +- [getInstance](AgreementStoreManager.md#getinstance) +- [setInstanceConfig](AgreementStoreManager.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new AgreementStoreManager**(`contractName`) + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Inherited from + +[ContractBase](ContractBase.md).[constructor](ContractBase.md#constructor) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L34) + +## Properties + +### address + +• **address**: `string` + +#### Inherited from + +[ContractBase](ContractBase.md).[address](ContractBase.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[ContractBase](ContractBase.md).[contract](ContractBase.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[ContractBase](ContractBase.md).[contractName](ContractBase.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[ContractBase](ContractBase.md).[events](ContractBase.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### templates + +• **templates**: `any` + +#### Defined in + +[src/keeper/contracts/managers/AgreementStoreManager.ts:19](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/AgreementStoreManager.ts#L19) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[ContractBase](ContractBase.md).[version](ContractBase.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ContractBase.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ContractBase.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +ContractBase.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ContractBase.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ContractBase.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +ContractBase.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +ContractBase.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +ContractBase.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### addTemplate + +▸ **addTemplate**(`name`, `obj`): `void` + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `name` | `string` | +| `obj` | `any` | + +#### Returns + +`void` + +#### Defined in + +[src/keeper/contracts/managers/AgreementStoreManager.ts:33](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/AgreementStoreManager.ts#L33) + +--- + +### agreementId + +▸ **agreementId**(`agreementIdSeed`, `creator`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :---------------- | :------- | +| `agreementIdSeed` | `string` | +| `creator` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/keeper/contracts/managers/AgreementStoreManager.ts:76](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/AgreementStoreManager.ts#L76) + +--- + +### 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](ContractBase.md).[call](ContractBase.md#call) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### createAgreement + +▸ **createAgreement**(`agreementId`, `did`, `conditionTypes`, `conditionIds`, `timeLocks`, `timeOuts`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :--------------- | :---------------------------------------------- | +| `agreementId` | `string` | +| `did` | `string` | +| `conditionTypes` | `string`[] | +| `conditionIds` | `string`[] | +| `timeLocks` | `number`[] | +| `timeOuts` | `number`[] | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Defined in + +[src/keeper/contracts/managers/AgreementStoreManager.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/AgreementStoreManager.ts#L80) + +--- + +### getAgreement + +▸ **getAgreement**(`agreementId`): `Promise`<[`AgreementData`](../interfaces/AgreementData.md)\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | + +#### Returns + +`Promise`<[`AgreementData`](../interfaces/AgreementData.md)\> + +#### Defined in + +[src/keeper/contracts/managers/AgreementStoreManager.ts:41](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/AgreementStoreManager.ts#L41) + +--- + +### getAgreements + +▸ **getAgreements**(`did`): `Promise`<[`AgreementData`](../interfaces/AgreementData.md)[]\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `did` | `string` | + +#### Returns + +`Promise`<[`AgreementData`](../interfaces/AgreementData.md)[]\> + +#### Defined in + +[src/keeper/contracts/managers/AgreementStoreManager.ts:68](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/AgreementStoreManager.ts#L68) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ContractBase](ContractBase.md).[getFromAddress](ContractBase.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[ContractBase](ContractBase.md).[getInputsOfMethod](ContractBase.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getOwner + +▸ **getOwner**(): `Promise`<`string`\> + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/keeper/contracts/managers/AgreementStoreManager.ts:37](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/AgreementStoreManager.ts#L37) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[ContractBase](ContractBase.md).[getSignatureOfMethod](ContractBase.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[ContractBase](ContractBase.md).[init](ContractBase.md#init) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ContractBase](ContractBase.md).[send](ContractBase.md#send) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ContractBase](ContractBase.md).[sendFrom](ContractBase.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ContractBase](ContractBase.md).[setInstanceConfig](ContractBase.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### setTemplates + +▸ **setTemplates**(`temp`): `void` + +#### Parameters + +| Name | Type | +| :----- | :---- | +| `temp` | `any` | + +#### Returns + +`void` + +#### Defined in + +[src/keeper/contracts/managers/AgreementStoreManager.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/AgreementStoreManager.ts#L29) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`): `Promise`<[`AgreementStoreManager`](AgreementStoreManager.md)\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`Promise`<[`AgreementStoreManager`](AgreementStoreManager.md)\> + +#### Overrides + +[ContractBase](ContractBase.md).[getInstance](ContractBase.md#getinstance) + +#### Defined in + +[src/keeper/contracts/managers/AgreementStoreManager.ts:21](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/AgreementStoreManager.ts#L21) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ContractBase](ContractBase.md).[setInstanceConfig](ContractBase.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/AgreementTemplate.md b/docs/api-reference/classes/AgreementTemplate.md index d0763ac37..9686c168e 100644 --- a/docs/api-reference/classes/AgreementTemplate.md +++ b/docs/api-reference/classes/AgreementTemplate.md @@ -10,11 +10,11 @@ ## Hierarchy -- `ContractBase` +- [`ContractBase`](ContractBase.md) ↳ **`AgreementTemplate`** - ↳↳ [`BaseTemplate`](templates.BaseTemplate.md) + ↳↳ [`BaseTemplate`](BaseTemplate.md) ## Table of contents @@ -24,6 +24,9 @@ ### Properties +- [\_conditionTypes](AgreementTemplate.md#_conditiontypes) +- [\_conditions](AgreementTemplate.md#_conditions) +- [address](AgreementTemplate.md#address) - [contract](AgreementTemplate.md#contract) - [contractName](AgreementTemplate.md#contractname) - [events](AgreementTemplate.md#events) @@ -31,8 +34,8 @@ ### Accessors -- [address](AgreementTemplate.md#address) - [artifactsFolder](AgreementTemplate.md#artifactsfolder) +- [circuitsFolder](AgreementTemplate.md#circuitsfolder) - [config](AgreementTemplate.md#config) - [instanceConfig](AgreementTemplate.md#instanceconfig) - [instantiableConfig](AgreementTemplate.md#instantiableconfig) @@ -42,23 +45,18 @@ ### Methods -- [addresses](AgreementTemplate.md#addresses) - [agreementId](AgreementTemplate.md#agreementid) - [call](AgreementTemplate.md#call) -- [checkExists](AgreementTemplate.md#checkexists) - [createAgreement](AgreementTemplate.md#createagreement) - [createAgreementAndPay](AgreementTemplate.md#createagreementandpay) - [createAgreementFromDDO](AgreementTemplate.md#createagreementfromddo) - [createAgreementWithPaymentFromDDO](AgreementTemplate.md#createagreementwithpaymentfromddo) -- [findSigner](AgreementTemplate.md#findsigner) -- [getAddress](AgreementTemplate.md#getaddress) - [getAgreementCreatedEvent](AgreementTemplate.md#getagreementcreatedevent) - [getAgreementIdsFromDDO](AgreementTemplate.md#getagreementidsfromddo) - [getAgreementStatus](AgreementTemplate.md#getagreementstatus) - [getAgreementsForDID](AgreementTemplate.md#getagreementsfordid) - [getConditionTypes](AgreementTemplate.md#getconditiontypes) - [getConditions](AgreementTemplate.md#getconditions) -- [getContract](AgreementTemplate.md#getcontract) - [getFromAddress](AgreementTemplate.md#getfromaddress) - [getInputsOfMethod](AgreementTemplate.md#getinputsofmethod) - [getServiceAgreementTemplate](AgreementTemplate.md#getserviceagreementtemplate) @@ -78,8 +76,6 @@ - [service](AgreementTemplate.md#service) - [setInstanceConfig](AgreementTemplate.md#setinstanceconfig) - [standardContext](AgreementTemplate.md#standardcontext) -- [addressesStatic](AgreementTemplate.md#addressesstatic) -- [findSignerStatic](AgreementTemplate.md#findsignerstatic) - [getInstance](AgreementTemplate.md#getinstance) - [setInstanceConfig](AgreementTemplate.md#setinstanceconfig-1) @@ -103,53 +99,87 @@ #### Overrides -ContractBase.constructor +[ContractBase](ContractBase.md).[constructor](ContractBase.md#constructor) #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:75](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L75) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:68](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L68) ## Properties +### \_conditionTypes + +• `Private` **\_conditionTypes**: `string`[] + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:52](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L52) + +--- + +### \_conditions + +• `Private` **\_conditions**: [`ConditionSmall`](ConditionSmall.md)[] + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:53](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L53) + +--- + +### address + +• **address**: `string` + +#### Inherited from + +[ContractBase](ContractBase.md).[address](ContractBase.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + ### contract -• **contract**: `Contract` = `null` +• **contract**: `BaseContract` = `null` #### Inherited from -ContractBase.contract +[ContractBase](ContractBase.md).[contract](ContractBase.md#contract) #### Defined in -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) --- ### contractName -• **contractName**: `string` +• `Readonly` **contractName**: `string` #### Inherited from -ContractBase.contractName +[ContractBase](ContractBase.md).[contractName](ContractBase.md#contractname) #### Defined in -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) --- ### events -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` #### Inherited from -ContractBase.events +[ContractBase](ContractBase.md).[events](ContractBase.md#events) #### Defined in -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) --- @@ -159,17 +189,17 @@ ContractBase.events #### Inherited from -ContractBase.version +[ContractBase](ContractBase.md).[version](ContractBase.md#version) #### Defined in -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) ## Accessors -### address +### artifactsFolder -• `get` **address**(): `string` +• `Protected` `get` **artifactsFolder**(): `string` #### Returns @@ -177,17 +207,17 @@ ContractBase.version #### Inherited from -ContractBase.address +ContractBase.artifactsFolder #### Defined in -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) --- -### artifactsFolder +### circuitsFolder -• `Protected` `get` **artifactsFolder**(): `string` +• `Protected` `get` **circuitsFolder**(): `string` #### Returns @@ -195,21 +225,21 @@ ContractBase.address #### Inherited from -ContractBase.artifactsFolder +ContractBase.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) --- ### config -• `Protected` `get` **config**(): [`Config`](Config.md) +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) #### Returns -[`Config`](Config.md) +[`NeverminedOptions`](NeverminedOptions.md) #### Inherited from @@ -217,17 +247,17 @@ ContractBase.config #### Defined in -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) --- ### instanceConfig -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) #### Returns -`InstantiableConfig` +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) #### Inherited from @@ -235,17 +265,17 @@ ContractBase.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) --- ### instantiableConfig -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) #### Returns -`InstantiableConfig` +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) #### Inherited from @@ -253,17 +283,17 @@ ContractBase.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) --- ### logger -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) +• `Protected` `get` **logger**(): `Logger` #### Returns -[`Logger`](utils.Logger.md) +`Logger` #### Inherited from @@ -271,7 +301,7 @@ ContractBase.logger #### Defined in -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) --- @@ -289,17 +319,17 @@ ContractBase.nevermined #### Defined in -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) --- ### web3 -• `Protected` `get` **web3**(): `JsonRpcProvider` +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` #### Returns -`JsonRpcProvider` +`JsonRpcProvider` \| `BrowserProvider` #### Inherited from @@ -307,28 +337,10 @@ ContractBase.web3 #### Defined in -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) ## Methods -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -ContractBase.addresses - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - ---- - ### agreementId ▸ **agreementId**(`agreementIdSeed`, `creator`): `Promise`<`string`\> @@ -346,7 +358,7 @@ ContractBase.addresses #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:213](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L213) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:213](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L213) --- @@ -374,118 +386,90 @@ ContractBase.addresses #### Inherited from -ContractBase.call +[ContractBase](ContractBase.md).[call](ContractBase.md#call) #### Defined in -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - ---- - -### 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](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) --- ### createAgreement -▸ **createAgreement**(`agreementId`, `did`, `conditionIds`, `timeLocks`, `timeOuts`, `extraArgs`, `from?`, `params?`): `Promise`<`ContractReceipt`\> +▸ **createAgreement**(`agreementId`, `did`, `conditionIds`, `timeLocks`, `timeOuts`, `extraArgs`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> #### Parameters -| Name | Type | -| :------------- | :---------------------- | -| `agreementId` | `string` | -| `did` | `string` | -| `conditionIds` | `string`[] | -| `timeLocks` | `number`[] | -| `timeOuts` | `number`[] | -| `extraArgs` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | +| Name | Type | +| :------------- | :---------------------------------------------- | +| `agreementId` | `string` | +| `did` | `string` | +| `conditionIds` | `string`[] | +| `timeLocks` | `number`[] | +| `timeOuts` | `number`[] | +| `extraArgs` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns -`Promise`<`ContractReceipt`\> +`Promise`<`ContractTransactionReceipt`\> #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L99) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L90) --- ### createAgreementAndPay -▸ **createAgreementAndPay**(`agreementId`, `did`, `conditionIds`, `timeLocks`, `timeOuts`, `accessConsumer`, `condIdx`, `rewardAddress`, `tokenAddress`, `amounts`, `receivers`, `from?`, `params?`): `Promise`<`ContractReceipt`\> +▸ **createAgreementAndPay**(`agreementId`, `did`, `conditionIds`, `timeLocks`, `timeOuts`, `accessConsumer`, `condIdx`, `rewardAddress`, `tokenAddress`, `amounts`, `receivers`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> #### 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`](Account.md) | -| `params?` | `TxParameters` | +| Name | Type | +| :--------------- | :---------------------------------------------- | +| `agreementId` | `string` | +| `did` | `string` | +| `conditionIds` | `string`[] | +| `timeLocks` | `number`[] | +| `timeOuts` | `number`[] | +| `accessConsumer` | `string` | +| `condIdx` | `number` | +| `rewardAddress` | `string` | +| `tokenAddress` | `string` | +| `amounts` | `bigint`[] | +| `receivers` | `string`[] | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns -`Promise`<`ContractReceipt`\> +`Promise`<`ContractTransactionReceipt`\> #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:124](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L124) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L115) --- ### createAgreementFromDDO -▸ **createAgreementFromDDO**(`agreementIdSeed`, `ddo`, `parameters`, `consumer`, `from`, `timeOuts?`, `params?`): `Promise`<`string`\> +▸ **createAgreementFromDDO**(`agreementIdSeed`, `ddo`, `parameters`, `consumer`, `from`, `timeOuts?`, `txParams?`): `Promise`<`string`\> Create a new agreement using the data of a DDO. #### Parameters -| Name | Type | Description | -| :---------------- | :---------------------- | :---------- | -| `agreementIdSeed` | `string` | - | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `parameters` | `Params` | | -| `consumer` | [`Account`](Account.md) | - | -| `from` | [`Account`](Account.md) | - | -| `timeOuts?` | `number`[] | - | -| `params?` | `TxParameters` | - | +| Name | Type | Description | +| :---------------- | :---------------------------------------------- | :---------- | +| `agreementIdSeed` | `string` | - | +| `ddo` | [`DDO`](DDO.md) | DDO. | +| `parameters` | `Params` | | +| `consumer` | [`Account`](Account.md) | - | +| `from` | [`Account`](Account.md) | - | +| `timeOuts?` | `number`[] | - | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | #### Returns @@ -495,26 +479,26 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:225](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L225) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:222](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L222) --- ### createAgreementWithPaymentFromDDO -▸ **createAgreementWithPaymentFromDDO**(`agreementIdSeed`, `ddo`, `parameters`, `consumer`, `from`, `timeOuts?`, `txParams?`, `observer?`): `Promise`<`string`\> +▸ **createAgreementWithPaymentFromDDO**(`agreementIdSeed`, `ddo`, `serviceReference`, `parameters`, `consumer`, `from`, `txParams?`, `observer?`): `Promise`<`string`\> #### Parameters -| Name | Type | -| :---------------- | :------------------------------------- | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `parameters` | `Params` | -| `consumer` | [`Account`](Account.md) | -| `from` | [`Account`](Account.md) | -| `timeOuts?` | `number`[] | -| `txParams?` | `TxParameters` | -| `observer?` | (`OrderProgressStep`: `any`) => `void` | +| Name | Type | +| :----------------- | :------------------------------------------------------------------------------------ | +| `agreementIdSeed` | `string` | +| `ddo` | [`DDO`](DDO.md) | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | +| `parameters` | `Params` | +| `consumer` | [`Account`](Account.md) | +| `from` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| `observer?` | (`orderProgressStep`: [`OrderProgressStep`](../enums/OrderProgressStep.md)) => `void` | #### Returns @@ -522,49 +506,7 @@ true if the call was successful. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:255](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L255) - ---- - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -ContractBase.findSigner - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - ---- - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ContractBase.getAddress - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:252](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L252) --- @@ -588,7 +530,7 @@ Agreement created event. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:469](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L469) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:459](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L459) --- @@ -615,13 +557,13 @@ The condition IDs. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:183](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L183) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:180](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L180) --- ### getAgreementStatus -▸ **getAgreementStatus**(`agreementId`): `Promise`<`false` \| [`AgreementConditionsStatus`](../interfaces/templates.AgreementConditionsStatus.md)\> +▸ **getAgreementStatus**(`agreementId`): `Promise`<`false` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> Returns the status of the conditions. @@ -633,13 +575,13 @@ Returns the status of the conditions. #### Returns -`Promise`<`false` \| [`AgreementConditionsStatus`](../interfaces/templates.AgreementConditionsStatus.md)\> +`Promise`<`false` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> The conditions status. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:343](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L343) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:346](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L346) --- @@ -659,7 +601,7 @@ The conditions status. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:496](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L496) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:485](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L485) --- @@ -677,43 +619,25 @@ A list of condition addresses. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:163](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L163) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L154) --- ### getConditions -▸ **getConditions**(): `Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)[]\> +▸ **getConditions**(): `Promise`<[`ConditionSmall`](ConditionSmall.md)[]\> List of condition contracts. #### Returns -`Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)[]\> +`Promise`<[`ConditionSmall`](ConditionSmall.md)[]\> A list of condition contracts. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L171) - ---- - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -ContractBase.getContract - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:165](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L165) --- @@ -733,17 +657,17 @@ ContractBase.getContract #### Inherited from -ContractBase.getFromAddress +[ContractBase](ContractBase.md).[getFromAddress](ContractBase.md#getfromaddress) #### Defined in -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) --- ### getInputsOfMethod -▸ **getInputsOfMethod**(`methodName`): `any`[] +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] #### Parameters @@ -753,35 +677,35 @@ ContractBase.getFromAddress #### Returns -`any`[] +readonly `ParamType`[] #### Inherited from -ContractBase.getInputsOfMethod +[ContractBase](ContractBase.md).[getInputsOfMethod](ContractBase.md#getinputsofmethod) #### Defined in -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) --- ### getServiceAgreementTemplate -▸ `Abstract` **getServiceAgreementTemplate**(): `Promise`<`ServiceAgreementTemplate`\> +▸ `Abstract` **getServiceAgreementTemplate**(): [`ServiceAgreementTemplate`](../interfaces/ServiceAgreementTemplate.md) #### Returns -`Promise`<`ServiceAgreementTemplate`\> +[`ServiceAgreementTemplate`](../interfaces/ServiceAgreementTemplate.md) #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:317](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L317) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:322](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L322) --- ### getServiceAgreementTemplateConditionByRef -▸ **getServiceAgreementTemplateConditionByRef**(`ref`): `Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)\> +▸ **getServiceAgreementTemplateConditionByRef**(`ref`): `Promise`<[`ConditionSmall`](ConditionSmall.md)\> #### Parameters @@ -791,25 +715,25 @@ ContractBase.getInputsOfMethod #### Returns -`Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)\> +`Promise`<[`ConditionSmall`](ConditionSmall.md)\> #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:324](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L324) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:329](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L329) --- ### getServiceAgreementTemplateConditions -▸ **getServiceAgreementTemplateConditions**(): `Promise`<`ServiceAgreementTemplateCondition`[]\> +▸ **getServiceAgreementTemplateConditions**(): [`ServiceAgreementTemplateCondition`](../interfaces/ServiceAgreementTemplateCondition.md)[] #### Returns -`Promise`<`ServiceAgreementTemplateCondition`[]\> +[`ServiceAgreementTemplateCondition`](../interfaces/ServiceAgreementTemplateCondition.md)[] #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:319](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L319) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:324](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L324) --- @@ -823,7 +747,7 @@ ContractBase.getInputsOfMethod #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:333](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L333) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:336](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L336) --- @@ -844,11 +768,11 @@ ContractBase.getInputsOfMethod #### Inherited from -ContractBase.getSignatureOfMethod +[ContractBase](ContractBase.md).[getSignatureOfMethod](ContractBase.md#getsignatureofmethod) #### Defined in -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) --- @@ -858,10 +782,10 @@ ContractBase.getSignatureOfMethod #### Parameters -| Name | Type | Default value | -| :--------- | :------------------- | :------------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | #### Returns @@ -869,17 +793,17 @@ ContractBase.getSignatureOfMethod #### Inherited from -ContractBase.init +[ContractBase](ContractBase.md).[init](ContractBase.md#init) #### Defined in -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) --- ### instanceFromDDO -▸ `Optional` `Abstract` **instanceFromDDO**(`agreementIdSeed`, `ddo`, `creator`, `parameters`): `Promise`<[`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`Params`\>\> +▸ `Optional` `Abstract` **instanceFromDDO**(`agreementIdSeed`, `ddo`, `creator`, `parameters`, `serviceIndex?`): `Promise`<[`AgreementInstance`](../interfaces/AgreementInstance.md)<`Params`\>\> #### Parameters @@ -889,14 +813,15 @@ ContractBase.init | `ddo` | [`DDO`](DDO.md) | | `creator` | `string` | | `parameters` | `Params` | +| `serviceIndex?` | `number` | #### Returns -`Promise`<[`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`Params`\>\> +`Promise`<[`AgreementInstance`](../interfaces/AgreementInstance.md)<`Params`\>\> #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:198](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L198) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:190](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L190) --- @@ -910,7 +835,7 @@ ContractBase.init #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L81) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:74](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L74) --- @@ -920,12 +845,12 @@ ContractBase.init #### Parameters -| Name | Type | -| :------------- | :---------------------- | -| `tokenAddress` | `any` | -| `amounts` | `any` | -| `from` | [`Account`](Account.md) | -| `txParams` | `TxParameters` | +| Name | Type | +| :------------- | :---------------------------------------------- | +| `tokenAddress` | `any` | +| `amounts` | `any` | +| `from` | [`Account`](Account.md) | +| `txParams` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns @@ -933,13 +858,13 @@ ContractBase.init #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:398](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L398) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:393](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L393) --- ### params -▸ `Abstract` **params**(...`args`): `Params` +▸ `Abstract` **params**(`...args`): `Params` #### Parameters @@ -953,27 +878,27 @@ ContractBase.init #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L79) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:72](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L72) --- ### paymentData -▸ **paymentData**(`service`): [`PaymentData`](../interfaces/templates.PaymentData.md) +▸ **paymentData**(`service`): `Promise`<[`PaymentData`](../interfaces/PaymentData.md)\> #### Parameters -| Name | Type | -| :-------- | :-------------- | -| `service` | `ServiceCommon` | +| Name | Type | +| :-------- | :------------------------------------------------ | +| `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | #### Returns -[`PaymentData`](../interfaces/templates.PaymentData.md) +`Promise`<[`PaymentData`](../interfaces/PaymentData.md)\> #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:85](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L85) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:78](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L78) --- @@ -995,75 +920,75 @@ Prints the agreement status. #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:439](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L439) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:429](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L429) --- ### send -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> #### Parameters -| Name | Type | -| :------- | :------------- | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns -`Promise`<`ContractReceipt`\> +`Promise`<`ContractTransactionReceipt`\> #### Inherited from -ContractBase.send +[ContractBase](ContractBase.md).[send](ContractBase.md#send) #### Defined in -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) --- ### sendFrom -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> #### Parameters -| Name | Type | -| :------- | :---------------------- | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns -`Promise`<`ContractReceipt`\> +`Promise`<`ContractTransactionReceipt`\> #### Inherited from -ContractBase.sendFrom +[ContractBase](ContractBase.md).[sendFrom](ContractBase.md#sendfrom) #### Defined in -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) --- ### service -▸ `Abstract` **service**(): `ServiceType` +▸ `Abstract` **service**(): [`ServiceType`](../code-reference.md#servicetype) #### Returns -`ServiceType` +[`ServiceType`](../code-reference.md#servicetype) #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:205](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L205) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:198](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L198) --- @@ -1073,9 +998,9 @@ ContractBase.sendFrom #### Parameters -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1083,83 +1008,33 @@ ContractBase.sendFrom #### Inherited from -ContractBase.setInstanceConfig +[ContractBase](ContractBase.md).[setInstanceConfig](ContractBase.md#setinstanceconfig) #### Defined in -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) --- ### standardContext -▸ **standardContext**(`ddo`, `creator`): [`ConditionContext`](../interfaces/conditions.ConditionContext.md) - -#### Parameters - -| Name | Type | -| :-------- | :-------------- | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | - -#### Returns - -[`ConditionContext`](../interfaces/conditions.ConditionContext.md) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:207](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L207) - ---- - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> +▸ **standardContext**(`ddo`, `creator`, `serviceIndex?`): [`ConditionContext`](../interfaces/ConditionContext.md) #### Parameters -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | +| Name | Type | +| :-------------- | :-------------- | +| `ddo` | [`DDO`](DDO.md) | +| `creator` | `string` | +| `serviceIndex?` | `number` | #### Returns -`Promise`<`string`[]\> - -#### Inherited from - -ContractBase.addressesStatic - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - ---- - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -ContractBase.findSignerStatic +[`ConditionContext`](../interfaces/ConditionContext.md) #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:200](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L200) --- @@ -1175,12 +1050,12 @@ ContractBase.findSignerStatic #### Parameters -| Name | Type | Default value | -| :--------------------- | :------------------- | :------------ | -| `config` | `InstantiableConfig` | `undefined` | -| `templateContractName` | `string` | `undefined` | -| `templateClass` | `any` | `undefined` | -| `optional` | `boolean` | `false` | +| Name | Type | Default value | +| :--------------------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `templateContractName` | `string` | `undefined` | +| `templateClass` | `any` | `undefined` | +| `optional` | `boolean` | `false` | #### Returns @@ -1188,11 +1063,11 @@ ContractBase.findSignerStatic #### Overrides -ContractBase.getInstance +[ContractBase](ContractBase.md).[getInstance](ContractBase.md#getinstance) #### Defined in -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:62](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L62) +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:55](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L55) --- @@ -1202,16 +1077,16 @@ ContractBase.getInstance #### Type parameters -| Name | Type | -| :--- | :--------------------------- | -| `T` | extends `Instantiable`<`T`\> | +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :------------------- | -| `instance` | `T` | -| `instantiableConfig` | `InstantiableConfig` | +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1219,8 +1094,8 @@ ContractBase.getInstance #### Inherited from -ContractBase.setInstanceConfig +[ContractBase](ContractBase.md).[setInstanceConfig](ContractBase.md#setinstanceconfig-1) #### Defined in -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/AgreementsApi.md b/docs/api-reference/classes/AgreementsApi.md new file mode 100644 index 000000000..7a5cac352 --- /dev/null +++ b/docs/api-reference/classes/AgreementsApi.md @@ -0,0 +1,462 @@ +[@nevermined-io/sdk](../code-reference.md) / AgreementsApi + +# Class: AgreementsApi + +Nevermined Agreements API. It allows the integration with Nevermined Service Execution Agreements + +## Hierarchy + +- [`Instantiable`](Instantiable.md) + + ↳ **`AgreementsApi`** + +## Table of contents + +### Constructors + +- [constructor](AgreementsApi.md#constructor) + +### Properties + +- [conditions](AgreementsApi.md#conditions) + +### Accessors + +- [artifactsFolder](AgreementsApi.md#artifactsfolder) +- [circuitsFolder](AgreementsApi.md#circuitsfolder) +- [config](AgreementsApi.md#config) +- [instanceConfig](AgreementsApi.md#instanceconfig) +- [instantiableConfig](AgreementsApi.md#instantiableconfig) +- [logger](AgreementsApi.md#logger) +- [nevermined](AgreementsApi.md#nevermined) +- [web3](AgreementsApi.md#web3) + +### Methods + +- [create](AgreementsApi.md#create) +- [getAgreement](AgreementsApi.md#getagreement) +- [getAgreements](AgreementsApi.md#getagreements) +- [isAccessGranted](AgreementsApi.md#isaccessgranted) +- [prepareSignature](AgreementsApi.md#preparesignature) +- [setInstanceConfig](AgreementsApi.md#setinstanceconfig) +- [status](AgreementsApi.md#status) +- [getInstance](AgreementsApi.md#getinstance) +- [setInstanceConfig](AgreementsApi.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new AgreementsApi**(`config`) + +Creates a new AgreementsApi + +#### Parameters + +| Name | Type | Description | +| :------- | :---------------------------------------------------------- | :--------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | Configuration of the Nevermined instance | + +#### Overrides + +[Instantiable](Instantiable.md).[constructor](Instantiable.md#constructor) + +#### Defined in + +[src/nevermined/api/AgreementsApi.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AgreementsApi.ts#L28) + +## Properties + +### conditions + +• **conditions**: `ConditionsApi` + +Agreements Conditions submodule. + +#### Defined in + +[src/nevermined/api/AgreementsApi.ts:21](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AgreementsApi.ts#L21) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +Instantiable.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +Instantiable.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +Instantiable.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +Instantiable.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### create + +▸ **create**(`did`, `agreementIdSeed`, `serviceType`, `agreementParams`, `consumer`, `publisher`, `params?`): `Promise`<`string`\> + +Create a service agreement on-chain. This should be called by the publisher of the asset. + +#### Parameters + +| Name | Type | Description | +| :---------------- | :------------------------------------------------ | :----------------- | +| `did` | `string` | Decentralized ID. | +| `agreementIdSeed` | `string` | - | +| `serviceType` | [`ServiceType`](../code-reference.md#servicetype) | Service. | +| `agreementParams` | `any` | - | +| `consumer` | [`Account`](Account.md) | Consumer account. | +| `publisher` | [`Account`](Account.md) | Publisher account. | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | - | + +#### Returns + +`Promise`<`string`\> + +The service agreement id + +**`Remarks`** + +Consumer signature will be verified on-chain, but it is recommended to verify the signature +in this method before submitting on-chain. + +#### Defined in + +[src/nevermined/api/AgreementsApi.ts:87](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AgreementsApi.ts#L87) + +--- + +### getAgreement + +▸ **getAgreement**(`agreementId`): `Promise`<[`AgreementData`](../interfaces/AgreementData.md)\> + +It returns the details of one agreement + +#### Parameters + +| Name | Type | Description | +| :------------ | :------- | :---------------------- | +| `agreementId` | `string` | The unique agreement id | + +#### Returns + +`Promise`<[`AgreementData`](../interfaces/AgreementData.md)\> + +the details of the agreement + +#### Defined in + +[src/nevermined/api/AgreementsApi.ts:148](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AgreementsApi.ts#L148) + +--- + +### getAgreements + +▸ **getAgreements**(`did`): `Promise`<[`AgreementData`](../interfaces/AgreementData.md)[]\> + +Gets the list of agreements created about an asset + +#### Parameters + +| Name | Type | Description | +| :---- | :------- | :--------------------------------- | +| `did` | `string` | the unique identifier of the asset | + +#### Returns + +`Promise`<[`AgreementData`](../interfaces/AgreementData.md)[]\> + +the list of agreements + +#### Defined in + +[src/nevermined/api/AgreementsApi.ts:157](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AgreementsApi.ts#L157) + +--- + +### isAccessGranted + +▸ **isAccessGranted**(`agreementId`, `did`, `consumerAddress`, `account`): `Promise`<`boolean`\> + +Checks if a consumer has permissions for a certain DID and Agreement Id + +#### Parameters + +| Name | Type | Description | +| :---------------- | :---------------------- | :--------------------------------- | +| `agreementId` | `string` | the agreement id | +| `did` | `string` | the unique identifier of the asset | +| `consumerAddress` | `string` | the address of the consumer | +| `account` | [`Account`](Account.md) | the user account | + +#### Returns + +`Promise`<`boolean`\> + +true if the user has permissions + +#### Defined in + +[src/nevermined/api/AgreementsApi.ts:169](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AgreementsApi.ts#L169) + +--- + +### prepareSignature + +▸ **prepareSignature**(`did`, `serviceType`, `consumer`): `Promise`<[`AgreementPrepareResult`](../interfaces/AgreementPrepareResult.md)\> + +Creates a consumer signature for the specified asset service. + +#### Parameters + +| Name | Type | Description | +| :------------ | :------------------------------------------------ | :---------------- | +| `did` | `string` | Decentralized ID. | +| `serviceType` | [`ServiceType`](../code-reference.md#servicetype) | Service. | +| `consumer` | [`Account`](Account.md) | Consumer account. | + +#### Returns + +`Promise`<[`AgreementPrepareResult`](../interfaces/AgreementPrepareResult.md)\> + +The agreement ID and signature. + +#### Defined in + +[src/nevermined/api/AgreementsApi.ts:45](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AgreementsApi.ts#L45) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### status + +▸ **status**(`agreementId`, `extended?`): `Promise`<`any`\> + +Get the status of a service agreement. + +#### Parameters + +| Name | Type | Default value | Description | +| :------------ | :-------- | :------------ | :------------------------------------------- | +| `agreementId` | `string` | `undefined` | Service agreement ID. | +| `extended` | `boolean` | `false` | Returns a complete status with dependencies. | + +#### Returns + +`Promise`<`any`\> + +status of the agreement + +#### Defined in + +[src/nevermined/api/AgreementsApi.ts:122](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AgreementsApi.ts#L122) + +--- + +### getInstance + +▸ `Static` **getInstance**(`..._args`): `any` + +#### Parameters + +| Name | Type | +| :--------- | :---- | +| `..._args` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[Instantiable](Instantiable.md).[getInstance](Instantiable.md#getinstance) + +#### Defined in + +[src/Instantiable.abstract.ts:86](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L86) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/ApiError.md b/docs/api-reference/classes/ApiError.md new file mode 100644 index 000000000..292680753 --- /dev/null +++ b/docs/api-reference/classes/ApiError.md @@ -0,0 +1,165 @@ +[@nevermined-io/sdk](../code-reference.md) / ApiError + +# Class: ApiError + +## Hierarchy + +- `Error` + + ↳ **`ApiError`** + +## Table of contents + +### Constructors + +- [constructor](ApiError.md#constructor) + +### Properties + +- [message](ApiError.md#message) +- [name](ApiError.md#name) +- [stack](ApiError.md#stack) +- [prepareStackTrace](ApiError.md#preparestacktrace) +- [stackTraceLimit](ApiError.md#stacktracelimit) + +### Methods + +- [captureStackTrace](ApiError.md#capturestacktrace) + +## Constructors + +### constructor + +• **new ApiError**(`message`) + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `message` | `string` | + +#### Overrides + +Error.constructor + +#### Defined in + +[src/errors/ApiError.ts:2](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/errors/ApiError.ts#L2) + +## Properties + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1068 + +--- + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1067 + +--- + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1069 + +--- + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +Optional override for formatting stack traces + +##### Parameters + +| Name | Type | +| :------------ | :----------- | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:11 + +--- + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:13 + +## Methods + +### captureStackTrace + +▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :---------------- | :--------- | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:4 diff --git a/docs/api-reference/classes/AssetAttributes.md b/docs/api-reference/classes/AssetAttributes.md new file mode 100644 index 000000000..f178f2c16 --- /dev/null +++ b/docs/api-reference/classes/AssetAttributes.md @@ -0,0 +1,218 @@ +[@nevermined-io/sdk](../code-reference.md) / AssetAttributes + +# Class: AssetAttributes + +## Hierarchy + +- **`AssetAttributes`** + + ↳ [`NFTAttributes`](NFTAttributes.md) + +## Table of contents + +### Constructors + +- [constructor](AssetAttributes.md#constructor) + +### Properties + +- [appId](AssetAttributes.md#appid) +- [encryptionMethod](AssetAttributes.md#encryptionmethod) +- [fulfillAccessTimelock](AssetAttributes.md#fulfillaccesstimelock) +- [fulfillAccessTimeout](AssetAttributes.md#fulfillaccesstimeout) +- [metadata](AssetAttributes.md#metadata) +- [predefinedAssetServices](AssetAttributes.md#predefinedassetservices) +- [providers](AssetAttributes.md#providers) +- [services](AssetAttributes.md#services) +- [DEFAULT_ENCRYPTION_METHOD](AssetAttributes.md#default_encryption_method) +- [defaultValues](AssetAttributes.md#defaultvalues) + +### Methods + +- [getInstance](AssetAttributes.md#getinstance) + +## Constructors + +### constructor + +• **new AssetAttributes**() + +## Properties + +### appId + +• `Optional` **appId**: `string` + +Unique identifier of the application/domain/vertical where the asset belong to. +That asset association typically helps to search and filter between assets part of a domain via Marketplace API + +#### Defined in + +[src/models/AssetAttributes.ts:47](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetAttributes.ts#L47) + +--- + +### encryptionMethod + +• `Optional` **encryptionMethod**: [`EncryptionMethod`](../code-reference.md#encryptionmethod) + +When an asset is published in a Nevermined network, some internal Metadata attributes are encrypted so they can't be accessed. +This method allows to specify the encryption method to be used. + +**`See`** + +[EncryptionMethod](../code-reference.md#encryptionmethod) + +#### Defined in + +[src/models/AssetAttributes.ts:20](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetAttributes.ts#L20) + +--- + +### fulfillAccessTimelock + +• `Optional` **fulfillAccessTimelock**: `number` + +An asset can offer different services. Each service can have different conditions that need to be fulfilled +to provide that service. These conditions can expire if they are not fulfilled in a certain period of time. +This attribute allows to specify a period of time the condition can not be fullfilled +Setting up a timelock of 0 means that the condition can be fulfilled at any time. +Setting a timelock greater than 0 means that the condition can not be fulfilled until that number of blocks after the agreement is created are mined. +This would allow to create an agreement that can not fulfilled until certain period of time. + +#### Defined in + +[src/models/AssetAttributes.ts:67](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetAttributes.ts#L67) + +--- + +### fulfillAccessTimeout + +• `Optional` **fulfillAccessTimeout**: `number` + +An asset can offer different services. Each service can have different conditions that need to be fulfilled +to provide that service. These conditions can expire if they are not fulfilled in a certain period of time. +This attribute allows to specify the timeouts for the access condition associated to the service. +Setting up a timeout of 0 means that the condition will never expire. +Setting a timeout greater than 0 means that the condition will expire after that number of blocks after the agreement is created. +This would allow to create an agreement that is not fulfilled after a certain period of time, the user can claim back funds locked if the condition is any. + +#### Defined in + +[src/models/AssetAttributes.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetAttributes.ts#L57) + +--- + +### metadata + +• **metadata**: [`MetaData`](../interfaces/MetaData.md) + +Metadata describing the asset + +**`See`** + +[MetaData](../interfaces/MetaData.md) + +#### Defined in + +[src/models/AssetAttributes.ts:13](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetAttributes.ts#L13) + +--- + +### predefinedAssetServices + +• `Optional` **predefinedAssetServices**: [`ServiceCommon`](../interfaces/ServiceCommon.md)[] + +List of additional asset services to be included as part of an asset + +**`See`** + +[Service](../code-reference.md#service) + +#### Defined in + +[src/models/AssetAttributes.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetAttributes.ts#L32) + +--- + +### providers + +• `Optional` **providers**: `string`[] + +A provider of an asset identify the public address of an account with some privileges over that asset. +Typically these permissions are granted to Nevermined Nodes to allow them to give access to some services without +the direct interaction of the final user. +Here a user publishing an asset can define a list of all the addresses with these permissions. +Typically just the address of one Nevermined Node trusted by the user. + +#### Defined in + +[src/models/AssetAttributes.ts:41](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetAttributes.ts#L41) + +--- + +### services + +• `Optional` **services**: [`ServiceAttributes`](../interfaces/ServiceAttributes.md)[] + +List of services and their attributes offered by an asset. + +**`See`** + +[ServiceAttributes](../interfaces/ServiceAttributes.md) + +#### Defined in + +[src/models/AssetAttributes.ts:26](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetAttributes.ts#L26) + +--- + +### DEFAULT_ENCRYPTION_METHOD + +▪ `Static` **DEFAULT_ENCRYPTION_METHOD**: [`EncryptionMethod`](../code-reference.md#encryptionmethod) + +#### Defined in + +[src/models/AssetAttributes.ts:7](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetAttributes.ts#L7) + +--- + +### defaultValues + +▪ `Static` **defaultValues**: `Object` + +#### Type declaration + +| Name | Type | +| :------------------------ | :-------------------------------------------------------------------------------------------------------------- | +| `appId` | `string` | +| `encryptionMethod` | [`EncryptionMethod`](../code-reference.md#encryptionmethod) | +| `fulfillAccessTimelock` | `number` | +| `fulfillAccessTimeout` | `number` | +| `predefinedAssetServices` | [`ServiceCommon`](../interfaces/ServiceCommon.md)[] | +| `providers` | `any`[] | +| `services` | { `price`: [`AssetPrice`](AssetPrice.md) ; `serviceType`: [`ServiceType`](../code-reference.md#servicetype) }[] | + +#### Defined in + +[src/models/AssetAttributes.ts:69](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetAttributes.ts#L69) + +## Methods + +### getInstance + +▸ `Static` **getInstance**(`assetAttributes`): `Required`<[`AssetAttributes`](AssetAttributes.md)\> + +#### Parameters + +| Name | Type | +| :---------------- | :-------------------------------------- | +| `assetAttributes` | [`AssetAttributes`](AssetAttributes.md) | + +#### Returns + +`Required`<[`AssetAttributes`](AssetAttributes.md)\> + +#### Defined in + +[src/models/AssetAttributes.ts:84](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetAttributes.ts#L84) diff --git a/docs/api-reference/classes/AssetError.md b/docs/api-reference/classes/AssetError.md new file mode 100644 index 000000000..8e3642d68 --- /dev/null +++ b/docs/api-reference/classes/AssetError.md @@ -0,0 +1,165 @@ +[@nevermined-io/sdk](../code-reference.md) / AssetError + +# Class: AssetError + +## Hierarchy + +- `Error` + + ↳ **`AssetError`** + +## Table of contents + +### Constructors + +- [constructor](AssetError.md#constructor) + +### Properties + +- [message](AssetError.md#message) +- [name](AssetError.md#name) +- [stack](AssetError.md#stack) +- [prepareStackTrace](AssetError.md#preparestacktrace) +- [stackTraceLimit](AssetError.md#stacktracelimit) + +### Methods + +- [captureStackTrace](AssetError.md#capturestacktrace) + +## Constructors + +### constructor + +• **new AssetError**(`message`) + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `message` | `string` | + +#### Overrides + +Error.constructor + +#### Defined in + +[src/errors/AssetError.ts:2](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/errors/AssetError.ts#L2) + +## Properties + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1068 + +--- + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1067 + +--- + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1069 + +--- + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +Optional override for formatting stack traces + +##### Parameters + +| Name | Type | +| :------------ | :----------- | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:11 + +--- + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:13 + +## Methods + +### captureStackTrace + +▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :---------------- | :--------- | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:4 diff --git a/docs/api-reference/classes/AssetPrice.md b/docs/api-reference/classes/AssetPrice.md new file mode 100644 index 000000000..57fd7d073 --- /dev/null +++ b/docs/api-reference/classes/AssetPrice.md @@ -0,0 +1,352 @@ +[@nevermined-io/sdk](../code-reference.md) / AssetPrice + +# Class: AssetPrice + +## Table of contents + +### Constructors + +- [constructor](AssetPrice.md#constructor) + +### Properties + +- [rewards](AssetPrice.md#rewards) +- [tokenAddress](AssetPrice.md#tokenaddress) +- [totalPrice](AssetPrice.md#totalprice) +- [NETWORK_FEE_DENOMINATOR](AssetPrice.md#network_fee_denominator) + +### Methods + +- [addNetworkFees](AssetPrice.md#addnetworkfees) +- [adjustToIncludeNetworkFees](AssetPrice.md#adjusttoincludenetworkfees) +- [getAmounts](AssetPrice.md#getamounts) +- [getAmountsString](AssetPrice.md#getamountsstring) +- [getReceivers](AssetPrice.md#getreceivers) +- [getReceiversString](AssetPrice.md#getreceiversstring) +- [getRewards](AssetPrice.md#getrewards) +- [getTokenAddress](AssetPrice.md#gettokenaddress) +- [getTotalPrice](AssetPrice.md#gettotalprice) +- [setReceiver](AssetPrice.md#setreceiver) +- [setTokenAddress](AssetPrice.md#settokenaddress) +- [toString](AssetPrice.md#tostring) +- [sumAmounts](AssetPrice.md#sumamounts) + +## Constructors + +### constructor + +• **new AssetPrice**() + +#### Defined in + +[src/models/AssetPrice.ts:10](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetPrice.ts#L10) + +• **new AssetPrice**(`_rewards`) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------- | +| `_rewards` | `Map`<`string`, `bigint`\> | + +#### Defined in + +[src/models/AssetPrice.ts:11](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetPrice.ts#L11) + +• **new AssetPrice**(`address`, `amount`) + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `address` | `string` | +| `amount` | `bigint` | + +#### Defined in + +[src/models/AssetPrice.ts:12](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetPrice.ts#L12) + +• **new AssetPrice**(`address`, `amount`, `tokenAddress`) + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `address` | `string` | +| `amount` | `bigint` | +| `tokenAddress` | `string` | + +#### Defined in + +[src/models/AssetPrice.ts:13](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetPrice.ts#L13) + +## Properties + +### rewards + +• `Private` **rewards**: `Map`<`string`, `bigint`\> + +#### Defined in + +[src/models/AssetPrice.ts:6](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetPrice.ts#L6) + +--- + +### tokenAddress + +• `Private` `Optional` **tokenAddress**: `string` + +#### Defined in + +[src/models/AssetPrice.ts:8](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetPrice.ts#L8) + +--- + +### totalPrice + +• `Private` **totalPrice**: `bigint` + +#### Defined in + +[src/models/AssetPrice.ts:4](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetPrice.ts#L4) + +--- + +### NETWORK_FEE_DENOMINATOR + +▪ `Static` `Readonly` **NETWORK_FEE_DENOMINATOR**: `10000n` + +#### Defined in + +[src/models/AssetPrice.ts:2](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetPrice.ts#L2) + +## Methods + +### addNetworkFees + +▸ **addNetworkFees**(`feeReceiver`, `networkFeePercent`): [`AssetPrice`](AssetPrice.md) + +It adds network fees on top of the already configured asset rewards + +#### Parameters + +| Name | Type | Description | +| :------------------ | :------- | :--------------------------------------------------------------- | +| `feeReceiver` | `string` | the address receiving the fees | +| `networkFeePercent` | `bigint` | the percent of fees to receive, it uses the contract denominator | + +#### Returns + +[`AssetPrice`](AssetPrice.md) + +the asset rewards object + +**`See`** + +AssetPrice.NETWORK_FEE_DENOMINATOR + +#### Defined in + +[src/models/AssetPrice.ts:75](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetPrice.ts#L75) + +--- + +### adjustToIncludeNetworkFees + +▸ **adjustToIncludeNetworkFees**(`feeReceiver`, `networkFeePercent`): [`AssetPrice`](AssetPrice.md) + +It includes network fees on the existing asset rewards subtracting the proportion taking into account the receivers percent + +#### Parameters + +| Name | Type | Description | +| :------------------ | :------- | :--------------------------------------------------------------- | +| `feeReceiver` | `string` | the address receiving the fees | +| `networkFeePercent` | `bigint` | the percent of fees to receive, it uses the contract denominator | + +#### Returns + +[`AssetPrice`](AssetPrice.md) + +the asset rewards object + +**`See`** + +AssetPrice.NETWORK_FEE_DENOMINATOR + +#### Defined in + +[src/models/AssetPrice.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetPrice.ts#L88) + +--- + +### getAmounts + +▸ **getAmounts**(): `bigint`[] + +#### Returns + +`bigint`[] + +#### Defined in + +[src/models/AssetPrice.ts:46](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetPrice.ts#L46) + +--- + +### getAmountsString + +▸ **getAmountsString**(): `string` + +#### Returns + +`string` + +#### Defined in + +[src/models/AssetPrice.ts:103](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetPrice.ts#L103) + +--- + +### getReceivers + +▸ **getReceivers**(): `string`[] + +#### Returns + +`string`[] + +#### Defined in + +[src/models/AssetPrice.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetPrice.ts#L50) + +--- + +### getReceiversString + +▸ **getReceiversString**(): `string` + +#### Returns + +`string` + +#### Defined in + +[src/models/AssetPrice.ts:109](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetPrice.ts#L109) + +--- + +### getRewards + +▸ **getRewards**(): `Map`<`string`, `bigint`\> + +#### Returns + +`Map`<`string`, `bigint`\> + +#### Defined in + +[src/models/AssetPrice.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetPrice.ts#L42) + +--- + +### getTokenAddress + +▸ **getTokenAddress**(): `string` + +#### Returns + +`string` + +#### Defined in + +[src/models/AssetPrice.ts:65](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetPrice.ts#L65) + +--- + +### getTotalPrice + +▸ **getTotalPrice**(): `bigint` + +#### Returns + +`bigint` + +#### Defined in + +[src/models/AssetPrice.ts:38](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetPrice.ts#L38) + +--- + +### setReceiver + +▸ **setReceiver**(`receiver`, `amount`): [`AssetPrice`](AssetPrice.md) + +#### Parameters + +| Name | Type | +| :--------- | :------- | +| `receiver` | `string` | +| `amount` | `bigint` | + +#### Returns + +[`AssetPrice`](AssetPrice.md) + +#### Defined in + +[src/models/AssetPrice.ts:54](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetPrice.ts#L54) + +--- + +### setTokenAddress + +▸ **setTokenAddress**(`address`): [`AssetPrice`](AssetPrice.md) + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `address` | `string` | + +#### Returns + +[`AssetPrice`](AssetPrice.md) + +#### Defined in + +[src/models/AssetPrice.ts:60](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetPrice.ts#L60) + +--- + +### toString + +▸ **toString**(): `string` + +#### Returns + +`string` + +#### Defined in + +[src/models/AssetPrice.ts:114](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetPrice.ts#L114) + +--- + +### sumAmounts + +▸ `Static` **sumAmounts**(`amounts`): `bigint` + +#### Parameters + +| Name | Type | +| :-------- | :--------- | +| `amounts` | `bigint`[] | + +#### Returns + +`bigint` + +#### Defined in + +[src/models/AssetPrice.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetPrice.ts#L34) diff --git a/docs/api-reference/classes/AssetPublicationOptions.md b/docs/api-reference/classes/AssetPublicationOptions.md new file mode 100644 index 000000000..7b56ce7d1 --- /dev/null +++ b/docs/api-reference/classes/AssetPublicationOptions.md @@ -0,0 +1,40 @@ +[@nevermined-io/sdk](../code-reference.md) / AssetPublicationOptions + +# Class: AssetPublicationOptions + +## Table of contents + +### Constructors + +- [constructor](AssetPublicationOptions.md#constructor) + +### Properties + +- [did](AssetPublicationOptions.md#did) +- [metadata](AssetPublicationOptions.md#metadata) + +## Constructors + +### constructor + +• **new AssetPublicationOptions**() + +## Properties + +### did + +• `Optional` **did**: [`PublishOnChainOptions`](../enums/PublishOnChainOptions.md) = `PublishOnChainOptions.DIDRegistry` + +#### Defined in + +[src/nevermined/api/AssetsApi.ts:38](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AssetsApi.ts#L38) + +--- + +### metadata + +• `Optional` **metadata**: [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) = `PublishMetadataOptions.OnlyMetadataAPI` + +#### Defined in + +[src/nevermined/api/AssetsApi.ts:37](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AssetsApi.ts#L37) diff --git a/docs/api-reference/classes/AssetsApi.md b/docs/api-reference/classes/AssetsApi.md new file mode 100644 index 000000000..f5399a2c3 --- /dev/null +++ b/docs/api-reference/classes/AssetsApi.md @@ -0,0 +1,1019 @@ +[@nevermined-io/sdk](../code-reference.md) / AssetsApi + +# Class: AssetsApi + +Nevermined Assets API. It allows the registration and management of digital assets in a +Nevermined digital ecosystem. +You can find more information about you can do in a Nevermined information here: +[https://docs.nevermined.io/docs/architecture/what-can-i-do](https://docs.nevermined.io/docs/architecture/what-can-i-do) + +## Hierarchy + +- [`RegistryBaseApi`](RegistryBaseApi.md) + + ↳ **`AssetsApi`** + +## Table of contents + +### Constructors + +- [constructor](AssetsApi.md#constructor) + +### Properties + +- [providers](AssetsApi.md#providers) +- [servicePlugin](AssetsApi.md#serviceplugin) + +### Accessors + +- [artifactsFolder](AssetsApi.md#artifactsfolder) +- [circuitsFolder](AssetsApi.md#circuitsfolder) +- [config](AssetsApi.md#config) +- [instanceConfig](AssetsApi.md#instanceconfig) +- [instantiableConfig](AssetsApi.md#instantiableconfig) +- [logger](AssetsApi.md#logger) +- [nevermined](AssetsApi.md#nevermined) +- [web3](AssetsApi.md#web3) + +### Methods + +- [access](AssetsApi.md#access) +- [addRating](AssetsApi.md#addrating) +- [consumerAssets](AssetsApi.md#consumerassets) +- [create](AssetsApi.md#create) +- [download](AssetsApi.md#download) +- [getNftContractAddress](AssetsApi.md#getnftcontractaddress) +- [getPermissions](AssetsApi.md#getpermissions) +- [grantPermissions](AssetsApi.md#grantpermissions) +- [list](AssetsApi.md#list) +- [order](AssetsApi.md#order) +- [orderAsset](AssetsApi.md#orderasset) +- [owner](AssetsApi.md#owner) +- [ownerAssets](AssetsApi.md#ownerassets) +- [ownerSignature](AssetsApi.md#ownersignature) +- [registerNeverminedAsset](AssetsApi.md#registerneverminedasset) +- [resolve](AssetsApi.md#resolve) +- [resolveAsset](AssetsApi.md#resolveasset) +- [retire](AssetsApi.md#retire) +- [revokePermissions](AssetsApi.md#revokepermissions) +- [setInstanceConfig](AssetsApi.md#setinstanceconfig) +- [transferOwnership](AssetsApi.md#transferownership) +- [update](AssetsApi.md#update) +- [updateAsset](AssetsApi.md#updateasset) +- [getInstance](AssetsApi.md#getinstance) +- [getServicePlugin](AssetsApi.md#getserviceplugin) +- [setInstanceConfig](AssetsApi.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new AssetsApi**(`config`) + +Creates a new AssetsApi + +#### Parameters + +| Name | Type | Description | +| :------- | :---------------------------------------------------------- | :--------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | Configuration of the Nevermined instance | + +#### Overrides + +[RegistryBaseApi](RegistryBaseApi.md).[constructor](RegistryBaseApi.md#constructor) + +#### Defined in + +[src/nevermined/api/AssetsApi.ts:121](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AssetsApi.ts#L121) + +## Properties + +### providers + +• **providers**: [`Providers`](Providers.md) + +Utilities about the providers associated to an asset + +#### Defined in + +[src/nevermined/api/AssetsApi.ts:114](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AssetsApi.ts#L114) + +--- + +### servicePlugin + +• **servicePlugin**: `Object` + +#### Index signature + +▪ [key: `string`]: [`ServicePlugin`](../interfaces/ServicePlugin.md)<[`Service`](../code-reference.md#service)\> + +#### Inherited from + +[RegistryBaseApi](RegistryBaseApi.md).[servicePlugin](RegistryBaseApi.md#serviceplugin) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L29) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +RegistryBaseApi.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +RegistryBaseApi.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +RegistryBaseApi.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +RegistryBaseApi.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +RegistryBaseApi.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +RegistryBaseApi.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +RegistryBaseApi.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +RegistryBaseApi.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### access + +▸ **access**(`agreementId`, `did`, `serviceReference`, `consumerAccount`, `resultPath?`, `fileIndex?`, `buyer?`, `babysig?`): `Promise`<`string` \| `true`\> + +Having previously ordered an "access" service (referenced via an "agreementId"). +This method allows to download the assets associated to that service. + +#### Parameters + +| Name | Type | Default value | Description | +| :----------------- | :------------------------------------------------------------ | :------------ | :----------------------------------------------------------------------------------------------------------------------------------------- | +| `agreementId` | `string` | `undefined` | The unique identifier of the order placed for a service | +| `did` | `string` | `undefined` | Unique identifier of the asset ordered | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `undefined` | The service to download. By default is the access service, but it can be specified the service.index to refer a different specific service | +| `consumerAccount` | [`Account`](Account.md) | `undefined` | The account of the user who ordered the asset and is downloading the files | +| `resultPath?` | `string` | `undefined` | Where the files will be downloaded | +| `fileIndex` | `number` | `-1` | The file to download. If not given or is -1 it will download all of them. | +| `buyer?` | `string` | `undefined` | Key which represent the buyer | +| `babysig?` | [`Babysig`](../interfaces/Babysig.md) | `undefined` | An elliptic curve signature | + +#### Returns + +`Promise`<`string` \| `true`\> + +The result path or true if everything went okay + +#### Defined in + +[src/nevermined/api/AssetsApi.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AssetsApi.ts#L235) + +--- + +### addRating + +▸ **addRating**(`did`, `newRating`, `numVotesAdded?`, `publisher`, `publishMetadata?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +Given a DID, it adds a vote to the asset curation information. + +#### Parameters + +| Name | Type | Default value | Description | +| :---------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `newRating` | `number` | `undefined` | New average rating of the asset | +| `numVotesAdded` | `number` | `1` | Number of new votes added to the rating, typically just 1 | +| `publisher` | [`Account`](Account.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +[DDO](DDO.md) The DDO updated + +#### Inherited from + +[RegistryBaseApi](RegistryBaseApi.md).[addRating](RegistryBaseApi.md#addrating) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:514](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L514) + +--- + +### consumerAssets + +▸ **consumerAssets**(`consumerAccount`): `Promise`<`string`[]\> + +Returns the assets of a consumer. + +#### Parameters + +| Name | Type | Description | +| :---------------- | :------- | :---------------- | +| `consumerAccount` | `string` | Consumer address. | + +#### Returns + +`Promise`<`string`[]\> + +List of DIDs. + +#### Defined in + +[src/nevermined/api/AssetsApi.ts:352](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AssetsApi.ts#L352) + +--- + +### create + +▸ **create**(`assetAttributes`, `publisherAccount`, `publicationOptions?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`CreateProgressStep`](../enums/CreateProgressStep.md), [`DDO`](DDO.md)\> + +Registers a new asset in Nevermined. +You can find more information about how different data is stored in Nevermined here: +[https://docs.nevermined.io/docs/architecture/nevermined-data](https://docs.nevermined.io/docs/architecture/nevermined-data) + +#### Parameters + +| Name | Type | Description | +| :------------------- | :------------------------------------------------------ | :-------------------------------------------------------------------------------- | +| `assetAttributes` | [`AssetAttributes`](AssetAttributes.md) | Attributes describing the asset | +| `publisherAccount` | [`Account`](Account.md) | The account publishing the asset | +| `publicationOptions` | [`AssetPublicationOptions`](AssetPublicationOptions.md) | Allows to specify the publication options of the off-chain and the on-chain data. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`CreateProgressStep`](../enums/CreateProgressStep.md), [`DDO`](DDO.md)\> + +The metadata of the asset created (DDO) + +[DDO](DDO.md) + +**`See`** + +[PublishOnChainOptions](../enums/PublishOnChainOptions.md) and [PublishMetadataOptions](../enums/PublishMetadataOptions.md) + +#### Defined in + +[src/nevermined/api/AssetsApi.ts:154](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AssetsApi.ts#L154) + +--- + +### download + +▸ **download**(`did`, `ownerAccount`, `resultPath?`, `fileIndex?`, `serviceType?`, `buyer?`, `babysig?`): `Promise`<`string`\> + +It allows to download of the files attached to the asset by their owner or provider. +This method only can be called successfully by the owner of the asset or a provider. + +#### Parameters + +| Name | Type | Default value | Description | +| :------------- | :------------------------------------------------ | :------------ | :----------------------------------------- | +| `did` | `string` | `undefined` | The Decentralized Identifier of the asset. | +| `ownerAccount` | [`Account`](Account.md) | `undefined` | The receiver account owner | +| `resultPath?` | `string` | `undefined` | Path to be the files downloader | +| `fileIndex` | `number` | `-1` | The index of the file | +| `serviceType` | [`ServiceType`](../code-reference.md#servicetype) | `'access'` | Service type. 'access' by default | +| `buyer?` | `string` | `undefined` | Key which represent the buyer | +| `babysig?` | [`Babysig`](../interfaces/Babysig.md) | `undefined` | An elliptic curve signature | + +#### Returns + +`Promise`<`string`\> + +Status, path destination if resultPath is provided + +#### Defined in + +[src/nevermined/api/AssetsApi.ts:377](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AssetsApi.ts#L377) + +--- + +### getNftContractAddress + +▸ **getNftContractAddress**(`ddo`, `serviceType?`): `string` + +Get the NFT contract address associated with a Nevermined asset. + +#### Parameters + +| Name | Type | Default value | Description | +| :------------ | :------------------------------------------------ | :------------- | :------------------------------------------------------- | +| `ddo` | [`DDO`](DDO.md) | `undefined` | The DDO of the asset. | +| `serviceType` | [`ServiceType`](../code-reference.md#servicetype) | `'nft-access'` | The service type to use to get the NFT contract address. | + +#### Returns + +`string` + +The NFT contract address. + +**`Example`** + +```ts +nevermined.assets.getNftContractAddress(ddo) +``` + +**`Throws`** + +DDOError - If the NFT contract address is not found in the DDO. + +#### Defined in + +[src/nevermined/api/AssetsApi.ts:490](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AssetsApi.ts#L490) + +--- + +### getPermissions + +▸ **getPermissions**(`did`, `address`): `Promise`<`boolean`\> + +Checks if an account with a specific address has permissions to a specific asset represented by a DID + +#### Parameters + +| Name | Type | Description | +| :-------- | :------- | :---------------------------------------------------------- | +| `did` | `string` | The unique identifier of the asset to check the permissions | +| `address` | `string` | The address of the account to check the permissions | + +#### Returns + +`Promise`<`boolean`\> + +True if the address has permissions on the asset + +#### Defined in + +[src/nevermined/api/AssetsApi.ts:472](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AssetsApi.ts#L472) + +--- + +### grantPermissions + +▸ **grantPermissions**(`did`, `address`, `ownerAccount`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +It grants permissions to an account for a specific asset represented by a DID. +Only can be called by the asset owner. + +#### Parameters + +| Name | Type | Description | +| :------------- | :---------------------------------------------- | :------------------------------------------------------------- | +| `did` | `string` | The unique identifier of the assert | +| `address` | `string` | The account to grant the permissions | +| `ownerAccount` | [`Account`](Account.md) | Account sending the request. It must be the owner of the asset | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Defined in + +[src/nevermined/api/AssetsApi.ts:430](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AssetsApi.ts#L430) + +--- + +### list + +▸ **list**(`did`, `list`, `publisher`, `publishMetadata?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +Given a DID, updates the metadata associated to the asset allowing to list or unlist it. It also can upload this metadata to a remote decentralized stored depending on the `publishMetadata` parameter. +In a Nevermined environment, when an asset is unlisted, it is not possible to be found and accessed by any user. + +#### Parameters + +| Name | Type | Default value | Description | +| :---------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `list` | `boolean` | `undefined` | Needs the asset to be listed or unlisted | +| `publisher` | [`Account`](Account.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +[DDO](DDO.md) The DDO updated + +#### Inherited from + +[RegistryBaseApi](RegistryBaseApi.md).[list](RegistryBaseApi.md#list) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:462](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L462) + +--- + +### order + +▸ **order**(`did`, `serviceReference?`, `consumerAccount`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`OrderProgressStep`](../enums/OrderProgressStep.md), `string`\> + +Start the purchase/order of an access service. Starts by signing the service agreement +then sends the request to the publisher via the service endpoint (Node http service). +If the access service to purchase is having associated some price, it will make the payment +for that service. + +#### Parameters + +| Name | Type | Default value | Description | +| :----------------- | :------------------------------------------------------------ | :------------ | :-------------------------------------------------------------------------------------------------------------------------------------- | +| `did` | `string` | `undefined` | Unique identifier of the asset to order | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'access'` | The service to order. By default is the access service, but it can be specified the service.index to refer a different specific service | +| `consumerAccount` | [`Account`](Account.md) | `undefined` | The account of the user ordering the asset | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`OrderProgressStep`](../enums/OrderProgressStep.md), `string`\> + +The agreement ID identifying the order + +#### Defined in + +[src/nevermined/api/AssetsApi.ts:213](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AssetsApi.ts#L213) + +--- + +### orderAsset + +▸ **orderAsset**(`did`, `serviceReference`, `consumer`, `params?`): [`SubscribablePromise`](SubscribablePromise.md)<[`OrderProgressStep`](../enums/OrderProgressStep.md), `string`\> + +Start the purchase/order of an asset's service. Starts by signing the service agreement +then sends the request to the publisher via the service endpoint (Node http service). + +#### Parameters + +| Name | Type | Description | +| :----------------- | :------------------------------------------------------------ | :---------------- | +| `did` | `string` | Decentralized ID. | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | Service. | +| `consumer` | [`Account`](Account.md) | Consumer account. | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | - | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`OrderProgressStep`](../enums/OrderProgressStep.md), `string`\> + +The agreement ID. + +#### Inherited from + +[RegistryBaseApi](RegistryBaseApi.md).[orderAsset](RegistryBaseApi.md#orderasset) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:563](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L563) + +--- + +### owner + +▸ **owner**(`did`): `Promise`<`string`\> + +Returns the owner of an asset. + +#### Parameters + +| Name | Type | Description | +| :---- | :------- | :---------------- | +| `did` | `string` | Decentralized ID. | + +#### Returns + +`Promise`<`string`\> + +The address of the owner of the asset + +#### Defined in + +[src/nevermined/api/AssetsApi.ts:290](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AssetsApi.ts#L290) + +--- + +### ownerAssets + +▸ **ownerAssets**(`owner`): `Promise`<`string`[]\> + +Returns the assets owned by an address + +#### Parameters + +| Name | Type | Description | +| :------ | :------- | :------------------- | +| `owner` | `string` | The address to check | + +#### Returns + +`Promise`<`string`[]\> + +List of DIDs owned by the address + +#### Defined in + +[src/nevermined/api/AssetsApi.ts:319](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AssetsApi.ts#L319) + +--- + +### ownerSignature + +▸ **ownerSignature**(`did`): `Promise`<`string`\> + +Returns the owner of an asset. + +#### Parameters + +| Name | Type | Description | +| :---- | :------- | :---------------- | +| `did` | `string` | Decentralized ID. | + +#### Returns + +`Promise`<`string`\> + +The address of the owner of the asset + +#### Defined in + +[src/nevermined/api/AssetsApi.ts:299](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AssetsApi.ts#L299) + +--- + +### registerNeverminedAsset + +▸ `Protected` **registerNeverminedAsset**(`assetAttributes`, `publisher`, `publicationOptions`, `nftAttributes?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`CreateProgressStep`](../enums/CreateProgressStep.md), [`DDO`](DDO.md)\> + +It registers a new asset in a Nevermined network. This method is protected and not exposed +via the Nevermined APIs directly. It must accessed via the `assets`, `compute`, and `nfts` APIs. + +#### Parameters + +| Name | Type | Description | +| :------------------- | :------------------------------------------------------ | :-------------------------------------------------------------------------------- | +| `assetAttributes` | [`AssetAttributes`](AssetAttributes.md) | Attributes describing the asset | +| `publisher` | [`Account`](Account.md) | The account publishing the asset | +| `publicationOptions` | [`AssetPublicationOptions`](AssetPublicationOptions.md) | Allows to specify the publication options of the off-chain and the on-chain data. | +| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | Attributes describing the NFT (ERC-721) associated to the asset | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`CreateProgressStep`](../enums/CreateProgressStep.md), [`DDO`](DDO.md)\> + +The metadata of the asset created (DDO) + +**`See`** + +[PublishOnChainOptions](../enums/PublishOnChainOptions.md) and [PublishMetadataOptions](../enums/PublishMetadataOptions.md) + +#### Inherited from + +[RegistryBaseApi](RegistryBaseApi.md).[registerNeverminedAsset](RegistryBaseApi.md#registerneverminedasset) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L42) + +--- + +### resolve + +▸ **resolve**(`did`, `policy?`): `Promise`<[`DDO`](DDO.md)\> + +Returns a DDO by DID. Depending of the resolution policy it prioritize the Metadata API or Immutable urls. + +#### Parameters + +| Name | Type | Default value | Description | +| :------- | :------------------------------------------------- | :---------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `did` | `string` | `undefined` | Decentralized ID. | +| `policy` | [`DIDResolvePolicy`](../enums/DIDResolvePolicy.md) | `DIDResolvePolicy.NoRegistry` | It specifies the resolve policy to apply. It allows to select that priorities during the asset resolution via Metadata API or Immutable URLs (IPFS, Filecoin, etc) | + +#### Returns + +`Promise`<[`DDO`](DDO.md)\> + +[DDO](DDO.md) + +#### Defined in + +[src/nevermined/api/AssetsApi.ts:134](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AssetsApi.ts#L134) + +--- + +### resolveAsset + +▸ `Protected` **resolveAsset**(`did`, `policy?`): `Promise`<[`DDO`](DDO.md)\> + +Returns a DDO by DID. Depending of the resolution policy it prioritize the Metadata API or Immutable urls. + +#### Parameters + +| Name | Type | Default value | Description | +| :------- | :------------------------------------------------- | :---------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `did` | `string` | `undefined` | Decentralized ID. | +| `policy` | [`DIDResolvePolicy`](../enums/DIDResolvePolicy.md) | `DIDResolvePolicy.MetadataAPIFirst` | It specifies the resolve policy to apply. It allows to select that priorities during the asset resolution via Metadata API or Immutable URLs (IPFS, Filecoin, etc) | + +#### Returns + +`Promise`<[`DDO`](DDO.md)\> + +[DDO](DDO.md) + +#### Inherited from + +[RegistryBaseApi](RegistryBaseApi.md).[resolveAsset](RegistryBaseApi.md#resolveasset) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:310](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L310) + +--- + +### retire + +▸ **retire**(`did`): `Promise`<`Response`\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `did` | `string` | + +#### Returns + +`Promise`<`Response`\> + +#### Defined in + +[src/nevermined/api/AssetsApi.ts:360](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AssetsApi.ts#L360) + +--- + +### revokePermissions + +▸ **revokePermissions**(`did`, `address`, `ownerAccount`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +It revokes permissions to an account for a specific asset represented by a DID. +Only can be called by the asset owner. + +#### Parameters + +| Name | Type | Description | +| :------------- | :---------------------------------------------- | :------------------------------------------------------------- | +| `did` | `string` | The unique identifier of the assert | +| `address` | `string` | The account to revoke the permissions | +| `ownerAccount` | [`Account`](Account.md) | Account sending the request. It must be the owner of the asset | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Defined in + +[src/nevermined/api/AssetsApi.ts:452](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AssetsApi.ts#L452) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[RegistryBaseApi](RegistryBaseApi.md).[setInstanceConfig](RegistryBaseApi.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### transferOwnership + +▸ **transferOwnership**(`did`, `newOwner`, `owner`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +Transfer ownership of an asset. + +#### Parameters + +| Name | Type | Description | +| :---------- | :---------------------------------------------- | :--------------------------------------------------------- | +| `did` | `string` | Asset DID. | +| `newOwner` | `string` | Ethereum address of the new owner of the DID. | +| `owner` | `string` \| [`Account`](Account.md) | Account owning the DID and doing the transfer of ownership | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +Returns ethers transaction receipt. + +#### Defined in + +[src/nevermined/api/AssetsApi.ts:331](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AssetsApi.ts#L331) + +--- + +### update + +▸ **update**(`did`, `metadata`, `publisherAccount`, `publishMetadata?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +Given a DID, updates the metadata associated to the asset. It also can upload this metadata to a remote decentralized stored depending on the `publishMetadata` parameter. + +#### Parameters + +| Name | Type | Default value | Description | +| :----------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | Metadata describing the asset | +| `publisherAccount` | [`Account`](Account.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +[DDO](DDO.md) The DDO updated + +**`Example`** + +```ts +const ddoUpdated = await nevermined.assets.update( + ddo.shortId(), + updatedMetadata, + publisher, + PublishMetadata.IPFS, +) +``` + +#### Defined in + +[src/nevermined/api/AssetsApi.ts:192](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AssetsApi.ts#L192) + +--- + +### updateAsset + +▸ `Protected` **updateAsset**(`did`, `metadata`, `publisher`, `publishMetadataOptions?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +Given a DID, updates the metadata associated to the asset. It also can upload this metadata to a remote decentralized stored depending on the `publishMetadata` parameter. + +#### Parameters + +| Name | Type | Default value | Description | +| :----------------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | Metadata describing the asset | +| `publisher` | [`Account`](Account.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadataOptions` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +[DDO](DDO.md) The DDO updated + +#### Inherited from + +[RegistryBaseApi](RegistryBaseApi.md).[updateAsset](RegistryBaseApi.md#updateasset) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:353](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L353) + +--- + +### getInstance + +▸ `Static` **getInstance**(`..._args`): `any` + +#### Parameters + +| Name | Type | +| :--------- | :---- | +| `..._args` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[RegistryBaseApi](RegistryBaseApi.md).[getInstance](RegistryBaseApi.md#getinstance) + +#### Defined in + +[src/Instantiable.abstract.ts:86](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L86) + +--- + +### getServicePlugin + +▸ `Static` `Protected` **getServicePlugin**(`config`): `Object` + +Initializes the default Nevermined service plugins and return that instance + +#### Parameters + +| Name | Type | Description | +| :------- | :---------------------------------------------------------- | :---------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | Nevermined config | + +#### Returns + +`Object` + +The Nevermined Service Plugin instance + +| Name | Type | +| :------------ | :------------------------------------------------------------------------------------------------------------ | +| `aave-credit` | [`ServicePlugin`](../interfaces/ServicePlugin.md)<[`ServiceAaveCredit`](../interfaces/ServiceAaveCredit.md)\> | +| `access` | [`AccessService`](AccessService.md) | +| `compute` | [`EscrowComputeExecutionTemplate`](EscrowComputeExecutionTemplate.md) | +| `nft-access` | [`NFTAccessService`](NFTAccessService.md) | +| `nft-sales` | [`NFTSalesService`](NFTSalesService.md) | + +#### Inherited from + +[RegistryBaseApi](RegistryBaseApi.md).[getServicePlugin](RegistryBaseApi.md#getserviceplugin) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:618](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L618) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[RegistryBaseApi](RegistryBaseApi.md).[setInstanceConfig](RegistryBaseApi.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/KeyTransfer.BabyjubPublicKey.md b/docs/api-reference/classes/BabyjubPublicKey.md similarity index 57% rename from docs/api-reference/classes/KeyTransfer.BabyjubPublicKey.md rename to docs/api-reference/classes/BabyjubPublicKey.md index eb6d69c5c..b68bad051 100644 --- a/docs/api-reference/classes/KeyTransfer.BabyjubPublicKey.md +++ b/docs/api-reference/classes/BabyjubPublicKey.md @@ -1,23 +1,21 @@ -[@nevermined-io/sdk](../code-reference.md) / [KeyTransfer](../modules/KeyTransfer.md) / BabyjubPublicKey +[@nevermined-io/sdk](../code-reference.md) / BabyjubPublicKey # Class: BabyjubPublicKey -[KeyTransfer](../modules/KeyTransfer.md).BabyjubPublicKey - ## Table of contents ### Constructors -- [constructor](KeyTransfer.BabyjubPublicKey.md#constructor) +- [constructor](BabyjubPublicKey.md#constructor) ### Properties -- [x](KeyTransfer.BabyjubPublicKey.md#x) -- [y](KeyTransfer.BabyjubPublicKey.md#y) +- [x](BabyjubPublicKey.md#x) +- [y](BabyjubPublicKey.md#y) ### Methods -- [param](KeyTransfer.BabyjubPublicKey.md#param) +- [param](BabyjubPublicKey.md#param) ## Constructors @@ -34,7 +32,7 @@ #### Defined in -[src/models/KeyTransfer.ts:8](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/KeyTransfer.ts#L8) +[src/models/KeyTransfer.ts:8](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/KeyTransfer.ts#L8) ## Properties @@ -44,7 +42,7 @@ #### Defined in -[src/models/KeyTransfer.ts:5](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/KeyTransfer.ts#L5) +[src/models/KeyTransfer.ts:5](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/KeyTransfer.ts#L5) --- @@ -54,7 +52,7 @@ #### Defined in -[src/models/KeyTransfer.ts:6](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/KeyTransfer.ts#L6) +[src/models/KeyTransfer.ts:6](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/KeyTransfer.ts#L6) ## Methods @@ -68,4 +66,4 @@ #### Defined in -[src/models/KeyTransfer.ts:13](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/KeyTransfer.ts#L13) +[src/models/KeyTransfer.ts:13](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/KeyTransfer.ts#L13) diff --git a/docs/api-reference/classes/BaseTemplate.md b/docs/api-reference/classes/BaseTemplate.md new file mode 100644 index 000000000..6899d74a8 --- /dev/null +++ b/docs/api-reference/classes/BaseTemplate.md @@ -0,0 +1,1450 @@ +[@nevermined-io/sdk](../code-reference.md) / BaseTemplate + +# Class: BaseTemplate + +## Type parameters + +| Name | Type | +| :------- | :------------------------------------------------ | +| `Params` | `Params` | +| `S` | extends [`Service`](../code-reference.md#service) | + +## Hierarchy + +- [`AgreementTemplate`](AgreementTemplate.md)<`Params`\> + + ↳ **`BaseTemplate`** + + ↳↳ [`AaveCreditTemplate`](AaveCreditTemplate.md) + + ↳↳ [`AccessTemplate`](AccessTemplate.md) + + ↳↳ [`EscrowComputeExecutionTemplate`](EscrowComputeExecutionTemplate.md) + + ↳↳ [`DIDSalesTemplate`](DIDSalesTemplate.md) + + ↳↳ [`NFTAccessTemplate`](NFTAccessTemplate.md) + + ↳↳ [`NFT721AccessTemplate`](NFT721AccessTemplate.md) + + ↳↳ [`NFTSalesTemplate`](NFTSalesTemplate.md) + + ↳↳ [`NFT721SalesTemplate`](NFT721SalesTemplate.md) + +## Implements + +- [`ServicePlugin`](../interfaces/ServicePlugin.md)<`S`\> + +## Table of contents + +### Constructors + +- [constructor](BaseTemplate.md#constructor) + +### Properties + +- [address](BaseTemplate.md#address) +- [contract](BaseTemplate.md#contract) +- [contractName](BaseTemplate.md#contractname) +- [events](BaseTemplate.md#events) +- [version](BaseTemplate.md#version) + +### Accessors + +- [artifactsFolder](BaseTemplate.md#artifactsfolder) +- [circuitsFolder](BaseTemplate.md#circuitsfolder) +- [config](BaseTemplate.md#config) +- [instanceConfig](BaseTemplate.md#instanceconfig) +- [instantiableConfig](BaseTemplate.md#instantiableconfig) +- [logger](BaseTemplate.md#logger) +- [nevermined](BaseTemplate.md#nevermined) +- [web3](BaseTemplate.md#web3) + +### Methods + +- [accept](BaseTemplate.md#accept) +- [agreementId](BaseTemplate.md#agreementid) +- [call](BaseTemplate.md#call) +- [conditions](BaseTemplate.md#conditions) +- [createAgreement](BaseTemplate.md#createagreement) +- [createAgreementAndPay](BaseTemplate.md#createagreementandpay) +- [createAgreementFromDDO](BaseTemplate.md#createagreementfromddo) +- [createAgreementWithPaymentFromDDO](BaseTemplate.md#createagreementwithpaymentfromddo) +- [createService](BaseTemplate.md#createservice) +- [description](BaseTemplate.md#description) +- [extraGen](BaseTemplate.md#extragen) +- [getAgreementCreatedEvent](BaseTemplate.md#getagreementcreatedevent) +- [getAgreementData](BaseTemplate.md#getagreementdata) +- [getAgreementIdsFromDDO](BaseTemplate.md#getagreementidsfromddo) +- [getAgreementStatus](BaseTemplate.md#getagreementstatus) +- [getAgreementsForDID](BaseTemplate.md#getagreementsfordid) +- [getConditionTypes](BaseTemplate.md#getconditiontypes) +- [getConditions](BaseTemplate.md#getconditions) +- [getFromAddress](BaseTemplate.md#getfromaddress) +- [getInputsOfMethod](BaseTemplate.md#getinputsofmethod) +- [getServiceAgreementTemplate](BaseTemplate.md#getserviceagreementtemplate) +- [getServiceAgreementTemplateConditionByRef](BaseTemplate.md#getserviceagreementtemplateconditionbyref) +- [getServiceAgreementTemplateConditions](BaseTemplate.md#getserviceagreementtemplateconditions) +- [getServiceAgreementTemplateDependencies](BaseTemplate.md#getserviceagreementtemplatedependencies) +- [getSignatureOfMethod](BaseTemplate.md#getsignatureofmethod) +- [init](BaseTemplate.md#init) +- [instanceFromDDO](BaseTemplate.md#instancefromddo) +- [lockConditionIndex](BaseTemplate.md#lockconditionindex) +- [lockTokens](BaseTemplate.md#locktokens) +- [name](BaseTemplate.md#name) +- [params](BaseTemplate.md#params) +- [paramsGen](BaseTemplate.md#paramsgen) +- [paymentData](BaseTemplate.md#paymentdata) +- [printAgreementStatus](BaseTemplate.md#printagreementstatus) +- [process](BaseTemplate.md#process) +- [send](BaseTemplate.md#send) +- [sendFrom](BaseTemplate.md#sendfrom) +- [service](BaseTemplate.md#service) +- [serviceEndpoint](BaseTemplate.md#serviceendpoint) +- [setInstanceConfig](BaseTemplate.md#setinstanceconfig) +- [standardContext](BaseTemplate.md#standardcontext) +- [track](BaseTemplate.md#track) +- [validateAgreement](BaseTemplate.md#validateagreement) +- [getInstance](BaseTemplate.md#getinstance) +- [setInstanceConfig](BaseTemplate.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• `Protected` **new BaseTemplate**<`Params`, `S`\>(`contractName`) + +#### Type parameters + +| Name | Type | +| :------- | :-------------------------------------------------------- | +| `Params` | `Params` | +| `S` | extends [`ServiceCommon`](../interfaces/ServiceCommon.md) | + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Inherited from + +[AgreementTemplate](AgreementTemplate.md).[constructor](AgreementTemplate.md#constructor) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:68](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L68) + +## Properties + +### address + +• **address**: `string` + +#### Inherited from + +[AgreementTemplate](AgreementTemplate.md).[address](AgreementTemplate.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[AgreementTemplate](AgreementTemplate.md).[contract](AgreementTemplate.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[AgreementTemplate](AgreementTemplate.md).[contractName](AgreementTemplate.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[AgreementTemplate](AgreementTemplate.md).[events](AgreementTemplate.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[AgreementTemplate](AgreementTemplate.md).[version](AgreementTemplate.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +AgreementTemplate.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +AgreementTemplate.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +AgreementTemplate.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +AgreementTemplate.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +AgreementTemplate.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +AgreementTemplate.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +AgreementTemplate.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +AgreementTemplate.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### accept + +▸ **accept**(`_params`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :-------- | :------------------------------------------------------ | +| `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | + +#### Returns + +`Promise`<`boolean`\> + +#### Implementation of + +[ServicePlugin](../interfaces/ServicePlugin.md).[accept](../interfaces/ServicePlugin.md#accept) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:98](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L98) + +--- + +### agreementId + +▸ **agreementId**(`agreementIdSeed`, `creator`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :---------------- | :------- | +| `agreementIdSeed` | `string` | +| `creator` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[AgreementTemplate](AgreementTemplate.md).[agreementId](AgreementTemplate.md#agreementid) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:213](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L213) + +--- + +### 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 + +[AgreementTemplate](AgreementTemplate.md).[call](AgreementTemplate.md#call) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### conditions + +▸ `Abstract` **conditions**(): [`Condition`](Condition.md)<`any`, `any`\>[] + +#### Returns + +[`Condition`](Condition.md)<`any`, `any`\>[] + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L29) + +--- + +### createAgreement + +▸ **createAgreement**(`agreementId`, `did`, `conditionIds`, `timeLocks`, `timeOuts`, `extraArgs`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `agreementId` | `string` | +| `did` | `string` | +| `conditionIds` | `string`[] | +| `timeLocks` | `number`[] | +| `timeOuts` | `number`[] | +| `extraArgs` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[AgreementTemplate](AgreementTemplate.md).[createAgreement](AgreementTemplate.md#createagreement) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L90) + +--- + +### createAgreementAndPay + +▸ **createAgreementAndPay**(`agreementId`, `did`, `conditionIds`, `timeLocks`, `timeOuts`, `accessConsumer`, `condIdx`, `rewardAddress`, `tokenAddress`, `amounts`, `receivers`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :--------------- | :---------------------------------------------- | +| `agreementId` | `string` | +| `did` | `string` | +| `conditionIds` | `string`[] | +| `timeLocks` | `number`[] | +| `timeOuts` | `number`[] | +| `accessConsumer` | `string` | +| `condIdx` | `number` | +| `rewardAddress` | `string` | +| `tokenAddress` | `string` | +| `amounts` | `bigint`[] | +| `receivers` | `string`[] | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[AgreementTemplate](AgreementTemplate.md).[createAgreementAndPay](AgreementTemplate.md#createagreementandpay) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L115) + +--- + +### createAgreementFromDDO + +▸ **createAgreementFromDDO**(`agreementIdSeed`, `ddo`, `parameters`, `consumer`, `from`, `timeOuts?`, `txParams?`): `Promise`<`string`\> + +Create a new agreement using the data of a DDO. + +#### Parameters + +| Name | Type | Description | +| :---------------- | :---------------------------------------------- | :---------- | +| `agreementIdSeed` | `string` | - | +| `ddo` | [`DDO`](DDO.md) | DDO. | +| `parameters` | `Params` | | +| `consumer` | [`Account`](Account.md) | - | +| `from` | [`Account`](Account.md) | - | +| `timeOuts?` | `number`[] | - | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | + +#### Returns + +`Promise`<`string`\> + +true if the call was successful. + +#### Inherited from + +[AgreementTemplate](AgreementTemplate.md).[createAgreementFromDDO](AgreementTemplate.md#createagreementfromddo) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:222](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L222) + +--- + +### createAgreementWithPaymentFromDDO + +▸ **createAgreementWithPaymentFromDDO**(`agreementIdSeed`, `ddo`, `serviceReference`, `parameters`, `consumer`, `from`, `txParams?`, `observer?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :----------------- | :------------------------------------------------------------------------------------ | +| `agreementIdSeed` | `string` | +| `ddo` | [`DDO`](DDO.md) | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | +| `parameters` | `Params` | +| `consumer` | [`Account`](Account.md) | +| `from` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| `observer?` | (`orderProgressStep`: [`OrderProgressStep`](../enums/OrderProgressStep.md)) => `void` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[AgreementTemplate](AgreementTemplate.md).[createAgreementWithPaymentFromDDO](AgreementTemplate.md#createagreementwithpaymentfromddo) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:252](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L252) + +--- + +### createService + +▸ **createService**(`publisher`, `metadata`, `serviceAttributes`, `nftAttributes?`, `priceData?`): `S` + +#### Parameters + +| Name | Type | +| :------------------ | :---------------------------------------------------------------------------- | +| `publisher` | [`Account`](Account.md) | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | +| `serviceAttributes` | [`ServiceAttributes`](../interfaces/ServiceAttributes.md) | +| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | +| `priceData?` | [`PricedMetadataInformation`](../code-reference.md#pricedmetadatainformation) | + +#### Returns + +`S` + +#### Implementation of + +[ServicePlugin](../interfaces/ServicePlugin.md).[createService](../interfaces/ServicePlugin.md#createservice) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L35) + +--- + +### description + +▸ `Abstract` **description**(): `string` + +#### Returns + +`string` + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L28) + +--- + +### extraGen + +▸ **extraGen**(`_params`): `Promise`<`any`\> + +#### Parameters + +| Name | Type | +| :-------- | :------------------------------------------------------ | +| `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:94](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L94) + +--- + +### 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. + +#### Inherited from + +[AgreementTemplate](AgreementTemplate.md).[getAgreementCreatedEvent](AgreementTemplate.md#getagreementcreatedevent) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:459](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L459) + +--- + +### getAgreementData + +▸ **getAgreementData**(`agreementId`): `Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | + +#### Returns + +`Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:21](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L21) + +--- + +### getAgreementIdsFromDDO + +▸ **getAgreementIdsFromDDO**(`agreementId`, `ddo`, `creator`, `params`): `Promise`<`string`[]\> + +Get agreement conditions IDs. + +#### Parameters + +| Name | Type | Description | +| :------------ | :-------------- | :------------ | +| `agreementId` | `string` | Agreement ID. | +| `ddo` | [`DDO`](DDO.md) | DDO. | +| `creator` | `string` | - | +| `params` | `Params` | - | + +#### Returns + +`Promise`<`string`[]\> + +The condition IDs. + +#### Inherited from + +[AgreementTemplate](AgreementTemplate.md).[getAgreementIdsFromDDO](AgreementTemplate.md#getagreementidsfromddo) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:180](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L180) + +--- + +### getAgreementStatus + +▸ **getAgreementStatus**(`agreementId`): `Promise`<`false` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> + +Returns the status of the conditions. + +#### Parameters + +| Name | Type | Description | +| :------------ | :------- | :------------ | +| `agreementId` | `string` | Agreement ID. | + +#### Returns + +`Promise`<`false` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> + +The conditions status. + +#### Inherited from + +[AgreementTemplate](AgreementTemplate.md).[getAgreementStatus](AgreementTemplate.md#getagreementstatus) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:346](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L346) + +--- + +### getAgreementsForDID + +▸ **getAgreementsForDID**(`did`): `Promise`<`string`[]\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `did` | `string` | + +#### Returns + +`Promise`<`string`[]\> + +#### Inherited from + +[AgreementTemplate](AgreementTemplate.md).[getAgreementsForDID](AgreementTemplate.md#getagreementsfordid) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:485](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L485) + +--- + +### getConditionTypes + +▸ **getConditionTypes**(): `Promise`<`string`[]\> + +Conditions address list. + +#### Returns + +`Promise`<`string`[]\> + +A list of condition addresses. + +#### Inherited from + +[AgreementTemplate](AgreementTemplate.md).[getConditionTypes](AgreementTemplate.md#getconditiontypes) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L154) + +--- + +### getConditions + +▸ **getConditions**(): `Promise`<[`ConditionSmall`](ConditionSmall.md)[]\> + +List of condition contracts. + +#### Returns + +`Promise`<[`ConditionSmall`](ConditionSmall.md)[]\> + +A list of condition contracts. + +#### Inherited from + +[AgreementTemplate](AgreementTemplate.md).[getConditions](AgreementTemplate.md#getconditions) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:165](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L165) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[AgreementTemplate](AgreementTemplate.md).[getFromAddress](AgreementTemplate.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[AgreementTemplate](AgreementTemplate.md).[getInputsOfMethod](AgreementTemplate.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getServiceAgreementTemplate + +▸ `Abstract` **getServiceAgreementTemplate**(): [`ServiceAgreementTemplate`](../interfaces/ServiceAgreementTemplate.md) + +#### Returns + +[`ServiceAgreementTemplate`](../interfaces/ServiceAgreementTemplate.md) + +#### Inherited from + +[AgreementTemplate](AgreementTemplate.md).[getServiceAgreementTemplate](AgreementTemplate.md#getserviceagreementtemplate) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:322](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L322) + +--- + +### getServiceAgreementTemplateConditionByRef + +▸ **getServiceAgreementTemplateConditionByRef**(`ref`): `Promise`<[`ConditionSmall`](ConditionSmall.md)\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `ref` | `string` | + +#### Returns + +`Promise`<[`ConditionSmall`](ConditionSmall.md)\> + +#### Inherited from + +[AgreementTemplate](AgreementTemplate.md).[getServiceAgreementTemplateConditionByRef](AgreementTemplate.md#getserviceagreementtemplateconditionbyref) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:329](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L329) + +--- + +### getServiceAgreementTemplateConditions + +▸ **getServiceAgreementTemplateConditions**(): [`ServiceAgreementTemplateCondition`](../interfaces/ServiceAgreementTemplateCondition.md)[] + +#### Returns + +[`ServiceAgreementTemplateCondition`](../interfaces/ServiceAgreementTemplateCondition.md)[] + +#### Inherited from + +[AgreementTemplate](AgreementTemplate.md).[getServiceAgreementTemplateConditions](AgreementTemplate.md#getserviceagreementtemplateconditions) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:324](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L324) + +--- + +### getServiceAgreementTemplateDependencies + +▸ **getServiceAgreementTemplateDependencies**(): `Promise`<{ `[condition: string]`: `string`[]; }\> + +#### Returns + +`Promise`<{ `[condition: string]`: `string`[]; }\> + +#### Inherited from + +[AgreementTemplate](AgreementTemplate.md).[getServiceAgreementTemplateDependencies](AgreementTemplate.md#getserviceagreementtemplatedependencies) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:336](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L336) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[AgreementTemplate](AgreementTemplate.md).[getSignatureOfMethod](AgreementTemplate.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[AgreementTemplate](AgreementTemplate.md).[init](AgreementTemplate.md#init) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### instanceFromDDO + +▸ `Optional` `Abstract` **instanceFromDDO**(`agreementIdSeed`, `ddo`, `creator`, `parameters`, `serviceIndex?`): `Promise`<[`AgreementInstance`](../interfaces/AgreementInstance.md)<`Params`\>\> + +#### Parameters + +| Name | Type | +| :---------------- | :-------------- | +| `agreementIdSeed` | `string` | +| `ddo` | [`DDO`](DDO.md) | +| `creator` | `string` | +| `parameters` | `Params` | +| `serviceIndex?` | `number` | + +#### Returns + +`Promise`<[`AgreementInstance`](../interfaces/AgreementInstance.md)<`Params`\>\> + +#### Inherited from + +[AgreementTemplate](AgreementTemplate.md).[instanceFromDDO](AgreementTemplate.md#instancefromddo) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:190](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L190) + +--- + +### lockConditionIndex + +▸ **lockConditionIndex**(): `number` + +#### Returns + +`number` + +#### Inherited from + +[AgreementTemplate](AgreementTemplate.md).[lockConditionIndex](AgreementTemplate.md#lockconditionindex) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:74](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L74) + +--- + +### lockTokens + +▸ **lockTokens**(`tokenAddress`, `amounts`, `from`, `txParams`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `tokenAddress` | `any` | +| `amounts` | `any` | +| `from` | [`Account`](Account.md) | +| `txParams` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[AgreementTemplate](AgreementTemplate.md).[lockTokens](AgreementTemplate.md#locktokens) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:393](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L393) + +--- + +### name + +▸ `Abstract` **name**(): `string` + +#### Returns + +`string` + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:27](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L27) + +--- + +### params + +▸ `Abstract` **params**(`...args`): `Params` + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +`Params` + +#### Inherited from + +[AgreementTemplate](AgreementTemplate.md).[params](AgreementTemplate.md#params) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:72](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L72) + +--- + +### paramsGen + +▸ `Abstract` **paramsGen**(`params`): `Promise`<`Params`\> + +Specialize params + +#### Parameters + +| Name | Type | Description | +| :------- | :------------------------------------------------------ | :----------------- | +| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | Generic parameters | + +#### Returns + +`Promise`<`Params`\> + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L92) + +--- + +### paymentData + +▸ **paymentData**(`service`): `Promise`<[`PaymentData`](../interfaces/PaymentData.md)\> + +#### Parameters + +| Name | Type | +| :-------- | :------------------------------------------------ | +| `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | + +#### Returns + +`Promise`<[`PaymentData`](../interfaces/PaymentData.md)\> + +#### Inherited from + +[AgreementTemplate](AgreementTemplate.md).[paymentData](AgreementTemplate.md#paymentdata) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:78](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L78) + +--- + +### printAgreementStatus + +▸ **printAgreementStatus**(`agreementId`): `Promise`<`void`\> + +Prints the agreement status. + +#### Parameters + +| Name | Type | Description | +| :------------ | :------- | :------------ | +| `agreementId` | `string` | Agreement ID. | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[AgreementTemplate](AgreementTemplate.md).[printAgreementStatus](AgreementTemplate.md#printagreementstatus) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:429](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L429) + +--- + +### process + +▸ **process**(`params`, `from`, `txparams?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :---------- | :------------------------------------------------------ | +| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `from` | [`Account`](Account.md) | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`void`\> + +#### Implementation of + +[ServicePlugin](../interfaces/ServicePlugin.md).[process](../interfaces/ServicePlugin.md#process) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:110](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L110) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[AgreementTemplate](AgreementTemplate.md).[send](AgreementTemplate.md#send) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[AgreementTemplate](AgreementTemplate.md).[sendFrom](AgreementTemplate.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### service + +▸ `Abstract` **service**(): [`ServiceType`](../code-reference.md#servicetype) + +#### Returns + +[`ServiceType`](../code-reference.md#servicetype) + +#### Inherited from + +[AgreementTemplate](AgreementTemplate.md).[service](AgreementTemplate.md#service) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:198](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L198) + +--- + +### serviceEndpoint + +▸ **serviceEndpoint**(): `string` + +#### Returns + +`string` + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L31) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[AgreementTemplate](AgreementTemplate.md).[setInstanceConfig](AgreementTemplate.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### standardContext + +▸ **standardContext**(`ddo`, `creator`, `serviceIndex?`): [`ConditionContext`](../interfaces/ConditionContext.md) + +#### Parameters + +| Name | Type | +| :-------------- | :-------------- | +| `ddo` | [`DDO`](DDO.md) | +| `creator` | `string` | +| `serviceIndex?` | `number` | + +#### Returns + +[`ConditionContext`](../interfaces/ConditionContext.md) + +#### Inherited from + +[AgreementTemplate](AgreementTemplate.md).[standardContext](AgreementTemplate.md#standardcontext) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:200](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L200) + +--- + +### track + +▸ **track**(`_params`, `_from`, `_txparams?`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :----------- | :------------------------------------------------------ | +| `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `_from` | [`Account`](Account.md) | +| `_txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`boolean`\> + +#### Implementation of + +[ServicePlugin](../interfaces/ServicePlugin.md).[track](../interfaces/ServicePlugin.md#track) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:102](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L102) + +--- + +### validateAgreement + +▸ **validateAgreement**(`agreement_id`, `did`, `params`, `from`, `extra?`, `txparams?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `agreement_id` | `string` | +| `did` | `string` | +| `params` | `Params` | +| `from` | [`Account`](Account.md) | +| `extra` | `any` | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:125](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L125) + +--- + +### getInstance + +▸ `Static` **getInstance**<`Params`\>(`config`, `templateContractName`, `templateClass`, `optional?`): `Promise`<`any`\> + +#### Type parameters + +| Name | +| :------- | +| `Params` | + +#### Parameters + +| Name | Type | Default value | +| :--------------------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `templateContractName` | `string` | `undefined` | +| `templateClass` | `any` | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`any`\> + +#### Inherited from + +[AgreementTemplate](AgreementTemplate.md).[getInstance](AgreementTemplate.md#getinstance) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:55](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L55) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[AgreementTemplate](AgreementTemplate.md).[setInstanceConfig](AgreementTemplate.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/Bookmarks.md b/docs/api-reference/classes/Bookmarks.md new file mode 100644 index 000000000..a950ff443 --- /dev/null +++ b/docs/api-reference/classes/Bookmarks.md @@ -0,0 +1,461 @@ +[@nevermined-io/sdk](../code-reference.md) / Bookmarks + +# Class: Bookmarks + +## Hierarchy + +- [`MarketplaceApi`](MarketplaceApi.md) + + ↳ **`Bookmarks`** + +## Table of contents + +### Constructors + +- [constructor](Bookmarks.md#constructor) + +### Accessors + +- [artifactsFolder](Bookmarks.md#artifactsfolder) +- [circuitsFolder](Bookmarks.md#circuitsfolder) +- [config](Bookmarks.md#config) +- [instanceConfig](Bookmarks.md#instanceconfig) +- [instantiableConfig](Bookmarks.md#instantiableconfig) +- [logger](Bookmarks.md#logger) +- [nevermined](Bookmarks.md#nevermined) +- [url](Bookmarks.md#url) +- [web3](Bookmarks.md#web3) + +### Methods + +- [addNewAddress](Bookmarks.md#addnewaddress) +- [create](Bookmarks.md#create) +- [deleteOneById](Bookmarks.md#deleteonebyid) +- [findManyByUserId](Bookmarks.md#findmanybyuserid) +- [findOneById](Bookmarks.md#findonebyid) +- [login](Bookmarks.md#login) +- [setInstanceConfig](Bookmarks.md#setinstanceconfig) +- [updateOneById](Bookmarks.md#updateonebyid) +- [getInstance](Bookmarks.md#getinstance) +- [setInstanceConfig](Bookmarks.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new Bookmarks**(`config`) + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Inherited from + +[MarketplaceApi](MarketplaceApi.md).[constructor](MarketplaceApi.md#constructor) + +#### Defined in + +[src/services/metadata/MarketplaceAPI.ts:7](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MarketplaceAPI.ts#L7) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +MarketplaceApi.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +MarketplaceApi.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +MarketplaceApi.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +MarketplaceApi.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +MarketplaceApi.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +MarketplaceApi.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +MarketplaceApi.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### url + +• `Protected` `get` **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +MarketplaceApi.url + +#### Defined in + +[src/services/metadata/MarketplaceAPI.ts:12](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MarketplaceAPI.ts#L12) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +MarketplaceApi.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### addNewAddress + +▸ **addNewAddress**(`clientAssertion`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :---------------- | :------- | +| `clientAssertion` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[MarketplaceApi](MarketplaceApi.md).[addNewAddress](MarketplaceApi.md#addnewaddress) + +#### Defined in + +[src/services/metadata/MarketplaceAPI.ts:36](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MarketplaceAPI.ts#L36) + +--- + +### create + +▸ **create**(`newBookmark`): `Promise`<[`Bookmark`](../interfaces/Bookmark.md)\> + +Create bookmark + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------------------- | +| `newBookmark` | [`NewBookmark`](../interfaces/NewBookmark.md) | + +#### Returns + +`Promise`<[`Bookmark`](../interfaces/Bookmark.md)\> + +#### Defined in + +[src/services/metadata/Bookmarks.ts:14](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/Bookmarks.ts#L14) + +--- + +### deleteOneById + +▸ **deleteOneById**(`id`): `Promise`<`void`\> + +Delele a bookmark by id + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `id` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[src/services/metadata/Bookmarks.ts:112](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/Bookmarks.ts#L112) + +--- + +### findManyByUserId + +▸ **findManyByUserId**(`userId`, `query?`): `Promise`<[`MarketplaceResults`](../interfaces/MarketplaceResults.md)<[`Bookmark`](../interfaces/Bookmark.md)\>\> + +Get bookmarks by userId + +#### Parameters + +| Name | Type | +| :------- | :-------------------------------------------- | +| `userId` | `string` | +| `query?` | [`SearchQuery`](../interfaces/SearchQuery.md) | + +#### Returns + +`Promise`<[`MarketplaceResults`](../interfaces/MarketplaceResults.md)<[`Bookmark`](../interfaces/Bookmark.md)\>\> + +#### Defined in + +[src/services/metadata/Bookmarks.ts:63](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/Bookmarks.ts#L63) + +--- + +### findOneById + +▸ **findOneById**(`id`): `Promise`<[`Bookmark`](../interfaces/Bookmark.md)\> + +Get a bookmark by Id + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `id` | `string` | + +#### Returns + +`Promise`<[`Bookmark`](../interfaces/Bookmark.md)\> + +#### Defined in + +[src/services/metadata/Bookmarks.ts:41](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/Bookmarks.ts#L41) + +--- + +### login + +▸ **login**(`clientAssertion`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :---------------- | :------- | +| `clientAssertion` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[MarketplaceApi](MarketplaceApi.md).[login](MarketplaceApi.md#login) + +#### Defined in + +[src/services/metadata/MarketplaceAPI.ts:16](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MarketplaceAPI.ts#L16) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[MarketplaceApi](MarketplaceApi.md).[setInstanceConfig](MarketplaceApi.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### updateOneById + +▸ **updateOneById**(`id`, `bookmark`): `Promise`<[`Bookmark`](../interfaces/Bookmark.md)\> + +Update a bookmark by id + +#### Parameters + +| Name | Type | +| :--------- | :-------------------------------------------------- | +| `id` | `string` | +| `bookmark` | `Partial`<[`Bookmark`](../interfaces/Bookmark.md)\> | + +#### Returns + +`Promise`<[`Bookmark`](../interfaces/Bookmark.md)\> + +#### Defined in + +[src/services/metadata/Bookmarks.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/Bookmarks.ts#L88) + +--- + +### getInstance + +▸ `Static` **getInstance**(`..._args`): `any` + +#### Parameters + +| Name | Type | +| :--------- | :---- | +| `..._args` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[MarketplaceApi](MarketplaceApi.md).[getInstance](MarketplaceApi.md#getinstance) + +#### Defined in + +[src/Instantiable.abstract.ts:86](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L86) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[MarketplaceApi](MarketplaceApi.md).[setInstanceConfig](MarketplaceApi.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/ClientError.md b/docs/api-reference/classes/ClientError.md index 8e4fe9dc2..0dc717783 100644 --- a/docs/api-reference/classes/ClientError.md +++ b/docs/api-reference/classes/ClientError.md @@ -45,7 +45,7 @@ Error.constructor #### Defined in -[src/errors/ClientError.ts:2](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/errors/ClientError.ts#L2) +[src/errors/ClientError.ts:2](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/errors/ClientError.ts#L2) ## Properties @@ -59,7 +59,7 @@ Error.message #### Defined in -node_modules/typescript/lib/lib.es5.d.ts:1041 +node_modules/typescript/lib/lib.es5.d.ts:1068 --- @@ -73,7 +73,7 @@ Error.name #### Defined in -node_modules/typescript/lib/lib.es5.d.ts:1040 +node_modules/typescript/lib/lib.es5.d.ts:1067 --- @@ -87,9 +87,7 @@ Error.stack #### Defined in -node_modules/typescript/lib/lib.es5.d.ts:1042 - -node_modules/@types/node/globals.d.ts:127 +node_modules/typescript/lib/lib.es5.d.ts:1069 --- @@ -103,10 +101,6 @@ node_modules/@types/node/globals.d.ts:127 Optional override for formatting stack traces -**`See`** - -https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces - ##### Parameters | Name | Type | @@ -118,13 +112,17 @@ https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces `any` +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Inherited from Error.prepareStackTrace #### Defined in -node_modules/@types/node/globals.d.ts:140 +node_modules/@types/node/globals.d.ts:11 --- @@ -138,7 +136,7 @@ Error.stackTraceLimit #### Defined in -node_modules/@types/node/globals.d.ts:142 +node_modules/@types/node/globals.d.ts:13 ## Methods @@ -152,7 +150,7 @@ Create .stack property on a target object | Name | Type | | :---------------- | :--------- | -| `targetObject` | `Object` | +| `targetObject` | `object` | | `constructorOpt?` | `Function` | #### Returns @@ -165,4 +163,4 @@ Error.captureStackTrace #### Defined in -node_modules/@types/node/globals.d.ts:133 +node_modules/@types/node/globals.d.ts:4 diff --git a/docs/api-reference/classes/ComputeApi.md b/docs/api-reference/classes/ComputeApi.md new file mode 100644 index 000000000..1d30a572c --- /dev/null +++ b/docs/api-reference/classes/ComputeApi.md @@ -0,0 +1,729 @@ +[@nevermined-io/sdk](../code-reference.md) / ComputeApi + +# Class: ComputeApi + +Nevermined Compute API. It allows the registration execution of compute jobs on top +of data registered in a Nevermined digital ecosystem. + +You can find more information about the Nevermined compute solution here: +[https://docs.nevermined.io/docs/getting-started/remote-computation](https://docs.nevermined.io/docs/getting-started/remote-computation) + +## Hierarchy + +- [`RegistryBaseApi`](RegistryBaseApi.md) + + ↳ **`ComputeApi`** + +## Table of contents + +### Constructors + +- [constructor](ComputeApi.md#constructor) + +### Properties + +- [servicePlugin](ComputeApi.md#serviceplugin) + +### Accessors + +- [artifactsFolder](ComputeApi.md#artifactsfolder) +- [circuitsFolder](ComputeApi.md#circuitsfolder) +- [config](ComputeApi.md#config) +- [instanceConfig](ComputeApi.md#instanceconfig) +- [instantiableConfig](ComputeApi.md#instantiableconfig) +- [logger](ComputeApi.md#logger) +- [nevermined](ComputeApi.md#nevermined) +- [web3](ComputeApi.md#web3) + +### Methods + +- [addRating](ComputeApi.md#addrating) +- [create](ComputeApi.md#create) +- [execute](ComputeApi.md#execute) +- [list](ComputeApi.md#list) +- [logs](ComputeApi.md#logs) +- [order](ComputeApi.md#order) +- [orderAsset](ComputeApi.md#orderasset) +- [registerNeverminedAsset](ComputeApi.md#registerneverminedasset) +- [resolveAsset](ComputeApi.md#resolveasset) +- [setInstanceConfig](ComputeApi.md#setinstanceconfig) +- [status](ComputeApi.md#status) +- [update](ComputeApi.md#update) +- [updateAsset](ComputeApi.md#updateasset) +- [getInstance](ComputeApi.md#getinstance) +- [getServicePlugin](ComputeApi.md#getserviceplugin) +- [setInstanceConfig](ComputeApi.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new ComputeApi**(`config`) + +Creates a new ComputeApi + +#### Parameters + +| Name | Type | Description | +| :------- | :---------------------------------------------------------- | :--------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | Configuration of the Nevermined instance | + +#### Overrides + +[RegistryBaseApi](RegistryBaseApi.md).[constructor](RegistryBaseApi.md#constructor) + +#### Defined in + +[src/nevermined/api/ComputeApi.ts:24](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/ComputeApi.ts#L24) + +## Properties + +### servicePlugin + +• **servicePlugin**: `Object` + +#### Index signature + +▪ [key: `string`]: [`ServicePlugin`](../interfaces/ServicePlugin.md)<[`Service`](../code-reference.md#service)\> + +#### Inherited from + +[RegistryBaseApi](RegistryBaseApi.md).[servicePlugin](RegistryBaseApi.md#serviceplugin) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L29) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +RegistryBaseApi.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +RegistryBaseApi.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +RegistryBaseApi.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +RegistryBaseApi.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +RegistryBaseApi.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +RegistryBaseApi.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +RegistryBaseApi.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +RegistryBaseApi.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### addRating + +▸ **addRating**(`did`, `newRating`, `numVotesAdded?`, `publisher`, `publishMetadata?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +Given a DID, it adds a vote to the asset curation information. + +#### Parameters + +| Name | Type | Default value | Description | +| :---------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `newRating` | `number` | `undefined` | New average rating of the asset | +| `numVotesAdded` | `number` | `1` | Number of new votes added to the rating, typically just 1 | +| `publisher` | [`Account`](Account.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +[DDO](DDO.md) The DDO updated + +#### Inherited from + +[RegistryBaseApi](RegistryBaseApi.md).[addRating](RegistryBaseApi.md#addrating) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:514](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L514) + +--- + +### create + +▸ **create**(`assetAttributes`, `publisherAccount`, `publicationOptions?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`CreateProgressStep`](../enums/CreateProgressStep.md), [`DDO`](DDO.md)\> + +Registers a new asset in Nevermined. +You can find more information about how different data is stored in Nevermined here: +[https://docs.nevermined.io/docs/architecture/nevermined-data](https://docs.nevermined.io/docs/architecture/nevermined-data) + +#### Parameters + +| Name | Type | Description | +| :------------------- | :------------------------------------------------------ | :-------------------------------------------------------------------------------- | +| `assetAttributes` | [`AssetAttributes`](AssetAttributes.md) | Attributes describing the asset | +| `publisherAccount` | [`Account`](Account.md) | The account publishing the asset | +| `publicationOptions` | [`AssetPublicationOptions`](AssetPublicationOptions.md) | Allows to specify the publication options of the off-chain and the on-chain data. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`CreateProgressStep`](../enums/CreateProgressStep.md), [`DDO`](DDO.md)\> + +The metadata of the asset created (DDO) + +[DDO](DDO.md) + +**`See`** + +[PublishOnChainOptions](../enums/PublishOnChainOptions.md) and [PublishMetadataOptions](../enums/PublishMetadataOptions.md) + +#### Defined in + +[src/nevermined/api/ComputeApi.ts:43](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/ComputeApi.ts#L43) + +--- + +### execute + +▸ **execute**(`agreementId`, `workflowDid`, `consumerAccount`): `Promise`<`string`\> + +It triggers the execution of a compute job + +#### Parameters + +| Name | Type | Description | +| :---------------- | :---------------------- | :----------------------------------------------------------- | +| `agreementId` | `string` | The unique identifier of the order placed for a service | +| `workflowDid` | `string` | The unique identifier of the Asset representing the workflow | +| `consumerAccount` | [`Account`](Account.md) | The account of the user triggering the computation | + +#### Returns + +`Promise`<`string`\> + +If the execution is correct it returns the response given by the Nevermined Node + +#### Defined in + +[src/nevermined/api/ComputeApi.ts:120](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/ComputeApi.ts#L120) + +--- + +### list + +▸ **list**(`did`, `list`, `publisher`, `publishMetadata?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +Given a DID, updates the metadata associated to the asset allowing to list or unlist it. It also can upload this metadata to a remote decentralized stored depending on the `publishMetadata` parameter. +In a Nevermined environment, when an asset is unlisted, it is not possible to be found and accessed by any user. + +#### Parameters + +| Name | Type | Default value | Description | +| :---------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `list` | `boolean` | `undefined` | Needs the asset to be listed or unlisted | +| `publisher` | [`Account`](Account.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +[DDO](DDO.md) The DDO updated + +#### Inherited from + +[RegistryBaseApi](RegistryBaseApi.md).[list](RegistryBaseApi.md#list) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:462](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L462) + +--- + +### logs + +▸ **logs**(`agreementId`, `executionId`, `consumerAccount`): `Promise`<`any`\> + +It returns the logs resulted by the execution of a Job + +#### Parameters + +| Name | Type | Description | +| :---------------- | :---------------------- | :------------------------------------------------------ | +| `agreementId` | `string` | The unique identifier of the order placed for a service | +| `executionId` | `string` | The unique identifier of the job executed | +| `consumerAccount` | [`Account`](Account.md) | The account of the user triggering the computation | + +#### Returns + +`Promise`<`any`\> + +The logs resulted of the execution of the job + +#### Defined in + +[src/nevermined/api/ComputeApi.ts:137](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/ComputeApi.ts#L137) + +--- + +### order + +▸ **order**(`did`, `consumerAccount`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`OrderProgressStep`](../enums/OrderProgressStep.md), `string`\> + +Start the purchase/order of a compute service. Starts by signing the service agreement +then sends the request to the publisher via the service endpoint (Node http service). + +#### Parameters + +| Name | Type | Description | +| :---------------- | :---------------------------------------------- | :----------------------------------------- | +| `did` | `string` | Unique identifier of the asset to order | +| `consumerAccount` | [`Account`](Account.md) | The account of the user ordering the asset | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`OrderProgressStep`](../enums/OrderProgressStep.md), `string`\> + +The agreement ID identifying the order + +#### Defined in + +[src/nevermined/api/ComputeApi.ts:105](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/ComputeApi.ts#L105) + +--- + +### orderAsset + +▸ **orderAsset**(`did`, `serviceReference`, `consumer`, `params?`): [`SubscribablePromise`](SubscribablePromise.md)<[`OrderProgressStep`](../enums/OrderProgressStep.md), `string`\> + +Start the purchase/order of an asset's service. Starts by signing the service agreement +then sends the request to the publisher via the service endpoint (Node http service). + +#### Parameters + +| Name | Type | Description | +| :----------------- | :------------------------------------------------------------ | :---------------- | +| `did` | `string` | Decentralized ID. | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | Service. | +| `consumer` | [`Account`](Account.md) | Consumer account. | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | - | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`OrderProgressStep`](../enums/OrderProgressStep.md), `string`\> + +The agreement ID. + +#### Inherited from + +[RegistryBaseApi](RegistryBaseApi.md).[orderAsset](RegistryBaseApi.md#orderasset) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:563](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L563) + +--- + +### registerNeverminedAsset + +▸ `Protected` **registerNeverminedAsset**(`assetAttributes`, `publisher`, `publicationOptions`, `nftAttributes?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`CreateProgressStep`](../enums/CreateProgressStep.md), [`DDO`](DDO.md)\> + +It registers a new asset in a Nevermined network. This method is protected and not exposed +via the Nevermined APIs directly. It must accessed via the `assets`, `compute`, and `nfts` APIs. + +#### Parameters + +| Name | Type | Description | +| :------------------- | :------------------------------------------------------ | :-------------------------------------------------------------------------------- | +| `assetAttributes` | [`AssetAttributes`](AssetAttributes.md) | Attributes describing the asset | +| `publisher` | [`Account`](Account.md) | The account publishing the asset | +| `publicationOptions` | [`AssetPublicationOptions`](AssetPublicationOptions.md) | Allows to specify the publication options of the off-chain and the on-chain data. | +| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | Attributes describing the NFT (ERC-721) associated to the asset | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`CreateProgressStep`](../enums/CreateProgressStep.md), [`DDO`](DDO.md)\> + +The metadata of the asset created (DDO) + +**`See`** + +[PublishOnChainOptions](../enums/PublishOnChainOptions.md) and [PublishMetadataOptions](../enums/PublishMetadataOptions.md) + +#### Inherited from + +[RegistryBaseApi](RegistryBaseApi.md).[registerNeverminedAsset](RegistryBaseApi.md#registerneverminedasset) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L42) + +--- + +### resolveAsset + +▸ `Protected` **resolveAsset**(`did`, `policy?`): `Promise`<[`DDO`](DDO.md)\> + +Returns a DDO by DID. Depending of the resolution policy it prioritize the Metadata API or Immutable urls. + +#### Parameters + +| Name | Type | Default value | Description | +| :------- | :------------------------------------------------- | :---------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `did` | `string` | `undefined` | Decentralized ID. | +| `policy` | [`DIDResolvePolicy`](../enums/DIDResolvePolicy.md) | `DIDResolvePolicy.MetadataAPIFirst` | It specifies the resolve policy to apply. It allows to select that priorities during the asset resolution via Metadata API or Immutable URLs (IPFS, Filecoin, etc) | + +#### Returns + +`Promise`<[`DDO`](DDO.md)\> + +[DDO](DDO.md) + +#### Inherited from + +[RegistryBaseApi](RegistryBaseApi.md).[resolveAsset](RegistryBaseApi.md#resolveasset) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:310](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L310) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[RegistryBaseApi](RegistryBaseApi.md).[setInstanceConfig](RegistryBaseApi.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### status + +▸ **status**(`agreementId`, `executionId`, `consumerAccount`): `Promise`<`any`\> + +It returns the status of a compute job + +#### Parameters + +| Name | Type | Description | +| :---------------- | :---------------------- | :------------------------------------------------------ | +| `agreementId` | `string` | The unique identifier of the order placed for a service | +| `executionId` | `string` | The unique identifier of the job executed | +| `consumerAccount` | [`Account`](Account.md) | The account of the user triggering the computation | + +#### Returns + +`Promise`<`any`\> + +The status of the job + +#### Defined in + +[src/nevermined/api/ComputeApi.ts:152](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/ComputeApi.ts#L152) + +--- + +### update + +▸ **update**(`did`, `metadata`, `publisherAccount`, `publishMetadata?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +Given a DID, updates the metadata associated to the asset. It also can upload this metadata to a remote decentralized stored depending on the `publishMetadata` parameter. + +#### Parameters + +| Name | Type | Default value | Description | +| :----------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | Metadata describing the asset | +| `publisherAccount` | [`Account`](Account.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +[DDO](DDO.md) The DDO updated + +**`Example`** + +```ts +const ddoUpdated = await nevermined.compute.update( + ddo.shortId(), + updatedMetadata, + publisher, + PublishMetadata.IPFS, +) +``` + +#### Defined in + +[src/nevermined/api/ComputeApi.ts:87](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/ComputeApi.ts#L87) + +--- + +### updateAsset + +▸ `Protected` **updateAsset**(`did`, `metadata`, `publisher`, `publishMetadataOptions?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +Given a DID, updates the metadata associated to the asset. It also can upload this metadata to a remote decentralized stored depending on the `publishMetadata` parameter. + +#### Parameters + +| Name | Type | Default value | Description | +| :----------------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | Metadata describing the asset | +| `publisher` | [`Account`](Account.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadataOptions` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +[DDO](DDO.md) The DDO updated + +#### Inherited from + +[RegistryBaseApi](RegistryBaseApi.md).[updateAsset](RegistryBaseApi.md#updateasset) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:353](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L353) + +--- + +### getInstance + +▸ `Static` **getInstance**(`..._args`): `any` + +#### Parameters + +| Name | Type | +| :--------- | :---- | +| `..._args` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[RegistryBaseApi](RegistryBaseApi.md).[getInstance](RegistryBaseApi.md#getinstance) + +#### Defined in + +[src/Instantiable.abstract.ts:86](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L86) + +--- + +### getServicePlugin + +▸ `Static` `Protected` **getServicePlugin**(`config`): `Object` + +Initializes the default Nevermined service plugins and return that instance + +#### Parameters + +| Name | Type | Description | +| :------- | :---------------------------------------------------------- | :---------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | Nevermined config | + +#### Returns + +`Object` + +The Nevermined Service Plugin instance + +| Name | Type | +| :------------ | :------------------------------------------------------------------------------------------------------------ | +| `aave-credit` | [`ServicePlugin`](../interfaces/ServicePlugin.md)<[`ServiceAaveCredit`](../interfaces/ServiceAaveCredit.md)\> | +| `access` | [`AccessService`](AccessService.md) | +| `compute` | [`EscrowComputeExecutionTemplate`](EscrowComputeExecutionTemplate.md) | +| `nft-access` | [`NFTAccessService`](NFTAccessService.md) | +| `nft-sales` | [`NFTSalesService`](NFTSalesService.md) | + +#### Inherited from + +[RegistryBaseApi](RegistryBaseApi.md).[getServicePlugin](RegistryBaseApi.md#getserviceplugin) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:618](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L618) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[RegistryBaseApi](RegistryBaseApi.md).[setInstanceConfig](RegistryBaseApi.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/ComputeExecutionCondition.md b/docs/api-reference/classes/ComputeExecutionCondition.md new file mode 100644 index 000000000..48b3c4de1 --- /dev/null +++ b/docs/api-reference/classes/ComputeExecutionCondition.md @@ -0,0 +1,985 @@ +[@nevermined-io/sdk](../code-reference.md) / ComputeExecutionCondition + +# Class: ComputeExecutionCondition + +## Hierarchy + +- [`ProviderCondition`](ProviderCondition.md)<`ComputeExecutionConditionContext`\> + + ↳ **`ComputeExecutionCondition`** + +## Table of contents + +### Constructors + +- [constructor](ComputeExecutionCondition.md#constructor) + +### Properties + +- [address](ComputeExecutionCondition.md#address) +- [contract](ComputeExecutionCondition.md#contract) +- [contractName](ComputeExecutionCondition.md#contractname) +- [events](ComputeExecutionCondition.md#events) +- [version](ComputeExecutionCondition.md#version) + +### Accessors + +- [artifactsFolder](ComputeExecutionCondition.md#artifactsfolder) +- [circuitsFolder](ComputeExecutionCondition.md#circuitsfolder) +- [config](ComputeExecutionCondition.md#config) +- [instanceConfig](ComputeExecutionCondition.md#instanceconfig) +- [instantiableConfig](ComputeExecutionCondition.md#instantiableconfig) +- [logger](ComputeExecutionCondition.md#logger) +- [nevermined](ComputeExecutionCondition.md#nevermined) +- [web3](ComputeExecutionCondition.md#web3) + +### Methods + +- [abortByTimeOut](ComputeExecutionCondition.md#abortbytimeout) +- [call](ComputeExecutionCondition.md#call) +- [fulfill](ComputeExecutionCondition.md#fulfill) +- [fulfillInstance](ComputeExecutionCondition.md#fulfillinstance) +- [fulfillPlain](ComputeExecutionCondition.md#fulfillplain) +- [fulfillWithNode](ComputeExecutionCondition.md#fulfillwithnode) +- [generateId](ComputeExecutionCondition.md#generateid) +- [generateIdHash](ComputeExecutionCondition.md#generateidhash) +- [generateIdWithSeed](ComputeExecutionCondition.md#generateidwithseed) +- [getConditionFulfilledEvent](ComputeExecutionCondition.md#getconditionfulfilledevent) +- [getFromAddress](ComputeExecutionCondition.md#getfromaddress) +- [getInputsOfMethod](ComputeExecutionCondition.md#getinputsofmethod) +- [getSignatureOfMethod](ComputeExecutionCondition.md#getsignatureofmethod) +- [hashValues](ComputeExecutionCondition.md#hashvalues) +- [hashValuesPlain](ComputeExecutionCondition.md#hashvaluesplain) +- [init](ComputeExecutionCondition.md#init) +- [instance](ComputeExecutionCondition.md#instance) +- [instanceFromDDO](ComputeExecutionCondition.md#instancefromddo) +- [nodeMethod](ComputeExecutionCondition.md#nodemethod) +- [params](ComputeExecutionCondition.md#params) +- [paramsFromDDO](ComputeExecutionCondition.md#paramsfromddo) +- [send](ComputeExecutionCondition.md#send) +- [sendFrom](ComputeExecutionCondition.md#sendfrom) +- [setInstanceConfig](ComputeExecutionCondition.md#setinstanceconfig) +- [wasComputeTriggered](ComputeExecutionCondition.md#wascomputetriggered) +- [getInstance](ComputeExecutionCondition.md#getinstance) +- [setInstanceConfig](ComputeExecutionCondition.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new ComputeExecutionCondition**(`contractName`) + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[constructor](ProviderCondition.md#constructor) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L34) + +## Properties + +### address + +• **address**: `string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[address](ProviderCondition.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[contract](ProviderCondition.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[contractName](ProviderCondition.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[events](ProviderCondition.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[version](ProviderCondition.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ProviderCondition.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ProviderCondition.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +ProviderCondition.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ProviderCondition.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ProviderCondition.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +ProviderCondition.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +ProviderCondition.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +ProviderCondition.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### abortByTimeOut + +▸ **abortByTimeOut**(`conditionId`, `from?`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------------ | :---------------------------------------------- | +| `conditionId` | `string` | +| `from?` | [`Account`](Account.md) | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[abortByTimeOut](ProviderCondition.md#abortbytimeout) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L88) + +--- + +### 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 + +[ProviderCondition](ProviderCondition.md).[call](ProviderCondition.md#call) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### fulfill + +▸ **fulfill**(`agreementId`, `did`, `computeConsumer`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :---------------- | :---------------------------------------------- | +| `agreementId` | `string` | +| `did` | `string` | +| `computeConsumer` | `string` | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[fulfill](ProviderCondition.md#fulfill) + +#### Defined in + +[src/keeper/contracts/conditions/ComputeExecutionCondition.ts:24](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/ComputeExecutionCondition.ts#L24) + +--- + +### fulfillInstance + +▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `txParams?`, `method?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | Default value | +| :----------------- | :----------------------------------------------------------------------------------------- | :------------ | +| `cond` | [`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | +| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | +| `from?` | [`Account`](Account.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[fulfillInstance](ProviderCondition.md#fulfillinstance) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:150](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L150) + +--- + +### fulfillPlain + +▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `txParams?`, `method?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | Default value | +| :------------ | :-------------------------------------------------------- | :------------ | +| `agreementId` | `string` | `undefined` | +| `args` | `any`[] | `undefined` | +| `from?` | [`Account`](Account.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[fulfillPlain](ProviderCondition.md#fulfillplain) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L63) + +--- + +### fulfillWithNode + +▸ **fulfillWithNode**(`cond`, `additionalParams`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :----------------- | :----------------------------------------------------------------------------------------- | +| `cond` | [`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | +| `additionalParams` | `Record`<`string`, `unknown`\> | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[fulfillWithNode](ProviderCondition.md#fulfillwithnode) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:194](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L194) + +--- + +### generateId + +▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `valueHash` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[generateId](ProviderCondition.md#generateid) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L77) + +--- + +### generateIdHash + +▸ **generateIdHash**(`agreementId`, `...values`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `...values` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[generateIdHash](ProviderCondition.md#generateidhash) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L73) + +--- + +### generateIdWithSeed + +▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `valueHash` | `string` | + +#### Returns + +`Promise`<[`string`, `string`]\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[generateIdWithSeed](ProviderCondition.md#generateidwithseed) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L81) + +--- + +### getConditionFulfilledEvent + +▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../code-reference.md#eventresult) + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | + +#### Returns + +[`EventResult`](../code-reference.md#eventresult) + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getConditionFulfilledEvent](ProviderCondition.md#getconditionfulfilledevent) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L92) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getFromAddress](ProviderCondition.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getInputsOfMethod](ProviderCondition.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getSignatureOfMethod](ProviderCondition.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### hashValues + +▸ **hashValues**(`...args`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[hashValues](ProviderCondition.md#hashvalues) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L129) + +--- + +### hashValuesPlain + +▸ **hashValuesPlain**(`...args`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[hashValuesPlain](ProviderCondition.md#hashvaluesplain) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:133](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L133) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[init](ProviderCondition.md#init) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### instance + +▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :------------ | :--------------------------------------------------------------------------------------------- | +| `agreementId` | `string` | +| `params` | [`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | + +#### Returns + +`Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[instance](ProviderCondition.md#instance) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:174](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L174) + +--- + +### instanceFromDDO + +▸ **instanceFromDDO**(`agreementId`, `ctx`, `...args`): `Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------------------------------------------- | +| `agreementId` | `string` | +| `ctx` | `ComputeExecutionConditionContext` | +| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | + +#### Returns + +`Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[instanceFromDDO](ProviderCondition.md#instancefromddo) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L142) + +--- + +### nodeMethod + +▸ **nodeMethod**(): [`ConditionMethod`](../code-reference.md#conditionmethod) + +#### Returns + +[`ConditionMethod`](../code-reference.md#conditionmethod) + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[nodeMethod](ProviderCondition.md#nodemethod) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:208](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L208) + +--- + +### params + +▸ **params**(`did`, `computeConsumer`): [`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> + +#### Parameters + +| Name | Type | +| :---------------- | :------- | +| `did` | `string` | +| `computeConsumer` | `string` | + +#### Returns + +[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[params](ProviderCondition.md#params) + +#### Defined in + +[src/keeper/contracts/conditions/ComputeExecutionCondition.ts:20](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/ComputeExecutionCondition.ts#L20) + +--- + +### paramsFromDDO + +▸ **paramsFromDDO**(`«destructured»`): `Promise`<[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :--------------- | :--------------------------------- | +| `«destructured»` | `ComputeExecutionConditionContext` | + +#### Returns + +`Promise`<[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[paramsFromDDO](ProviderCondition.md#paramsfromddo) + +#### Defined in + +[src/keeper/contracts/conditions/ComputeExecutionCondition.ts:12](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/ComputeExecutionCondition.ts#L12) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[send](ProviderCondition.md#send) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[sendFrom](ProviderCondition.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[setInstanceConfig](ProviderCondition.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### wasComputeTriggered + +▸ **wasComputeTriggered**(`did`, `computeConsumer`, `from?`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :---------------- | :---------------------- | +| `did` | `string` | +| `computeConsumer` | `string` | +| `from?` | [`Account`](Account.md) | + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[src/keeper/contracts/conditions/ComputeExecutionCondition.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/ComputeExecutionCondition.ts#L39) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`): `Promise`<[`ComputeExecutionCondition`](ComputeExecutionCondition.md)\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`Promise`<[`ComputeExecutionCondition`](ComputeExecutionCondition.md)\> + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[getInstance](ProviderCondition.md#getinstance) + +#### Defined in + +[src/keeper/contracts/conditions/ComputeExecutionCondition.ts:16](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/ComputeExecutionCondition.ts#L16) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[setInstanceConfig](ProviderCondition.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/Condition.md b/docs/api-reference/classes/Condition.md index 1f05eeef2..8acc4f9b3 100644 --- a/docs/api-reference/classes/Condition.md +++ b/docs/api-reference/classes/Condition.md @@ -4,20 +4,20 @@ ## Type parameters -| Name | Type | -| :------ | :------------------------------------------------------------------------- | -| `Ctx` | extends [`ConditionContext`](../interfaces/conditions.ConditionContext.md) | -| `Extra` | `Record`<`string`, `unknown`\> | +| Name | Type | +| :------ | :-------------------------------------------------------------- | +| `Ctx` | extends [`ConditionContext`](../interfaces/ConditionContext.md) | +| `Extra` | `Record`<`string`, `unknown`\> | ## Hierarchy -- [`ConditionSmall`](conditions.ConditionSmall.md) +- [`ConditionSmall`](ConditionSmall.md) ↳ **`Condition`** - ↳↳ [`ProviderCondition`](conditions.ProviderCondition.md) + ↳↳ [`ProviderCondition`](ProviderCondition.md) - ↳↳ [`ConsumerCondition`](conditions.ConsumerCondition.md) + ↳↳ [`ConsumerCondition`](ConsumerCondition.md) ## Table of contents @@ -27,6 +27,7 @@ ### Properties +- [address](Condition.md#address) - [contract](Condition.md#contract) - [contractName](Condition.md#contractname) - [events](Condition.md#events) @@ -34,8 +35,8 @@ ### Accessors -- [address](Condition.md#address) - [artifactsFolder](Condition.md#artifactsfolder) +- [circuitsFolder](Condition.md#circuitsfolder) - [config](Condition.md#config) - [instanceConfig](Condition.md#instanceconfig) - [instantiableConfig](Condition.md#instantiableconfig) @@ -46,20 +47,15 @@ ### Methods - [abortByTimeOut](Condition.md#abortbytimeout) -- [addresses](Condition.md#addresses) - [call](Condition.md#call) -- [checkExists](Condition.md#checkexists) -- [findSigner](Condition.md#findsigner) - [fulfill](Condition.md#fulfill) -- [fulfillGateway](Condition.md#fulfillgateway) - [fulfillInstance](Condition.md#fulfillinstance) - [fulfillPlain](Condition.md#fulfillplain) +- [fulfillWithNode](Condition.md#fulfillwithnode) - [generateId](Condition.md#generateid) - [generateIdHash](Condition.md#generateidhash) - [generateIdWithSeed](Condition.md#generateidwithseed) -- [getAddress](Condition.md#getaddress) - [getConditionFulfilledEvent](Condition.md#getconditionfulfilledevent) -- [getContract](Condition.md#getcontract) - [getFromAddress](Condition.md#getfromaddress) - [getInputsOfMethod](Condition.md#getinputsofmethod) - [getSignatureOfMethod](Condition.md#getsignatureofmethod) @@ -73,8 +69,6 @@ - [send](Condition.md#send) - [sendFrom](Condition.md#sendfrom) - [setInstanceConfig](Condition.md#setinstanceconfig) -- [addressesStatic](Condition.md#addressesstatic) -- [findSignerStatic](Condition.md#findsignerstatic) - [getInstance](Condition.md#getinstance) - [setInstanceConfig](Condition.md#setinstanceconfig-1) @@ -86,10 +80,10 @@ #### Type parameters -| Name | Type | -| :------ | :------------------------------------------------------------------------- | -| `Ctx` | extends [`ConditionContext`](../interfaces/conditions.ConditionContext.md) | -| `Extra` | `Record`<`string`, `unknown`\> | +| Name | Type | +| :------ | :-------------------------------------------------------------- | +| `Ctx` | extends [`ConditionContext`](../interfaces/ConditionContext.md) | +| `Extra` | `Record`<`string`, `unknown`\> | #### Parameters @@ -99,53 +93,67 @@ #### Inherited from -[ConditionSmall](conditions.ConditionSmall.md).[constructor](conditions.ConditionSmall.md#constructor) +[ConditionSmall](ConditionSmall.md).[constructor](ConditionSmall.md#constructor) #### Defined in -[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L32) +[src/keeper/contracts/ContractBase.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L34) ## Properties +### address + +• **address**: `string` + +#### Inherited from + +[ConditionSmall](ConditionSmall.md).[address](ConditionSmall.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + ### contract -• **contract**: `Contract` = `null` +• **contract**: `BaseContract` = `null` #### Inherited from -[ConditionSmall](conditions.ConditionSmall.md).[contract](conditions.ConditionSmall.md#contract) +[ConditionSmall](ConditionSmall.md).[contract](ConditionSmall.md#contract) #### Defined in -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) --- ### contractName -• **contractName**: `string` +• `Readonly` **contractName**: `string` #### Inherited from -[ConditionSmall](conditions.ConditionSmall.md).[contractName](conditions.ConditionSmall.md#contractname) +[ConditionSmall](ConditionSmall.md).[contractName](ConditionSmall.md#contractname) #### Defined in -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) --- ### events -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` #### Inherited from -[ConditionSmall](conditions.ConditionSmall.md).[events](conditions.ConditionSmall.md#events) +[ConditionSmall](ConditionSmall.md).[events](ConditionSmall.md#events) #### Defined in -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) --- @@ -155,17 +163,17 @@ #### Inherited from -[ConditionSmall](conditions.ConditionSmall.md).[version](conditions.ConditionSmall.md#version) +[ConditionSmall](ConditionSmall.md).[version](ConditionSmall.md#version) #### Defined in -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) ## Accessors -### address +### artifactsFolder -• `get` **address**(): `string` +• `Protected` `get` **artifactsFolder**(): `string` #### Returns @@ -173,17 +181,17 @@ #### Inherited from -ConditionSmall.address +ConditionSmall.artifactsFolder #### Defined in -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) --- -### artifactsFolder +### circuitsFolder -• `Protected` `get` **artifactsFolder**(): `string` +• `Protected` `get` **circuitsFolder**(): `string` #### Returns @@ -191,21 +199,21 @@ ConditionSmall.address #### Inherited from -ConditionSmall.artifactsFolder +ConditionSmall.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) --- ### config -• `Protected` `get` **config**(): [`Config`](Config.md) +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) #### Returns -[`Config`](Config.md) +[`NeverminedOptions`](NeverminedOptions.md) #### Inherited from @@ -213,17 +221,17 @@ ConditionSmall.config #### Defined in -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) --- ### instanceConfig -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) #### Returns -`InstantiableConfig` +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) #### Inherited from @@ -231,17 +239,17 @@ ConditionSmall.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) --- ### instantiableConfig -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) #### Returns -`InstantiableConfig` +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) #### Inherited from @@ -249,17 +257,17 @@ ConditionSmall.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) --- ### logger -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) +• `Protected` `get` **logger**(): `Logger` #### Returns -[`Logger`](utils.Logger.md) +`Logger` #### Inherited from @@ -267,7 +275,7 @@ ConditionSmall.logger #### Defined in -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) --- @@ -285,17 +293,17 @@ ConditionSmall.nevermined #### Defined in -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) --- ### web3 -• `Protected` `get` **web3**(): `JsonRpcProvider` +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` #### Returns -`JsonRpcProvider` +`JsonRpcProvider` \| `BrowserProvider` #### Inherited from @@ -303,51 +311,33 @@ ConditionSmall.web3 #### Defined in -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) ## Methods ### abortByTimeOut -▸ **abortByTimeOut**(`agreementId`, `from?`, `params?`): `Promise`<`ContractReceipt`\> +▸ **abortByTimeOut**(`conditionId`, `from?`, `params?`): `Promise`<`ContractTransactionReceipt`\> #### Parameters -| Name | Type | -| :------------ | :---------------------- | -| `agreementId` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | +| Name | Type | +| :------------ | :---------------------------------------------- | +| `conditionId` | `string` | +| `from?` | [`Account`](Account.md) | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns -`Promise`<`ContractReceipt`\> +`Promise`<`ContractTransactionReceipt`\> #### Inherited from -[ConditionSmall](conditions.ConditionSmall.md).[abortByTimeOut](conditions.ConditionSmall.md#abortbytimeout) +[ConditionSmall](ConditionSmall.md).[abortByTimeOut](ConditionSmall.md#abortbytimeout) #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L97) - ---- - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ConditionSmall](conditions.ConditionSmall.md).[addresses](conditions.ConditionSmall.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) +[src/keeper/contracts/conditions/Condition.abstract.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L88) --- @@ -375,69 +365,17 @@ ConditionSmall.web3 #### Inherited from -[ConditionSmall](conditions.ConditionSmall.md).[call](conditions.ConditionSmall.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - ---- - -### 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 - -[ConditionSmall](conditions.ConditionSmall.md).[checkExists](conditions.ConditionSmall.md#checkexists) +[ConditionSmall](ConditionSmall.md).[call](ConditionSmall.md#call) #### Defined in -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - ---- - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ConditionSmall](conditions.ConditionSmall.md).[findSigner](conditions.ConditionSmall.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) --- ### fulfill -▸ `Abstract` **fulfill**(`agreementId`, ...`args`): `any` +▸ `Abstract` **fulfill**(`agreementId`, `...args`): `any` #### Parameters @@ -452,86 +390,86 @@ true if the contract exists. #### Inherited from -[ConditionSmall](conditions.ConditionSmall.md).[fulfill](conditions.ConditionSmall.md#fulfill) +[ConditionSmall](ConditionSmall.md).[fulfill](ConditionSmall.md#fulfill) #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:67](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L67) +[src/keeper/contracts/conditions/Condition.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L61) --- -### fulfillGateway +### fulfillInstance -▸ `Abstract` **fulfillGateway**(`cond`, `additionalParams`, `from?`, `params?`): `Promise`<`void` \| `ContractReceipt`\> +▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `txParams?`, `method?`): `Promise`<`ContractTransactionReceipt`\> #### Parameters -| Name | Type | -| :----------------- | :----------------------------------------------------------------------------- | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Extra`\> | -| `additionalParams` | `Extra` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | +| Name | Type | Default value | +| :----------------- | :------------------------------------------------------------------ | :------------ | +| `cond` | [`ConditionInstance`](../interfaces/ConditionInstance.md)<`Extra`\> | `undefined` | +| `additionalParams` | `Extra` | `undefined` | +| `from?` | [`Account`](Account.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | #### Returns -`Promise`<`void` \| `ContractReceipt`\> +`Promise`<`ContractTransactionReceipt`\> #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:177](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L177) +[src/keeper/contracts/conditions/Condition.abstract.ts:150](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L150) --- -### fulfillInstance +### fulfillPlain -▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> +▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `txParams?`, `method?`): `Promise`<`ContractTransactionReceipt`\> #### Parameters -| Name | Type | Default value | -| :----------------- | :----------------------------------------------------------------------------- | :------------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Extra`\> | `undefined` | -| `additionalParams` | `Extra` | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | +| Name | Type | Default value | +| :------------ | :-------------------------------------------------------- | :------------ | +| `agreementId` | `string` | `undefined` | +| `args` | `any`[] | `undefined` | +| `from?` | [`Account`](Account.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | #### Returns -`Promise`<`ContractReceipt`\> +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ConditionSmall](ConditionSmall.md).[fulfillPlain](ConditionSmall.md#fulfillplain) #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L162) +[src/keeper/contracts/conditions/Condition.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L63) --- -### fulfillPlain +### fulfillWithNode -▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> +▸ `Abstract` **fulfillWithNode**(`cond`, `additionalParams`, `from?`, `txParams?`): `Promise`<`void` \| `ContractTransactionReceipt`\> #### Parameters -| Name | Type | Default value | -| :------------ | :------------------------------------------------------------ | :------------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | +| Name | Type | +| :----------------- | :------------------------------------------------------------------ | +| `cond` | [`ConditionInstance`](../interfaces/ConditionInstance.md)<`Extra`\> | +| `additionalParams` | `Extra` | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConditionSmall](conditions.ConditionSmall.md).[fulfillPlain](conditions.ConditionSmall.md#fulfillplain) +`Promise`<`void` \| `ContractTransactionReceipt`\> #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L69) +[src/keeper/contracts/conditions/Condition.abstract.ts:167](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L167) --- @@ -552,17 +490,17 @@ true if the contract exists. #### Inherited from -[ConditionSmall](conditions.ConditionSmall.md).[generateId](conditions.ConditionSmall.md#generateid) +[ConditionSmall](ConditionSmall.md).[generateId](ConditionSmall.md#generateid) #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:83](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L83) +[src/keeper/contracts/conditions/Condition.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L77) --- ### generateIdHash -▸ **generateIdHash**(`agreementId`, ...`values`): `Promise`<`string`\> +▸ **generateIdHash**(`agreementId`, `...values`): `Promise`<`string`\> #### Parameters @@ -577,11 +515,11 @@ true if the contract exists. #### Inherited from -[ConditionSmall](conditions.ConditionSmall.md).[generateIdHash](conditions.ConditionSmall.md#generateidhash) +[ConditionSmall](ConditionSmall.md).[generateIdHash](ConditionSmall.md#generateidhash) #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L79) +[src/keeper/contracts/conditions/Condition.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L73) --- @@ -602,35 +540,17 @@ true if the contract exists. #### Inherited from -[ConditionSmall](conditions.ConditionSmall.md).[generateIdWithSeed](conditions.ConditionSmall.md#generateidwithseed) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L87) - ---- - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[ConditionSmall](conditions.ConditionSmall.md).[getAddress](conditions.ConditionSmall.md#getaddress) +[ConditionSmall](ConditionSmall.md).[generateIdWithSeed](ConditionSmall.md#generateidwithseed) #### Defined in -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) +[src/keeper/contracts/conditions/Condition.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L81) --- ### getConditionFulfilledEvent -▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../modules/events.md#eventresult) +▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../code-reference.md#eventresult) #### Parameters @@ -640,33 +560,15 @@ true if the contract exists. #### Returns -[`EventResult`](../modules/events.md#eventresult) - -#### Inherited from - -[ConditionSmall](conditions.ConditionSmall.md).[getConditionFulfilledEvent](conditions.ConditionSmall.md#getconditionfulfilledevent) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:101](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L101) - ---- - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` +[`EventResult`](../code-reference.md#eventresult) #### Inherited from -[ConditionSmall](conditions.ConditionSmall.md).[getContract](conditions.ConditionSmall.md#getcontract) +[ConditionSmall](ConditionSmall.md).[getConditionFulfilledEvent](ConditionSmall.md#getconditionfulfilledevent) #### Defined in -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) +[src/keeper/contracts/conditions/Condition.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L92) --- @@ -686,17 +588,17 @@ true if the contract exists. #### Inherited from -[ConditionSmall](conditions.ConditionSmall.md).[getFromAddress](conditions.ConditionSmall.md#getfromaddress) +[ConditionSmall](ConditionSmall.md).[getFromAddress](ConditionSmall.md#getfromaddress) #### Defined in -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) --- ### getInputsOfMethod -▸ **getInputsOfMethod**(`methodName`): `any`[] +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] #### Parameters @@ -706,15 +608,15 @@ true if the contract exists. #### Returns -`any`[] +readonly `ParamType`[] #### Inherited from -[ConditionSmall](conditions.ConditionSmall.md).[getInputsOfMethod](conditions.ConditionSmall.md#getinputsofmethod) +[ConditionSmall](ConditionSmall.md).[getInputsOfMethod](ConditionSmall.md#getinputsofmethod) #### Defined in -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) --- @@ -735,17 +637,17 @@ true if the contract exists. #### Inherited from -[ConditionSmall](conditions.ConditionSmall.md).[getSignatureOfMethod](conditions.ConditionSmall.md#getsignatureofmethod) +[ConditionSmall](ConditionSmall.md).[getSignatureOfMethod](ConditionSmall.md#getsignatureofmethod) #### Defined in -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) --- ### hashValues -▸ **hashValues**(...`args`): `Promise`<`string`\> +▸ **hashValues**(`...args`): `Promise`<`string`\> #### Parameters @@ -759,17 +661,17 @@ true if the contract exists. #### Overrides -[ConditionSmall](conditions.ConditionSmall.md).[hashValues](conditions.ConditionSmall.md#hashvalues) +[ConditionSmall](ConditionSmall.md).[hashValues](ConditionSmall.md#hashvalues) #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L141) +[src/keeper/contracts/conditions/Condition.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L129) --- ### hashValuesPlain -▸ **hashValuesPlain**(...`args`): `Promise`<`string`\> +▸ **hashValuesPlain**(`...args`): `Promise`<`string`\> #### Parameters @@ -783,7 +685,7 @@ true if the contract exists. #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L145) +[src/keeper/contracts/conditions/Condition.abstract.ts:133](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L133) --- @@ -793,10 +695,10 @@ true if the contract exists. #### Parameters -| Name | Type | Default value | -| :--------- | :------------------- | :------------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | #### Returns @@ -804,60 +706,60 @@ true if the contract exists. #### Inherited from -[ConditionSmall](conditions.ConditionSmall.md).[init](conditions.ConditionSmall.md#init) +[ConditionSmall](ConditionSmall.md).[init](ConditionSmall.md#init) #### Defined in -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) --- ### instance -▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Extra`\>\> +▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Extra`\>\> #### Parameters -| Name | Type | -| :------------ | :--------------------------------------------------------------------------------- | -| `agreementId` | `string` | -| `params` | [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Extra`\> | +| Name | Type | +| :------------ | :---------------------------------------------------------------------- | +| `agreementId` | `string` | +| `params` | [`ConditionParameters`](../interfaces/ConditionParameters.md)<`Extra`\> | #### Returns -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Extra`\>\> +`Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Extra`\>\> #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:184](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L184) +[src/keeper/contracts/conditions/Condition.abstract.ts:174](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L174) --- ### instanceFromDDO -▸ **instanceFromDDO**(`agreementId`, `ctx`, ...`args`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Extra`\>\> +▸ **instanceFromDDO**(`agreementId`, `ctx`, `...args`): `Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Extra`\>\> #### Parameters -| Name | Type | -| :------------ | :------------------------------------------------------------------------------- | -| `agreementId` | `string` | -| `ctx` | `Ctx` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | +| Name | Type | +| :------------ | :-------------------------------------------------------------------- | +| `agreementId` | `string` | +| `ctx` | `Ctx` | +| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | #### Returns -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Extra`\>\> +`Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Extra`\>\> #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L154) +[src/keeper/contracts/conditions/Condition.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L142) --- ### params -▸ **params**(...`args`): [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Extra`\> +▸ **params**(`...args`): [`ConditionParameters`](../interfaces/ConditionParameters.md)<`Extra`\> #### Parameters @@ -867,86 +769,86 @@ true if the contract exists. #### Returns -[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Extra`\> +[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Extra`\> #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:134](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L134) +[src/keeper/contracts/conditions/Condition.abstract.ts:122](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L122) --- ### paramsFromDDO -▸ `Abstract` **paramsFromDDO**(`ctx`, ...`args`): `Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Extra`\>\> +▸ `Abstract` **paramsFromDDO**(`ctx`, `...args`): `Promise`<[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Extra`\>\> #### Parameters -| Name | Type | -| :-------- | :------------------------------------------------------------------------------- | -| `ctx` | `Ctx` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | +| Name | Type | +| :-------- | :-------------------------------------------------------------------- | +| `ctx` | `Ctx` | +| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | #### Returns -`Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Extra`\>\> +`Promise`<[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Extra`\>\> #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L149) +[src/keeper/contracts/conditions/Condition.abstract.ts:137](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L137) --- ### send -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> #### Parameters -| Name | Type | -| :------- | :------------- | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns -`Promise`<`ContractReceipt`\> +`Promise`<`ContractTransactionReceipt`\> #### Inherited from -[ConditionSmall](conditions.ConditionSmall.md).[send](conditions.ConditionSmall.md#send) +[ConditionSmall](ConditionSmall.md).[send](ConditionSmall.md#send) #### Defined in -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) --- ### sendFrom -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> #### Parameters -| Name | Type | -| :------- | :---------------------- | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | #### Returns -`Promise`<`ContractReceipt`\> +`Promise`<`ContractTransactionReceipt`\> #### Inherited from -[ConditionSmall](conditions.ConditionSmall.md).[sendFrom](conditions.ConditionSmall.md#sendfrom) +[ConditionSmall](ConditionSmall.md).[sendFrom](ConditionSmall.md#sendfrom) #### Defined in -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) --- @@ -956,9 +858,9 @@ true if the contract exists. #### Parameters -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -966,62 +868,11 @@ true if the contract exists. #### Inherited from -[ConditionSmall](conditions.ConditionSmall.md).[setInstanceConfig](conditions.ConditionSmall.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - ---- - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ConditionSmall](conditions.ConditionSmall.md).[addressesStatic](conditions.ConditionSmall.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - ---- - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ConditionSmall](conditions.ConditionSmall.md).[findSignerStatic](conditions.ConditionSmall.md#findsignerstatic) +[ConditionSmall](ConditionSmall.md).[setInstanceConfig](ConditionSmall.md#setinstanceconfig) #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) --- @@ -1031,19 +882,19 @@ true if the contract exists. #### Type parameters -| Name | Type | -| :------ | :------------------------------------------------------------------------- | -| `Ctx` | extends [`ConditionContext`](../interfaces/conditions.ConditionContext.md) | -| `Extra` | `Extra` | +| Name | Type | +| :------ | :-------------------------------------------------------------- | +| `Ctx` | extends [`ConditionContext`](../interfaces/ConditionContext.md) | +| `Extra` | `Extra` | #### Parameters -| Name | Type | Default value | -| :---------------- | :------------------- | :------------ | -| `config` | `InstantiableConfig` | `undefined` | -| `conditionName` | `string` | `undefined` | -| `conditionsClass` | `any` | `undefined` | -| `optional` | `boolean` | `false` | +| Name | Type | Default value | +| :---------------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `conditionName` | `string` | `undefined` | +| `conditionsClass` | `any` | `undefined` | +| `optional` | `boolean` | `false` | #### Returns @@ -1051,11 +902,11 @@ true if the contract exists. #### Overrides -[ConditionSmall](conditions.ConditionSmall.md).[getInstance](conditions.ConditionSmall.md#getinstance) +[ConditionSmall](ConditionSmall.md).[getInstance](ConditionSmall.md#getinstance) #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:121](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L121) +[src/keeper/contracts/conditions/Condition.abstract.ts:111](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L111) --- @@ -1065,16 +916,16 @@ true if the contract exists. #### Type parameters -| Name | Type | -| :--- | :--------------------------- | -| `T` | extends `Instantiable`<`T`\> | +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :------------------- | -| `instance` | `T` | -| `instantiableConfig` | `InstantiableConfig` | +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -1082,8 +933,8 @@ true if the contract exists. #### Inherited from -[ConditionSmall](conditions.ConditionSmall.md).[setInstanceConfig](conditions.ConditionSmall.md#setinstanceconfig-1) +[ConditionSmall](ConditionSmall.md).[setInstanceConfig](ConditionSmall.md#setinstanceconfig-1) #### Defined in -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/ConditionSmall.md b/docs/api-reference/classes/ConditionSmall.md new file mode 100644 index 000000000..23eebf87b --- /dev/null +++ b/docs/api-reference/classes/ConditionSmall.md @@ -0,0 +1,734 @@ +[@nevermined-io/sdk](../code-reference.md) / ConditionSmall + +# Class: ConditionSmall + +## Hierarchy + +- [`ContractBase`](ContractBase.md) + + ↳ **`ConditionSmall`** + + ↳↳ [`Condition`](Condition.md) + +## Table of contents + +### Constructors + +- [constructor](ConditionSmall.md#constructor) + +### Properties + +- [address](ConditionSmall.md#address) +- [contract](ConditionSmall.md#contract) +- [contractName](ConditionSmall.md#contractname) +- [events](ConditionSmall.md#events) +- [version](ConditionSmall.md#version) + +### Accessors + +- [artifactsFolder](ConditionSmall.md#artifactsfolder) +- [circuitsFolder](ConditionSmall.md#circuitsfolder) +- [config](ConditionSmall.md#config) +- [instanceConfig](ConditionSmall.md#instanceconfig) +- [instantiableConfig](ConditionSmall.md#instantiableconfig) +- [logger](ConditionSmall.md#logger) +- [nevermined](ConditionSmall.md#nevermined) +- [web3](ConditionSmall.md#web3) + +### Methods + +- [abortByTimeOut](ConditionSmall.md#abortbytimeout) +- [call](ConditionSmall.md#call) +- [fulfill](ConditionSmall.md#fulfill) +- [fulfillPlain](ConditionSmall.md#fulfillplain) +- [generateId](ConditionSmall.md#generateid) +- [generateIdHash](ConditionSmall.md#generateidhash) +- [generateIdWithSeed](ConditionSmall.md#generateidwithseed) +- [getConditionFulfilledEvent](ConditionSmall.md#getconditionfulfilledevent) +- [getFromAddress](ConditionSmall.md#getfromaddress) +- [getInputsOfMethod](ConditionSmall.md#getinputsofmethod) +- [getSignatureOfMethod](ConditionSmall.md#getsignatureofmethod) +- [hashValues](ConditionSmall.md#hashvalues) +- [init](ConditionSmall.md#init) +- [send](ConditionSmall.md#send) +- [sendFrom](ConditionSmall.md#sendfrom) +- [setInstanceConfig](ConditionSmall.md#setinstanceconfig) +- [getInstance](ConditionSmall.md#getinstance) +- [setInstanceConfig](ConditionSmall.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new ConditionSmall**(`contractName`) + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Inherited from + +[ContractBase](ContractBase.md).[constructor](ContractBase.md#constructor) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L34) + +## Properties + +### address + +• **address**: `string` + +#### Inherited from + +[ContractBase](ContractBase.md).[address](ContractBase.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[ContractBase](ContractBase.md).[contract](ContractBase.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[ContractBase](ContractBase.md).[contractName](ContractBase.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[ContractBase](ContractBase.md).[events](ContractBase.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[ContractBase](ContractBase.md).[version](ContractBase.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ContractBase.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ContractBase.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +ContractBase.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ContractBase.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ContractBase.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +ContractBase.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +ContractBase.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +ContractBase.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### abortByTimeOut + +▸ **abortByTimeOut**(`conditionId`, `from?`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------------ | :---------------------------------------------- | +| `conditionId` | `string` | +| `from?` | [`Account`](Account.md) | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L88) + +--- + +### 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](ContractBase.md).[call](ContractBase.md#call) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### fulfill + +▸ `Abstract` **fulfill**(`agreementId`, `...args`): `any` + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `...args` | `any`[] | + +#### Returns + +`any` + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L61) + +--- + +### fulfillPlain + +▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `txParams?`, `method?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | Default value | +| :------------ | :-------------------------------------------------------- | :------------ | +| `agreementId` | `string` | `undefined` | +| `args` | `any`[] | `undefined` | +| `from?` | [`Account`](Account.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L63) + +--- + +### generateId + +▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `valueHash` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L77) + +--- + +### generateIdHash + +▸ **generateIdHash**(`agreementId`, `...values`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `...values` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L73) + +--- + +### generateIdWithSeed + +▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `valueHash` | `string` | + +#### Returns + +`Promise`<[`string`, `string`]\> + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L81) + +--- + +### getConditionFulfilledEvent + +▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../code-reference.md#eventresult) + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | + +#### Returns + +[`EventResult`](../code-reference.md#eventresult) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L92) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ContractBase](ContractBase.md).[getFromAddress](ContractBase.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[ContractBase](ContractBase.md).[getInputsOfMethod](ContractBase.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[ContractBase](ContractBase.md).[getSignatureOfMethod](ContractBase.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### hashValues + +▸ **hashValues**(`...args`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L57) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[ContractBase](ContractBase.md).[init](ContractBase.md#init) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ContractBase](ContractBase.md).[send](ContractBase.md#send) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ContractBase](ContractBase.md).[sendFrom](ContractBase.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ContractBase](ContractBase.md).[setInstanceConfig](ContractBase.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### getInstance + +▸ `Static` **getInstance**<`Ctx`, `Extra`\>(`config`, `conditionName`, `conditionsClass`, `optional?`): `Promise`<`any`\> + +#### Type parameters + +| Name | Type | +| :------ | :-------------------------------------------------------------- | +| `Ctx` | extends [`ConditionContext`](../interfaces/ConditionContext.md) | +| `Extra` | `Extra` | + +#### Parameters + +| Name | Type | Default value | +| :---------------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `conditionName` | `string` | `undefined` | +| `conditionsClass` | `any` | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`any`\> + +#### Overrides + +[ContractBase](ContractBase.md).[getInstance](ContractBase.md#getinstance) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:46](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L46) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ContractBase](ContractBase.md).[setInstanceConfig](ContractBase.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/ConditionStoreManager.md b/docs/api-reference/classes/ConditionStoreManager.md new file mode 100644 index 000000000..8c9197861 --- /dev/null +++ b/docs/api-reference/classes/ConditionStoreManager.md @@ -0,0 +1,684 @@ +[@nevermined-io/sdk](../code-reference.md) / ConditionStoreManager + +# Class: ConditionStoreManager + +## Hierarchy + +- [`ContractBase`](ContractBase.md) + + ↳ **`ConditionStoreManager`** + +## Table of contents + +### Constructors + +- [constructor](ConditionStoreManager.md#constructor) + +### Properties + +- [address](ConditionStoreManager.md#address) +- [contract](ConditionStoreManager.md#contract) +- [contractName](ConditionStoreManager.md#contractname) +- [events](ConditionStoreManager.md#events) +- [version](ConditionStoreManager.md#version) + +### Accessors + +- [artifactsFolder](ConditionStoreManager.md#artifactsfolder) +- [circuitsFolder](ConditionStoreManager.md#circuitsfolder) +- [config](ConditionStoreManager.md#config) +- [instanceConfig](ConditionStoreManager.md#instanceconfig) +- [instantiableConfig](ConditionStoreManager.md#instantiableconfig) +- [logger](ConditionStoreManager.md#logger) +- [nevermined](ConditionStoreManager.md#nevermined) +- [web3](ConditionStoreManager.md#web3) + +### Methods + +- [call](ConditionStoreManager.md#call) +- [createCondition](ConditionStoreManager.md#createcondition) +- [delegateCreateRole](ConditionStoreManager.md#delegatecreaterole) +- [getCondition](ConditionStoreManager.md#getcondition) +- [getCreateRole](ConditionStoreManager.md#getcreaterole) +- [getFromAddress](ConditionStoreManager.md#getfromaddress) +- [getInputsOfMethod](ConditionStoreManager.md#getinputsofmethod) +- [getOwner](ConditionStoreManager.md#getowner) +- [getSignatureOfMethod](ConditionStoreManager.md#getsignatureofmethod) +- [init](ConditionStoreManager.md#init) +- [isConditionTimeLocked](ConditionStoreManager.md#isconditiontimelocked) +- [isConditionTimedOut](ConditionStoreManager.md#isconditiontimedout) +- [send](ConditionStoreManager.md#send) +- [sendFrom](ConditionStoreManager.md#sendfrom) +- [setInstanceConfig](ConditionStoreManager.md#setinstanceconfig) +- [getInstance](ConditionStoreManager.md#getinstance) +- [setInstanceConfig](ConditionStoreManager.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new ConditionStoreManager**(`contractName`) + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Inherited from + +[ContractBase](ContractBase.md).[constructor](ContractBase.md#constructor) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L34) + +## Properties + +### address + +• **address**: `string` + +#### Inherited from + +[ContractBase](ContractBase.md).[address](ContractBase.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[ContractBase](ContractBase.md).[contract](ContractBase.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[ContractBase](ContractBase.md).[contractName](ContractBase.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[ContractBase](ContractBase.md).[events](ContractBase.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[ContractBase](ContractBase.md).[version](ContractBase.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ContractBase.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ContractBase.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +ContractBase.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ContractBase.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ContractBase.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +ContractBase.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +ContractBase.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +ContractBase.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### 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](ContractBase.md).[call](ContractBase.md#call) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### createCondition + +▸ **createCondition**(`id`, `typeRef`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :---------- | :---------------------------------------------- | +| `id` | `string` | +| `typeRef` | `string` | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Defined in + +[src/keeper/contracts/managers/ConditionStoreManager.ts:26](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/ConditionStoreManager.ts#L26) + +--- + +### delegateCreateRole + +▸ **delegateCreateRole**(`delegatee`, `owner`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :---------- | :---------------------------------------------- | +| `delegatee` | `string` | +| `owner` | `string` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Defined in + +[src/keeper/contracts/managers/ConditionStoreManager.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/ConditionStoreManager.ts#L35) + +--- + +### getCondition + +▸ **getCondition**(`conditionId`): `Promise`<[`ConditionData`](../interfaces/ConditionData.md)\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `conditionId` | `string` | + +#### Returns + +`Promise`<[`ConditionData`](../interfaces/ConditionData.md)\> + +#### Defined in + +[src/keeper/contracts/managers/ConditionStoreManager.ts:55](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/ConditionStoreManager.ts#L55) + +--- + +### getCreateRole + +▸ **getCreateRole**(): `Promise`<`unknown`\> + +#### Returns + +`Promise`<`unknown`\> + +#### Defined in + +[src/keeper/contracts/managers/ConditionStoreManager.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/ConditionStoreManager.ts#L39) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ContractBase](ContractBase.md).[getFromAddress](ContractBase.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[ContractBase](ContractBase.md).[getInputsOfMethod](ContractBase.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getOwner + +▸ **getOwner**(): `Promise`<`string`\> + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/keeper/contracts/managers/ConditionStoreManager.ts:51](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/ConditionStoreManager.ts#L51) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[ContractBase](ContractBase.md).[getSignatureOfMethod](ContractBase.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[ContractBase](ContractBase.md).[init](ContractBase.md#init) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### isConditionTimeLocked + +▸ **isConditionTimeLocked**(`id`): `Promise`<`unknown`\> + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `id` | `string` | + +#### Returns + +`Promise`<`unknown`\> + +#### Defined in + +[src/keeper/contracts/managers/ConditionStoreManager.ts:43](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/ConditionStoreManager.ts#L43) + +--- + +### isConditionTimedOut + +▸ **isConditionTimedOut**(`id`): `Promise`<`unknown`\> + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `id` | `string` | + +#### Returns + +`Promise`<`unknown`\> + +#### Defined in + +[src/keeper/contracts/managers/ConditionStoreManager.ts:47](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/ConditionStoreManager.ts#L47) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ContractBase](ContractBase.md).[send](ContractBase.md#send) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ContractBase](ContractBase.md).[sendFrom](ContractBase.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ContractBase](ContractBase.md).[setInstanceConfig](ContractBase.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`): `Promise`<[`ConditionStoreManager`](ConditionStoreManager.md)\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`Promise`<[`ConditionStoreManager`](ConditionStoreManager.md)\> + +#### Overrides + +[ContractBase](ContractBase.md).[getInstance](ContractBase.md#getinstance) + +#### Defined in + +[src/keeper/contracts/managers/ConditionStoreManager.ts:18](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/ConditionStoreManager.ts#L18) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ContractBase](ContractBase.md).[setInstanceConfig](ContractBase.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/Config.md b/docs/api-reference/classes/Config.md deleted file mode 100644 index 19105c44f..000000000 --- a/docs/api-reference/classes/Config.md +++ /dev/null @@ -1,247 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / Config - -# Class: Config - -## Table of contents - -### Constructors - -- [constructor](Config.md#constructor) - -### Properties - -- [aaveConfig](Config.md#aaveconfig) -- [accounts](Config.md#accounts) -- [artifactsFolder](Config.md#artifactsfolder) -- [authMessage](Config.md#authmessage) -- [authTokenExpiration](Config.md#authtokenexpiration) -- [faucetUri](Config.md#fauceturi) -- [feeReceiver](Config.md#feereceiver) -- [gasMultiplier](Config.md#gasmultiplier) -- [neverminedNodeAddress](Config.md#neverminednodeaddress) -- [neverminedNodeUri](Config.md#neverminedNodeUri) -- [graphHttpUri](Config.md#graphhttpuri) -- [marketplaceAuthToken](Config.md#marketplaceauthtoken) -- [marketplaceUri](Config.md#marketplaceuri) -- [networkFee](Config.md#networkfee) -- [web3ProviderUri](Config.md#web3ProviderUri) -- [threshold](Config.md#threshold) -- [verbose](Config.md#verbose) -- [web3Provider](Config.md#web3provider) - -## Constructors - -### constructor - -• **new Config**() - -## Properties - -### aaveConfig - -• `Optional` **aaveConfig**: `AaveConfig` - -#### Defined in - -[src/models/Config.ts:71](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/Config.ts#L71) - ---- - -### accounts - -• `Optional` **accounts**: `Signer`[] - -#### Defined in - -[src/models/Config.ts:78](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/Config.ts#L78) - ---- - -### artifactsFolder - -• `Optional` **artifactsFolder**: `string` - -The folder where the nevermined contract artifacts are located. - -#### Defined in - -[src/models/Config.ts:76](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/Config.ts#L76) - ---- - -### authMessage - -• `Optional` **authMessage**: `string` - -Message shown when the user creates its own token. - -#### Defined in - -[src/models/Config.ts:51](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/Config.ts#L51) - ---- - -### authTokenExpiration - -• `Optional` **authTokenExpiration**: `number` - -Token expiration time in ms. - -#### Defined in - -[src/models/Config.ts:56](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/Config.ts#L56) - ---- - -### faucetUri - -• `Optional` **faucetUri**: `string` - -Faucet URL. - -#### Defined in - -[src/models/Config.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/Config.ts#L26) - ---- - -### feeReceiver - -• `Optional` **feeReceiver**: `string` = `ZeroAddress` - -The address receiving the fee if this is higher than 0 - -#### Defined in - -[src/models/Config.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/Config.ts#L90) - ---- - -### gasMultiplier - -• `Optional` **gasMultiplier**: `number` - -Gas multiplier for the fees. -Can be used to speed up the transactions. - -#### Defined in - -[src/models/Config.ts:64](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/Config.ts#L64) - ---- - -### neverminedNodeAddress - -• `Optional` **neverminedNodeAddress**: `string` - -Address of Nevermined Node. - -#### Defined in - -[src/models/Config.ts:31](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/Config.ts#L31) - ---- - -### neverminedNodeUri - -• **neverminedNodeUri**: `string` - -Nevermined Node URL. - -#### Defined in - -[src/models/Config.ts:21](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/Config.ts#L21) - ---- - -### graphHttpUri - -• `Optional` **graphHttpUri**: `string` - -Enpoint for the graph-node http query - -#### Defined in - -[src/models/Config.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/Config.ts#L69) - ---- - -### marketplaceAuthToken - -• `Optional` **marketplaceAuthToken**: `string` - -Marketplace auth token. - -#### Defined in - -[src/models/Config.ts:16](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/Config.ts#L16) - ---- - -### marketplaceUri - -• **marketplaceUri**: `string` - -MarketPlace URL. - -#### Defined in - -[src/models/Config.ts:11](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/Config.ts#L11) - ---- - -### networkFee - -• `Optional` **networkFee**: `number` = `0` - -The fee charged by Nevermined for using the Service Agreements - -#### Defined in - -[src/models/Config.ts:85](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/Config.ts#L85) - ---- - -### web3ProviderUri - -• `Optional` **web3ProviderUri**: `string` - -Ethereum node URL. - -#### Defined in - -[src/models/Config.ts:36](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/Config.ts#L36) - ---- - -### threshold - -• `Optional` **threshold**: `number` - -#### Defined in - -[src/models/Config.ts:58](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/Config.ts#L58) - ---- - -### verbose - -• `Optional` **verbose**: `boolean` \| [`LogLevel`](../enums/utils.LogLevel.md) - -Log level. - -#### Defined in - -[src/models/Config.ts:46](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/Config.ts#L46) - ---- - -### web3Provider - -• `Optional` **web3Provider**: `any` - -Web3 Provider. - -#### Defined in - -[src/models/Config.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/Config.ts#L41) diff --git a/docs/api-reference/classes/ConsumerCondition.md b/docs/api-reference/classes/ConsumerCondition.md new file mode 100644 index 000000000..2ab52eb36 --- /dev/null +++ b/docs/api-reference/classes/ConsumerCondition.md @@ -0,0 +1,972 @@ +[@nevermined-io/sdk](../code-reference.md) / ConsumerCondition + +# Class: ConsumerCondition + +## Type parameters + +| Name | Type | +| :------ | :-------------------------------------------------------------- | +| `Ctx` | extends [`ConditionContext`](../interfaces/ConditionContext.md) | +| `Extra` | `Record`<`string`, `unknown`\> | + +## Hierarchy + +- [`Condition`](Condition.md)<`Ctx`, `Extra`\> + + ↳ **`ConsumerCondition`** + + ↳↳ [`LockPaymentCondition`](LockPaymentCondition.md) + + ↳↳ [`NFTHolderCondition`](NFTHolderCondition.md) + + ↳↳ [`NFT721HolderCondition`](NFT721HolderCondition.md) + + ↳↳ [`NFTLockCondition`](NFTLockCondition.md) + +## Table of contents + +### Constructors + +- [constructor](ConsumerCondition.md#constructor) + +### Properties + +- [address](ConsumerCondition.md#address) +- [contract](ConsumerCondition.md#contract) +- [contractName](ConsumerCondition.md#contractname) +- [events](ConsumerCondition.md#events) +- [version](ConsumerCondition.md#version) + +### Accessors + +- [artifactsFolder](ConsumerCondition.md#artifactsfolder) +- [circuitsFolder](ConsumerCondition.md#circuitsfolder) +- [config](ConsumerCondition.md#config) +- [instanceConfig](ConsumerCondition.md#instanceconfig) +- [instantiableConfig](ConsumerCondition.md#instantiableconfig) +- [logger](ConsumerCondition.md#logger) +- [nevermined](ConsumerCondition.md#nevermined) +- [web3](ConsumerCondition.md#web3) + +### Methods + +- [abortByTimeOut](ConsumerCondition.md#abortbytimeout) +- [call](ConsumerCondition.md#call) +- [fulfill](ConsumerCondition.md#fulfill) +- [fulfillInstance](ConsumerCondition.md#fulfillinstance) +- [fulfillPlain](ConsumerCondition.md#fulfillplain) +- [fulfillWithNode](ConsumerCondition.md#fulfillwithnode) +- [generateId](ConsumerCondition.md#generateid) +- [generateIdHash](ConsumerCondition.md#generateidhash) +- [generateIdWithSeed](ConsumerCondition.md#generateidwithseed) +- [getConditionFulfilledEvent](ConsumerCondition.md#getconditionfulfilledevent) +- [getFromAddress](ConsumerCondition.md#getfromaddress) +- [getInputsOfMethod](ConsumerCondition.md#getinputsofmethod) +- [getSignatureOfMethod](ConsumerCondition.md#getsignatureofmethod) +- [hashValues](ConsumerCondition.md#hashvalues) +- [hashValuesPlain](ConsumerCondition.md#hashvaluesplain) +- [init](ConsumerCondition.md#init) +- [instance](ConsumerCondition.md#instance) +- [instanceFromDDO](ConsumerCondition.md#instancefromddo) +- [params](ConsumerCondition.md#params) +- [paramsFromDDO](ConsumerCondition.md#paramsfromddo) +- [send](ConsumerCondition.md#send) +- [sendFrom](ConsumerCondition.md#sendfrom) +- [setInstanceConfig](ConsumerCondition.md#setinstanceconfig) +- [getInstance](ConsumerCondition.md#getinstance) +- [setInstanceConfig](ConsumerCondition.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new ConsumerCondition**<`Ctx`, `Extra`\>(`contractName`) + +#### Type parameters + +| Name | Type | +| :------ | :-------------------------------------------------------------- | +| `Ctx` | extends [`ConditionContext`](../interfaces/ConditionContext.md) | +| `Extra` | `Record`<`string`, `unknown`\> | + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Inherited from + +[Condition](Condition.md).[constructor](Condition.md#constructor) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L34) + +## Properties + +### address + +• **address**: `string` + +#### Inherited from + +[Condition](Condition.md).[address](Condition.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[Condition](Condition.md).[contract](Condition.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[Condition](Condition.md).[contractName](Condition.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[Condition](Condition.md).[events](Condition.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[Condition](Condition.md).[version](Condition.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Condition.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Condition.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +Condition.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Condition.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Condition.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +Condition.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +Condition.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +Condition.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### abortByTimeOut + +▸ **abortByTimeOut**(`conditionId`, `from?`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------------ | :---------------------------------------------- | +| `conditionId` | `string` | +| `from?` | [`Account`](Account.md) | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[Condition](Condition.md).[abortByTimeOut](Condition.md#abortbytimeout) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L88) + +--- + +### 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 + +[Condition](Condition.md).[call](Condition.md#call) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### fulfill + +▸ `Abstract` **fulfill**(`agreementId`, `...args`): `any` + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `...args` | `any`[] | + +#### Returns + +`any` + +#### Inherited from + +[Condition](Condition.md).[fulfill](Condition.md#fulfill) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L61) + +--- + +### fulfillInstance + +▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `txParams?`, `method?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | Default value | +| :----------------- | :------------------------------------------------------------------ | :------------ | +| `cond` | [`ConditionInstance`](../interfaces/ConditionInstance.md)<`Extra`\> | `undefined` | +| `additionalParams` | `Extra` | `undefined` | +| `from?` | [`Account`](Account.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[Condition](Condition.md).[fulfillInstance](Condition.md#fulfillinstance) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:150](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L150) + +--- + +### fulfillPlain + +▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `txParams?`, `method?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | Default value | +| :------------ | :-------------------------------------------------------- | :------------ | +| `agreementId` | `string` | `undefined` | +| `args` | `any`[] | `undefined` | +| `from?` | [`Account`](Account.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[Condition](Condition.md).[fulfillPlain](Condition.md#fulfillplain) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L63) + +--- + +### fulfillWithNode + +▸ **fulfillWithNode**(`_cond`, `_additionalParams`, `_from?`, `_txParams?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------------ | :------------------------------------------------------------------ | +| `_cond` | [`ConditionInstance`](../interfaces/ConditionInstance.md)<`Extra`\> | +| `_additionalParams` | `Extra` | +| `_from?` | [`Account`](Account.md) | +| `_txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`void`\> + +#### Overrides + +[Condition](Condition.md).[fulfillWithNode](Condition.md#fulfillwithnode) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:217](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L217) + +--- + +### generateId + +▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `valueHash` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[Condition](Condition.md).[generateId](Condition.md#generateid) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L77) + +--- + +### generateIdHash + +▸ **generateIdHash**(`agreementId`, `...values`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `...values` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[Condition](Condition.md).[generateIdHash](Condition.md#generateidhash) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L73) + +--- + +### generateIdWithSeed + +▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `valueHash` | `string` | + +#### Returns + +`Promise`<[`string`, `string`]\> + +#### Inherited from + +[Condition](Condition.md).[generateIdWithSeed](Condition.md#generateidwithseed) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L81) + +--- + +### getConditionFulfilledEvent + +▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../code-reference.md#eventresult) + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | + +#### Returns + +[`EventResult`](../code-reference.md#eventresult) + +#### Inherited from + +[Condition](Condition.md).[getConditionFulfilledEvent](Condition.md#getconditionfulfilledevent) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L92) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[Condition](Condition.md).[getFromAddress](Condition.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[Condition](Condition.md).[getInputsOfMethod](Condition.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[Condition](Condition.md).[getSignatureOfMethod](Condition.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### hashValues + +▸ **hashValues**(`...args`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[Condition](Condition.md).[hashValues](Condition.md#hashvalues) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L129) + +--- + +### hashValuesPlain + +▸ **hashValuesPlain**(`...args`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[Condition](Condition.md).[hashValuesPlain](Condition.md#hashvaluesplain) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:133](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L133) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[Condition](Condition.md).[init](Condition.md#init) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### instance + +▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Extra`\>\> + +#### Parameters + +| Name | Type | +| :------------ | :---------------------------------------------------------------------- | +| `agreementId` | `string` | +| `params` | [`ConditionParameters`](../interfaces/ConditionParameters.md)<`Extra`\> | + +#### Returns + +`Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Extra`\>\> + +#### Inherited from + +[Condition](Condition.md).[instance](Condition.md#instance) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:174](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L174) + +--- + +### instanceFromDDO + +▸ **instanceFromDDO**(`agreementId`, `ctx`, `...args`): `Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Extra`\>\> + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------------------------------------------- | +| `agreementId` | `string` | +| `ctx` | `Ctx` | +| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | + +#### Returns + +`Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Extra`\>\> + +#### Inherited from + +[Condition](Condition.md).[instanceFromDDO](Condition.md#instancefromddo) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L142) + +--- + +### params + +▸ **params**(`...args`): [`ConditionParameters`](../interfaces/ConditionParameters.md)<`Extra`\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Extra`\> + +#### Inherited from + +[Condition](Condition.md).[params](Condition.md#params) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:122](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L122) + +--- + +### paramsFromDDO + +▸ `Abstract` **paramsFromDDO**(`ctx`, `...args`): `Promise`<[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Extra`\>\> + +#### Parameters + +| Name | Type | +| :-------- | :-------------------------------------------------------------------- | +| `ctx` | `Ctx` | +| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | + +#### Returns + +`Promise`<[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Extra`\>\> + +#### Inherited from + +[Condition](Condition.md).[paramsFromDDO](Condition.md#paramsfromddo) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:137](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L137) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[Condition](Condition.md).[send](Condition.md#send) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[Condition](Condition.md).[sendFrom](Condition.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Condition](Condition.md).[setInstanceConfig](Condition.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### getInstance + +▸ `Static` **getInstance**<`Ctx`, `Extra`\>(`config`, `conditionName`, `conditionsClass`, `optional?`): `Promise`<`any`\> + +#### Type parameters + +| Name | Type | +| :------ | :-------------------------------------------------------------- | +| `Ctx` | extends [`ConditionContext`](../interfaces/ConditionContext.md) | +| `Extra` | `Extra` | + +#### Parameters + +| Name | Type | Default value | +| :---------------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `conditionName` | `string` | `undefined` | +| `conditionsClass` | `any` | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`any`\> + +#### Inherited from + +[Condition](Condition.md).[getInstance](Condition.md#getinstance) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:111](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L111) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Condition](Condition.md).[setInstanceConfig](Condition.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/ContractBase.md b/docs/api-reference/classes/ContractBase.md new file mode 100644 index 000000000..5d720adc6 --- /dev/null +++ b/docs/api-reference/classes/ContractBase.md @@ -0,0 +1,642 @@ +[@nevermined-io/sdk](../code-reference.md) / ContractBase + +# Class: ContractBase + +## Hierarchy + +- [`Instantiable`](Instantiable.md) + + ↳ **`ContractBase`** + + ↳↳ [`ConditionSmall`](ConditionSmall.md) + + ↳↳ [`AgreementStoreManager`](AgreementStoreManager.md) + + ↳↳ [`ConditionStoreManager`](ConditionStoreManager.md) + + ↳↳ [`TemplateStoreManager`](TemplateStoreManager.md) + + ↳↳ [`RewardsDistributor`](RewardsDistributor.md) + + ↳↳ [`RoyaltyScheme`](RoyaltyScheme.md) + + ↳↳ [`AgreementTemplate`](AgreementTemplate.md) + + ↳↳ [`DIDRegistry`](DIDRegistry.md) + + ↳↳ [`Dispenser`](Dispenser.md) + + ↳↳ [`GenericContract`](GenericContract.md) + + ↳↳ [`NFTContractsBase`](NFTContractsBase.md) + + ↳↳ [`Token`](Token.md) + +## Table of contents + +### Constructors + +- [constructor](ContractBase.md#constructor) + +### Properties + +- [address](ContractBase.md#address) +- [contract](ContractBase.md#contract) +- [contractName](ContractBase.md#contractname) +- [events](ContractBase.md#events) +- [version](ContractBase.md#version) + +### Accessors + +- [artifactsFolder](ContractBase.md#artifactsfolder) +- [circuitsFolder](ContractBase.md#circuitsfolder) +- [config](ContractBase.md#config) +- [instanceConfig](ContractBase.md#instanceconfig) +- [instantiableConfig](ContractBase.md#instantiableconfig) +- [logger](ContractBase.md#logger) +- [nevermined](ContractBase.md#nevermined) +- [web3](ContractBase.md#web3) + +### Methods + +- [call](ContractBase.md#call) +- [estimateGas](ContractBase.md#estimategas) +- [getFromAddress](ContractBase.md#getfromaddress) +- [getInputsOfMethod](ContractBase.md#getinputsofmethod) +- [getSignatureOfMethod](ContractBase.md#getsignatureofmethod) +- [init](ContractBase.md#init) +- [internalSend](ContractBase.md#internalsend) +- [internalSendZeroDev](ContractBase.md#internalsendzerodev) +- [searchMethod](ContractBase.md#searchmethod) +- [searchMethodInputs](ContractBase.md#searchmethodinputs) +- [send](ContractBase.md#send) +- [sendFrom](ContractBase.md#sendfrom) +- [setInstanceConfig](ContractBase.md#setinstanceconfig) +- [getInstance](ContractBase.md#getinstance) +- [setInstanceConfig](ContractBase.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new ContractBase**(`contractName`) + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Overrides + +[Instantiable](Instantiable.md).[constructor](Instantiable.md#constructor) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L34) + +## Properties + +### address + +• **address**: `string` + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### version + +• **version**: `string` + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +Instantiable.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +Instantiable.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +Instantiable.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +Instantiable.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### call + +▸ **call**<`T`\>(`name`, `args`, `from?`): `Promise`<`T`\> + +#### Type parameters + +| Name | +| :--- | +| `T` | + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | `string` | + +#### Returns + +`Promise`<`T`\> + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### estimateGas + +▸ `Private` **estimateGas**(`contract`, `methodSignature`, `args`, `from`, `value`, `gasMultiplier?`): `Promise`<`bigint`\> + +#### Parameters + +| Name | Type | +| :---------------- | :------------- | +| `contract` | `BaseContract` | +| `methodSignature` | `string` | +| `args` | `any`[] | +| `from` | `string` | +| `value` | `string` | +| `gasMultiplier?` | `number` | + +#### Returns + +`Promise`<`bigint`\> + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:359](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L359) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### internalSend + +▸ `Private` **internalSend**(`name`, `from`, `args`, `txparams`, `contract`, `progress`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :--------- | :------------------------ | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `txparams` | `any` | +| `contract` | `BaseContract` | +| `progress` | (`data`: `any`) => `void` | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:102](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L102) + +--- + +### internalSendZeroDev + +▸ `Private` **internalSendZeroDev**(`name`, `from`, `args`, `txparams`, `contract`, `progress`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :--------- | :------------------------ | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `txparams` | `any` | +| `contract` | `BaseContract` | +| `progress` | (`data`: `any`) => `void` | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:168](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L168) + +--- + +### searchMethod + +▸ `Private` **searchMethod**(`methodName`, `args?`): `Fragment` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`Fragment` + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:339](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L339) + +--- + +### searchMethodInputs + +▸ `Private` **searchMethodInputs**(`methodName`, `args?`): { `name`: `string` = input.name; `value`: `any` }[] + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +{ `name`: `string` = input.name; `value`: `any` }[] + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:350](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L350) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### getInstance + +▸ `Static` **getInstance**(`..._args`): `any` + +#### Parameters + +| Name | Type | +| :--------- | :---- | +| `..._args` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[Instantiable](Instantiable.md).[getInstance](Instantiable.md#getinstance) + +#### Defined in + +[src/Instantiable.abstract.ts:86](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L86) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/ContractEvent.md b/docs/api-reference/classes/ContractEvent.md new file mode 100644 index 000000000..50e98e638 --- /dev/null +++ b/docs/api-reference/classes/ContractEvent.md @@ -0,0 +1,476 @@ +[@nevermined-io/sdk](../code-reference.md) / ContractEvent + +# Class: ContractEvent + +## Hierarchy + +- [`NeverminedEvent`](NeverminedEvent.md) + + ↳ **`ContractEvent`** + +## Table of contents + +### Constructors + +- [constructor](ContractEvent.md#constructor) + +### Properties + +- [contract](ContractEvent.md#contract) +- [eventEmitter](ContractEvent.md#eventemitter) + +### Accessors + +- [artifactsFolder](ContractEvent.md#artifactsfolder) +- [circuitsFolder](ContractEvent.md#circuitsfolder) +- [config](ContractEvent.md#config) +- [instanceConfig](ContractEvent.md#instanceconfig) +- [instantiableConfig](ContractEvent.md#instantiableconfig) +- [logger](ContractEvent.md#logger) +- [nevermined](ContractEvent.md#nevermined) +- [web3](ContractEvent.md#web3) + +### Methods + +- [eventExists](ContractEvent.md#eventexists) +- [filterToArgs](ContractEvent.md#filtertoargs) +- [getBlockNumber](ContractEvent.md#getblocknumber) +- [getEventData](ContractEvent.md#geteventdata) +- [getPastEvents](ContractEvent.md#getpastevents) +- [once](ContractEvent.md#once) +- [setInstanceConfig](ContractEvent.md#setinstanceconfig) +- [subscribe](ContractEvent.md#subscribe) +- [getInstance](ContractEvent.md#getinstance) +- [setInstanceConfig](ContractEvent.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• `Protected` **new ContractEvent**(`contract`, `eventEmitter`) + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `contract` | [`ContractBase`](ContractBase.md) | +| `eventEmitter` | [`EventEmitter`](../interfaces/EventEmitter.md) | + +#### Inherited from + +[NeverminedEvent](NeverminedEvent.md).[constructor](NeverminedEvent.md#constructor) + +#### Defined in + +[src/events/NeverminedEvent.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/NeverminedEvent.ts#L34) + +## Properties + +### contract + +• `Protected` **contract**: [`ContractBase`](ContractBase.md) = `null` + +#### Inherited from + +[NeverminedEvent](NeverminedEvent.md).[contract](NeverminedEvent.md#contract) + +#### Defined in + +[src/events/NeverminedEvent.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/NeverminedEvent.ts#L29) + +--- + +### eventEmitter + +• `Protected` **eventEmitter**: [`EventEmitter`](../interfaces/EventEmitter.md) + +#### Inherited from + +[NeverminedEvent](NeverminedEvent.md).[eventEmitter](NeverminedEvent.md#eventemitter) + +#### Defined in + +[src/events/NeverminedEvent.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/NeverminedEvent.ts#L28) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +NeverminedEvent.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +NeverminedEvent.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +NeverminedEvent.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +NeverminedEvent.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +NeverminedEvent.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +NeverminedEvent.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +NeverminedEvent.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +NeverminedEvent.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### eventExists + +▸ `Private` **eventExists**(`eventName`): `boolean` + +#### Parameters + +| Name | Type | +| :---------- | :------- | +| `eventName` | `string` | + +#### Returns + +`boolean` + +#### Defined in + +[src/events/ContractEvent.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/ContractEvent.ts#L57) + +--- + +### filterToArgs + +▸ `Private` **filterToArgs**(`eventName`, `filter`): `any`[] + +#### Parameters + +| Name | Type | +| :---------- | :---------------------------------- | +| `eventName` | `string` | +| `filter` | [`Filter`](../interfaces/Filter.md) | + +#### Returns + +`any`[] + +#### Defined in + +[src/events/ContractEvent.ts:61](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/ContractEvent.ts#L61) + +--- + +### getBlockNumber + +▸ **getBlockNumber**(): `Promise`<`number`\> + +#### Returns + +`Promise`<`number`\> + +#### Overrides + +[NeverminedEvent](NeverminedEvent.md).[getBlockNumber](NeverminedEvent.md#getblocknumber) + +#### Defined in + +[src/events/ContractEvent.ts:53](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/ContractEvent.ts#L53) + +--- + +### getEventData + +▸ **getEventData**(`options`): [`EventResult`](../code-reference.md#eventresult) + +#### Parameters + +| Name | Type | +| :-------- | :---------------------------------------------- | +| `options` | [`EventOptions`](../interfaces/EventOptions.md) | + +#### Returns + +[`EventResult`](../code-reference.md#eventresult) + +#### Overrides + +[NeverminedEvent](NeverminedEvent.md).[getEventData](NeverminedEvent.md#geteventdata) + +#### Defined in + +[src/events/ContractEvent.ts:23](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/ContractEvent.ts#L23) + +--- + +### getPastEvents + +▸ **getPastEvents**(`options`): [`EventResult`](../code-reference.md#eventresult) + +#### Parameters + +| Name | Type | +| :-------- | :---------------------------------------------- | +| `options` | [`EventOptions`](../interfaces/EventOptions.md) | + +#### Returns + +[`EventResult`](../code-reference.md#eventresult) + +#### Overrides + +[NeverminedEvent](NeverminedEvent.md).[getPastEvents](NeverminedEvent.md#getpastevents) + +#### Defined in + +[src/events/ContractEvent.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/ContractEvent.ts#L35) + +--- + +### once + +▸ **once**(`callback?`, `options?`): `Promise`<[`EventResult`](../code-reference.md#eventresult)\> + +#### Parameters + +| Name | Type | +| :---------- | :------------------------------------------------------------------------ | +| `callback?` | (`events`: [`EventResult`](../code-reference.md#eventresult)[]) => `void` | +| `options?` | [`EventOptions`](../interfaces/EventOptions.md) | + +#### Returns + +`Promise`<[`EventResult`](../code-reference.md#eventresult)\> + +#### Inherited from + +[NeverminedEvent](NeverminedEvent.md).[once](NeverminedEvent.md#once) + +#### Defined in + +[src/events/NeverminedEvent.ts:54](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/NeverminedEvent.ts#L54) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[NeverminedEvent](NeverminedEvent.md).[setInstanceConfig](NeverminedEvent.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### subscribe + +▸ **subscribe**(`callback`, `options`): [`ContractEventSubscription`](../interfaces/ContractEventSubscription.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------------------------------------------ | +| `callback` | (`events`: [`EventResult`](../code-reference.md#eventresult)[]) => `void` | +| `options` | [`EventOptions`](../interfaces/EventOptions.md) | + +#### Returns + +[`ContractEventSubscription`](../interfaces/ContractEventSubscription.md) + +#### Inherited from + +[NeverminedEvent](NeverminedEvent.md).[subscribe](NeverminedEvent.md#subscribe) + +#### Defined in + +[src/events/NeverminedEvent.ts:40](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/NeverminedEvent.ts#L40) + +--- + +### getInstance + +▸ `Static` **getInstance**(`contract`, `eventEmitter`, `nevermined`, `web3`): [`ContractEvent`](ContractEvent.md) + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `contract` | [`ContractBase`](ContractBase.md) | +| `eventEmitter` | [`EventEmitter`](../interfaces/EventEmitter.md) | +| `nevermined` | [`Nevermined`](Nevermined.md) | +| `web3` | `JsonRpcProvider` \| `BrowserProvider` | + +#### Returns + +[`ContractEvent`](ContractEvent.md) + +#### Overrides + +[NeverminedEvent](NeverminedEvent.md).[getInstance](NeverminedEvent.md#getinstance) + +#### Defined in + +[src/events/ContractEvent.ts:8](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/ContractEvent.ts#L8) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[NeverminedEvent](NeverminedEvent.md).[setInstanceConfig](NeverminedEvent.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/ContractHandler.md b/docs/api-reference/classes/ContractHandler.md new file mode 100644 index 000000000..7dfd7cded --- /dev/null +++ b/docs/api-reference/classes/ContractHandler.md @@ -0,0 +1,630 @@ +[@nevermined-io/sdk](../code-reference.md) / ContractHandler + +# Class: ContractHandler + +## Hierarchy + +- [`Instantiable`](Instantiable.md) + + ↳ **`ContractHandler`** + +## Table of contents + +### Constructors + +- [constructor](ContractHandler.md#constructor) + +### Properties + +- [contracts](ContractHandler.md#contracts) + +### Accessors + +- [artifactsFolder](ContractHandler.md#artifactsfolder) +- [circuitsFolder](ContractHandler.md#circuitsfolder) +- [config](ContractHandler.md#config) +- [instanceConfig](ContractHandler.md#instanceconfig) +- [instantiableConfig](ContractHandler.md#instantiableconfig) +- [logger](ContractHandler.md#logger) +- [nevermined](ContractHandler.md#nevermined) +- [web3](ContractHandler.md#web3) + +### Methods + +- [checkExists](ContractHandler.md#checkexists) +- [deployAbi](ContractHandler.md#deployabi) +- [get](ContractHandler.md#get) +- [getFeeData](ContractHandler.md#getfeedata) +- [getFeeDataArbitrum](ContractHandler.md#getfeedataarbitrum) +- [getFeeDataPolygon](ContractHandler.md#getfeedatapolygon) +- [getVersion](ContractHandler.md#getversion) +- [load](ContractHandler.md#load) +- [setInstanceConfig](ContractHandler.md#setinstanceconfig) +- [fetchJson](ContractHandler.md#fetchjson) +- [getABI](ContractHandler.md#getabi) +- [getContract](ContractHandler.md#getcontract) +- [getHash](ContractHandler.md#gethash) +- [getInstance](ContractHandler.md#getinstance) +- [getSignatureOfMethod](ContractHandler.md#getsignatureofmethod) +- [hasContract](ContractHandler.md#hascontract) +- [setContract](ContractHandler.md#setcontract) +- [setInstanceConfig](ContractHandler.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new ContractHandler**(`config`) + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Overrides + +[Instantiable](Instantiable.md).[constructor](Instantiable.md#constructor) + +#### Defined in + +[src/keeper/ContractHandler.ts:47](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/ContractHandler.ts#L47) + +## Properties + +### contracts + +▪ `Static` `Private` **contracts**: `Map`<`string`, `BaseContract`\> + +#### Defined in + +[src/keeper/ContractHandler.ts:38](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/ContractHandler.ts#L38) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +Instantiable.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +Instantiable.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +Instantiable.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +Instantiable.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### checkExists + +▸ **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. + +#### Defined in + +[src/keeper/ContractHandler.ts:208](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/ContractHandler.ts#L208) + +--- + +### deployAbi + +▸ **deployAbi**(`artifact`, `from`, `args?`): `Promise`<`BaseContract`\> + +#### Parameters + +| Name | Type | Default value | +| :------------------ | :---------------------- | :------------ | +| `artifact` | `Object` | `undefined` | +| `artifact.abi` | `InterfaceAbi` | `undefined` | +| `artifact.bytecode` | `string` | `undefined` | +| `artifact.name?` | `string` | `undefined` | +| `from` | [`Account`](Account.md) | `undefined` | +| `args` | `string`[] | `[]` | + +#### Returns + +`Promise`<`BaseContract`\> + +#### Defined in + +[src/keeper/ContractHandler.ts:116](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/ContractHandler.ts#L116) + +--- + +### get + +▸ **get**(`what`, `optional?`, `artifactsFolder`, `address?`): `Promise`<`BaseContract`\> + +#### Parameters + +| Name | Type | Default value | +| :---------------- | :-------- | :------------ | +| `what` | `string` | `undefined` | +| `optional` | `boolean` | `false` | +| `artifactsFolder` | `string` | `undefined` | +| `address?` | `string` | `undefined` | + +#### Returns + +`Promise`<`BaseContract`\> + +#### Defined in + +[src/keeper/ContractHandler.ts:52](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/ContractHandler.ts#L52) + +--- + +### getFeeData + +▸ **getFeeData**(`gasPrice?`, `maxFeePerGas?`, `maxPriorityFeePerGas?`): `Promise`<{ `maxFeePerGas`: `bigint` = maxFeePerGas; `maxPriorityFeePerGas`: `bigint` = maxPriorityFeePerGas; `type`: `number` = 2 } \| { `gasPrice`: `bigint` = feeData.gasPrice }\> + +#### Parameters + +| Name | Type | +| :---------------------- | :------- | +| `gasPrice?` | `bigint` | +| `maxFeePerGas?` | `bigint` | +| `maxPriorityFeePerGas?` | `bigint` | + +#### Returns + +`Promise`<{ `maxFeePerGas`: `bigint` = maxFeePerGas; `maxPriorityFeePerGas`: `bigint` = maxPriorityFeePerGas; `type`: `number` = 2 } \| { `gasPrice`: `bigint` = feeData.gasPrice }\> + +#### Defined in + +[src/keeper/ContractHandler.ts:258](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/ContractHandler.ts#L258) + +--- + +### getFeeDataArbitrum + +▸ `Private` **getFeeDataArbitrum**(): `Promise`<{ `gasPrice`: `bigint` = feeData.gasPrice }\> + +#### Returns + +`Promise`<{ `gasPrice`: `bigint` = feeData.gasPrice }\> + +#### Defined in + +[src/keeper/ContractHandler.ts:322](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/ContractHandler.ts#L322) + +--- + +### getFeeDataPolygon + +▸ `Private` **getFeeDataPolygon**(`networkId`): `Promise`<{ `maxFeePerGas`: `bigint` = maxFeePerGas; `maxPriorityFeePerGas`: `bigint` = maxPriorityFeePerGas; `type`: `number` = 2 }\> + +#### Parameters + +| Name | Type | +| :---------- | :------- | +| `networkId` | `number` | + +#### Returns + +`Promise`<{ `maxFeePerGas`: `bigint` = maxFeePerGas; `maxPriorityFeePerGas`: `bigint` = maxPriorityFeePerGas; `type`: `number` = 2 }\> + +#### Defined in + +[src/keeper/ContractHandler.ts:287](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/ContractHandler.ts#L287) + +--- + +### getVersion + +▸ **getVersion**(`contractName`, `artifactsFolder`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :---------------- | :------- | +| `contractName` | `string` | +| `artifactsFolder` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/keeper/ContractHandler.ts:100](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/ContractHandler.ts#L100) + +--- + +### load + +▸ `Private` **load**(`what`, `where`, `networkId`, `artifactsFolder`, `address?`): `Promise`<`BaseContract`\> + +#### Parameters + +| Name | Type | +| :---------------- | :------- | +| `what` | `string` | +| `where` | `string` | +| `networkId` | `number` | +| `artifactsFolder` | `string` | +| `address?` | `string` | + +#### Returns + +`Promise`<`BaseContract`\> + +#### Defined in + +[src/keeper/ContractHandler.ts:172](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/ContractHandler.ts#L172) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### fetchJson + +▸ `Static` **fetchJson**(`path`): `Promise`<`any`\> + +#### Parameters + +| Name | Type | +| :----- | :---- | +| `path` | `any` | + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +[src/keeper/ContractHandler.ts:239](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/ContractHandler.ts#L239) + +--- + +### getABI + +▸ `Static` **getABI**(`contractName`, `artifactsFolder?`, `networkName?`): `Promise`<`any`\> + +#### Parameters + +| Name | Type | Default value | +| :---------------- | :------- | :-------------- | +| `contractName` | `string` | `undefined` | +| `artifactsFolder` | `string` | `'./artifacts'` | +| `networkName?` | `string` | `undefined` | + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +[src/keeper/ContractHandler.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/ContractHandler.ts#L73) + +--- + +### getContract + +▸ `Static` `Protected` **getContract**(`what`, `networkId`, `address?`): `BaseContract` + +#### Parameters + +| Name | Type | +| :---------- | :------- | +| `what` | `string` | +| `networkId` | `number` | +| `address?` | `string` | + +#### Returns + +`BaseContract` + +#### Defined in + +[src/keeper/ContractHandler.ts:21](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/ContractHandler.ts#L21) + +--- + +### getHash + +▸ `Static` `Private` **getHash**(`what`, `networkId`, `address?`): `string` + +#### Parameters + +| Name | Type | +| :---------- | :------- | +| `what` | `string` | +| `networkId` | `number` | +| `address?` | `string` | + +#### Returns + +`string` + +#### Defined in + +[src/keeper/ContractHandler.ts:43](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/ContractHandler.ts#L43) + +--- + +### getInstance + +▸ `Static` **getInstance**(`..._args`): `any` + +#### Parameters + +| Name | Type | +| :--------- | :---- | +| `..._args` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[Instantiable](Instantiable.md).[getInstance](Instantiable.md#getinstance) + +#### Defined in + +[src/Instantiable.abstract.ts:86](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L86) + +--- + +### getSignatureOfMethod + +▸ `Static` **getSignatureOfMethod**(`baseContract`, `methodName`, `args`): `string` + +#### Parameters + +| Name | Type | +| :------------- | :------------- | +| `baseContract` | `BaseContract` | +| `methodName` | `string` | +| `args` | `any`[] | + +#### Returns + +`string` + +#### Defined in + +[src/keeper/ContractHandler.ts:224](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/ContractHandler.ts#L224) + +--- + +### hasContract + +▸ `Static` `Protected` **hasContract**(`what`, `networkId`, `address?`): `boolean` + +#### Parameters + +| Name | Type | +| :---------- | :------- | +| `what` | `string` | +| `networkId` | `number` | +| `address?` | `string` | + +#### Returns + +`boolean` + +#### Defined in + +[src/keeper/ContractHandler.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/ContractHandler.ts#L34) + +--- + +### setContract + +▸ `Static` `Protected` **setContract**(`what`, `networkId`, `contractInstance`, `address?`): `void` + +#### Parameters + +| Name | Type | +| :----------------- | :------------- | +| `what` | `string` | +| `networkId` | `number` | +| `contractInstance` | `BaseContract` | +| `address?` | `string` | + +#### Returns + +`void` + +#### Defined in + +[src/keeper/ContractHandler.ts:25](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/ContractHandler.ts#L25) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/CurveRoyalties.md b/docs/api-reference/classes/CurveRoyalties.md new file mode 100644 index 000000000..bfe3cf699 --- /dev/null +++ b/docs/api-reference/classes/CurveRoyalties.md @@ -0,0 +1,597 @@ +[@nevermined-io/sdk](../code-reference.md) / CurveRoyalties + +# Class: CurveRoyalties + +## Hierarchy + +- [`RoyaltyScheme`](RoyaltyScheme.md) + + ↳ **`CurveRoyalties`** + +## Table of contents + +### Constructors + +- [constructor](CurveRoyalties.md#constructor) + +### Properties + +- [address](CurveRoyalties.md#address) +- [contract](CurveRoyalties.md#contract) +- [contractName](CurveRoyalties.md#contractname) +- [events](CurveRoyalties.md#events) +- [version](CurveRoyalties.md#version) + +### Accessors + +- [artifactsFolder](CurveRoyalties.md#artifactsfolder) +- [circuitsFolder](CurveRoyalties.md#circuitsfolder) +- [config](CurveRoyalties.md#config) +- [instanceConfig](CurveRoyalties.md#instanceconfig) +- [instantiableConfig](CurveRoyalties.md#instantiableconfig) +- [logger](CurveRoyalties.md#logger) +- [nevermined](CurveRoyalties.md#nevermined) +- [web3](CurveRoyalties.md#web3) + +### Methods + +- [call](CurveRoyalties.md#call) +- [getFromAddress](CurveRoyalties.md#getfromaddress) +- [getInputsOfMethod](CurveRoyalties.md#getinputsofmethod) +- [getRoyalty](CurveRoyalties.md#getroyalty) +- [getSignatureOfMethod](CurveRoyalties.md#getsignatureofmethod) +- [init](CurveRoyalties.md#init) +- [send](CurveRoyalties.md#send) +- [sendFrom](CurveRoyalties.md#sendfrom) +- [setInstanceConfig](CurveRoyalties.md#setinstanceconfig) +- [setRoyalty](CurveRoyalties.md#setroyalty) +- [getInstance](CurveRoyalties.md#getinstance) +- [setInstanceConfig](CurveRoyalties.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new CurveRoyalties**(`contractName`) + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Inherited from + +[RoyaltyScheme](RoyaltyScheme.md).[constructor](RoyaltyScheme.md#constructor) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L34) + +## Properties + +### address + +• **address**: `string` + +#### Inherited from + +[RoyaltyScheme](RoyaltyScheme.md).[address](RoyaltyScheme.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[RoyaltyScheme](RoyaltyScheme.md).[contract](RoyaltyScheme.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[RoyaltyScheme](RoyaltyScheme.md).[contractName](RoyaltyScheme.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[RoyaltyScheme](RoyaltyScheme.md).[events](RoyaltyScheme.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[RoyaltyScheme](RoyaltyScheme.md).[version](RoyaltyScheme.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +RoyaltyScheme.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +RoyaltyScheme.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +RoyaltyScheme.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +RoyaltyScheme.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +RoyaltyScheme.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +RoyaltyScheme.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +RoyaltyScheme.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +RoyaltyScheme.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### 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 + +[RoyaltyScheme](RoyaltyScheme.md).[call](RoyaltyScheme.md#call) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[RoyaltyScheme](RoyaltyScheme.md).[getFromAddress](RoyaltyScheme.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[RoyaltyScheme](RoyaltyScheme.md).[getInputsOfMethod](RoyaltyScheme.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getRoyalty + +▸ **getRoyalty**(`did`): `Promise`<`number`\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `did` | `string` | + +#### Returns + +`Promise`<`number`\> + +#### Inherited from + +[RoyaltyScheme](RoyaltyScheme.md).[getRoyalty](RoyaltyScheme.md#getroyalty) + +#### Defined in + +[src/keeper/contracts/royalties/RoyaltyScheme.abstract.ts:26](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/royalties/RoyaltyScheme.abstract.ts#L26) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[RoyaltyScheme](RoyaltyScheme.md).[getSignatureOfMethod](RoyaltyScheme.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[RoyaltyScheme](RoyaltyScheme.md).[init](RoyaltyScheme.md#init) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[RoyaltyScheme](RoyaltyScheme.md).[send](RoyaltyScheme.md#send) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[RoyaltyScheme](RoyaltyScheme.md).[sendFrom](RoyaltyScheme.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[RoyaltyScheme](RoyaltyScheme.md).[setInstanceConfig](RoyaltyScheme.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### setRoyalty + +▸ **setRoyalty**(`did`, `amount`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :---------- | :---------------------------------------------- | +| `did` | `string` | +| `amount` | `number` | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[RoyaltyScheme](RoyaltyScheme.md).[setRoyalty](RoyaltyScheme.md#setroyalty) + +#### Defined in + +[src/keeper/contracts/royalties/RoyaltyScheme.abstract.ts:22](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/royalties/RoyaltyScheme.abstract.ts#L22) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`): `Promise`<[`CurveRoyalties`](CurveRoyalties.md)\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`Promise`<[`CurveRoyalties`](CurveRoyalties.md)\> + +#### Overrides + +[RoyaltyScheme](RoyaltyScheme.md).[getInstance](RoyaltyScheme.md#getinstance) + +#### Defined in + +[src/keeper/contracts/royalties/CurveRoyalties.ts:5](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/royalties/CurveRoyalties.ts#L5) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[RoyaltyScheme](RoyaltyScheme.md).[setInstanceConfig](RoyaltyScheme.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/CustomToken.md b/docs/api-reference/classes/CustomToken.md new file mode 100644 index 000000000..b2c8d3efb --- /dev/null +++ b/docs/api-reference/classes/CustomToken.md @@ -0,0 +1,788 @@ +[@nevermined-io/sdk](../code-reference.md) / CustomToken + +# Class: CustomToken + +## Hierarchy + +- [`Token`](Token.md) + + ↳ **`CustomToken`** + +## Table of contents + +### Constructors + +- [constructor](CustomToken.md#constructor) + +### Properties + +- [address](CustomToken.md#address) +- [contract](CustomToken.md#contract) +- [contractName](CustomToken.md#contractname) +- [events](CustomToken.md#events) +- [version](CustomToken.md#version) +- [ERC20_ABI](CustomToken.md#erc20_abi) + +### Accessors + +- [artifactsFolder](CustomToken.md#artifactsfolder) +- [circuitsFolder](CustomToken.md#circuitsfolder) +- [config](CustomToken.md#config) +- [instanceConfig](CustomToken.md#instanceconfig) +- [instantiableConfig](CustomToken.md#instantiableconfig) +- [logger](CustomToken.md#logger) +- [nevermined](CustomToken.md#nevermined) +- [web3](CustomToken.md#web3) + +### Methods + +- [approve](CustomToken.md#approve) +- [balanceOf](CustomToken.md#balanceof) +- [balanceOfConverted](CustomToken.md#balanceofconverted) +- [call](CustomToken.md#call) +- [decimals](CustomToken.md#decimals) +- [getFromAddress](CustomToken.md#getfromaddress) +- [getInputsOfMethod](CustomToken.md#getinputsofmethod) +- [getSignatureOfMethod](CustomToken.md#getsignatureofmethod) +- [init](CustomToken.md#init) +- [name](CustomToken.md#name) +- [send](CustomToken.md#send) +- [sendFrom](CustomToken.md#sendfrom) +- [setInstanceConfig](CustomToken.md#setinstanceconfig) +- [strBalanceOf](CustomToken.md#strbalanceof) +- [symbol](CustomToken.md#symbol) +- [totalSupply](CustomToken.md#totalsupply) +- [transfer](CustomToken.md#transfer) +- [getInstance](CustomToken.md#getinstance) +- [getInstanceByAddress](CustomToken.md#getinstancebyaddress) +- [setInstanceConfig](CustomToken.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new CustomToken**(`contractName`) + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Inherited from + +[Token](Token.md).[constructor](Token.md#constructor) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L34) + +## Properties + +### address + +• **address**: `string` + +#### Inherited from + +[Token](Token.md).[address](Token.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[Token](Token.md).[contract](Token.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[Token](Token.md).[contractName](Token.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[Token](Token.md).[events](Token.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[Token](Token.md).[version](Token.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +--- + +### ERC20_ABI + +▪ `Static` **ERC20_ABI**: `string`[] + +#### Inherited from + +[Token](Token.md).[ERC20_ABI](Token.md#erc20_abi) + +#### Defined in + +[src/keeper/contracts/Token.ts:7](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Token.ts#L7) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Token.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Token.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +Token.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Token.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Token.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +Token.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +Token.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +Token.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### approve + +▸ **approve**(`to`, `price`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :---------- | :---------------------------------------------- | +| `to` | `string` | +| `price` | `bigint` | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[Token](Token.md).[approve](Token.md#approve) + +#### Defined in + +[src/keeper/contracts/Token.ts:27](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Token.ts#L27) + +--- + +### balanceOf + +▸ **balanceOf**(`address`): `Promise`<`bigint`\> + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `address` | `string` | + +#### Returns + +`Promise`<`bigint`\> + +#### Inherited from + +[Token](Token.md).[balanceOf](Token.md#balanceof) + +#### Defined in + +[src/keeper/contracts/Token.ts:43](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Token.ts#L43) + +--- + +### balanceOfConverted + +▸ **balanceOfConverted**(`address`): `Promise`<`bigint`\> + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `address` | `string` | + +#### Returns + +`Promise`<`bigint`\> + +#### Inherited from + +[Token](Token.md).[balanceOfConverted](Token.md#balanceofconverted) + +#### Defined in + +[src/keeper/contracts/Token.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Token.ts#L35) + +--- + +### 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 + +[Token](Token.md).[call](Token.md#call) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### decimals + +▸ **decimals**(): `Promise`<`number`\> + +#### Returns + +`Promise`<`number`\> + +#### Inherited from + +[Token](Token.md).[decimals](Token.md#decimals) + +#### Defined in + +[src/keeper/contracts/Token.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Token.ts#L31) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[Token](Token.md).[getFromAddress](Token.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[Token](Token.md).[getInputsOfMethod](Token.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[Token](Token.md).[getSignatureOfMethod](Token.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[Token](Token.md).[init](Token.md#init) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### name + +▸ **name**(): `Promise`<`string`\> + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[Token](Token.md).[name](Token.md#name) + +#### Defined in + +[src/keeper/contracts/Token.ts:51](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Token.ts#L51) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[Token](Token.md).[send](Token.md#send) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[Token](Token.md).[sendFrom](Token.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Token](Token.md).[setInstanceConfig](Token.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### strBalanceOf + +▸ **strBalanceOf**(`address`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `address` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[Token](Token.md).[strBalanceOf](Token.md#strbalanceof) + +#### Defined in + +[src/keeper/contracts/Token.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Token.ts#L39) + +--- + +### symbol + +▸ **symbol**(): `Promise`<`string`\> + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[Token](Token.md).[symbol](Token.md#symbol) + +#### Defined in + +[src/keeper/contracts/Token.ts:47](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Token.ts#L47) + +--- + +### totalSupply + +▸ **totalSupply**(): `Promise`<`bigint`\> + +#### Returns + +`Promise`<`bigint`\> + +#### Inherited from + +[Token](Token.md).[totalSupply](Token.md#totalsupply) + +#### Defined in + +[src/keeper/contracts/Token.ts:55](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Token.ts#L55) + +--- + +### transfer + +▸ **transfer**(`to`, `amount`, `from`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :---------- | :---------------------------------------------- | +| `to` | `string` | +| `amount` | `bigint` | +| `from` | `string` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[Token](Token.md).[transfer](Token.md#transfer) + +#### Defined in + +[src/keeper/contracts/Token.ts:59](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Token.ts#L59) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`): `Promise`<[`Token`](Token.md)\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`Promise`<[`Token`](Token.md)\> + +#### Inherited from + +[Token](Token.md).[getInstance](Token.md#getinstance) + +#### Defined in + +[src/keeper/contracts/Token.ts:21](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Token.ts#L21) + +--- + +### getInstanceByAddress + +▸ `Static` **getInstanceByAddress**(`config`, `address`): `Promise`<[`CustomToken`](CustomToken.md)\> + +#### Parameters + +| Name | Type | +| :-------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | +| `address` | `string` | + +#### Returns + +`Promise`<[`CustomToken`](CustomToken.md)\> + +#### Defined in + +[src/keeper/contracts/CustomToken.ts:7](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/CustomToken.ts#L7) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Token](Token.md).[setInstanceConfig](Token.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/DDO.md b/docs/api-reference/classes/DDO.md index 23ebb43a6..932d314e7 100644 --- a/docs/api-reference/classes/DDO.md +++ b/docs/api-reference/classes/DDO.md @@ -22,6 +22,7 @@ Contains all the data related to an asset. - [proof](DDO.md#proof) - [publicKey](DDO.md#publickey) - [service](DDO.md#service) +- [updated](DDO.md#updated) ### Methods @@ -31,15 +32,38 @@ Contains all the data related to an asset. - [addSignature](DDO.md#addsignature) - [assignDid](DDO.md#assigndid) - [checksum](DDO.md#checksum) -- [findServiceById](DDO.md#findservicebyid) +- [findServiceByIndex](DDO.md#findservicebyindex) +- [findServiceByReference](DDO.md#findservicebyreference) - [findServiceByType](DDO.md#findservicebytype) - [generateDidSeed](DDO.md#generatedidseed) - [generateProof](DDO.md#generateproof) +- [getAssetPriceFromDDOByServiceType](DDO.md#getassetpricefromddobyservicetype) - [getPriceByService](DDO.md#getpricebyservice) +- [getProofChecksum](DDO.md#getproofchecksum) +- [getServicesByType](DDO.md#getservicesbytype) +- [reorderServices](DDO.md#reorderservices) +- [replaceService](DDO.md#replaceservice) +- [serviceExists](DDO.md#serviceexists) +- [serviceIndexExists](DDO.md#serviceindexexists) +- [setAssetPriceFromDDOByService](DDO.md#setassetpricefromddobyservice) +- [setNFTRewardsFromService](DDO.md#setnftrewardsfromservice) - [shortId](DDO.md#shortid) +- [updateMetadataService](DDO.md#updatemetadataservice) - [updateService](DDO.md#updateservice) +- [createAuthorizationService](DDO.md#createauthorizationservice) - [deserialize](DDO.md#deserialize) +- [findAndReplaceDDOAttribute](DDO.md#findandreplaceddoattribute) +- [findServiceConditionByName](DDO.md#findserviceconditionbyname) +- [getAssetPriceFromService](DDO.md#getassetpricefromservice) +- [getDIDFromService](DDO.md#getdidfromservice) +- [getDurationFromService](DDO.md#getdurationfromservice) - [getInstance](DDO.md#getinstance) +- [getNFTTransferFromService](DDO.md#getnfttransferfromservice) +- [getNftAmountFromService](DDO.md#getnftamountfromservice) +- [getNftContractAddressFromService](DDO.md#getnftcontractaddressfromservice) +- [getNftHolderFromService](DDO.md#getnftholderfromservice) +- [getParameterFromCondition](DDO.md#getparameterfromcondition) +- [getTokenIdFromService](DDO.md#gettokenidfromservice) - [serialize](DDO.md#serialize) ## Constructors @@ -56,7 +80,7 @@ Contains all the data related to an asset. #### Defined in -[src/ddo/DDO.ts:62](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/DDO.ts#L62) +[src/ddo/DDO.ts:100](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L100) ## Properties @@ -66,27 +90,27 @@ Contains all the data related to an asset. #### Defined in -[src/ddo/DDO.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/DDO.ts#L41) +[src/ddo/DDO.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L77) --- ### \_nvm -• **\_nvm**: `NvmConfig` +• **\_nvm**: [`NvmConfig`](../interfaces/NvmConfig.md) #### Defined in -[src/ddo/DDO.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/DDO.ts#L50) +[src/ddo/DDO.ts:86](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L86) --- ### authentication -• **authentication**: `Authentication`[] = `[]` +• **authentication**: [`Authentication`](../interfaces/Authentication.md)[] = `[]` #### Defined in -[src/ddo/DDO.ts:56](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/DDO.ts#L56) +[src/ddo/DDO.ts:94](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L94) --- @@ -96,7 +120,7 @@ Contains all the data related to an asset. #### Defined in -[src/ddo/DDO.ts:52](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/DDO.ts#L52) +[src/ddo/DDO.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L88) --- @@ -106,7 +130,7 @@ Contains all the data related to an asset. #### Defined in -[src/ddo/DDO.ts:48](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/DDO.ts#L48) +[src/ddo/DDO.ts:84](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L84) --- @@ -118,58 +142,72 @@ DID, decentralizes ID. #### Defined in -[src/ddo/DDO.ts:46](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/DDO.ts#L46) +[src/ddo/DDO.ts:82](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L82) --- ### proof -• **proof**: `Proof` +• **proof**: [`Proof`](../interfaces/Proof.md) #### Defined in -[src/ddo/DDO.ts:60](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/DDO.ts#L60) +[src/ddo/DDO.ts:98](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L98) --- ### publicKey -• **publicKey**: `PublicKey`[] = `[]` +• **publicKey**: [`PublicKey`](../interfaces/PublicKey.md)[] = `[]` #### Defined in -[src/ddo/DDO.ts:54](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/DDO.ts#L54) +[src/ddo/DDO.ts:92](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L92) --- ### service -• **service**: `ServiceCommon`[] = `[]` +• **service**: [`ServiceCommon`](../interfaces/ServiceCommon.md)[] = `[]` #### Defined in -[src/ddo/DDO.ts:58](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/DDO.ts#L58) +[src/ddo/DDO.ts:96](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L96) + +--- + +### updated + +• `Optional` **updated**: `string` + +#### Defined in + +[src/ddo/DDO.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L90) ## Methods ### addDefaultMetadataService -▸ **addDefaultMetadataService**(`metadata`, `nftAttributes?`): `Promise`<[`MetaDataMain`](../interfaces/MetaDataMain.md)\> +▸ **addDefaultMetadataService**(`metadata`, `nftAttributes?`): [`MetaDataMain`](../interfaces/MetaDataMain.md) + +Adds a default metadata service to the DDO. #### Parameters -| Name | Type | -| :--------------- | :-------------------------------------- | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | -| `nftAttributes?` | `NFTAttributes` | +| Name | Type | Description | +| :--------------- | :-------------------------------------- | :------------- | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | metadata | +| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | nft attributes | #### Returns -`Promise`<[`MetaDataMain`](../interfaces/MetaDataMain.md)\> +[`MetaDataMain`](../interfaces/MetaDataMain.md) + +main metadata attributes #### Defined in -[src/ddo/DDO.ts:199](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/DDO.ts#L199) +[src/ddo/DDO.ts:322](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L322) --- @@ -189,31 +227,33 @@ Generates and adds a proof using personal sign on the DDO. `Promise`<`void`\> -Proof object. +void. #### Defined in -[src/ddo/DDO.ts:188](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/DDO.ts#L188) +[src/ddo/DDO.ts:272](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L272) --- ### addService -▸ **addService**(`service`): `Promise`<`void`\> +▸ **addService**(`service`): `void` + +Adds a service to the DDO. #### Parameters -| Name | Type | -| :-------- | :---- | -| `service` | `any` | +| Name | Type | +| :-------- | :------------------------------------------------ | +| `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | #### Returns -`Promise`<`void`\> +`void` #### Defined in -[src/ddo/DDO.ts:195](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/DDO.ts#L195) +[src/ddo/DDO.ts:294](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L294) --- @@ -221,12 +261,14 @@ Proof object. ▸ **addSignature**(`nevermined`, `publicKey`): `Promise`<`void`\> +It adds a signature to the the proof object of the DDO + #### Parameters -| Name | Type | -| :----------- | :---------------------------- | -| `nevermined` | [`Nevermined`](Nevermined.md) | -| `publicKey` | `string` | +| Name | Type | Description | +| :----------- | :---------------------------- | :------------------------- | +| `nevermined` | [`Nevermined`](Nevermined.md) | nevermined object | +| `publicKey` | `string` | public key to sign the DDO | #### Returns @@ -234,7 +276,7 @@ Proof object. #### Defined in -[src/ddo/DDO.ts:250](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/DDO.ts#L250) +[src/ddo/DDO.ts:404](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L404) --- @@ -242,13 +284,15 @@ Proof object. ▸ **assignDid**(`didSeed`, `didRegistry`, `publisher`): `Promise`<`void`\> +Assign a DID to the DDO + #### Parameters -| Name | Type | -| :------------ | :---------------------- | -| `didSeed` | `string` | -| `didRegistry` | `default` | -| `publisher` | [`Account`](Account.md) | +| Name | Type | Description | +| :------------ | :------------------------------ | :-------------------------- | +| `didSeed` | `string` | DID seed | +| `didRegistry` | [`DIDRegistry`](DIDRegistry.md) | DIDRegistry contract | +| `publisher` | [`Account`](Account.md) | account registering the DID | #### Returns @@ -256,7 +300,7 @@ Proof object. #### Defined in -[src/ddo/DDO.ts:234](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/DDO.ts#L234) +[src/ddo/DDO.ts:382](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L382) --- @@ -276,71 +320,101 @@ Proof object. #### Defined in -[src/ddo/DDO.ts:156](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/DDO.ts#L156) +[src/ddo/DDO.ts:234](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L234) --- -### findServiceById +### findServiceByIndex -▸ **findServiceById**<`T`\>(`index`): `Service`<`T`\> +▸ **findServiceByIndex**<`T`\>(`index`): [`Service`](../code-reference.md#service)<`T`\> Finds a service of a DDO by index. #### Type parameters -| Name | Type | -| :--- | :-------------------- | -| `T` | extends `ServiceType` | +| Name | Type | +| :--- | :-------------------------------------------------------- | +| `T` | extends [`ServiceType`](../code-reference.md#servicetype) | #### Parameters -| Name | Type | Description | -| :------ | :------- | :---------- | -| `index` | `number` | index. | +| Name | Type | Description | +| :------ | :------- | :------------------------------- | +| `index` | `number` | index of the service in the DDO. | #### Returns -`Service`<`T`\> +[`Service`](../code-reference.md#service)<`T`\> Service. #### Defined in -[src/ddo/DDO.ts:106](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/DDO.ts#L106) +[src/ddo/DDO.ts:139](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L139) --- -### findServiceByType +### findServiceByReference -▸ **findServiceByType**<`T`\>(`serviceType`): `Service`<`T`\> +▸ **findServiceByReference**<`T`\>(`serviceReference`): [`Service`](../code-reference.md#service)<`T`\> -Finds a service of a DDO by type. +Finds a service of a DDO by index. -**`Throws`** +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------- | +| `T` | extends [`ServiceType`](../code-reference.md#servicetype) | + +#### Parameters + +| Name | Type | Description | +| :----------------- | :------------------------------------------------------------ | :---------------------------------------- | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | reference to the service (index or type). | + +#### Returns -DDOServiceNotFoundError If the service is not in the DDO. +[`Service`](../code-reference.md#service)<`T`\> + +Service. + +#### Defined in + +[src/ddo/DDO.ts:173](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L173) + +--- + +### findServiceByType + +▸ **findServiceByType**<`T`\>(`serviceType`): [`Service`](../code-reference.md#service)<`T`\> + +Finds the first service of a DDO by type. #### Type parameters -| Name | Type | -| :--- | :-------------------- | -| `T` | extends `ServiceType` | +| Name | Type | +| :--- | :-------------------------------------------------------- | +| `T` | extends [`ServiceType`](../code-reference.md#servicetype) | #### Parameters -| Name | Type | Description | -| :------------ | :--- | :------------ | -| `serviceType` | `T` | Service type. | +| Name | Type | Description | +| :------------ | :--- | :------------------------------------ | +| `serviceType` | `T` | Service type used by find the service | #### Returns -`Service`<`T`\> +[`Service`](../code-reference.md#service)<`T`\> + +[Service](../code-reference.md#service). -[Service](../interfaces/Service.md). +**`Throws`** + +[DDOServiceNotFoundError](DDOServiceNotFoundError.md) If the service is not in the DDO. #### Defined in -[src/ddo/DDO.ts:126](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/DDO.ts#L126) +[src/ddo/DDO.ts:159](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L159) --- @@ -348,25 +422,29 @@ DDOServiceNotFoundError If the service is not in the DDO. ▸ **generateDidSeed**(`seed`): `Promise`<`string`\> +It generates a DID seed from a seed + #### Parameters -| Name | Type | -| :----- | :---- | -| `seed` | `any` | +| Name | Type | Description | +| :----- | :---- | :---------- | +| `seed` | `any` | the seed | #### Returns `Promise`<`string`\> +the string represeing the DID seed + #### Defined in -[src/ddo/DDO.ts:246](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/DDO.ts#L246) +[src/ddo/DDO.ts:395](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L395) --- ### generateProof -▸ **generateProof**(`publicKey`): `Promise`<`Proof`\> +▸ **generateProof**(`publicKey`): `Promise`<[`Proof`](../interfaces/Proof.md)\> Generates proof using personal sign. @@ -378,22 +456,58 @@ Generates proof using personal sign. #### Returns -`Promise`<`Proof`\> +`Promise`<[`Proof`](../interfaces/Proof.md)\> Proof object. #### Defined in -[src/ddo/DDO.ts:167](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/DDO.ts#L167) +[src/ddo/DDO.ts:243](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L243) + +--- + +### getAssetPriceFromDDOByServiceType + +▸ **getAssetPriceFromDDOByServiceType**(`service`): [`AssetPrice`](AssetPrice.md) + +It gets the AssetPrice from a service given the serviceType + +#### Parameters + +| Name | Type | Description | +| :-------- | :------------------------------------------------ | :----------------------- | +| `service` | [`ServiceType`](../code-reference.md#servicetype) | the service to search in | + +#### Returns + +[`AssetPrice`](AssetPrice.md) + +the AssetPrice object + +#### Defined in + +[src/ddo/DDO.ts:552](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L552) --- ### getPriceByService -▸ **getPriceByService**(`serviceType?`): `default` +▸ **getPriceByService**(`serviceType?`): `bigint` Get the total price of a service. +#### Parameters + +| Name | Type | Default value | Description | +| :------------ | :------------------------------------------------ | :------------ | :----------- | +| `serviceType` | [`ServiceType`](../code-reference.md#servicetype) | `'access'` | Service type | + +#### Returns + +`bigint` + +bigint + **`Example`** ```ts @@ -402,23 +516,199 @@ const price = ddo.getPriceByService('nft-access') **`Throws`** -DDOPriceNotFoundError +[DDOPriceNotFoundError](DDOPriceNotFoundError.md) + +#### Defined in + +[src/ddo/DDO.ts:224](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L224) + +--- + +### getProofChecksum + +▸ **getProofChecksum**(): `string` + +Get the checksum of the proof. + +#### Returns + +`string` + +string containing the checksum of the proof. + +#### Defined in + +[src/ddo/DDO.ts:263](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L263) + +--- + +### getServicesByType + +▸ **getServicesByType**<`T`\>(`serviceType`): [`Service`](../code-reference.md#service)<`T`\>[] + +Gets all the services of a DDO with a specific type. + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------- | +| `T` | extends [`ServiceType`](../code-reference.md#servicetype) | #### Parameters -| Name | Type | Default value | Description | -| :------------ | :------------ | :------------ | :----------- | -| `serviceType` | `ServiceType` | `'access'` | Service type | +| Name | Type | Description | +| :------------ | :--- | :------------ | +| `serviceType` | `T` | Service type. | #### Returns -`default` +[`Service`](../code-reference.md#service)<`T`\>[] -BigNumber +[Service](../code-reference.md#service). #### Defined in -[src/ddo/DDO.ts:146](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/DDO.ts#L146) +[src/ddo/DDO.ts:189](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L189) + +--- + +### reorderServices + +▸ **reorderServices**(): `void` + +It reorders the services of the DDO using the service index + +#### Returns + +`void` + +#### Defined in + +[src/ddo/DDO.ts:282](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L282) + +--- + +### replaceService + +▸ **replaceService**(`index`, `service`): `void` + +Replaces a service in the DDO. + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `index` | `number` | +| `service` | `any` | + +#### Returns + +`void` + +#### Defined in + +[src/ddo/DDO.ts:310](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L310) + +--- + +### serviceExists + +▸ **serviceExists**<`T`\>(`serviceType`): `boolean` + +Checks if a service exists in the DDO. + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------- | +| `T` | extends [`ServiceType`](../code-reference.md#servicetype) | + +#### Parameters + +| Name | Type | Description | +| :------------ | :--- | :------------ | +| `serviceType` | `T` | Service type. | + +#### Returns + +`boolean` + +true if service exists. + +#### Defined in + +[src/ddo/DDO.ts:199](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L199) + +--- + +### serviceIndexExists + +▸ **serviceIndexExists**(`serviceIndex`): `boolean` + +Checks if a service index in the DDO. + +#### Parameters + +| Name | Type | Description | +| :------------- | :------- | :------------- | +| `serviceIndex` | `number` | Service index. | + +#### Returns + +`boolean` + +true if service exists. + +#### Defined in + +[src/ddo/DDO.ts:209](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L209) + +--- + +### setAssetPriceFromDDOByService + +▸ **setAssetPriceFromDDOByService**(`serviceType`, `rewards`): `void` + +Given a service type, it sets the AssetPrice in the escrowPayment condition + +#### Parameters + +| Name | Type | Description | +| :------------ | :------------------------------------------------ | :--------------------------- | +| `serviceType` | [`ServiceType`](../code-reference.md#servicetype) | the service to search in | +| `rewards` | [`AssetPrice`](AssetPrice.md) | the AssetPrice object to set | + +#### Returns + +`void` + +#### Defined in + +[src/ddo/DDO.ts:562](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L562) + +--- + +### setNFTRewardsFromService + +▸ **setNFTRewardsFromService**(`serviceType`, `rewards`, `holderAddress`): `DDOConditionNotFoundError` + +Given the service type it sets the AssetPrice and NFT holder + +#### Parameters + +| Name | Type | Description | +| :-------------- | :------------------------------------------------ | :---------------------------- | +| `serviceType` | [`ServiceType`](../code-reference.md#servicetype) | the service type to search in | +| `rewards` | [`AssetPrice`](AssetPrice.md) | the AssetPrice object to set | +| `holderAddress` | `string` | the NFT Holder address to set | + +#### Returns + +`DDOConditionNotFoundError` + +#### Defined in + +[src/ddo/DDO.ts:585](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L585) --- @@ -432,28 +722,77 @@ BigNumber #### Defined in -[src/ddo/DDO.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/DDO.ts#L97) +[src/ddo/DDO.ts:130](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L130) + +--- + +### updateMetadataService + +▸ **updateMetadataService**(`service`): `void` + +Updates a service in the DDO + +#### Parameters + +| Name | Type | Description | +| :-------- | :---- | :------------------------ | +| `service` | `any` | the service to be updated | + +#### Returns + +`void` + +#### Defined in + +[src/ddo/DDO.ts:368](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L368) --- ### updateService -▸ **updateService**(`nevermined`, `service`): `Promise`<`void`\> +▸ **updateService**(`service`, `serviceIndex?`): `void` #### Parameters -| Name | Type | -| :----------- | :---------------------------- | -| `nevermined` | [`Nevermined`](Nevermined.md) | -| `service` | `any` | +| Name | Type | Default value | Description | +| :------------- | :------- | :------------ | :---------------------------------------------------- | +| `service` | `any` | `undefined` | the service to be updated | +| `serviceIndex` | `number` | `0` | the position of the service in the DDO.services array | #### Returns -`Promise`<`void`\> +`void` + +**`Deprecated`** + +use the `updateMetadataService` or `replaceService` methods instead +Updates a service in the DDO + +#### Defined in + +[src/ddo/DDO.ts:359](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L359) + +--- + +### createAuthorizationService + +▸ `Static` **createAuthorizationService**(`neverminedNodeUri`, `publicKey`, `method`): [`ServiceCommon`](../interfaces/ServiceCommon.md) + +#### Parameters + +| Name | Type | +| :------------------ | :------- | +| `neverminedNodeUri` | `string` | +| `publicKey` | `string` | +| `method` | `string` | + +#### Returns + +[`ServiceCommon`](../interfaces/ServiceCommon.md) #### Defined in -[src/ddo/DDO.ts:230](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/DDO.ts#L230) +[src/ddo/DDO.ts:58](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L58) --- @@ -477,7 +816,130 @@ The deserialized [DDO](DDO.md). #### Defined in -[src/ddo/DDO.ts:35](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/DDO.ts#L35) +[src/ddo/DDO.ts:52](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L52) + +--- + +### findAndReplaceDDOAttribute + +▸ `Static` **findAndReplaceDDOAttribute**(`ddo`, `paramName`, `value`): [`DDO`](DDO.md) + +Finds an attribute in the DDO and replace it with the given value + +#### Parameters + +| Name | Type | Description | +| :---------- | :-------------- | :------------------------ | +| `ddo` | [`DDO`](DDO.md) | the originial DDO | +| `paramName` | `string` | the param name to replace | +| `value` | `string` | the new value | + +#### Returns + +[`DDO`](DDO.md) + +the DDO with the replaced attribute + +#### Defined in + +[src/ddo/DDO.ts:606](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L606) + +--- + +### findServiceConditionByName + +▸ `Static` **findServiceConditionByName**(`service`, `name`): [`ServiceAgreementTemplateCondition`](../interfaces/ServiceAgreementTemplateCondition.md) + +If fins a service condition by name + +#### Parameters + +| Name | Type | Description | +| :-------- | :---------------------------------------------------- | :------------------------ | +| `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | the service to search in | +| `name` | [`ConditionType`](../code-reference.md#conditiontype) | the name of the condition | + +#### Returns + +[`ServiceAgreementTemplateCondition`](../interfaces/ServiceAgreementTemplateCondition.md) + +ServiceAgreementTemplateCondition the condition + +#### Defined in + +[src/ddo/DDO.ts:416](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L416) + +--- + +### getAssetPriceFromService + +▸ `Static` **getAssetPriceFromService**(`service`): [`AssetPrice`](AssetPrice.md) + +It gets the AssetPrice from a service with escrowPayment condition + +#### Parameters + +| Name | Type | Description | +| :-------- | :------------------------------------------------ | :----------------------- | +| `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | the service to search in | + +#### Returns + +[`AssetPrice`](AssetPrice.md) + +the AssetPrice object + +#### Defined in + +[src/ddo/DDO.ts:529](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L529) + +--- + +### getDIDFromService + +▸ `Static` **getDIDFromService**(`service`): `string` + +Gets the DID in the escrowPayment condition of the service + +#### Parameters + +| Name | Type | Description | +| :-------- | :------------------------------------------------ | :----------------------- | +| `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | the service to search in | + +#### Returns + +`string` + +the DID + +#### Defined in + +[src/ddo/DDO.ts:432](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L432) + +--- + +### getDurationFromService + +▸ `Static` **getDurationFromService**(`service`): `number` + +Gets the duration parameter in the transferNFT condition of the service + +#### Parameters + +| Name | Type | Description | +| :-------- | :------------------------------------------------ | :----------------------- | +| `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | the service to search in | + +#### Returns + +`number` + +the duration of the subscription + +#### Defined in + +[src/ddo/DDO.ts:486](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L486) --- @@ -499,7 +961,153 @@ The deserialized [DDO](DDO.md). #### Defined in -[src/ddo/DDO.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/DDO.ts#L69) +[src/ddo/DDO.ts:106](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L106) + +--- + +### getNFTTransferFromService + +▸ `Static` **getNFTTransferFromService**(`service`): `boolean` + +Gets the nftTransfer parameter in the transferNFT condition of the service + +#### Parameters + +| Name | Type | Description | +| :-------- | :------------------------------------------------ | :----------------------- | +| `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | the service to search in | + +#### Returns + +`boolean` + +if condition will do a nft transfer or a mint + +#### Defined in + +[src/ddo/DDO.ts:475](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L475) + +--- + +### getNftAmountFromService + +▸ `Static` **getNftAmountFromService**(`service`): `bigint` + +Gets the number of NFTs in the transferNFT condition of the service + +#### Parameters + +| Name | Type | Description | +| :-------- | :------------------------------------------------ | :----------------------- | +| `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | the service to search in | + +#### Returns + +`bigint` + +the number of NFTs + +#### Defined in + +[src/ddo/DDO.ts:463](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L463) + +--- + +### getNftContractAddressFromService + +▸ `Static` **getNftContractAddressFromService**(`service`): `string` + +Gets the NFT Contract address used in the NFT Access or NFT Sales service + +#### Parameters + +| Name | Type | Description | +| :-------- | :--------------------------------------------------------------------------------------------------------------- | :----------------------- | +| `service` | [`ServiceNFTAccess`](../interfaces/ServiceNFTAccess.md) \| [`ServiceNFTSales`](../interfaces/ServiceNFTSales.md) | the service to search in | + +#### Returns + +`string` + +the NFT contract address + +#### Defined in + +[src/ddo/DDO.ts:515](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L515) + +--- + +### getNftHolderFromService + +▸ `Static` **getNftHolderFromService**(`service`): `string` + +Gets the NFT Holder in the transferNFT condition of the service + +#### Parameters + +| Name | Type | Description | +| :-------- | :------------------------------------------------ | :----------------------- | +| `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | the service to search in | + +#### Returns + +`string` + +the NFT Holder address + +#### Defined in + +[src/ddo/DDO.ts:442](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L442) + +--- + +### getParameterFromCondition + +▸ `Static` **getParameterFromCondition**(`service`, `conditionType`, `paramName`): `string` \| `number` \| `string`[] + +Given a service, condition and param name it returns the value + +#### Parameters + +| Name | Type | Description | +| :-------------- | :---------------------------------------------------- | :--------------------------------- | +| `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | The service where the condition is | +| `conditionType` | [`ConditionType`](../code-reference.md#conditiontype) | the condition type | +| `paramName` | `string` | the param name | + +#### Returns + +`string` \| `number` \| `string`[] + +the value + +#### Defined in + +[src/ddo/DDO.ts:497](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L497) + +--- + +### getTokenIdFromService + +▸ `Static` **getTokenIdFromService**(`service`): `string` + +Gets the NFT TokenId in the nftHolder condition of the service + +#### Parameters + +| Name | Type | Description | +| :-------- | :------------------------------------------------ | :----------------------- | +| `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | the service to search in | + +#### Returns + +`string` + +the NFT Token Id + +#### Defined in + +[src/ddo/DDO.ts:451](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L451) --- @@ -523,4 +1131,4 @@ DDO serialized. #### Defined in -[src/ddo/DDO.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/DDO.ts#L26) +[src/ddo/DDO.ts:43](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L43) diff --git a/docs/api-reference/classes/DDOError.md b/docs/api-reference/classes/DDOError.md new file mode 100644 index 000000000..140f178cc --- /dev/null +++ b/docs/api-reference/classes/DDOError.md @@ -0,0 +1,170 @@ +[@nevermined-io/sdk](../code-reference.md) / DDOError + +# Class: DDOError + +## Hierarchy + +- `Error` + + ↳ **`DDOError`** + + ↳↳ [`DDOPriceNotFoundError`](DDOPriceNotFoundError.md) + + ↳↳ [`DDOServiceNotFoundError`](DDOServiceNotFoundError.md) + +## Table of contents + +### Constructors + +- [constructor](DDOError.md#constructor) + +### Properties + +- [message](DDOError.md#message) +- [name](DDOError.md#name) +- [stack](DDOError.md#stack) +- [prepareStackTrace](DDOError.md#preparestacktrace) +- [stackTraceLimit](DDOError.md#stacktracelimit) + +### Methods + +- [captureStackTrace](DDOError.md#capturestacktrace) + +## Constructors + +### constructor + +• **new DDOError**(`message`, `did?`) + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `message` | `string` | +| `did?` | `string` | + +#### Overrides + +Error.constructor + +#### Defined in + +[src/errors/DDOError.ts:4](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/errors/DDOError.ts#L4) + +## Properties + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1068 + +--- + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1067 + +--- + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1069 + +--- + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +Optional override for formatting stack traces + +##### Parameters + +| Name | Type | +| :------------ | :----------- | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:11 + +--- + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:13 + +## Methods + +### captureStackTrace + +▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :---------------- | :--------- | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:4 diff --git a/docs/api-reference/classes/DDOPriceNotFoundError.md b/docs/api-reference/classes/DDOPriceNotFoundError.md new file mode 100644 index 000000000..558ccb6bb --- /dev/null +++ b/docs/api-reference/classes/DDOPriceNotFoundError.md @@ -0,0 +1,166 @@ +[@nevermined-io/sdk](../code-reference.md) / DDOPriceNotFoundError + +# Class: DDOPriceNotFoundError + +## Hierarchy + +- [`DDOError`](DDOError.md) + + ↳ **`DDOPriceNotFoundError`** + +## Table of contents + +### Constructors + +- [constructor](DDOPriceNotFoundError.md#constructor) + +### Properties + +- [message](DDOPriceNotFoundError.md#message) +- [name](DDOPriceNotFoundError.md#name) +- [stack](DDOPriceNotFoundError.md#stack) +- [prepareStackTrace](DDOPriceNotFoundError.md#preparestacktrace) +- [stackTraceLimit](DDOPriceNotFoundError.md#stacktracelimit) + +### Methods + +- [captureStackTrace](DDOPriceNotFoundError.md#capturestacktrace) + +## Constructors + +### constructor + +• **new DDOPriceNotFoundError**(`serviceType`, `did?`) + +#### Parameters + +| Name | Type | +| :------------ | :------------------------------------------------ | +| `serviceType` | [`ServiceType`](../code-reference.md#servicetype) | +| `did?` | `string` | + +#### Overrides + +[DDOError](DDOError.md).[constructor](DDOError.md#constructor) + +#### Defined in + +[src/errors/DDOError.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/errors/DDOError.ts#L42) + +## Properties + +### message + +• **message**: `string` + +#### Inherited from + +[DDOError](DDOError.md).[message](DDOError.md#message) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1068 + +--- + +### name + +• **name**: `string` + +#### Inherited from + +[DDOError](DDOError.md).[name](DDOError.md#name) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1067 + +--- + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +[DDOError](DDOError.md).[stack](DDOError.md#stack) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1069 + +--- + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +Optional override for formatting stack traces + +##### Parameters + +| Name | Type | +| :------------ | :----------- | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Inherited from + +[DDOError](DDOError.md).[prepareStackTrace](DDOError.md#preparestacktrace) + +#### Defined in + +node_modules/@types/node/globals.d.ts:11 + +--- + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +[DDOError](DDOError.md).[stackTraceLimit](DDOError.md#stacktracelimit) + +#### Defined in + +node_modules/@types/node/globals.d.ts:13 + +## Methods + +### captureStackTrace + +▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :---------------- | :--------- | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +[DDOError](DDOError.md).[captureStackTrace](DDOError.md#capturestacktrace) + +#### Defined in + +node_modules/@types/node/globals.d.ts:4 diff --git a/docs/api-reference/classes/DDOServiceNotFoundError.md b/docs/api-reference/classes/DDOServiceNotFoundError.md new file mode 100644 index 000000000..a9c0f2040 --- /dev/null +++ b/docs/api-reference/classes/DDOServiceNotFoundError.md @@ -0,0 +1,166 @@ +[@nevermined-io/sdk](../code-reference.md) / DDOServiceNotFoundError + +# Class: DDOServiceNotFoundError + +## Hierarchy + +- [`DDOError`](DDOError.md) + + ↳ **`DDOServiceNotFoundError`** + +## Table of contents + +### Constructors + +- [constructor](DDOServiceNotFoundError.md#constructor) + +### Properties + +- [message](DDOServiceNotFoundError.md#message) +- [name](DDOServiceNotFoundError.md#name) +- [stack](DDOServiceNotFoundError.md#stack) +- [prepareStackTrace](DDOServiceNotFoundError.md#preparestacktrace) +- [stackTraceLimit](DDOServiceNotFoundError.md#stacktracelimit) + +### Methods + +- [captureStackTrace](DDOServiceNotFoundError.md#capturestacktrace) + +## Constructors + +### constructor + +• **new DDOServiceNotFoundError**(`serviceType`, `did?`) + +#### Parameters + +| Name | Type | +| :------------ | :------------------------------------------------ | +| `serviceType` | [`ServiceType`](../code-reference.md#servicetype) | +| `did?` | `string` | + +#### Overrides + +[DDOError](DDOError.md).[constructor](DDOError.md#constructor) + +#### Defined in + +[src/errors/DDOError.ts:18](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/errors/DDOError.ts#L18) + +## Properties + +### message + +• **message**: `string` + +#### Inherited from + +[DDOError](DDOError.md).[message](DDOError.md#message) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1068 + +--- + +### name + +• **name**: `string` + +#### Inherited from + +[DDOError](DDOError.md).[name](DDOError.md#name) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1067 + +--- + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +[DDOError](DDOError.md).[stack](DDOError.md#stack) + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1069 + +--- + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +Optional override for formatting stack traces + +##### Parameters + +| Name | Type | +| :------------ | :----------- | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Inherited from + +[DDOError](DDOError.md).[prepareStackTrace](DDOError.md#preparestacktrace) + +#### Defined in + +node_modules/@types/node/globals.d.ts:11 + +--- + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +[DDOError](DDOError.md).[stackTraceLimit](DDOError.md#stacktracelimit) + +#### Defined in + +node_modules/@types/node/globals.d.ts:13 + +## Methods + +### captureStackTrace + +▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :---------------- | :--------- | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +[DDOError](DDOError.md).[captureStackTrace](DDOError.md#capturestacktrace) + +#### Defined in + +node_modules/@types/node/globals.d.ts:4 diff --git a/docs/api-reference/classes/DID.md b/docs/api-reference/classes/DID.md index 39e82f65e..290374bed 100644 --- a/docs/api-reference/classes/DID.md +++ b/docs/api-reference/classes/DID.md @@ -17,9 +17,12 @@ Decentralized ID. ### Methods - [getDid](DID.md#getdid) +- [getEncoded](DID.md#getencoded) - [getId](DID.md#getid) +- [fromEncoded](DID.md#fromencoded) - [generate](DID.md#generate) - [parse](DID.md#parse) +- [parseBigInt](DID.md#parsebigint) ## Constructors @@ -35,7 +38,7 @@ Decentralized ID. #### Defined in -[src/nevermined/DID.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/DID.ts#L45) +[src/nevermined/DID.ts:83](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/DID.ts#L83) ## Properties @@ -43,11 +46,11 @@ Decentralized ID. • `Private` **id**: `string` -ID. +Short ID. #### Defined in -[src/nevermined/DID.ts:43](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/DID.ts#L43) +[src/nevermined/DID.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/DID.ts#L81) ## Methods @@ -55,7 +58,7 @@ ID. ▸ **getDid**(): `string` -Returns the DID. +Returns the DID (i.e did:nv:...) #### Returns @@ -65,7 +68,25 @@ A string with the prefixed id. #### Defined in -[src/nevermined/DID.ts:53](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/DID.ts#L53) +[src/nevermined/DID.ts:91](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/DID.ts#L91) + +--- + +### getEncoded + +▸ **getEncoded**(): `string` + +Generates an encoded string in base 36 from a DID. + +#### Returns + +`string` + +A base36 encoded string. + +#### Defined in + +[src/nevermined/DID.ts:74](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/DID.ts#L74) --- @@ -73,7 +94,7 @@ A string with the prefixed id. ▸ **getId**(): `string` -Returns the ID. +Returns the Short ID. #### Returns @@ -83,7 +104,31 @@ A string of the _id_ without the prefix. #### Defined in -[src/nevermined/DID.ts:61](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/DID.ts#L61) +[src/nevermined/DID.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/DID.ts#L99) + +--- + +### fromEncoded + +▸ `Static` **fromEncoded**(`encoded`): [`DID`](DID.md) + +Returns a new DID from a base36 encoded string. + +#### Parameters + +| Name | Type | Description | +| :-------- | :------- | :--------------------- | +| `encoded` | `string` | Base36 encoded string. | + +#### Returns + +[`DID`](DID.md) + +[DID](DID.md) + +#### Defined in + +[src/nevermined/DID.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/DID.ts#L64) --- @@ -101,7 +146,7 @@ Returns a new DID. #### Defined in -[src/nevermined/DID.ts:36](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/DID.ts#L36) +[src/nevermined/DID.ts:43](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/DID.ts#L43) --- @@ -113,9 +158,9 @@ Parses a DID from a string. #### Parameters -| Name | Type | Description | -| :---------- | :-------------------------- | :------------- | -| `didString` | `string` \| [`DID`](DID.md) | DID in string. | +| Name | Type | Description | +| :---------- | :-------------------------- | :------------------------------------------------------------------------------------------ | +| `didString` | `string` \| [`DID`](DID.md) | DID in string format or DID instance. The didString can be in did:nv: format or 0x: format. | #### Returns @@ -125,4 +170,25 @@ Parses a DID from a string. #### Defined in -[src/nevermined/DID.ts:14](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/DID.ts#L14) +[src/nevermined/DID.ts:14](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/DID.ts#L14) + +--- + +### parseBigInt + +▸ `Static` **parseBigInt**(`value`, `radix?`): `any` + +#### Parameters + +| Name | Type | Default value | +| :------ | :------- | :------------ | +| `value` | `any` | `undefined` | +| `radix` | `number` | `36` | + +#### Returns + +`any` + +#### Defined in + +[src/nevermined/DID.ts:47](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/DID.ts#L47) diff --git a/docs/api-reference/classes/DIDRegistry.md b/docs/api-reference/classes/DIDRegistry.md new file mode 100644 index 000000000..d36059491 --- /dev/null +++ b/docs/api-reference/classes/DIDRegistry.md @@ -0,0 +1,1491 @@ +[@nevermined-io/sdk](../code-reference.md) / DIDRegistry + +# Class: DIDRegistry + +## Hierarchy + +- [`ContractBase`](ContractBase.md) + + ↳ **`DIDRegistry`** + +## Table of contents + +### Constructors + +- [constructor](DIDRegistry.md#constructor) + +### Properties + +- [address](DIDRegistry.md#address) +- [contract](DIDRegistry.md#contract) +- [contractName](DIDRegistry.md#contractname) +- [events](DIDRegistry.md#events) +- [version](DIDRegistry.md#version) + +### Accessors + +- [artifactsFolder](DIDRegistry.md#artifactsfolder) +- [circuitsFolder](DIDRegistry.md#circuitsfolder) +- [config](DIDRegistry.md#config) +- [instanceConfig](DIDRegistry.md#instanceconfig) +- [instantiableConfig](DIDRegistry.md#instantiableconfig) +- [logger](DIDRegistry.md#logger) +- [nevermined](DIDRegistry.md#nevermined) +- [web3](DIDRegistry.md#web3) + +### Methods + +- [actedOnBehalf](DIDRegistry.md#actedonbehalf) +- [addDidProvenanceDelegate](DIDRegistry.md#adddidprovenancedelegate) +- [addProvider](DIDRegistry.md#addprovider) +- [burn](DIDRegistry.md#burn) +- [call](DIDRegistry.md#call) +- [enableAndMintDidNft](DIDRegistry.md#enableandmintdidnft) +- [enableAndMintDidNft721](DIDRegistry.md#enableandmintdidnft721) +- [getAttributesByDid](DIDRegistry.md#getattributesbydid) +- [getAttributesByOwner](DIDRegistry.md#getattributesbyowner) +- [getBlockNumberUpdated](DIDRegistry.md#getblocknumberupdated) +- [getDIDOwner](DIDRegistry.md#getdidowner) +- [getDIDProvenanceEvents](DIDRegistry.md#getdidprovenanceevents) +- [getDIDProvenanceMethodEvents](DIDRegistry.md#getdidprovenancemethodevents) +- [getDIDRegister](DIDRegistry.md#getdidregister) +- [getDIDRoyalties](DIDRegistry.md#getdidroyalties) +- [getFromAddress](DIDRegistry.md#getfromaddress) +- [getInputsOfMethod](DIDRegistry.md#getinputsofmethod) +- [getNFTInfo](DIDRegistry.md#getnftinfo) +- [getPermission](DIDRegistry.md#getpermission) +- [getProvenanceEntry](DIDRegistry.md#getprovenanceentry) +- [getProvenanceOwner](DIDRegistry.md#getprovenanceowner) +- [getProviders](DIDRegistry.md#getproviders) +- [getSignatureOfMethod](DIDRegistry.md#getsignatureofmethod) +- [grantPermission](DIDRegistry.md#grantpermission) +- [grantRegistryOperatorRole](DIDRegistry.md#grantregistryoperatorrole) +- [hashDID](DIDRegistry.md#hashdid) +- [init](DIDRegistry.md#init) +- [isDIDProvider](DIDRegistry.md#isdidprovider) +- [isProvenanceDelegate](DIDRegistry.md#isprovenancedelegate) +- [mint](DIDRegistry.md#mint) +- [registerAttribute](DIDRegistry.md#registerattribute) +- [registerDID](DIDRegistry.md#registerdid) +- [registerMintableDID](DIDRegistry.md#registermintabledid) +- [registerMintableDID721](DIDRegistry.md#registermintabledid721) +- [removeDidProvenanceDelegate](DIDRegistry.md#removedidprovenancedelegate) +- [removeProvider](DIDRegistry.md#removeprovider) +- [revokePermission](DIDRegistry.md#revokepermission) +- [send](DIDRegistry.md#send) +- [sendFrom](DIDRegistry.md#sendfrom) +- [setDIDRoyalties](DIDRegistry.md#setdidroyalties) +- [setInstanceConfig](DIDRegistry.md#setinstanceconfig) +- [transferDIDOwnership](DIDRegistry.md#transferdidownership) +- [updateMetadataUrl](DIDRegistry.md#updatemetadataurl) +- [used](DIDRegistry.md#used) +- [wasAssociatedWith](DIDRegistry.md#wasassociatedwith) +- [wasDerivedFrom](DIDRegistry.md#wasderivedfrom) +- [getInstance](DIDRegistry.md#getinstance) +- [setInstanceConfig](DIDRegistry.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new DIDRegistry**(`contractName`) + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Inherited from + +[ContractBase](ContractBase.md).[constructor](ContractBase.md#constructor) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L34) + +## Properties + +### address + +• **address**: `string` + +#### Inherited from + +[ContractBase](ContractBase.md).[address](ContractBase.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[ContractBase](ContractBase.md).[contract](ContractBase.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[ContractBase](ContractBase.md).[contractName](ContractBase.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[ContractBase](ContractBase.md).[events](ContractBase.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[ContractBase](ContractBase.md).[version](ContractBase.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ContractBase.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ContractBase.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +ContractBase.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ContractBase.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ContractBase.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +ContractBase.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +ContractBase.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +ContractBase.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### actedOnBehalf + +▸ **actedOnBehalf**(`provId`, `did`, `delegateAgentId`, `responsibleAgentId`, `activityId`, `signatureDelegate`, `attributes`, `ownerAddress`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------- | +| `provId` | `string` | +| `did` | `string` | +| `delegateAgentId` | `string` | +| `responsibleAgentId` | `string` | +| `activityId` | `string` | +| `signatureDelegate` | `string` | +| `attributes` | `string` | +| `ownerAddress` | `string` | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Defined in + +[src/keeper/contracts/DIDRegistry.ts:533](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/DIDRegistry.ts#L533) + +--- + +### addDidProvenanceDelegate + +▸ **addDidProvenanceDelegate**(`did`, `delegateAddress`, `ownerAddress`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :---------------- | :---------------------------------------------- | +| `did` | `string` | +| `delegateAddress` | `string` | +| `ownerAddress` | `string` | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Defined in + +[src/keeper/contracts/DIDRegistry.ts:560](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/DIDRegistry.ts#L560) + +--- + +### addProvider + +▸ **addProvider**(`did`, `provider`, `from`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :--------- | :---------------------------------------------- | +| `did` | `string` | +| `provider` | `string` | +| `from` | `string` | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Defined in + +[src/keeper/contracts/DIDRegistry.ts:604](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/DIDRegistry.ts#L604) + +--- + +### burn + +▸ **burn**(`did`, `amount`, `from`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :-------- | :---------------------------------------------- | +| `did` | `string` | +| `amount` | `bigint` | +| `from` | `string` | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Defined in + +[src/keeper/contracts/DIDRegistry.ts:600](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/DIDRegistry.ts#L600) + +--- + +### 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](ContractBase.md).[call](ContractBase.md#call) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### enableAndMintDidNft + +▸ **enableAndMintDidNft**(`did`, `cap`, `royalties`, `preMint`, `ownerAddress`, `nftMetadata`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +It activates a NFT associated to a NFT (ERC-1155) and allows to pre-mint. This method only can be called once per DID, so if this was called +or executed before internally the method will fail. +Only use if the intention is to register a mintable asset and it was registered via `registerDID` or `registerAttribute` + +#### Parameters + +| Name | Type | Description | +| :------------- | :---------------------------------------------- | :-------------------------------------- | +| `did` | `string` | The unique identifier of the asset | +| `cap` | `number` | Max number of editions | +| `royalties` | `number` | Asset royalties in the secondary market | +| `preMint` | `boolean` | If true pre-mints the editions of NFT | +| `ownerAddress` | `string` | Address of the user registering the DID | +| `nftMetadata` | `string` | URL to the metadata describing the NFT | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction additional parameters | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +Contract Receipt + +#### Defined in + +[src/keeper/contracts/DIDRegistry.ts:215](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/DIDRegistry.ts#L215) + +--- + +### enableAndMintDidNft721 + +▸ **enableAndMintDidNft721**(`did`, `royalties`, `preMint`, `ownerAddress`, `nftMetadata`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +It activates a NFT associated to a NFT (ERC-721) and allows to pre-mint. This method only can be called once per DID, so if this was called +or executed before internally the method will fail. +Only use if the intention is to register a mintable asset and it was registered via `registerDID` or `registerAttribute` + +#### Parameters + +| Name | Type | Description | +| :------------- | :---------------------------------------------- | :-------------------------------------- | +| `did` | `string` | The unique identifier of the asset | +| `royalties` | `number` | Asset royalties in the secondary market | +| `preMint` | `boolean` | If true pre-mints the editions of NFT | +| `ownerAddress` | `string` | Address of the user registering the DID | +| `nftMetadata` | `string` | URL to the metadata describing the NFT | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction additional parameters | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +Contract Receipt + +#### Defined in + +[src/keeper/contracts/DIDRegistry.ts:245](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/DIDRegistry.ts#L245) + +--- + +### getAttributesByDid + +▸ **getAttributesByDid**(`did`): `Promise`<{ `checksum`: `string` ; `did`: `string` ; `immutableUrl`: `string` ; `nftInitialized`: `boolean` ; `owner`: `string` ; `providers`: `string`[] ; `royalties`: `bigint` ; `serviceEndpoint`: `string` }\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `did` | `string` | + +#### Returns + +`Promise`<{ `checksum`: `string` ; `did`: `string` ; `immutableUrl`: `string` ; `nftInitialized`: `boolean` ; `owner`: `string` ; `providers`: `string`[] ; `royalties`: `bigint` ; `serviceEndpoint`: `string` }\> + +#### Defined in + +[src/keeper/contracts/DIDRegistry.ts:298](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/DIDRegistry.ts#L298) + +--- + +### getAttributesByOwner + +▸ **getAttributesByOwner**(`owner`): `Promise`<`string`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `owner` | `string` | + +#### Returns + +`Promise`<`string`[]\> + +#### Defined in + +[src/keeper/contracts/DIDRegistry.ts:273](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/DIDRegistry.ts#L273) + +--- + +### getBlockNumberUpdated + +▸ **getBlockNumberUpdated**(`did`): `Promise`<`number`\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `did` | `string` | + +#### Returns + +`Promise`<`number`\> + +#### Defined in + +[src/keeper/contracts/DIDRegistry.ts:265](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/DIDRegistry.ts#L265) + +--- + +### getDIDOwner + +▸ **getDIDOwner**(`did`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `did` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/keeper/contracts/DIDRegistry.ts:261](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/DIDRegistry.ts#L261) + +--- + +### getDIDProvenanceEvents + +▸ **getDIDProvenanceEvents**(`did`): `Promise`<{ `activityId`: `string` ; `agentId`: `string` ; `agentInvolvedId`: `string` ; `attributes?`: `string` ; `blockNumberUpdated`: `number` ; `did`: `string` ; `id`: `string` ; `method`: `number` ; `provId`: `string` ; `relatedDid`: `string` }[]\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `did` | `string` | + +#### Returns + +`Promise`<{ `activityId`: `string` ; `agentId`: `string` ; `agentInvolvedId`: `string` ; `attributes?`: `string` ; `blockNumberUpdated`: `number` ; `did`: `string` ; `id`: `string` ; `method`: `number` ; `provId`: `string` ; `relatedDid`: `string` }[]\> + +#### Defined in + +[src/keeper/contracts/DIDRegistry.ts:374](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/DIDRegistry.ts#L374) + +--- + +### getDIDProvenanceMethodEvents + +▸ **getDIDProvenanceMethodEvents**<`T`\>(`did`, `method`): `Promise`<[`ProvenanceEvent`](../code-reference.md#provenanceevent)<`T`\>[]\> + +#### Type parameters + +| Name | Type | +| :--- | :--------------------------------------------------------- | +| `T` | extends [`ProvenanceMethod`](../enums/ProvenanceMethod.md) | + +#### Parameters + +| Name | Type | +| :------- | :------- | +| `did` | `string` | +| `method` | `T` | + +#### Returns + +`Promise`<[`ProvenanceEvent`](../code-reference.md#provenanceevent)<`T`\>[]\> + +#### Defined in + +[src/keeper/contracts/DIDRegistry.ts:409](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/DIDRegistry.ts#L409) + +--- + +### getDIDRegister + +▸ **getDIDRegister**(`did`): `Promise`<`unknown`\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `did` | `string` | + +#### Returns + +`Promise`<`unknown`\> + +#### Defined in + +[src/keeper/contracts/DIDRegistry.ts:617](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/DIDRegistry.ts#L617) + +--- + +### getDIDRoyalties + +▸ **getDIDRoyalties**(`did`): `Promise`<`unknown`\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `did` | `string` | + +#### Returns + +`Promise`<`unknown`\> + +#### Defined in + +[src/keeper/contracts/DIDRegistry.ts:351](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/DIDRegistry.ts#L351) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ContractBase](ContractBase.md).[getFromAddress](ContractBase.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[ContractBase](ContractBase.md).[getInputsOfMethod](ContractBase.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getNFTInfo + +▸ **getNFTInfo**(`did`): `Promise`<`unknown`\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `did` | `string` | + +#### Returns + +`Promise`<`unknown`\> + +#### Defined in + +[src/keeper/contracts/DIDRegistry.ts:621](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/DIDRegistry.ts#L621) + +--- + +### getPermission + +▸ **getPermission**(`did`, `grantee`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `did` | `string` | +| `grantee` | `string` | + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[src/keeper/contracts/DIDRegistry.ts:355](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/DIDRegistry.ts#L355) + +--- + +### getProvenanceEntry + +▸ **getProvenanceEntry**(`provId`): `Promise`<[`ProvenanceRegistry`](../interfaces/ProvenanceRegistry.md)\> + +#### Parameters + +| Name | Type | +| :------- | :------- | +| `provId` | `string` | + +#### Returns + +`Promise`<[`ProvenanceRegistry`](../interfaces/ProvenanceRegistry.md)\> + +#### Defined in + +[src/keeper/contracts/DIDRegistry.ts:458](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/DIDRegistry.ts#L458) + +--- + +### getProvenanceOwner + +▸ **getProvenanceOwner**(`did`): `Promise`<`unknown`\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `did` | `string` | + +#### Returns + +`Promise`<`unknown`\> + +#### Defined in + +[src/keeper/contracts/DIDRegistry.ts:592](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/DIDRegistry.ts#L592) + +--- + +### getProviders + +▸ **getProviders**(`did`): `Promise`<`any`\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `did` | `string` | + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +[src/keeper/contracts/DIDRegistry.ts:612](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/DIDRegistry.ts#L612) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[ContractBase](ContractBase.md).[getSignatureOfMethod](ContractBase.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### grantPermission + +▸ **grantPermission**(`did`, `grantee`, `ownerAddress`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `did` | `string` | +| `grantee` | `string` | +| `ownerAddress` | `string` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Defined in + +[src/keeper/contracts/DIDRegistry.ts:324](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/DIDRegistry.ts#L324) + +--- + +### grantRegistryOperatorRole + +▸ **grantRegistryOperatorRole**(`manager`, `from`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :-------- | :---------------------------------------------- | +| `manager` | `string` | +| `from` | `string` | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Defined in + +[src/keeper/contracts/DIDRegistry.ts:629](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/DIDRegistry.ts#L629) + +--- + +### hashDID + +▸ **hashDID**(`didSeed`, `creator`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `didSeed` | `string` | +| `creator` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/keeper/contracts/DIDRegistry.ts:625](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/DIDRegistry.ts#L625) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[ContractBase](ContractBase.md).[init](ContractBase.md#init) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### isDIDProvider + +▸ **isDIDProvider**(`did`, `provider`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :--------- | :------- | +| `did` | `string` | +| `provider` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/keeper/contracts/DIDRegistry.ts:269](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/DIDRegistry.ts#L269) + +--- + +### isProvenanceDelegate + +▸ **isProvenanceDelegate**(`did`, `delegateAddress`): `Promise`<`unknown`\> + +#### Parameters + +| Name | Type | +| :---------------- | :------- | +| `did` | `string` | +| `delegateAddress` | `string` | + +#### Returns + +`Promise`<`unknown`\> + +#### Defined in + +[src/keeper/contracts/DIDRegistry.ts:588](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/DIDRegistry.ts#L588) + +--- + +### mint + +▸ **mint**(`did`, `amount`, `from`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :-------- | :---------------------------------------------- | +| `did` | `string` | +| `amount` | `bigint` | +| `from` | `string` | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Defined in + +[src/keeper/contracts/DIDRegistry.ts:596](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/DIDRegistry.ts#L596) + +--- + +### registerAttribute + +▸ **registerAttribute**(`did`, `checksum`, `providers`, `url`, `ownerAddress`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +It registers a decentralized identifier (aka DID) in the `DIDRegistry` smart contract + +#### Parameters + +| Name | Type | Description | +| :------------- | :---------------------------------------------- | :----------------------------------------------------- | +| `did` | `string` | The unique identifier of the asset | +| `checksum` | `string` | Checksum resulted of hash the asset metadata | +| `providers` | `string`[] | List of addresses in charge of interact with the asset | +| `url` | `string` | URL to the metadata in the Metadata/Marketplace API | +| `ownerAddress` | `string` | Address of the user registering the DID | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction additional parameters | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +Contract Receipt + +#### Defined in + +[src/keeper/contracts/DIDRegistry.ts:33](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/DIDRegistry.ts#L33) + +--- + +### registerDID + +▸ **registerDID**(`did`, `checksum`, `providers`, `ownerAddress`, `url`, `immutableUrl?`, `activityId?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +It registers a decentralized identifier (aka DID) in the `DIDRegistry` smart contract + +#### Parameters + +| Name | Type | Default value | Description | +| :------------- | :---------------------------------------------- | :--------------------------------- | :------------------------------------------------------------------------------------ | +| `did` | `string` | `undefined` | The unique identifier of the asset | +| `checksum` | `string` | `undefined` | Checksum resulted of hash the asset metadata | +| `providers` | `string`[] | `undefined` | List of addresses in charge of interact with the asset | +| `ownerAddress` | `string` | `undefined` | Address of the user registering the DID | +| `url` | `string` | `undefined` | URL to the metadata in the Metadata/Marketplace API | +| `immutableUrl` | `string` | `''` | Hash or URL to the metadata stored in a immutable data store like IPFS, Filecoin, etc | +| `activityId` | `string` | `DEFAULT_REGISTRATION_ACTIVITY_ID` | Provenance identifier about the asset registration action | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Transaction additional parameters | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +Contract Receipt + +#### Defined in + +[src/keeper/contracts/DIDRegistry.ts:62](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/DIDRegistry.ts#L62) + +--- + +### registerMintableDID + +▸ **registerMintableDID**(`did`, `nftContractAddress`, `checksum`, `providers`, `ownerAddress`, `nftAttributes`, `url`, `immutableUrl?`, `activityId?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +It registers a decentralized identifier (aka DID) in the `DIDRegistry` smart contract with a ERC-1155 NFT attached to it + +#### Parameters + +| Name | Type | Default value | Description | +| :------------------- | :---------------------------------------------- | :--------------------------------- | :------------------------------------------------------------------------------------ | +| `did` | `string` | `undefined` | The unique identifier of the asset | +| `nftContractAddress` | `string` | `undefined` | - | +| `checksum` | `string` | `undefined` | Checksum resulted of hash the asset metadata | +| `providers` | `string`[] | `undefined` | List of addresses in charge of interact with the asset | +| `ownerAddress` | `string` | `undefined` | Address of the user registering the DID | +| `nftAttributes` | [`NFTAttributes`](NFTAttributes.md) | `undefined` | Attributes of the NFT associated to the NFT | +| `url` | `string` | `undefined` | URL to the metadata in the Metadata/Marketplace API | +| `immutableUrl` | `string` | `''` | Hash or URL to the metadata stored in a immutable data store like IPFS, Filecoin, etc | +| `activityId` | `string` | `DEFAULT_REGISTRATION_ACTIVITY_ID` | Provenance identifier about the asset registration action | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Transaction additional parameters | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +Contract Receipt + +#### Defined in + +[src/keeper/contracts/DIDRegistry.ts:94](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/DIDRegistry.ts#L94) + +--- + +### registerMintableDID721 + +▸ **registerMintableDID721**(`did`, `nftContractAddress`, `checksum`, `providers`, `ownerAddress`, `nftAttributes`, `url`, `immutableUrl?`, `activityId?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +It registers a decentralized identifier (aka DID) in the `DIDRegistry` smart contract with a ERC-721 NFT attached to it + +#### Parameters + +| Name | Type | Default value | Description | +| :------------------- | :---------------------------------------------- | :--------------------------------- | :------------------------------------------------------------------------------------ | +| `did` | `string` | `undefined` | The unique identifier of the asset | +| `nftContractAddress` | `string` | `undefined` | - | +| `checksum` | `string` | `undefined` | Checksum resulted of hash the asset metadata | +| `providers` | `string`[] | `undefined` | List of addresses in charge of interact with the asset | +| `ownerAddress` | `string` | `undefined` | Address of the user registering the DID | +| `nftAttributes` | [`NFTAttributes`](NFTAttributes.md) | `undefined` | Attributes of the NFT associated to the NFT | +| `url` | `string` | `undefined` | URL to the metadata in the Metadata/Marketplace API | +| `immutableUrl` | `string` | `''` | Hash or URL to the metadata stored in a immutable data store like IPFS, Filecoin, etc | +| `activityId` | `string` | `DEFAULT_REGISTRATION_ACTIVITY_ID` | Provenance identifier about the asset registration action | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Transaction additional parameters | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +Contract Receipt + +#### Defined in + +[src/keeper/contracts/DIDRegistry.ts:142](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/DIDRegistry.ts#L142) + +--- + +### removeDidProvenanceDelegate + +▸ **removeDidProvenanceDelegate**(`did`, `delegateAddress`, `ownerAddress`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :---------------- | :---------------------------------------------- | +| `did` | `string` | +| `delegateAddress` | `string` | +| `ownerAddress` | `string` | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Defined in + +[src/keeper/contracts/DIDRegistry.ts:574](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/DIDRegistry.ts#L574) + +--- + +### removeProvider + +▸ **removeProvider**(`did`, `provider`, `from`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :--------- | :---------------------------------------------- | +| `did` | `string` | +| `provider` | `string` | +| `from` | `string` | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Defined in + +[src/keeper/contracts/DIDRegistry.ts:608](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/DIDRegistry.ts#L608) + +--- + +### revokePermission + +▸ **revokePermission**(`did`, `grantee`, `ownerAddress`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `did` | `string` | +| `grantee` | `string` | +| `ownerAddress` | `string` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Defined in + +[src/keeper/contracts/DIDRegistry.ts:333](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/DIDRegistry.ts#L333) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ContractBase](ContractBase.md).[send](ContractBase.md#send) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ContractBase](ContractBase.md).[sendFrom](ContractBase.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### setDIDRoyalties + +▸ **setDIDRoyalties**(`did`, `scheme`, `ownerAddress`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `did` | `string` | +| `scheme` | `string` | +| `ownerAddress` | `string` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Defined in + +[src/keeper/contracts/DIDRegistry.ts:342](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/DIDRegistry.ts#L342) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ContractBase](ContractBase.md).[setInstanceConfig](ContractBase.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### transferDIDOwnership + +▸ **transferDIDOwnership**(`did`, `newOwnerAddress`, `ownerAddress`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :---------------- | :---------------------------------------------- | +| `did` | `string` | +| `newOwnerAddress` | `string` | +| `ownerAddress` | `string` | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Defined in + +[src/keeper/contracts/DIDRegistry.ts:359](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/DIDRegistry.ts#L359) + +--- + +### updateMetadataUrl + +▸ **updateMetadataUrl**(`did`, `checksum`, `ownerAddress`, `url`, `immutableUrl?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +It registers a decentralized identifier (aka DID) in the `DIDRegistry` smart contract with a ERC-721 NFT attached to it + +#### Parameters + +| Name | Type | Default value | Description | +| :------------- | :---------------------------------------------- | :------------ | :------------------------------------------------------------------------------------ | +| `did` | `string` | `undefined` | The unique identifier of the asset | +| `checksum` | `string` | `undefined` | Checksum resulted of hash the asset metadata | +| `ownerAddress` | `string` | `undefined` | Address of the user registering the DID | +| `url` | `string` | `undefined` | URL to the metadata in the Metadata/Marketplace API | +| `immutableUrl` | `string` | `''` | Hash or URL to the metadata stored in a immutable data store like IPFS, Filecoin, etc | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Transaction additional parameters | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +Contract Receipt + +#### Defined in + +[src/keeper/contracts/DIDRegistry.ts:185](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/DIDRegistry.ts#L185) + +--- + +### used + +▸ **used**(`provId`, `did`, `agentId`, `activityId`, `signatureUsing`, `attributes`, `ownerAddress`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :--------------- | :---------------------------------------------- | +| `provId` | `string` | +| `did` | `string` | +| `agentId` | `string` | +| `activityId` | `string` | +| `signatureUsing` | `string` | +| `attributes` | `string` | +| `ownerAddress` | `string` | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Defined in + +[src/keeper/contracts/DIDRegistry.ts:466](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/DIDRegistry.ts#L466) + +--- + +### wasAssociatedWith + +▸ **wasAssociatedWith**(`provId`, `did`, `agentId`, `activityId`, `attributes`, `ownerAddress`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `provId` | `string` | +| `did` | `string` | +| `agentId` | `string` | +| `activityId` | `string` | +| `attributes` | `string` | +| `ownerAddress` | `string` | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Defined in + +[src/keeper/contracts/DIDRegistry.ts:516](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/DIDRegistry.ts#L516) + +--- + +### wasDerivedFrom + +▸ **wasDerivedFrom**(`provId`, `newEntityDid`, `usedEntityDid`, `agentId`, `activityId`, `attributes`, `ownerAddress`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :-------------- | :---------------------------------------------- | +| `provId` | `string` | +| `newEntityDid` | `string` | +| `usedEntityDid` | `string` | +| `agentId` | `string` | +| `activityId` | `string` | +| `attributes` | `string` | +| `ownerAddress` | `string` | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Defined in + +[src/keeper/contracts/DIDRegistry.ts:491](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/DIDRegistry.ts#L491) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`): `Promise`<[`DIDRegistry`](DIDRegistry.md)\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`Promise`<[`DIDRegistry`](DIDRegistry.md)\> + +#### Overrides + +[ContractBase](ContractBase.md).[getInstance](ContractBase.md#getinstance) + +#### Defined in + +[src/keeper/contracts/DIDRegistry.ts:16](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/DIDRegistry.ts#L16) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ContractBase](ContractBase.md).[setInstanceConfig](ContractBase.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/DIDSalesTemplate.md b/docs/api-reference/classes/DIDSalesTemplate.md new file mode 100644 index 000000000..590427462 --- /dev/null +++ b/docs/api-reference/classes/DIDSalesTemplate.md @@ -0,0 +1,1438 @@ +[@nevermined-io/sdk](../code-reference.md) / DIDSalesTemplate + +# Class: DIDSalesTemplate + +## Hierarchy + +- [`BaseTemplate`](BaseTemplate.md)<`DIDSalesTemplateParams`, `any`\> + + ↳ **`DIDSalesTemplate`** + +## Table of contents + +### Constructors + +- [constructor](DIDSalesTemplate.md#constructor) + +### Properties + +- [address](DIDSalesTemplate.md#address) +- [contract](DIDSalesTemplate.md#contract) +- [contractName](DIDSalesTemplate.md#contractname) +- [events](DIDSalesTemplate.md#events) +- [version](DIDSalesTemplate.md#version) + +### Accessors + +- [artifactsFolder](DIDSalesTemplate.md#artifactsfolder) +- [circuitsFolder](DIDSalesTemplate.md#circuitsfolder) +- [config](DIDSalesTemplate.md#config) +- [instanceConfig](DIDSalesTemplate.md#instanceconfig) +- [instantiableConfig](DIDSalesTemplate.md#instantiableconfig) +- [logger](DIDSalesTemplate.md#logger) +- [nevermined](DIDSalesTemplate.md#nevermined) +- [web3](DIDSalesTemplate.md#web3) + +### Methods + +- [accept](DIDSalesTemplate.md#accept) +- [agreementId](DIDSalesTemplate.md#agreementid) +- [call](DIDSalesTemplate.md#call) +- [conditions](DIDSalesTemplate.md#conditions) +- [createAgreement](DIDSalesTemplate.md#createagreement) +- [createAgreementAndPay](DIDSalesTemplate.md#createagreementandpay) +- [createAgreementFromDDO](DIDSalesTemplate.md#createagreementfromddo) +- [createAgreementWithPaymentFromDDO](DIDSalesTemplate.md#createagreementwithpaymentfromddo) +- [createService](DIDSalesTemplate.md#createservice) +- [description](DIDSalesTemplate.md#description) +- [extraGen](DIDSalesTemplate.md#extragen) +- [getAgreementCreatedEvent](DIDSalesTemplate.md#getagreementcreatedevent) +- [getAgreementData](DIDSalesTemplate.md#getagreementdata) +- [getAgreementIdsFromDDO](DIDSalesTemplate.md#getagreementidsfromddo) +- [getAgreementStatus](DIDSalesTemplate.md#getagreementstatus) +- [getAgreementsForDID](DIDSalesTemplate.md#getagreementsfordid) +- [getConditionTypes](DIDSalesTemplate.md#getconditiontypes) +- [getConditions](DIDSalesTemplate.md#getconditions) +- [getFromAddress](DIDSalesTemplate.md#getfromaddress) +- [getInputsOfMethod](DIDSalesTemplate.md#getinputsofmethod) +- [getServiceAgreementTemplate](DIDSalesTemplate.md#getserviceagreementtemplate) +- [getServiceAgreementTemplateConditionByRef](DIDSalesTemplate.md#getserviceagreementtemplateconditionbyref) +- [getServiceAgreementTemplateConditions](DIDSalesTemplate.md#getserviceagreementtemplateconditions) +- [getServiceAgreementTemplateDependencies](DIDSalesTemplate.md#getserviceagreementtemplatedependencies) +- [getSignatureOfMethod](DIDSalesTemplate.md#getsignatureofmethod) +- [init](DIDSalesTemplate.md#init) +- [instanceFromDDO](DIDSalesTemplate.md#instancefromddo) +- [lockConditionIndex](DIDSalesTemplate.md#lockconditionindex) +- [lockTokens](DIDSalesTemplate.md#locktokens) +- [name](DIDSalesTemplate.md#name) +- [params](DIDSalesTemplate.md#params) +- [paramsGen](DIDSalesTemplate.md#paramsgen) +- [paymentData](DIDSalesTemplate.md#paymentdata) +- [printAgreementStatus](DIDSalesTemplate.md#printagreementstatus) +- [process](DIDSalesTemplate.md#process) +- [send](DIDSalesTemplate.md#send) +- [sendFrom](DIDSalesTemplate.md#sendfrom) +- [service](DIDSalesTemplate.md#service) +- [serviceEndpoint](DIDSalesTemplate.md#serviceendpoint) +- [setInstanceConfig](DIDSalesTemplate.md#setinstanceconfig) +- [standardContext](DIDSalesTemplate.md#standardcontext) +- [track](DIDSalesTemplate.md#track) +- [validateAgreement](DIDSalesTemplate.md#validateagreement) +- [getInstance](DIDSalesTemplate.md#getinstance) +- [setInstanceConfig](DIDSalesTemplate.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• `Protected` **new DIDSalesTemplate**(`contractName`) + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[constructor](BaseTemplate.md#constructor) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:68](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L68) + +## Properties + +### address + +• **address**: `string` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[address](BaseTemplate.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[contract](BaseTemplate.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[contractName](BaseTemplate.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[events](BaseTemplate.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[version](BaseTemplate.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +BaseTemplate.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +BaseTemplate.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +BaseTemplate.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +BaseTemplate.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +BaseTemplate.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +BaseTemplate.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +BaseTemplate.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +BaseTemplate.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### accept + +▸ **accept**(`_params`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :-------- | :------------------------------------------------------ | +| `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | + +#### Returns + +`Promise`<`boolean`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[accept](BaseTemplate.md#accept) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:98](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L98) + +--- + +### agreementId + +▸ **agreementId**(`agreementIdSeed`, `creator`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :---------------- | :------- | +| `agreementIdSeed` | `string` | +| `creator` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[agreementId](BaseTemplate.md#agreementid) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:213](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L213) + +--- + +### 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 + +[BaseTemplate](BaseTemplate.md).[call](BaseTemplate.md#call) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### conditions + +▸ **conditions**(): [[`LockPaymentCondition`](LockPaymentCondition.md), [`TransferDIDOwnershipCondition`](TransferDIDOwnershipCondition.md), [`EscrowPaymentCondition`](EscrowPaymentCondition.md)] + +#### Returns + +[[`LockPaymentCondition`](LockPaymentCondition.md), [`TransferDIDOwnershipCondition`](TransferDIDOwnershipCondition.md), [`EscrowPaymentCondition`](EscrowPaymentCondition.md)] + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[conditions](BaseTemplate.md#conditions) + +#### Defined in + +[src/keeper/contracts/templates/DIDSalesTemplate.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/DIDSalesTemplate.ts#L32) + +--- + +### createAgreement + +▸ **createAgreement**(`agreementId`, `did`, `conditionIds`, `timeLocks`, `timeOuts`, `extraArgs`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `agreementId` | `string` | +| `did` | `string` | +| `conditionIds` | `string`[] | +| `timeLocks` | `number`[] | +| `timeOuts` | `number`[] | +| `extraArgs` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[createAgreement](BaseTemplate.md#createagreement) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L90) + +--- + +### createAgreementAndPay + +▸ **createAgreementAndPay**(`agreementId`, `did`, `conditionIds`, `timeLocks`, `timeOuts`, `accessConsumer`, `condIdx`, `rewardAddress`, `tokenAddress`, `amounts`, `receivers`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :--------------- | :---------------------------------------------- | +| `agreementId` | `string` | +| `did` | `string` | +| `conditionIds` | `string`[] | +| `timeLocks` | `number`[] | +| `timeOuts` | `number`[] | +| `accessConsumer` | `string` | +| `condIdx` | `number` | +| `rewardAddress` | `string` | +| `tokenAddress` | `string` | +| `amounts` | `bigint`[] | +| `receivers` | `string`[] | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[createAgreementAndPay](BaseTemplate.md#createagreementandpay) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L115) + +--- + +### createAgreementFromDDO + +▸ **createAgreementFromDDO**(`agreementIdSeed`, `ddo`, `parameters`, `consumer`, `from`, `timeOuts?`, `txParams?`): `Promise`<`string`\> + +Create a new agreement using the data of a DDO. + +#### Parameters + +| Name | Type | Description | +| :---------------- | :---------------------------------------------- | :---------- | +| `agreementIdSeed` | `string` | - | +| `ddo` | [`DDO`](DDO.md) | DDO. | +| `parameters` | `DIDSalesTemplateParams` | | +| `consumer` | [`Account`](Account.md) | - | +| `from` | [`Account`](Account.md) | - | +| `timeOuts?` | `number`[] | - | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | + +#### Returns + +`Promise`<`string`\> + +true if the call was successful. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[createAgreementFromDDO](BaseTemplate.md#createagreementfromddo) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:222](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L222) + +--- + +### createAgreementWithPaymentFromDDO + +▸ **createAgreementWithPaymentFromDDO**(`agreementIdSeed`, `ddo`, `serviceReference`, `parameters`, `consumer`, `from`, `txParams?`, `observer?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :----------------- | :------------------------------------------------------------------------------------ | +| `agreementIdSeed` | `string` | +| `ddo` | [`DDO`](DDO.md) | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | +| `parameters` | `DIDSalesTemplateParams` | +| `consumer` | [`Account`](Account.md) | +| `from` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| `observer?` | (`orderProgressStep`: [`OrderProgressStep`](../enums/OrderProgressStep.md)) => `void` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[createAgreementWithPaymentFromDDO](BaseTemplate.md#createagreementwithpaymentfromddo) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:252](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L252) + +--- + +### createService + +▸ **createService**(`publisher`, `metadata`, `serviceAttributes`, `nftAttributes?`, `priceData?`): `any` + +#### Parameters + +| Name | Type | +| :------------------ | :---------------------------------------------------------------------------- | +| `publisher` | [`Account`](Account.md) | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | +| `serviceAttributes` | [`ServiceAttributes`](../interfaces/ServiceAttributes.md) | +| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | +| `priceData?` | [`PricedMetadataInformation`](../code-reference.md#pricedmetadatainformation) | + +#### Returns + +`any` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[createService](BaseTemplate.md#createservice) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L35) + +--- + +### description + +▸ **description**(): `string` + +#### Returns + +`string` + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[description](BaseTemplate.md#description) + +#### Defined in + +[src/keeper/contracts/templates/DIDSalesTemplate.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/DIDSalesTemplate.ts#L28) + +--- + +### extraGen + +▸ **extraGen**(`_params`): `Promise`<`any`\> + +#### Parameters + +| Name | Type | +| :-------- | :------------------------------------------------------ | +| `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | + +#### Returns + +`Promise`<`any`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[extraGen](BaseTemplate.md#extragen) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:94](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L94) + +--- + +### 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. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getAgreementCreatedEvent](BaseTemplate.md#getagreementcreatedevent) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:459](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L459) + +--- + +### getAgreementData + +▸ **getAgreementData**(`agreementId`): `Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | + +#### Returns + +`Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getAgreementData](BaseTemplate.md#getagreementdata) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:21](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L21) + +--- + +### getAgreementIdsFromDDO + +▸ **getAgreementIdsFromDDO**(`agreementId`, `ddo`, `creator`, `params`): `Promise`<`string`[]\> + +Get agreement conditions IDs. + +#### Parameters + +| Name | Type | Description | +| :------------ | :----------------------- | :------------ | +| `agreementId` | `string` | Agreement ID. | +| `ddo` | [`DDO`](DDO.md) | DDO. | +| `creator` | `string` | - | +| `params` | `DIDSalesTemplateParams` | - | + +#### Returns + +`Promise`<`string`[]\> + +The condition IDs. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getAgreementIdsFromDDO](BaseTemplate.md#getagreementidsfromddo) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:180](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L180) + +--- + +### getAgreementStatus + +▸ **getAgreementStatus**(`agreementId`): `Promise`<`false` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> + +Returns the status of the conditions. + +#### Parameters + +| Name | Type | Description | +| :------------ | :------- | :------------ | +| `agreementId` | `string` | Agreement ID. | + +#### Returns + +`Promise`<`false` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> + +The conditions status. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getAgreementStatus](BaseTemplate.md#getagreementstatus) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:346](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L346) + +--- + +### getAgreementsForDID + +▸ **getAgreementsForDID**(`did`): `Promise`<`string`[]\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `did` | `string` | + +#### Returns + +`Promise`<`string`[]\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getAgreementsForDID](BaseTemplate.md#getagreementsfordid) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:485](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L485) + +--- + +### getConditionTypes + +▸ **getConditionTypes**(): `Promise`<`string`[]\> + +Conditions address list. + +#### Returns + +`Promise`<`string`[]\> + +A list of condition addresses. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getConditionTypes](BaseTemplate.md#getconditiontypes) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L154) + +--- + +### getConditions + +▸ **getConditions**(): `Promise`<[`ConditionSmall`](ConditionSmall.md)[]\> + +List of condition contracts. + +#### Returns + +`Promise`<[`ConditionSmall`](ConditionSmall.md)[]\> + +A list of condition contracts. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getConditions](BaseTemplate.md#getconditions) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:165](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L165) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getFromAddress](BaseTemplate.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getInputsOfMethod](BaseTemplate.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getServiceAgreementTemplate + +▸ **getServiceAgreementTemplate**(): [`ServiceAgreementTemplate`](../interfaces/ServiceAgreementTemplate.md) + +#### Returns + +[`ServiceAgreementTemplate`](../interfaces/ServiceAgreementTemplate.md) + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[getServiceAgreementTemplate](BaseTemplate.md#getserviceagreementtemplate) + +#### Defined in + +[src/keeper/contracts/templates/DIDSalesTemplate.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/DIDSalesTemplate.ts#L90) + +--- + +### getServiceAgreementTemplateConditionByRef + +▸ **getServiceAgreementTemplateConditionByRef**(`ref`): `Promise`<[`ConditionSmall`](ConditionSmall.md)\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `ref` | `string` | + +#### Returns + +`Promise`<[`ConditionSmall`](ConditionSmall.md)\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getServiceAgreementTemplateConditionByRef](BaseTemplate.md#getserviceagreementtemplateconditionbyref) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:329](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L329) + +--- + +### getServiceAgreementTemplateConditions + +▸ **getServiceAgreementTemplateConditions**(): [`ServiceAgreementTemplateCondition`](../interfaces/ServiceAgreementTemplateCondition.md)[] + +#### Returns + +[`ServiceAgreementTemplateCondition`](../interfaces/ServiceAgreementTemplateCondition.md)[] + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getServiceAgreementTemplateConditions](BaseTemplate.md#getserviceagreementtemplateconditions) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:324](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L324) + +--- + +### getServiceAgreementTemplateDependencies + +▸ **getServiceAgreementTemplateDependencies**(): `Promise`<{ `[condition: string]`: `string`[]; }\> + +#### Returns + +`Promise`<{ `[condition: string]`: `string`[]; }\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getServiceAgreementTemplateDependencies](BaseTemplate.md#getserviceagreementtemplatedependencies) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:336](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L336) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getSignatureOfMethod](BaseTemplate.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[init](BaseTemplate.md#init) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### instanceFromDDO + +▸ **instanceFromDDO**(`agreementIdSeed`, `ddo`, `creator`, `parameters`): `Promise`<[`AgreementInstance`](../interfaces/AgreementInstance.md)<`DIDSalesTemplateParams`\>\> + +#### Parameters + +| Name | Type | +| :---------------- | :----------------------- | +| `agreementIdSeed` | `string` | +| `ddo` | [`DDO`](DDO.md) | +| `creator` | `string` | +| `parameters` | `DIDSalesTemplateParams` | + +#### Returns + +`Promise`<[`AgreementInstance`](../interfaces/AgreementInstance.md)<`DIDSalesTemplateParams`\>\> + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[instanceFromDDO](BaseTemplate.md#instancefromddo) + +#### Defined in + +[src/keeper/contracts/templates/DIDSalesTemplate.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/DIDSalesTemplate.ts#L42) + +--- + +### lockConditionIndex + +▸ **lockConditionIndex**(): `number` + +#### Returns + +`number` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[lockConditionIndex](BaseTemplate.md#lockconditionindex) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:74](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L74) + +--- + +### lockTokens + +▸ **lockTokens**(`tokenAddress`, `amounts`, `from`, `txParams`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `tokenAddress` | `any` | +| `amounts` | `any` | +| `from` | [`Account`](Account.md) | +| `txParams` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[lockTokens](BaseTemplate.md#locktokens) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:393](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L393) + +--- + +### name + +▸ **name**(): `string` + +#### Returns + +`string` + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[name](BaseTemplate.md#name) + +#### Defined in + +[src/keeper/contracts/templates/DIDSalesTemplate.ts:25](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/DIDSalesTemplate.ts#L25) + +--- + +### params + +▸ **params**(`receiverId`): `DIDSalesTemplateParams` + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `receiverId` | `string` | + +#### Returns + +`DIDSalesTemplateParams` + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[params](BaseTemplate.md#params) + +#### Defined in + +[src/keeper/contracts/templates/DIDSalesTemplate.ts:22](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/DIDSalesTemplate.ts#L22) + +--- + +### paramsGen + +▸ **paramsGen**(`params`): `Promise`<`DIDSalesTemplateParams`\> + +Specialize params + +#### Parameters + +| Name | Type | Description | +| :------- | :------------------------------------------------------ | :----------------- | +| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | Generic parameters | + +#### Returns + +`Promise`<`DIDSalesTemplateParams`\> + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[paramsGen](BaseTemplate.md#paramsgen) + +#### Defined in + +[src/keeper/contracts/templates/DIDSalesTemplate.ts:19](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/DIDSalesTemplate.ts#L19) + +--- + +### paymentData + +▸ **paymentData**(`service`): `Promise`<[`PaymentData`](../interfaces/PaymentData.md)\> + +#### Parameters + +| Name | Type | +| :-------- | :------------------------------------------------ | +| `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | + +#### Returns + +`Promise`<[`PaymentData`](../interfaces/PaymentData.md)\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[paymentData](BaseTemplate.md#paymentdata) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:78](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L78) + +--- + +### printAgreementStatus + +▸ **printAgreementStatus**(`agreementId`): `Promise`<`void`\> + +Prints the agreement status. + +#### Parameters + +| Name | Type | Description | +| :------------ | :------- | :------------ | +| `agreementId` | `string` | Agreement ID. | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[printAgreementStatus](BaseTemplate.md#printagreementstatus) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:429](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L429) + +--- + +### process + +▸ **process**(`params`, `from`, `txparams?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :---------- | :------------------------------------------------------ | +| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `from` | [`Account`](Account.md) | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[process](BaseTemplate.md#process) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:110](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L110) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[send](BaseTemplate.md#send) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[sendFrom](BaseTemplate.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### service + +▸ **service**(): [`ServiceType`](../code-reference.md#servicetype) + +#### Returns + +[`ServiceType`](../code-reference.md#servicetype) + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[service](BaseTemplate.md#service) + +#### Defined in + +[src/keeper/contracts/templates/DIDSalesTemplate.ts:83](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/DIDSalesTemplate.ts#L83) + +--- + +### serviceEndpoint + +▸ **serviceEndpoint**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[serviceEndpoint](BaseTemplate.md#serviceendpoint) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L31) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[setInstanceConfig](BaseTemplate.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### standardContext + +▸ **standardContext**(`ddo`, `creator`, `serviceIndex?`): [`ConditionContext`](../interfaces/ConditionContext.md) + +#### Parameters + +| Name | Type | +| :-------------- | :-------------- | +| `ddo` | [`DDO`](DDO.md) | +| `creator` | `string` | +| `serviceIndex?` | `number` | + +#### Returns + +[`ConditionContext`](../interfaces/ConditionContext.md) + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[standardContext](BaseTemplate.md#standardcontext) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:200](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L200) + +--- + +### track + +▸ **track**(`_params`, `_from`, `_txparams?`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :----------- | :------------------------------------------------------ | +| `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `_from` | [`Account`](Account.md) | +| `_txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`boolean`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[track](BaseTemplate.md#track) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:102](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L102) + +--- + +### validateAgreement + +▸ **validateAgreement**(`agreement_id`, `did`, `params`, `from`, `extra?`, `txparams?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `agreement_id` | `string` | +| `did` | `string` | +| `params` | `DIDSalesTemplateParams` | +| `from` | [`Account`](Account.md) | +| `extra` | `any` | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[validateAgreement](BaseTemplate.md#validateagreement) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:125](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L125) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`): `Promise`<[`DIDSalesTemplate`](DIDSalesTemplate.md)\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`Promise`<[`DIDSalesTemplate`](DIDSalesTemplate.md)\> + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[getInstance](BaseTemplate.md#getinstance) + +#### Defined in + +[src/keeper/contracts/templates/DIDSalesTemplate.ts:86](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/DIDSalesTemplate.ts#L86) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[setInstanceConfig](BaseTemplate.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/Dispenser.md b/docs/api-reference/classes/Dispenser.md new file mode 100644 index 000000000..deccf4c6d --- /dev/null +++ b/docs/api-reference/classes/Dispenser.md @@ -0,0 +1,567 @@ +[@nevermined-io/sdk](../code-reference.md) / Dispenser + +# Class: Dispenser + +## Hierarchy + +- [`ContractBase`](ContractBase.md) + + ↳ **`Dispenser`** + +## Table of contents + +### Constructors + +- [constructor](Dispenser.md#constructor) + +### Properties + +- [address](Dispenser.md#address) +- [contract](Dispenser.md#contract) +- [contractName](Dispenser.md#contractname) +- [events](Dispenser.md#events) +- [version](Dispenser.md#version) + +### Accessors + +- [artifactsFolder](Dispenser.md#artifactsfolder) +- [circuitsFolder](Dispenser.md#circuitsfolder) +- [config](Dispenser.md#config) +- [instanceConfig](Dispenser.md#instanceconfig) +- [instantiableConfig](Dispenser.md#instantiableconfig) +- [logger](Dispenser.md#logger) +- [nevermined](Dispenser.md#nevermined) +- [web3](Dispenser.md#web3) + +### Methods + +- [call](Dispenser.md#call) +- [getFromAddress](Dispenser.md#getfromaddress) +- [getInputsOfMethod](Dispenser.md#getinputsofmethod) +- [getSignatureOfMethod](Dispenser.md#getsignatureofmethod) +- [init](Dispenser.md#init) +- [requestTokens](Dispenser.md#requesttokens) +- [send](Dispenser.md#send) +- [sendFrom](Dispenser.md#sendfrom) +- [setInstanceConfig](Dispenser.md#setinstanceconfig) +- [getInstance](Dispenser.md#getinstance) +- [setInstanceConfig](Dispenser.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new Dispenser**(`contractName`) + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Inherited from + +[ContractBase](ContractBase.md).[constructor](ContractBase.md#constructor) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L34) + +## Properties + +### address + +• **address**: `string` + +#### Inherited from + +[ContractBase](ContractBase.md).[address](ContractBase.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[ContractBase](ContractBase.md).[contract](ContractBase.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[ContractBase](ContractBase.md).[contractName](ContractBase.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[ContractBase](ContractBase.md).[events](ContractBase.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[ContractBase](ContractBase.md).[version](ContractBase.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ContractBase.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ContractBase.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +ContractBase.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ContractBase.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ContractBase.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +ContractBase.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +ContractBase.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +ContractBase.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### 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](ContractBase.md).[call](ContractBase.md#call) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ContractBase](ContractBase.md).[getFromAddress](ContractBase.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[ContractBase](ContractBase.md).[getInputsOfMethod](ContractBase.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[ContractBase](ContractBase.md).[getSignatureOfMethod](ContractBase.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[ContractBase](ContractBase.md).[init](ContractBase.md#init) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### requestTokens + +▸ **requestTokens**(`amount`, `receiverAddress`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :---------------- | :---------------------------------------------- | +| `amount` | `string` \| `number` \| `bigint` | +| `receiverAddress` | `string` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Defined in + +[src/keeper/contracts/Dispenser.ts:11](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Dispenser.ts#L11) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ContractBase](ContractBase.md).[send](ContractBase.md#send) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ContractBase](ContractBase.md).[sendFrom](ContractBase.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ContractBase](ContractBase.md).[setInstanceConfig](ContractBase.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`): `Promise`<[`Dispenser`](Dispenser.md)\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`Promise`<[`Dispenser`](Dispenser.md)\> + +#### Overrides + +[ContractBase](ContractBase.md).[getInstance](ContractBase.md#getinstance) + +#### Defined in + +[src/keeper/contracts/Dispenser.ts:5](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Dispenser.ts#L5) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ContractBase](ContractBase.md).[setInstanceConfig](ContractBase.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/DistributeNFTCollateralCondition.md b/docs/api-reference/classes/DistributeNFTCollateralCondition.md new file mode 100644 index 000000000..4cd7ceb03 --- /dev/null +++ b/docs/api-reference/classes/DistributeNFTCollateralCondition.md @@ -0,0 +1,976 @@ +[@nevermined-io/sdk](../code-reference.md) / DistributeNFTCollateralCondition + +# Class: DistributeNFTCollateralCondition + +Condition allowing to transfer an NFT either to the original owner or a lender +depending on the loan status. + +## Hierarchy + +- [`ProviderCondition`](ProviderCondition.md)<`DistributeNFTCollateralConditionContext`\> + + ↳ **`DistributeNFTCollateralCondition`** + +## Table of contents + +### Constructors + +- [constructor](DistributeNFTCollateralCondition.md#constructor) + +### Properties + +- [address](DistributeNFTCollateralCondition.md#address) +- [contract](DistributeNFTCollateralCondition.md#contract) +- [contractName](DistributeNFTCollateralCondition.md#contractname) +- [events](DistributeNFTCollateralCondition.md#events) +- [version](DistributeNFTCollateralCondition.md#version) + +### Accessors + +- [artifactsFolder](DistributeNFTCollateralCondition.md#artifactsfolder) +- [circuitsFolder](DistributeNFTCollateralCondition.md#circuitsfolder) +- [config](DistributeNFTCollateralCondition.md#config) +- [instanceConfig](DistributeNFTCollateralCondition.md#instanceconfig) +- [instantiableConfig](DistributeNFTCollateralCondition.md#instantiableconfig) +- [logger](DistributeNFTCollateralCondition.md#logger) +- [nevermined](DistributeNFTCollateralCondition.md#nevermined) +- [web3](DistributeNFTCollateralCondition.md#web3) + +### Methods + +- [abortByTimeOut](DistributeNFTCollateralCondition.md#abortbytimeout) +- [call](DistributeNFTCollateralCondition.md#call) +- [fulfill](DistributeNFTCollateralCondition.md#fulfill) +- [fulfillInstance](DistributeNFTCollateralCondition.md#fulfillinstance) +- [fulfillPlain](DistributeNFTCollateralCondition.md#fulfillplain) +- [fulfillWithNode](DistributeNFTCollateralCondition.md#fulfillwithnode) +- [generateId](DistributeNFTCollateralCondition.md#generateid) +- [generateIdHash](DistributeNFTCollateralCondition.md#generateidhash) +- [generateIdWithSeed](DistributeNFTCollateralCondition.md#generateidwithseed) +- [getConditionFulfilledEvent](DistributeNFTCollateralCondition.md#getconditionfulfilledevent) +- [getFromAddress](DistributeNFTCollateralCondition.md#getfromaddress) +- [getInputsOfMethod](DistributeNFTCollateralCondition.md#getinputsofmethod) +- [getSignatureOfMethod](DistributeNFTCollateralCondition.md#getsignatureofmethod) +- [hashValues](DistributeNFTCollateralCondition.md#hashvalues) +- [hashValuesPlain](DistributeNFTCollateralCondition.md#hashvaluesplain) +- [init](DistributeNFTCollateralCondition.md#init) +- [instance](DistributeNFTCollateralCondition.md#instance) +- [instanceFromDDO](DistributeNFTCollateralCondition.md#instancefromddo) +- [nodeMethod](DistributeNFTCollateralCondition.md#nodemethod) +- [params](DistributeNFTCollateralCondition.md#params) +- [paramsFromDDO](DistributeNFTCollateralCondition.md#paramsfromddo) +- [send](DistributeNFTCollateralCondition.md#send) +- [sendFrom](DistributeNFTCollateralCondition.md#sendfrom) +- [setInstanceConfig](DistributeNFTCollateralCondition.md#setinstanceconfig) +- [getInstance](DistributeNFTCollateralCondition.md#getinstance) +- [setInstanceConfig](DistributeNFTCollateralCondition.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new DistributeNFTCollateralCondition**(`contractName`) + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[constructor](ProviderCondition.md#constructor) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L34) + +## Properties + +### address + +• **address**: `string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[address](ProviderCondition.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[contract](ProviderCondition.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[contractName](ProviderCondition.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[events](ProviderCondition.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[version](ProviderCondition.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ProviderCondition.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ProviderCondition.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +ProviderCondition.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ProviderCondition.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ProviderCondition.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +ProviderCondition.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +ProviderCondition.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +ProviderCondition.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### abortByTimeOut + +▸ **abortByTimeOut**(`conditionId`, `from?`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------------ | :---------------------------------------------- | +| `conditionId` | `string` | +| `from?` | [`Account`](Account.md) | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[abortByTimeOut](ProviderCondition.md#abortbytimeout) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L88) + +--- + +### 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 + +[ProviderCondition](ProviderCondition.md).[call](ProviderCondition.md#call) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### fulfill + +▸ **fulfill**(`agreementId`, `did`, `vaultAddress`, `nftContractAddress`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +Fulfill the distribute NFT collateral condition. +Only the borrower or the lender can call this method. + +#### Parameters + +| Name | Type | Description | +| :------------------- | :---------------------------------------------- | :--------------------------------------------------------- | +| `agreementId` | `string` | The agreement identifier. | +| `did` | `string` | The DID of the asset with NFTs. | +| `vaultAddress` | `string` | The address of the vault contract where the NFT is locked. | +| `nftContractAddress` | `string` | The address of the NFT721 contract | +| `from?` | [`Account`](Account.md) | | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +Condition state. + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[fulfill](ProviderCondition.md#fulfill) + +#### Defined in + +[src/keeper/contracts/defi/DistributeNFT721CollateralCondition.ts:58](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/DistributeNFT721CollateralCondition.ts#L58) + +--- + +### fulfillInstance + +▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `txParams?`, `method?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | Default value | +| :----------------- | :----------------------------------------------------------------------------------------- | :------------ | +| `cond` | [`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | +| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | +| `from?` | [`Account`](Account.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[fulfillInstance](ProviderCondition.md#fulfillinstance) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:150](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L150) + +--- + +### fulfillPlain + +▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `txParams?`, `method?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | Default value | +| :------------ | :-------------------------------------------------------- | :------------ | +| `agreementId` | `string` | `undefined` | +| `args` | `any`[] | `undefined` | +| `from?` | [`Account`](Account.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[fulfillPlain](ProviderCondition.md#fulfillplain) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L63) + +--- + +### fulfillWithNode + +▸ **fulfillWithNode**(`cond`, `additionalParams`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :----------------- | :----------------------------------------------------------------------------------------- | +| `cond` | [`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | +| `additionalParams` | `Record`<`string`, `unknown`\> | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[fulfillWithNode](ProviderCondition.md#fulfillwithnode) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:194](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L194) + +--- + +### generateId + +▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `valueHash` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[generateId](ProviderCondition.md#generateid) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L77) + +--- + +### generateIdHash + +▸ **generateIdHash**(`agreementId`, `...values`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `...values` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[generateIdHash](ProviderCondition.md#generateidhash) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L73) + +--- + +### generateIdWithSeed + +▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `valueHash` | `string` | + +#### Returns + +`Promise`<[`string`, `string`]\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[generateIdWithSeed](ProviderCondition.md#generateidwithseed) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L81) + +--- + +### getConditionFulfilledEvent + +▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../code-reference.md#eventresult) + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | + +#### Returns + +[`EventResult`](../code-reference.md#eventresult) + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getConditionFulfilledEvent](ProviderCondition.md#getconditionfulfilledevent) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L92) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getFromAddress](ProviderCondition.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getInputsOfMethod](ProviderCondition.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getSignatureOfMethod](ProviderCondition.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### hashValues + +▸ **hashValues**(`...args`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[hashValues](ProviderCondition.md#hashvalues) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L129) + +--- + +### hashValuesPlain + +▸ **hashValuesPlain**(`...args`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[hashValuesPlain](ProviderCondition.md#hashvaluesplain) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:133](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L133) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[init](ProviderCondition.md#init) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### instance + +▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :------------ | :--------------------------------------------------------------------------------------------- | +| `agreementId` | `string` | +| `params` | [`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | + +#### Returns + +`Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[instance](ProviderCondition.md#instance) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:174](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L174) + +--- + +### instanceFromDDO + +▸ **instanceFromDDO**(`agreementId`, `ctx`, `...args`): `Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------------------------------------------- | +| `agreementId` | `string` | +| `ctx` | `DistributeNFTCollateralConditionContext` | +| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | + +#### Returns + +`Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[instanceFromDDO](ProviderCondition.md#instancefromddo) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L142) + +--- + +### nodeMethod + +▸ **nodeMethod**(): [`ConditionMethod`](../code-reference.md#conditionmethod) + +#### Returns + +[`ConditionMethod`](../code-reference.md#conditionmethod) + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[nodeMethod](ProviderCondition.md#nodemethod) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:208](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L208) + +--- + +### params + +▸ **params**(`did`, `vaultAddress`, `nftContractAddress`): [`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> + +Generates the ash of condition inputs. + +#### Parameters + +| Name | Type | Description | +| :------------------- | :------- | :--------------------------------------------------------- | +| `did` | `string` | The DID of the asset with NFTs. | +| `vaultAddress` | `string` | The address of the vault contract where the NFT is locked. | +| `nftContractAddress` | `string` | The address of the NFT721 contract | + +#### Returns + +[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> + +Hash of all the values + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[params](ProviderCondition.md#params) + +#### Defined in + +[src/keeper/contracts/defi/DistributeNFT721CollateralCondition.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/DistributeNFT721CollateralCondition.ts#L35) + +--- + +### paramsFromDDO + +▸ **paramsFromDDO**(`«destructured»`): `Promise`<[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :--------------- | :---------------------------------------- | +| `«destructured»` | `DistributeNFTCollateralConditionContext` | + +#### Returns + +`Promise`<[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[paramsFromDDO](ProviderCondition.md#paramsfromddo) + +#### Defined in + +[src/keeper/contracts/defi/DistributeNFT721CollateralCondition.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/DistributeNFT721CollateralCondition.ts#L39) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[send](ProviderCondition.md#send) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[sendFrom](ProviderCondition.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[setInstanceConfig](ProviderCondition.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`): `Promise`<[`DistributeNFTCollateralCondition`](DistributeNFTCollateralCondition.md)\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`Promise`<[`DistributeNFTCollateralCondition`](DistributeNFTCollateralCondition.md)\> + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[getInstance](ProviderCondition.md#getinstance) + +#### Defined in + +[src/keeper/contracts/defi/DistributeNFT721CollateralCondition.ts:17](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/DistributeNFT721CollateralCondition.ts#L17) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[setInstanceConfig](ProviderCondition.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/EscrowComputeExecutionTemplate.md b/docs/api-reference/classes/EscrowComputeExecutionTemplate.md new file mode 100644 index 000000000..1b845d9e5 --- /dev/null +++ b/docs/api-reference/classes/EscrowComputeExecutionTemplate.md @@ -0,0 +1,1461 @@ +[@nevermined-io/sdk](../code-reference.md) / EscrowComputeExecutionTemplate + +# Class: EscrowComputeExecutionTemplate + +## Hierarchy + +- [`BaseTemplate`](BaseTemplate.md)<`EscrowComputeExecutionParams`, [`ServiceCompute`](../interfaces/ServiceCompute.md)\> + + ↳ **`EscrowComputeExecutionTemplate`** + +## Table of contents + +### Constructors + +- [constructor](EscrowComputeExecutionTemplate.md#constructor) + +### Properties + +- [address](EscrowComputeExecutionTemplate.md#address) +- [contract](EscrowComputeExecutionTemplate.md#contract) +- [contractName](EscrowComputeExecutionTemplate.md#contractname) +- [events](EscrowComputeExecutionTemplate.md#events) +- [version](EscrowComputeExecutionTemplate.md#version) + +### Accessors + +- [artifactsFolder](EscrowComputeExecutionTemplate.md#artifactsfolder) +- [circuitsFolder](EscrowComputeExecutionTemplate.md#circuitsfolder) +- [config](EscrowComputeExecutionTemplate.md#config) +- [instanceConfig](EscrowComputeExecutionTemplate.md#instanceconfig) +- [instantiableConfig](EscrowComputeExecutionTemplate.md#instantiableconfig) +- [logger](EscrowComputeExecutionTemplate.md#logger) +- [nevermined](EscrowComputeExecutionTemplate.md#nevermined) +- [web3](EscrowComputeExecutionTemplate.md#web3) + +### Methods + +- [accept](EscrowComputeExecutionTemplate.md#accept) +- [agreementId](EscrowComputeExecutionTemplate.md#agreementid) +- [call](EscrowComputeExecutionTemplate.md#call) +- [conditions](EscrowComputeExecutionTemplate.md#conditions) +- [createAgreement](EscrowComputeExecutionTemplate.md#createagreement) +- [createAgreementAndPay](EscrowComputeExecutionTemplate.md#createagreementandpay) +- [createAgreementFromDDO](EscrowComputeExecutionTemplate.md#createagreementfromddo) +- [createAgreementWithPaymentFromDDO](EscrowComputeExecutionTemplate.md#createagreementwithpaymentfromddo) +- [createService](EscrowComputeExecutionTemplate.md#createservice) +- [description](EscrowComputeExecutionTemplate.md#description) +- [extraGen](EscrowComputeExecutionTemplate.md#extragen) +- [getAgreementCreatedEvent](EscrowComputeExecutionTemplate.md#getagreementcreatedevent) +- [getAgreementData](EscrowComputeExecutionTemplate.md#getagreementdata) +- [getAgreementIdsFromDDO](EscrowComputeExecutionTemplate.md#getagreementidsfromddo) +- [getAgreementStatus](EscrowComputeExecutionTemplate.md#getagreementstatus) +- [getAgreementsForDID](EscrowComputeExecutionTemplate.md#getagreementsfordid) +- [getConditionTypes](EscrowComputeExecutionTemplate.md#getconditiontypes) +- [getConditions](EscrowComputeExecutionTemplate.md#getconditions) +- [getFromAddress](EscrowComputeExecutionTemplate.md#getfromaddress) +- [getInputsOfMethod](EscrowComputeExecutionTemplate.md#getinputsofmethod) +- [getServiceAgreementTemplate](EscrowComputeExecutionTemplate.md#getserviceagreementtemplate) +- [getServiceAgreementTemplateConditionByRef](EscrowComputeExecutionTemplate.md#getserviceagreementtemplateconditionbyref) +- [getServiceAgreementTemplateConditions](EscrowComputeExecutionTemplate.md#getserviceagreementtemplateconditions) +- [getServiceAgreementTemplateDependencies](EscrowComputeExecutionTemplate.md#getserviceagreementtemplatedependencies) +- [getSignatureOfMethod](EscrowComputeExecutionTemplate.md#getsignatureofmethod) +- [init](EscrowComputeExecutionTemplate.md#init) +- [instanceFromDDO](EscrowComputeExecutionTemplate.md#instancefromddo) +- [lockConditionIndex](EscrowComputeExecutionTemplate.md#lockconditionindex) +- [lockTokens](EscrowComputeExecutionTemplate.md#locktokens) +- [name](EscrowComputeExecutionTemplate.md#name) +- [params](EscrowComputeExecutionTemplate.md#params) +- [paramsGen](EscrowComputeExecutionTemplate.md#paramsgen) +- [paymentData](EscrowComputeExecutionTemplate.md#paymentdata) +- [printAgreementStatus](EscrowComputeExecutionTemplate.md#printagreementstatus) +- [process](EscrowComputeExecutionTemplate.md#process) +- [providerConfig](EscrowComputeExecutionTemplate.md#providerconfig) +- [send](EscrowComputeExecutionTemplate.md#send) +- [sendFrom](EscrowComputeExecutionTemplate.md#sendfrom) +- [service](EscrowComputeExecutionTemplate.md#service) +- [serviceEndpoint](EscrowComputeExecutionTemplate.md#serviceendpoint) +- [setInstanceConfig](EscrowComputeExecutionTemplate.md#setinstanceconfig) +- [standardContext](EscrowComputeExecutionTemplate.md#standardcontext) +- [track](EscrowComputeExecutionTemplate.md#track) +- [validateAgreement](EscrowComputeExecutionTemplate.md#validateagreement) +- [getInstance](EscrowComputeExecutionTemplate.md#getinstance) +- [setInstanceConfig](EscrowComputeExecutionTemplate.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• `Protected` **new EscrowComputeExecutionTemplate**(`contractName`) + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[constructor](BaseTemplate.md#constructor) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:68](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L68) + +## Properties + +### address + +• **address**: `string` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[address](BaseTemplate.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[contract](BaseTemplate.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[contractName](BaseTemplate.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[events](BaseTemplate.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[version](BaseTemplate.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +BaseTemplate.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +BaseTemplate.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +BaseTemplate.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +BaseTemplate.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +BaseTemplate.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +BaseTemplate.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +BaseTemplate.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +BaseTemplate.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### accept + +▸ **accept**(`_params`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :-------- | :------------------------------------------------------ | +| `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | + +#### Returns + +`Promise`<`boolean`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[accept](BaseTemplate.md#accept) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:98](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L98) + +--- + +### agreementId + +▸ **agreementId**(`agreementIdSeed`, `creator`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :---------------- | :------- | +| `agreementIdSeed` | `string` | +| `creator` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[agreementId](BaseTemplate.md#agreementid) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:213](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L213) + +--- + +### 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 + +[BaseTemplate](BaseTemplate.md).[call](BaseTemplate.md#call) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### conditions + +▸ **conditions**(): [[`ComputeExecutionCondition`](ComputeExecutionCondition.md), [`LockPaymentCondition`](LockPaymentCondition.md), [`EscrowPaymentCondition`](EscrowPaymentCondition.md)] + +#### Returns + +[[`ComputeExecutionCondition`](ComputeExecutionCondition.md), [`LockPaymentCondition`](LockPaymentCondition.md), [`EscrowPaymentCondition`](EscrowPaymentCondition.md)] + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[conditions](BaseTemplate.md#conditions) + +#### Defined in + +[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:102](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L102) + +--- + +### createAgreement + +▸ **createAgreement**(`agreementId`, `did`, `conditionIds`, `timeLocks`, `timeOuts`, `extraArgs`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `agreementId` | `string` | +| `did` | `string` | +| `conditionIds` | `string`[] | +| `timeLocks` | `number`[] | +| `timeOuts` | `number`[] | +| `extraArgs` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[createAgreement](BaseTemplate.md#createagreement) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L90) + +--- + +### createAgreementAndPay + +▸ **createAgreementAndPay**(`agreementId`, `did`, `conditionIds`, `timeLocks`, `timeOuts`, `accessConsumer`, `condIdx`, `rewardAddress`, `tokenAddress`, `amounts`, `receivers`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :--------------- | :---------------------------------------------- | +| `agreementId` | `string` | +| `did` | `string` | +| `conditionIds` | `string`[] | +| `timeLocks` | `number`[] | +| `timeOuts` | `number`[] | +| `accessConsumer` | `string` | +| `condIdx` | `number` | +| `rewardAddress` | `string` | +| `tokenAddress` | `string` | +| `amounts` | `bigint`[] | +| `receivers` | `string`[] | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[createAgreementAndPay](BaseTemplate.md#createagreementandpay) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L115) + +--- + +### createAgreementFromDDO + +▸ **createAgreementFromDDO**(`agreementIdSeed`, `ddo`, `parameters`, `consumer`, `from`, `timeOuts?`, `txParams?`): `Promise`<`string`\> + +Create a new agreement using the data of a DDO. + +#### Parameters + +| Name | Type | Description | +| :---------------- | :---------------------------------------------- | :---------- | +| `agreementIdSeed` | `string` | - | +| `ddo` | [`DDO`](DDO.md) | DDO. | +| `parameters` | `EscrowComputeExecutionParams` | | +| `consumer` | [`Account`](Account.md) | - | +| `from` | [`Account`](Account.md) | - | +| `timeOuts?` | `number`[] | - | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | + +#### Returns + +`Promise`<`string`\> + +true if the call was successful. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[createAgreementFromDDO](BaseTemplate.md#createagreementfromddo) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:222](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L222) + +--- + +### createAgreementWithPaymentFromDDO + +▸ **createAgreementWithPaymentFromDDO**(`agreementIdSeed`, `ddo`, `serviceReference`, `parameters`, `consumer`, `from`, `txParams?`, `observer?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :----------------- | :------------------------------------------------------------------------------------ | +| `agreementIdSeed` | `string` | +| `ddo` | [`DDO`](DDO.md) | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | +| `parameters` | `EscrowComputeExecutionParams` | +| `consumer` | [`Account`](Account.md) | +| `from` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| `observer?` | (`orderProgressStep`: [`OrderProgressStep`](../enums/OrderProgressStep.md)) => `void` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[createAgreementWithPaymentFromDDO](BaseTemplate.md#createagreementwithpaymentfromddo) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:252](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L252) + +--- + +### createService + +▸ **createService**(`publisher`, `metadata`, `serviceAttributes`, `nftAttributes?`, `priceData?`): [`ServiceCompute`](../interfaces/ServiceCompute.md) + +#### Parameters + +| Name | Type | +| :------------------ | :---------------------------------------------------------------------------- | +| `publisher` | [`Account`](Account.md) | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | +| `serviceAttributes` | [`ServiceAttributes`](../interfaces/ServiceAttributes.md) | +| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | +| `priceData?` | [`PricedMetadataInformation`](../code-reference.md#pricedmetadatainformation) | + +#### Returns + +[`ServiceCompute`](../interfaces/ServiceCompute.md) + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[createService](BaseTemplate.md#createservice) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L35) + +--- + +### description + +▸ **description**(): `string` + +#### Returns + +`string` + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[description](BaseTemplate.md#description) + +#### Defined in + +[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L39) + +--- + +### extraGen + +▸ **extraGen**(`_params`): `Promise`<`any`\> + +#### Parameters + +| Name | Type | +| :-------- | :------------------------------------------------------ | +| `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | + +#### Returns + +`Promise`<`any`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[extraGen](BaseTemplate.md#extragen) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:94](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L94) + +--- + +### 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. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getAgreementCreatedEvent](BaseTemplate.md#getagreementcreatedevent) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:459](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L459) + +--- + +### getAgreementData + +▸ **getAgreementData**(`agreementId`): `Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | + +#### Returns + +`Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getAgreementData](BaseTemplate.md#getagreementdata) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:21](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L21) + +--- + +### getAgreementIdsFromDDO + +▸ **getAgreementIdsFromDDO**(`agreementId`, `ddo`, `creator`, `params`): `Promise`<`string`[]\> + +Get agreement conditions IDs. + +#### Parameters + +| Name | Type | Description | +| :------------ | :----------------------------- | :------------ | +| `agreementId` | `string` | Agreement ID. | +| `ddo` | [`DDO`](DDO.md) | DDO. | +| `creator` | `string` | - | +| `params` | `EscrowComputeExecutionParams` | - | + +#### Returns + +`Promise`<`string`[]\> + +The condition IDs. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getAgreementIdsFromDDO](BaseTemplate.md#getagreementidsfromddo) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:180](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L180) + +--- + +### getAgreementStatus + +▸ **getAgreementStatus**(`agreementId`): `Promise`<`false` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> + +Returns the status of the conditions. + +#### Parameters + +| Name | Type | Description | +| :------------ | :------- | :------------ | +| `agreementId` | `string` | Agreement ID. | + +#### Returns + +`Promise`<`false` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> + +The conditions status. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getAgreementStatus](BaseTemplate.md#getagreementstatus) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:346](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L346) + +--- + +### getAgreementsForDID + +▸ **getAgreementsForDID**(`did`): `Promise`<`string`[]\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `did` | `string` | + +#### Returns + +`Promise`<`string`[]\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getAgreementsForDID](BaseTemplate.md#getagreementsfordid) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:485](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L485) + +--- + +### getConditionTypes + +▸ **getConditionTypes**(): `Promise`<`string`[]\> + +Conditions address list. + +#### Returns + +`Promise`<`string`[]\> + +A list of condition addresses. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getConditionTypes](BaseTemplate.md#getconditiontypes) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L154) + +--- + +### getConditions + +▸ **getConditions**(): `Promise`<[`ConditionSmall`](ConditionSmall.md)[]\> + +List of condition contracts. + +#### Returns + +`Promise`<[`ConditionSmall`](ConditionSmall.md)[]\> + +A list of condition contracts. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getConditions](BaseTemplate.md#getconditions) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:165](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L165) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getFromAddress](BaseTemplate.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getInputsOfMethod](BaseTemplate.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getServiceAgreementTemplate + +▸ **getServiceAgreementTemplate**(): `Object` + +#### Returns + +`Object` + +| Name | Type | +| :-------------------- | :------------------------------------------------------------------------------------------ | +| `conditionDependency` | { `[condition: string]`: `string`[]; } | +| `conditions` | [`ServiceAgreementTemplateCondition`](../interfaces/ServiceAgreementTemplateCondition.md)[] | +| `contractName` | `string` | +| `events` | [`ServiceAgreementTemplateEvent`](../interfaces/ServiceAgreementTemplateEvent.md)[] | +| `fulfillmentOrder` | `string`[] | + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[getServiceAgreementTemplate](BaseTemplate.md#getserviceagreementtemplate) + +#### Defined in + +[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L90) + +--- + +### getServiceAgreementTemplateConditionByRef + +▸ **getServiceAgreementTemplateConditionByRef**(`ref`): `Promise`<[`ConditionSmall`](ConditionSmall.md)\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `ref` | `string` | + +#### Returns + +`Promise`<[`ConditionSmall`](ConditionSmall.md)\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getServiceAgreementTemplateConditionByRef](BaseTemplate.md#getserviceagreementtemplateconditionbyref) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:329](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L329) + +--- + +### getServiceAgreementTemplateConditions + +▸ **getServiceAgreementTemplateConditions**(): [`ServiceAgreementTemplateCondition`](../interfaces/ServiceAgreementTemplateCondition.md)[] + +#### Returns + +[`ServiceAgreementTemplateCondition`](../interfaces/ServiceAgreementTemplateCondition.md)[] + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getServiceAgreementTemplateConditions](BaseTemplate.md#getserviceagreementtemplateconditions) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:324](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L324) + +--- + +### getServiceAgreementTemplateDependencies + +▸ **getServiceAgreementTemplateDependencies**(): `Promise`<{ `[condition: string]`: `string`[]; }\> + +#### Returns + +`Promise`<{ `[condition: string]`: `string`[]; }\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getServiceAgreementTemplateDependencies](BaseTemplate.md#getserviceagreementtemplatedependencies) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:336](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L336) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getSignatureOfMethod](BaseTemplate.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[init](BaseTemplate.md#init) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### instanceFromDDO + +▸ **instanceFromDDO**(`agreementIdSeed`, `ddo`, `creator`, `parameters`): `Promise`<[`AgreementInstance`](../interfaces/AgreementInstance.md)<`EscrowComputeExecutionParams`\>\> + +#### Parameters + +| Name | Type | +| :---------------- | :----------------------------- | +| `agreementIdSeed` | `string` | +| `ddo` | [`DDO`](DDO.md) | +| `creator` | `string` | +| `parameters` | `EscrowComputeExecutionParams` | + +#### Returns + +`Promise`<[`AgreementInstance`](../interfaces/AgreementInstance.md)<`EscrowComputeExecutionParams`\>\> + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[instanceFromDDO](BaseTemplate.md#instancefromddo) + +#### Defined in + +[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:108](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L108) + +--- + +### lockConditionIndex + +▸ **lockConditionIndex**(): `number` + +#### Returns + +`number` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[lockConditionIndex](BaseTemplate.md#lockconditionindex) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:74](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L74) + +--- + +### lockTokens + +▸ **lockTokens**(`tokenAddress`, `amounts`, `from`, `txParams`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `tokenAddress` | `any` | +| `amounts` | `any` | +| `from` | [`Account`](Account.md) | +| `txParams` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[lockTokens](BaseTemplate.md#locktokens) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:393](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L393) + +--- + +### name + +▸ **name**(): `string` + +#### Returns + +`string` + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[name](BaseTemplate.md#name) + +#### Defined in + +[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:36](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L36) + +--- + +### params + +▸ **params**(`consumer`): `EscrowComputeExecutionParams` + +#### Parameters + +| Name | Type | +| :--------- | :---------------------- | +| `consumer` | [`Account`](Account.md) | + +#### Returns + +`EscrowComputeExecutionParams` + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[params](BaseTemplate.md#params) + +#### Defined in + +[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:98](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L98) + +--- + +### paramsGen + +▸ **paramsGen**(`params`): `Promise`<`EscrowComputeExecutionParams`\> + +Specialize params + +#### Parameters + +| Name | Type | Description | +| :------- | :------------------------------------------------------ | :----------------- | +| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | Generic parameters | + +#### Returns + +`Promise`<`EscrowComputeExecutionParams`\> + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[paramsGen](BaseTemplate.md#paramsgen) + +#### Defined in + +[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:22](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L22) + +--- + +### paymentData + +▸ **paymentData**(`service`): `Promise`<[`PaymentData`](../interfaces/PaymentData.md)\> + +#### Parameters + +| Name | Type | +| :-------- | :------------------------------------------------ | +| `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | + +#### Returns + +`Promise`<[`PaymentData`](../interfaces/PaymentData.md)\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[paymentData](BaseTemplate.md#paymentdata) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:78](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L78) + +--- + +### printAgreementStatus + +▸ **printAgreementStatus**(`agreementId`): `Promise`<`void`\> + +Prints the agreement status. + +#### Parameters + +| Name | Type | Description | +| :------------ | :------- | :------------ | +| `agreementId` | `string` | Agreement ID. | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[printAgreementStatus](BaseTemplate.md#printagreementstatus) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:429](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L429) + +--- + +### process + +▸ **process**(`params`, `from`, `txparams?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :---------- | :------------------------------------------------------ | +| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `from` | [`Account`](Account.md) | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[process](BaseTemplate.md#process) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:110](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L110) + +--- + +### providerConfig + +▸ **providerConfig**(): `Promise`<{ `description`: `string` = ''; `environment`: { `cluster`: { `type`: `string` = 'Kubernetes'; `url`: `string` = 'http://10.0.0.17/xxx' } ; `supportedContainers`: { `checksum`: `string` = 'sha256:cb57ecfa6ebbefd8ffc7f75c0f00e57a7fa739578a429b6f72a0df19315deadc'; `image`: `string` = 'tensorflow/tensorflow'; `tag`: `string` = 'latest' }[] ; `supportedServers`: { `cpu`: `string` = '16'; `disk`: `string` = '160gb'; `gpu`: `string` = '0'; `maxExecutionTime`: `number` = 86400; `memory`: `string` = '128gb'; `price`: `string` = '50'; `serverId`: `string` = '1'; `serverType`: `string` = 'xlsize' }[] } ; `type`: `string` = 'Azure' }\> + +#### Returns + +`Promise`<{ `description`: `string` = ''; `environment`: { `cluster`: { `type`: `string` = 'Kubernetes'; `url`: `string` = 'http://10.0.0.17/xxx' } ; `supportedContainers`: { `checksum`: `string` = 'sha256:cb57ecfa6ebbefd8ffc7f75c0f00e57a7fa739578a429b6f72a0df19315deadc'; `image`: `string` = 'tensorflow/tensorflow'; `tag`: `string` = 'latest' }[] ; `supportedServers`: { `cpu`: `string` = '16'; `disk`: `string` = '160gb'; `gpu`: `string` = '0'; `maxExecutionTime`: `number` = 86400; `memory`: `string` = '128gb'; `price`: `string` = '50'; `serverId`: `string` = '1'; `serverType`: `string` = 'xlsize' }[] } ; `type`: `string` = 'Azure' }\> + +#### Defined in + +[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:43](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L43) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[send](BaseTemplate.md#send) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[sendFrom](BaseTemplate.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### service + +▸ **service**(): [`ServiceType`](../code-reference.md#servicetype) + +#### Returns + +[`ServiceType`](../code-reference.md#servicetype) + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[service](BaseTemplate.md#service) + +#### Defined in + +[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:94](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L94) + +--- + +### serviceEndpoint + +▸ **serviceEndpoint**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[serviceEndpoint](BaseTemplate.md#serviceendpoint) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L31) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[setInstanceConfig](BaseTemplate.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### standardContext + +▸ **standardContext**(`ddo`, `creator`, `serviceIndex?`): [`ConditionContext`](../interfaces/ConditionContext.md) + +#### Parameters + +| Name | Type | +| :-------------- | :-------------- | +| `ddo` | [`DDO`](DDO.md) | +| `creator` | `string` | +| `serviceIndex?` | `number` | + +#### Returns + +[`ConditionContext`](../interfaces/ConditionContext.md) + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[standardContext](BaseTemplate.md#standardcontext) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:200](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L200) + +--- + +### track + +▸ **track**(`_params`, `_from`, `_txparams?`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :----------- | :------------------------------------------------------ | +| `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `_from` | [`Account`](Account.md) | +| `_txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`boolean`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[track](BaseTemplate.md#track) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:102](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L102) + +--- + +### validateAgreement + +▸ **validateAgreement**(`agreement_id`, `did`, `params`, `from`, `extra?`, `txparams?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `agreement_id` | `string` | +| `did` | `string` | +| `params` | `EscrowComputeExecutionParams` | +| `from` | [`Account`](Account.md) | +| `extra` | `any` | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[validateAgreement](BaseTemplate.md#validateagreement) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:125](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L125) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`): `Promise`<[`EscrowComputeExecutionTemplate`](EscrowComputeExecutionTemplate.md)\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`Promise`<[`EscrowComputeExecutionTemplate`](EscrowComputeExecutionTemplate.md)\> + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[getInstance](BaseTemplate.md#getinstance) + +#### Defined in + +[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:27](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L27) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[setInstanceConfig](BaseTemplate.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/EscrowPaymentCondition.md b/docs/api-reference/classes/EscrowPaymentCondition.md new file mode 100644 index 000000000..21d607b15 --- /dev/null +++ b/docs/api-reference/classes/EscrowPaymentCondition.md @@ -0,0 +1,976 @@ +[@nevermined-io/sdk](../code-reference.md) / EscrowPaymentCondition + +# Class: EscrowPaymentCondition + +## Hierarchy + +- [`ProviderCondition`](ProviderCondition.md)<`EscrowPaymentConditionContext`\> + + ↳ **`EscrowPaymentCondition`** + +## Table of contents + +### Constructors + +- [constructor](EscrowPaymentCondition.md#constructor) + +### Properties + +- [address](EscrowPaymentCondition.md#address) +- [contract](EscrowPaymentCondition.md#contract) +- [contractName](EscrowPaymentCondition.md#contractname) +- [events](EscrowPaymentCondition.md#events) +- [version](EscrowPaymentCondition.md#version) + +### Accessors + +- [artifactsFolder](EscrowPaymentCondition.md#artifactsfolder) +- [circuitsFolder](EscrowPaymentCondition.md#circuitsfolder) +- [config](EscrowPaymentCondition.md#config) +- [instanceConfig](EscrowPaymentCondition.md#instanceconfig) +- [instantiableConfig](EscrowPaymentCondition.md#instantiableconfig) +- [logger](EscrowPaymentCondition.md#logger) +- [nevermined](EscrowPaymentCondition.md#nevermined) +- [web3](EscrowPaymentCondition.md#web3) + +### Methods + +- [abortByTimeOut](EscrowPaymentCondition.md#abortbytimeout) +- [call](EscrowPaymentCondition.md#call) +- [fulfill](EscrowPaymentCondition.md#fulfill) +- [fulfillInstance](EscrowPaymentCondition.md#fulfillinstance) +- [fulfillPlain](EscrowPaymentCondition.md#fulfillplain) +- [fulfillWithNode](EscrowPaymentCondition.md#fulfillwithnode) +- [generateId](EscrowPaymentCondition.md#generateid) +- [generateIdHash](EscrowPaymentCondition.md#generateidhash) +- [generateIdWithSeed](EscrowPaymentCondition.md#generateidwithseed) +- [getConditionFulfilledEvent](EscrowPaymentCondition.md#getconditionfulfilledevent) +- [getFromAddress](EscrowPaymentCondition.md#getfromaddress) +- [getInputsOfMethod](EscrowPaymentCondition.md#getinputsofmethod) +- [getSignatureOfMethod](EscrowPaymentCondition.md#getsignatureofmethod) +- [hashValues](EscrowPaymentCondition.md#hashvalues) +- [hashValuesPlain](EscrowPaymentCondition.md#hashvaluesplain) +- [init](EscrowPaymentCondition.md#init) +- [instance](EscrowPaymentCondition.md#instance) +- [instanceFromDDO](EscrowPaymentCondition.md#instancefromddo) +- [nodeMethod](EscrowPaymentCondition.md#nodemethod) +- [params](EscrowPaymentCondition.md#params) +- [paramsFromDDO](EscrowPaymentCondition.md#paramsfromddo) +- [send](EscrowPaymentCondition.md#send) +- [sendFrom](EscrowPaymentCondition.md#sendfrom) +- [setInstanceConfig](EscrowPaymentCondition.md#setinstanceconfig) +- [getInstance](EscrowPaymentCondition.md#getinstance) +- [setInstanceConfig](EscrowPaymentCondition.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new EscrowPaymentCondition**(`contractName`) + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[constructor](ProviderCondition.md#constructor) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L34) + +## Properties + +### address + +• **address**: `string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[address](ProviderCondition.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[contract](ProviderCondition.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[contractName](ProviderCondition.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[events](ProviderCondition.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[version](ProviderCondition.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ProviderCondition.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ProviderCondition.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +ProviderCondition.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ProviderCondition.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ProviderCondition.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +ProviderCondition.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +ProviderCondition.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +ProviderCondition.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### abortByTimeOut + +▸ **abortByTimeOut**(`conditionId`, `from?`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------------ | :---------------------------------------------- | +| `conditionId` | `string` | +| `from?` | [`Account`](Account.md) | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[abortByTimeOut](ProviderCondition.md#abortbytimeout) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L88) + +--- + +### 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 + +[ProviderCondition](ProviderCondition.md).[call](ProviderCondition.md#call) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### fulfill + +▸ **fulfill**(`agreementId`, `did`, `amounts`, `receivers`, `returnAddress`, `lockPaymentAddress`, `tokenAddress`, `lockCondition`, `releaseCondition`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------- | +| `agreementId` | `string` | +| `did` | `string` | +| `amounts` | `bigint`[] | +| `receivers` | `string`[] | +| `returnAddress` | `string` | +| `lockPaymentAddress` | `string` | +| `tokenAddress` | `string` | +| `lockCondition` | `string` | +| `releaseCondition` | `string` | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[fulfill](ProviderCondition.md#fulfill) + +#### Defined in + +[src/keeper/contracts/conditions/EscrowPaymentCondition.ts:60](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/EscrowPaymentCondition.ts#L60) + +--- + +### fulfillInstance + +▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `txParams?`, `method?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | Default value | +| :----------------- | :----------------------------------------------------------------------------------------- | :------------ | +| `cond` | [`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | +| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | +| `from?` | [`Account`](Account.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[fulfillInstance](ProviderCondition.md#fulfillinstance) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:150](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L150) + +--- + +### fulfillPlain + +▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `txParams?`, `method?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | Default value | +| :------------ | :-------------------------------------------------------- | :------------ | +| `agreementId` | `string` | `undefined` | +| `args` | `any`[] | `undefined` | +| `from?` | [`Account`](Account.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[fulfillPlain](ProviderCondition.md#fulfillplain) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L63) + +--- + +### fulfillWithNode + +▸ **fulfillWithNode**(`cond`, `additionalParams`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :----------------- | :----------------------------------------------------------------------------------------- | +| `cond` | [`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | +| `additionalParams` | `Record`<`string`, `unknown`\> | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[fulfillWithNode](ProviderCondition.md#fulfillwithnode) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:194](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L194) + +--- + +### generateId + +▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `valueHash` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[generateId](ProviderCondition.md#generateid) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L77) + +--- + +### generateIdHash + +▸ **generateIdHash**(`agreementId`, `...values`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `...values` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[generateIdHash](ProviderCondition.md#generateidhash) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L73) + +--- + +### generateIdWithSeed + +▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `valueHash` | `string` | + +#### Returns + +`Promise`<[`string`, `string`]\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[generateIdWithSeed](ProviderCondition.md#generateidwithseed) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L81) + +--- + +### getConditionFulfilledEvent + +▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../code-reference.md#eventresult) + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | + +#### Returns + +[`EventResult`](../code-reference.md#eventresult) + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getConditionFulfilledEvent](ProviderCondition.md#getconditionfulfilledevent) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L92) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getFromAddress](ProviderCondition.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getInputsOfMethod](ProviderCondition.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getSignatureOfMethod](ProviderCondition.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### hashValues + +▸ **hashValues**(`...args`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[hashValues](ProviderCondition.md#hashvalues) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L129) + +--- + +### hashValuesPlain + +▸ **hashValuesPlain**(`...args`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[hashValuesPlain](ProviderCondition.md#hashvaluesplain) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:133](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L133) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[init](ProviderCondition.md#init) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### instance + +▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :------------ | :--------------------------------------------------------------------------------------------- | +| `agreementId` | `string` | +| `params` | [`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | + +#### Returns + +`Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[instance](ProviderCondition.md#instance) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:174](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L174) + +--- + +### instanceFromDDO + +▸ **instanceFromDDO**(`agreementId`, `ctx`, `...args`): `Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------------------------------------------- | +| `agreementId` | `string` | +| `ctx` | `EscrowPaymentConditionContext` | +| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | + +#### Returns + +`Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[instanceFromDDO](ProviderCondition.md#instancefromddo) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L142) + +--- + +### nodeMethod + +▸ **nodeMethod**(): [`ConditionMethod`](../code-reference.md#conditionmethod) + +#### Returns + +[`ConditionMethod`](../code-reference.md#conditionmethod) + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[nodeMethod](ProviderCondition.md#nodemethod) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:208](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L208) + +--- + +### params + +▸ **params**(`did`, `amounts`, `receivers`, `returnAddress`, `sender`, `tokenAddress`, `lockCondition`, `releaseCondition`): [`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> + +#### Parameters + +| Name | Type | +| :----------------- | :--------- | +| `did` | `string` | +| `amounts` | `bigint`[] | +| `receivers` | `string`[] | +| `returnAddress` | `string` | +| `sender` | `string` | +| `tokenAddress` | `string` | +| `lockCondition` | `string` | +| `releaseCondition` | `string` | + +#### Returns + +[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[params](ProviderCondition.md#params) + +#### Defined in + +[src/keeper/contracts/conditions/EscrowPaymentCondition.ts:22](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/EscrowPaymentCondition.ts#L22) + +--- + +### paramsFromDDO + +▸ **paramsFromDDO**(`«destructured»`, `access`, `lock`): `Promise`<[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :--------------- | :------------------------------------------------------------------ | +| `«destructured»` | `EscrowPaymentConditionContext` | +| `access` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md) | +| `lock` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md) | + +#### Returns + +`Promise`<[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[paramsFromDDO](ProviderCondition.md#paramsfromddo) + +#### Defined in + +[src/keeper/contracts/conditions/EscrowPaymentCondition.ts:41](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/EscrowPaymentCondition.ts#L41) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[send](ProviderCondition.md#send) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[sendFrom](ProviderCondition.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[setInstanceConfig](ProviderCondition.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`): `Promise`<[`EscrowPaymentCondition`](EscrowPaymentCondition.md)\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`Promise`<[`EscrowPaymentCondition`](EscrowPaymentCondition.md)\> + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[getInstance](ProviderCondition.md#getinstance) + +#### Defined in + +[src/keeper/contracts/conditions/EscrowPaymentCondition.ts:18](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/EscrowPaymentCondition.ts#L18) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[setInstanceConfig](ProviderCondition.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/EthSignJWT.md b/docs/api-reference/classes/EthSignJWT.md new file mode 100644 index 000000000..5e8aa9632 --- /dev/null +++ b/docs/api-reference/classes/EthSignJWT.md @@ -0,0 +1,441 @@ +[@nevermined-io/sdk](../code-reference.md) / EthSignJWT + +# Class: EthSignJWT + +## Hierarchy + +- `SignJWT` + + ↳ **`EthSignJWT`** + +## Table of contents + +### Constructors + +- [constructor](EthSignJWT.md#constructor) + +### Properties + +- [\_payload](EthSignJWT.md#_payload) +- [protectedHeader](EthSignJWT.md#protectedheader) + +### Methods + +- [base64url](EthSignJWT.md#base64url) +- [concat](EthSignJWT.md#concat) +- [ethSign](EthSignJWT.md#ethsign) +- [setAudience](EthSignJWT.md#setaudience) +- [setExpirationTime](EthSignJWT.md#setexpirationtime) +- [setIssuedAt](EthSignJWT.md#setissuedat) +- [setIssuer](EthSignJWT.md#setissuer) +- [setJti](EthSignJWT.md#setjti) +- [setNotBefore](EthSignJWT.md#setnotbefore) +- [setProtectedHeader](EthSignJWT.md#setprotectedheader) +- [setSubject](EthSignJWT.md#setsubject) +- [sign](EthSignJWT.md#sign) +- [signMessage](EthSignJWT.md#signmessage) +- [signText](EthSignJWT.md#signtext) +- [signTypedMessage](EthSignJWT.md#signtypedmessage) + +## Constructors + +### constructor + +• **new EthSignJWT**(`payload`) + +#### Parameters + +| Name | Type | Description | +| :-------- | :----------- | :------------------------- | +| `payload` | `JWTPayload` | The JWT Claims Set object. | + +#### Inherited from + +SignJWT.constructor + +#### Defined in + +node_modules/jose/dist/types/jwt/produce.d.ts:6 + +## Properties + +### \_payload + +• `Protected` **\_payload**: `JWTPayload` + +#### Inherited from + +SignJWT.\_payload + +#### Defined in + +node_modules/jose/dist/types/jwt/produce.d.ts:4 + +--- + +### protectedHeader + +• **protectedHeader**: `JWSHeaderParameters` + +#### Defined in + +[src/nevermined/utils/JwtUtils.ts:27](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/JwtUtils.ts#L27) + +## Methods + +### base64url + +▸ `Private` **base64url**(`input`): `string` + +#### Parameters + +| Name | Type | +| :------ | :----------------------- | +| `input` | `string` \| `Uint8Array` | + +#### Returns + +`string` + +#### Defined in + +[src/nevermined/utils/JwtUtils.ts:128](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/JwtUtils.ts#L128) + +--- + +### concat + +▸ `Private` **concat**(`...buffers`): `Uint8Array` + +#### Parameters + +| Name | Type | +| :----------- | :------------- | +| `...buffers` | `Uint8Array`[] | + +#### Returns + +`Uint8Array` + +#### Defined in + +[src/nevermined/utils/JwtUtils.ts:136](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/JwtUtils.ts#L136) + +--- + +### ethSign + +▸ **ethSign**(`signer`, `eip712Data?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :--------------------------------------------- | +| `signer` | `Signer` \| `ZeroDevAccountSigner`<`"ECDSA"`\> | +| `eip712Data?` | [`Eip712Data`](../interfaces/Eip712Data.md) | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/nevermined/utils/JwtUtils.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/JwtUtils.ts#L34) + +--- + +### setAudience + +▸ **setAudience**(`audience`): [`EthSignJWT`](EthSignJWT.md) + +Set "aud" (Audience) Claim. + +#### Parameters + +| Name | Type | Description | +| :--------- | :--------------------- | :--------------------------------------------------------- | +| `audience` | `string` \| `string`[] | "aud" (Audience) Claim value to set on the JWT Claims Set. | + +#### Returns + +[`EthSignJWT`](EthSignJWT.md) + +#### Inherited from + +SignJWT.setAudience + +#### Defined in + +node_modules/jose/dist/types/jwt/produce.d.ts:24 + +--- + +### setExpirationTime + +▸ **setExpirationTime**(`input`): [`EthSignJWT`](EthSignJWT.md) + +Set "exp" (Expiration Time) Claim. + +#### Parameters + +| Name | Type | Description | +| :------ | :------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `input` | `string` \| `number` | "exp" (Expiration Time) Claim value to set on the JWT Claims Set. When number is passed that is used as a value, when string is passed it is resolved to a time span and added to the current timestamp. | + +#### Returns + +[`EthSignJWT`](EthSignJWT.md) + +#### Inherited from + +SignJWT.setExpirationTime + +#### Defined in + +node_modules/jose/dist/types/jwt/produce.d.ts:46 + +--- + +### setIssuedAt + +▸ **setIssuedAt**(`input?`): [`EthSignJWT`](EthSignJWT.md) + +Set "iat" (Issued At) Claim. + +#### Parameters + +| Name | Type | Description | +| :------- | :------- | :---------------------------------------------------------------------------------------- | +| `input?` | `number` | "iat" (Issued At) Claim value to set on the JWT Claims Set. Default is current timestamp. | + +#### Returns + +[`EthSignJWT`](EthSignJWT.md) + +#### Inherited from + +SignJWT.setIssuedAt + +#### Defined in + +node_modules/jose/dist/types/jwt/produce.d.ts:52 + +--- + +### setIssuer + +▸ **setIssuer**(`issuer`): [`EthSignJWT`](EthSignJWT.md) + +Set "iss" (Issuer) Claim. + +#### Parameters + +| Name | Type | Description | +| :------- | :------- | :------------------------------------------------- | +| `issuer` | `string` | "Issuer" Claim value to set on the JWT Claims Set. | + +#### Returns + +[`EthSignJWT`](EthSignJWT.md) + +#### Inherited from + +SignJWT.setIssuer + +#### Defined in + +node_modules/jose/dist/types/jwt/produce.d.ts:12 + +--- + +### setJti + +▸ **setJti**(`jwtId`): [`EthSignJWT`](EthSignJWT.md) + +Set "jti" (JWT ID) Claim. + +#### Parameters + +| Name | Type | Description | +| :------ | :------- | :------------------------------------------------------- | +| `jwtId` | `string` | "jti" (JWT ID) Claim value to set on the JWT Claims Set. | + +#### Returns + +[`EthSignJWT`](EthSignJWT.md) + +#### Inherited from + +SignJWT.setJti + +#### Defined in + +node_modules/jose/dist/types/jwt/produce.d.ts:30 + +--- + +### setNotBefore + +▸ **setNotBefore**(`input`): [`EthSignJWT`](EthSignJWT.md) + +Set "nbf" (Not Before) Claim. + +#### Parameters + +| Name | Type | Description | +| :------ | :------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `input` | `string` \| `number` | "nbf" (Not Before) Claim value to set on the JWT Claims Set. When number is passed that is used as a value, when string is passed it is resolved to a time span and added to the current timestamp. | + +#### Returns + +[`EthSignJWT`](EthSignJWT.md) + +#### Inherited from + +SignJWT.setNotBefore + +#### Defined in + +node_modules/jose/dist/types/jwt/produce.d.ts:38 + +--- + +### setProtectedHeader + +▸ **setProtectedHeader**(`protectedHeader`): [`EthSignJWT`](EthSignJWT.md) + +#### Parameters + +| Name | Type | +| :---------------- | :-------------------- | +| `protectedHeader` | `JWSHeaderParameters` | + +#### Returns + +[`EthSignJWT`](EthSignJWT.md) + +#### Overrides + +SignJWT.setProtectedHeader + +#### Defined in + +[src/nevermined/utils/JwtUtils.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/JwtUtils.ts#L29) + +--- + +### setSubject + +▸ **setSubject**(`subject`): [`EthSignJWT`](EthSignJWT.md) + +Set "sub" (Subject) Claim. + +#### Parameters + +| Name | Type | Description | +| :-------- | :------- | :-------------------------------------------------------- | +| `subject` | `string` | "sub" (Subject) Claim value to set on the JWT Claims Set. | + +#### Returns + +[`EthSignJWT`](EthSignJWT.md) + +#### Inherited from + +SignJWT.setSubject + +#### Defined in + +node_modules/jose/dist/types/jwt/produce.d.ts:18 + +--- + +### sign + +▸ **sign**(`key`, `options?`): `Promise`<`string`\> + +Signs and returns the JWT. + +#### Parameters + +| Name | Type | Description | +| :--------- | :------------------------ | :------------------------------------------ | +| `key` | `Uint8Array` \| `KeyLike` | Private Key or Secret to sign the JWT with. | +| `options?` | `SignOptions` | JWT Sign options. | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +SignJWT.sign + +#### Defined in + +node_modules/jose/dist/types/jwt/sign.d.ts:34 + +--- + +### signMessage + +▸ `Static` `Private` **signMessage**(`message`, `signer`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :--------------------------------------------- | +| `message` | `string` \| `Uint8Array` | +| `signer` | `Signer` \| `ZeroDevAccountSigner`<`"ECDSA"`\> | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/nevermined/utils/JwtUtils.ts:100](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/JwtUtils.ts#L100) + +--- + +### signText + +▸ `Static` **signText**(`text`, `signer`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------- | :----------------------- | +| `text` | `string` \| `Uint8Array` | +| `signer` | `Signer` | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/nevermined/utils/JwtUtils.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/JwtUtils.ts#L90) + +--- + +### signTypedMessage + +▸ `Static` `Private` **signTypedMessage**(`domain`, `types`, `value`, `signer`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------- | +| `domain` | [`TypedDataDomain`](../interfaces/TypedDataDomain.md) | +| `types` | [`TypedDataTypes`](../interfaces/TypedDataTypes.md) | +| `value` | `Record`<`string`, `any`\> | +| `signer` | `Signer` \| `ZeroDevAccountSigner`<`"ECDSA"`\> | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/nevermined/utils/JwtUtils.ts:111](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/JwtUtils.ts#L111) diff --git a/docs/api-reference/classes/events.EventHandler.md b/docs/api-reference/classes/EventHandler.md similarity index 59% rename from docs/api-reference/classes/events.EventHandler.md rename to docs/api-reference/classes/EventHandler.md index c9d9ed730..43f24b89d 100644 --- a/docs/api-reference/classes/events.EventHandler.md +++ b/docs/api-reference/classes/EventHandler.md @@ -1,33 +1,31 @@ -[@nevermined-io/sdk](../code-reference.md) / [events](../modules/events.md) / EventHandler +[@nevermined-io/sdk](../code-reference.md) / EventHandler # Class: EventHandler -[events](../modules/events.md).EventHandler - ## Table of contents ### Constructors -- [constructor](events.EventHandler.md#constructor) +- [constructor](EventHandler.md#constructor) ### Properties -- [events](events.EventHandler.md#events) -- [getBlockNumber](events.EventHandler.md#getblocknumber) -- [interval](events.EventHandler.md#interval) -- [lastBlock](events.EventHandler.md#lastblock) -- [lastTimeout](events.EventHandler.md#lasttimeout) -- [polling](events.EventHandler.md#polling) +- [events](EventHandler.md#events) +- [getBlockNumber](EventHandler.md#getblocknumber) +- [interval](EventHandler.md#interval) +- [lastBlock](EventHandler.md#lastblock) +- [lastTimeout](EventHandler.md#lasttimeout) +- [polling](EventHandler.md#polling) ### Accessors -- [count](events.EventHandler.md#count) +- [count](EventHandler.md#count) ### Methods -- [checkBlock](events.EventHandler.md#checkblock) -- [subscribe](events.EventHandler.md#subscribe) -- [unsubscribe](events.EventHandler.md#unsubscribe) +- [checkBlock](EventHandler.md#checkblock) +- [subscribe](EventHandler.md#subscribe) +- [unsubscribe](EventHandler.md#unsubscribe) ## Constructors @@ -43,7 +41,7 @@ #### Defined in -[src/events/EventHandler.ts:6](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/EventHandler.ts#L6) +[src/events/EventHandler.ts:6](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/EventHandler.ts#L6) --- @@ -61,7 +59,7 @@ #### Defined in -[src/events/EventHandler.ts:16](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/EventHandler.ts#L16) +[src/events/EventHandler.ts:16](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/EventHandler.ts#L16) --- @@ -71,7 +69,7 @@ #### Defined in -[src/events/EventHandler.ts:10](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/EventHandler.ts#L10) +[src/events/EventHandler.ts:10](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/EventHandler.ts#L10) --- @@ -81,7 +79,7 @@ #### Defined in -[src/events/EventHandler.ts:8](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/EventHandler.ts#L8) +[src/events/EventHandler.ts:8](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/EventHandler.ts#L8) --- @@ -91,7 +89,7 @@ #### Defined in -[src/events/EventHandler.ts:14](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/EventHandler.ts#L14) +[src/events/EventHandler.ts:14](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/EventHandler.ts#L14) --- @@ -101,7 +99,7 @@ #### Defined in -[src/events/EventHandler.ts:12](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/EventHandler.ts#L12) +[src/events/EventHandler.ts:12](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/EventHandler.ts#L12) ## Accessors @@ -115,20 +113,19 @@ #### Defined in -[src/events/EventHandler.ts:2](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/EventHandler.ts#L2) +[src/events/EventHandler.ts:2](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/EventHandler.ts#L2) ## Methods ### checkBlock -▸ `Private` **checkBlock**(`isInterval?`, `n?`): `Promise`<`void`\> +▸ `Private` **checkBlock**(`isInterval?`): `Promise`<`void`\> #### Parameters -| Name | Type | Default value | -| :------------ | :-------- | :------------ | -| `isInterval?` | `boolean` | `undefined` | -| `n` | `number` | `0` | +| Name | Type | +| :------------ | :-------- | +| `isInterval?` | `boolean` | #### Returns @@ -136,7 +133,7 @@ #### Defined in -[src/events/EventHandler.ts:40](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/EventHandler.ts#L40) +[src/events/EventHandler.ts:37](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/EventHandler.ts#L37) --- @@ -161,7 +158,7 @@ #### Defined in -[src/events/EventHandler.ts:18](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/EventHandler.ts#L18) +[src/events/EventHandler.ts:18](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/EventHandler.ts#L18) --- @@ -181,4 +178,4 @@ #### Defined in -[src/events/EventHandler.ts:31](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/EventHandler.ts#L31) +[src/events/EventHandler.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/EventHandler.ts#L28) diff --git a/docs/api-reference/classes/Files.md b/docs/api-reference/classes/Files.md new file mode 100644 index 000000000..d71efe915 --- /dev/null +++ b/docs/api-reference/classes/Files.md @@ -0,0 +1,297 @@ +[@nevermined-io/sdk](../code-reference.md) / Files + +# Class: Files + +## Hierarchy + +- [`Instantiable`](Instantiable.md) + + ↳ **`Files`** + +## Table of contents + +### Constructors + +- [constructor](Files.md#constructor) + +### Accessors + +- [artifactsFolder](Files.md#artifactsfolder) +- [circuitsFolder](Files.md#circuitsfolder) +- [config](Files.md#config) +- [instanceConfig](Files.md#instanceconfig) +- [instantiableConfig](Files.md#instantiableconfig) +- [logger](Files.md#logger) +- [nevermined](Files.md#nevermined) +- [web3](Files.md#web3) + +### Methods + +- [setInstanceConfig](Files.md#setinstanceconfig) +- [uploadFilecoin](Files.md#uploadfilecoin) +- [getInstance](Files.md#getinstance) +- [setInstanceConfig](Files.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new Files**(`config`) + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Overrides + +[Instantiable](Instantiable.md).[constructor](Instantiable.md#constructor) + +#### Defined in + +[src/nevermined/Files.ts:5](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Files.ts#L5) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +Instantiable.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +Instantiable.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +Instantiable.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +Instantiable.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### uploadFilecoin + +▸ **uploadFilecoin**(`data`, `encrypt?`): `Promise`<`any`\> + +#### Parameters + +| Name | Type | +| :--------- | :----------------------- | +| `data` | `string` \| `ReadStream` | +| `encrypt?` | `boolean` | + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +[src/nevermined/Files.ts:10](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Files.ts#L10) + +--- + +### getInstance + +▸ `Static` **getInstance**(`..._args`): `any` + +#### Parameters + +| Name | Type | +| :--------- | :---- | +| `..._args` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[Instantiable](Instantiable.md).[getInstance](Instantiable.md#getinstance) + +#### Defined in + +[src/Instantiable.abstract.ts:86](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L86) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/GenericContract.md b/docs/api-reference/classes/GenericContract.md new file mode 100644 index 000000000..35af32a50 --- /dev/null +++ b/docs/api-reference/classes/GenericContract.md @@ -0,0 +1,573 @@ +[@nevermined-io/sdk](../code-reference.md) / GenericContract + +# Class: GenericContract + +## Hierarchy + +- [`ContractBase`](ContractBase.md) + + ↳ **`GenericContract`** + +## Table of contents + +### Constructors + +- [constructor](GenericContract.md#constructor) + +### Properties + +- [address](GenericContract.md#address) +- [contract](GenericContract.md#contract) +- [contractName](GenericContract.md#contractname) +- [events](GenericContract.md#events) +- [fixedAddress](GenericContract.md#fixedaddress) +- [version](GenericContract.md#version) + +### Accessors + +- [artifactsFolder](GenericContract.md#artifactsfolder) +- [circuitsFolder](GenericContract.md#circuitsfolder) +- [config](GenericContract.md#config) +- [instanceConfig](GenericContract.md#instanceconfig) +- [instantiableConfig](GenericContract.md#instantiableconfig) +- [logger](GenericContract.md#logger) +- [nevermined](GenericContract.md#nevermined) +- [web3](GenericContract.md#web3) + +### Methods + +- [call](GenericContract.md#call) +- [getContract](GenericContract.md#getcontract) +- [getFromAddress](GenericContract.md#getfromaddress) +- [getInputsOfMethod](GenericContract.md#getinputsofmethod) +- [getSignatureOfMethod](GenericContract.md#getsignatureofmethod) +- [init](GenericContract.md#init) +- [send](GenericContract.md#send) +- [sendFrom](GenericContract.md#sendfrom) +- [setInstanceConfig](GenericContract.md#setinstanceconfig) +- [getInstance](GenericContract.md#getinstance) +- [setInstanceConfig](GenericContract.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• `Private` **new GenericContract**(`contractName`, `address?`) + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | +| `address?` | `string` | + +#### Overrides + +[ContractBase](ContractBase.md).[constructor](ContractBase.md#constructor) + +#### Defined in + +[src/keeper/contracts/GenericContract.ts:18](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/GenericContract.ts#L18) + +## Properties + +### address + +• **address**: `string` + +#### Inherited from + +[ContractBase](ContractBase.md).[address](ContractBase.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[ContractBase](ContractBase.md).[contract](ContractBase.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[ContractBase](ContractBase.md).[contractName](ContractBase.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[ContractBase](ContractBase.md).[events](ContractBase.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### fixedAddress + +• `Protected` **fixedAddress**: `string` + +#### Defined in + +[src/keeper/contracts/GenericContract.ts:6](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/GenericContract.ts#L6) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[ContractBase](ContractBase.md).[version](ContractBase.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ContractBase.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ContractBase.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +ContractBase.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ContractBase.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ContractBase.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +ContractBase.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +ContractBase.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +ContractBase.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### call + +▸ **call**<`T`\>(`name`, `args`, `from?`): `Promise`<`T`\> + +#### Type parameters + +| Name | +| :--- | +| `T` | + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | `string` | + +#### Returns + +`Promise`<`T`\> + +#### Overrides + +[ContractBase](ContractBase.md).[call](ContractBase.md#call) + +#### Defined in + +[src/keeper/contracts/GenericContract.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/GenericContract.ts#L34) + +--- + +### getContract + +▸ **getContract**(): `BaseContract` + +#### Returns + +`BaseContract` + +#### Defined in + +[src/keeper/contracts/GenericContract.ts:47](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/GenericContract.ts#L47) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ContractBase](ContractBase.md).[getFromAddress](ContractBase.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[ContractBase](ContractBase.md).[getInputsOfMethod](ContractBase.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[ContractBase](ContractBase.md).[getSignatureOfMethod](ContractBase.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Overrides + +[ContractBase](ContractBase.md).[init](ContractBase.md#init) + +#### Defined in + +[src/keeper/contracts/GenericContract.ts:23](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/GenericContract.ts#L23) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Overrides + +[ContractBase](ContractBase.md).[send](ContractBase.md#send) + +#### Defined in + +[src/keeper/contracts/GenericContract.ts:38](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/GenericContract.ts#L38) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ContractBase](ContractBase.md).[sendFrom](ContractBase.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ContractBase](ContractBase.md).[setInstanceConfig](ContractBase.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`, `contractName`, `address?`): `Promise`<[`GenericContract`](GenericContract.md)\> + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | +| `contractName` | `string` | +| `address?` | `string` | + +#### Returns + +`Promise`<[`GenericContract`](GenericContract.md)\> + +#### Overrides + +[ContractBase](ContractBase.md).[getInstance](ContractBase.md#getinstance) + +#### Defined in + +[src/keeper/contracts/GenericContract.ts:8](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/GenericContract.ts#L8) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ContractBase](ContractBase.md).[setInstanceConfig](ContractBase.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/GraphError.md b/docs/api-reference/classes/GraphError.md new file mode 100644 index 000000000..7be6b54bf --- /dev/null +++ b/docs/api-reference/classes/GraphError.md @@ -0,0 +1,165 @@ +[@nevermined-io/sdk](../code-reference.md) / GraphError + +# Class: GraphError + +## Hierarchy + +- `Error` + + ↳ **`GraphError`** + +## Table of contents + +### Constructors + +- [constructor](GraphError.md#constructor) + +### Properties + +- [message](GraphError.md#message) +- [name](GraphError.md#name) +- [stack](GraphError.md#stack) +- [prepareStackTrace](GraphError.md#preparestacktrace) +- [stackTraceLimit](GraphError.md#stacktracelimit) + +### Methods + +- [captureStackTrace](GraphError.md#capturestacktrace) + +## Constructors + +### constructor + +• **new GraphError**(`message`) + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `message` | `string` | + +#### Overrides + +Error.constructor + +#### Defined in + +[src/errors/GraphError.ts:2](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/errors/GraphError.ts#L2) + +## Properties + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1068 + +--- + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1067 + +--- + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1069 + +--- + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +Optional override for formatting stack traces + +##### Parameters + +| Name | Type | +| :------------ | :----------- | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:11 + +--- + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:13 + +## Methods + +### captureStackTrace + +▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :---------------- | :--------- | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:4 diff --git a/docs/api-reference/classes/HttpError.md b/docs/api-reference/classes/HttpError.md new file mode 100644 index 000000000..8ba3ad647 --- /dev/null +++ b/docs/api-reference/classes/HttpError.md @@ -0,0 +1,166 @@ +[@nevermined-io/sdk](../code-reference.md) / HttpError + +# Class: HttpError + +## Hierarchy + +- `Error` + + ↳ **`HttpError`** + +## Table of contents + +### Constructors + +- [constructor](HttpError.md#constructor) + +### Properties + +- [message](HttpError.md#message) +- [name](HttpError.md#name) +- [stack](HttpError.md#stack) +- [prepareStackTrace](HttpError.md#preparestacktrace) +- [stackTraceLimit](HttpError.md#stacktracelimit) + +### Methods + +- [captureStackTrace](HttpError.md#capturestacktrace) + +## Constructors + +### constructor + +• **new HttpError**(`message`, `code`) + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `message` | `string` | +| `code` | `number` | + +#### Overrides + +Error.constructor + +#### Defined in + +[src/errors/HttpError.ts:2](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/errors/HttpError.ts#L2) + +## Properties + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1068 + +--- + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1067 + +--- + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1069 + +--- + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +Optional override for formatting stack traces + +##### Parameters + +| Name | Type | +| :------------ | :----------- | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:11 + +--- + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:13 + +## Methods + +### captureStackTrace + +▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :---------------- | :--------- | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:4 diff --git a/docs/api-reference/classes/Instantiable.md b/docs/api-reference/classes/Instantiable.md new file mode 100644 index 000000000..55ec73553 --- /dev/null +++ b/docs/api-reference/classes/Instantiable.md @@ -0,0 +1,283 @@ +[@nevermined-io/sdk](../code-reference.md) / Instantiable + +# Class: Instantiable + +## Hierarchy + +- **`Instantiable`** + + ↳ [`NeverminedEvent`](NeverminedEvent.md) + + ↳ [`AccountsApi`](AccountsApi.md) + + ↳ [`AgreementsApi`](AgreementsApi.md) + + ↳ [`ProvenanceApi`](ProvenanceApi.md) + + ↳ [`RegistryBaseApi`](RegistryBaseApi.md) + + ↳ [`SearchApi`](SearchApi.md) + + ↳ [`ServicesApi`](ServicesApi.md) + + ↳ [`UtilsApi`](UtilsApi.md) + + ↳ [`JwtUtils`](JwtUtils.md) + + ↳ [`ServiceAgreement`](ServiceAgreement.md) + + ↳ [`SignatureUtils`](SignatureUtils.md) + + ↳ [`WebServiceConnector`](WebServiceConnector.md) + + ↳ [`AccessService`](AccessService.md) + + ↳ [`NFTAccessService`](NFTAccessService.md) + + ↳ [`NFTSalesService`](NFTSalesService.md) + + ↳ [`Account`](Account.md) + + ↳ [`Files`](Files.md) + + ↳ [`Nevermined`](Nevermined.md) + + ↳ [`Providers`](Providers.md) + + ↳ [`TokenUtils`](TokenUtils.md) + + ↳ [`Versions`](Versions.md) + + ↳ [`AaveCredit`](AaveCredit.md) + + ↳ [`MarketplaceApi`](MarketplaceApi.md) + + ↳ [`NeverminedNode`](NeverminedNode.md) + + ↳ [`ContractBase`](ContractBase.md) + + ↳ [`ContractHandler`](ContractHandler.md) + + ↳ [`Keeper`](Keeper.md) + +## Table of contents + +### Constructors + +- [constructor](Instantiable.md#constructor) + +### Properties + +- [\_instantiableConfig](Instantiable.md#_instantiableconfig) + +### Accessors + +- [artifactsFolder](Instantiable.md#artifactsfolder) +- [circuitsFolder](Instantiable.md#circuitsfolder) +- [config](Instantiable.md#config) +- [instanceConfig](Instantiable.md#instanceconfig) +- [instantiableConfig](Instantiable.md#instantiableconfig) +- [logger](Instantiable.md#logger) +- [nevermined](Instantiable.md#nevermined) +- [web3](Instantiable.md#web3) + +### Methods + +- [setInstanceConfig](Instantiable.md#setinstanceconfig) +- [getInstance](Instantiable.md#getinstance) +- [setInstanceConfig](Instantiable.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new Instantiable**() + +## Properties + +### \_instantiableConfig + +• `Private` `Optional` **\_instantiableConfig**: [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Defined in + +[src/Instantiable.abstract.ts:97](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L97) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### getInstance + +▸ `Static` **getInstance**(`..._args`): `any` + +#### Parameters + +| Name | Type | +| :--------- | :---- | +| `..._args` | `any` | + +#### Returns + +`any` + +#### Defined in + +[src/Instantiable.abstract.ts:86](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L86) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/JwtUtils.md b/docs/api-reference/classes/JwtUtils.md new file mode 100644 index 000000000..4e20967ca --- /dev/null +++ b/docs/api-reference/classes/JwtUtils.md @@ -0,0 +1,592 @@ +[@nevermined-io/sdk](../code-reference.md) / JwtUtils + +# Class: JwtUtils + +## Hierarchy + +- [`Instantiable`](Instantiable.md) + + ↳ **`JwtUtils`** + +## Table of contents + +### Constructors + +- [constructor](JwtUtils.md#constructor) + +### Properties + +- [BASE_AUD](JwtUtils.md#base_aud) +- [CLIENT_ASSERTION_TYPE](JwtUtils.md#client_assertion_type) +- [tokenCache](JwtUtils.md#tokencache) + +### Accessors + +- [artifactsFolder](JwtUtils.md#artifactsfolder) +- [circuitsFolder](JwtUtils.md#circuitsfolder) +- [config](JwtUtils.md#config) +- [instanceConfig](JwtUtils.md#instanceconfig) +- [instantiableConfig](JwtUtils.md#instantiableconfig) +- [logger](JwtUtils.md#logger) +- [nevermined](JwtUtils.md#nevermined) +- [web3](JwtUtils.md#web3) + +### Methods + +- [accountToJwk](JwtUtils.md#accounttojwk) +- [generateAccessGrantToken](JwtUtils.md#generateaccessgranttoken) +- [generateCacheKey](JwtUtils.md#generatecachekey) +- [generateClientAssertion](JwtUtils.md#generateclientassertion) +- [generateComputeGrantToken](JwtUtils.md#generatecomputegranttoken) +- [generateDownloadGrantToken](JwtUtils.md#generatedownloadgranttoken) +- [generateExecuteGrantToken](JwtUtils.md#generateexecutegranttoken) +- [generateNftAccessGrantToken](JwtUtils.md#generatenftaccessgranttoken) +- [generateToken](JwtUtils.md#generatetoken) +- [getDownloadGrantToken](JwtUtils.md#getdownloadgranttoken) +- [getNftAccessGrantToken](JwtUtils.md#getnftaccessgranttoken) +- [getSigner](JwtUtils.md#getsigner) +- [setInstanceConfig](JwtUtils.md#setinstanceconfig) +- [getInstance](JwtUtils.md#getinstance) +- [setInstanceConfig](JwtUtils.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new JwtUtils**(`config`) + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Overrides + +[Instantiable](Instantiable.md).[constructor](Instantiable.md#constructor) + +#### Defined in + +[src/nevermined/utils/JwtUtils.ts:154](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/JwtUtils.ts#L154) + +## Properties + +### BASE_AUD + +• **BASE_AUD**: `string` = `'/api/v1/node/services'` + +#### Defined in + +[src/nevermined/utils/JwtUtils.ts:150](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/JwtUtils.ts#L150) + +--- + +### CLIENT_ASSERTION_TYPE + +• **CLIENT_ASSERTION_TYPE**: `string` = `'urn:ietf:params:oauth:client-assertion-type:jwt-bearer'` + +#### Defined in + +[src/nevermined/utils/JwtUtils.ts:149](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/JwtUtils.ts#L149) + +--- + +### tokenCache + +• **tokenCache**: `Map`<`string`, `string`\> + +#### Defined in + +[src/nevermined/utils/JwtUtils.ts:152](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/JwtUtils.ts#L152) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +Instantiable.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +Instantiable.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +Instantiable.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +Instantiable.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### accountToJwk + +▸ **accountToJwk**(`account`): `Promise`<`any`\> + +#### Parameters + +| Name | Type | +| :-------- | :---------------------- | +| `account` | [`Account`](Account.md) | + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +[src/nevermined/utils/JwtUtils.ts:171](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/JwtUtils.ts#L171) + +--- + +### generateAccessGrantToken + +▸ **generateAccessGrantToken**(`account`, `serviceAgreementId`, `did`, `buyer?`, `babysig?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------------- | :------------------------------------ | +| `account` | [`Account`](Account.md) | +| `serviceAgreementId` | `string` | +| `did` | `string` | +| `buyer?` | `string` | +| `babysig?` | [`Babysig`](../interfaces/Babysig.md) | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/nevermined/utils/JwtUtils.ts:212](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/JwtUtils.ts#L212) + +--- + +### generateCacheKey + +▸ **generateCacheKey**(`...args`): `string` + +#### Parameters + +| Name | Type | +| :-------- | :--------- | +| `...args` | `string`[] | + +#### Returns + +`string` + +#### Defined in + +[src/nevermined/utils/JwtUtils.ts:167](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/JwtUtils.ts#L167) + +--- + +### generateClientAssertion + +▸ **generateClientAssertion**(`account`, `message?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :--------- | :---------------------- | +| `account` | [`Account`](Account.md) | +| `message?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/nevermined/utils/JwtUtils.ts:192](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/JwtUtils.ts#L192) + +--- + +### generateComputeGrantToken + +▸ **generateComputeGrantToken**(`account`, `serviceAgreementId`, `executionId`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------- | +| `account` | [`Account`](Account.md) | +| `serviceAgreementId` | `string` | +| `executionId` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/nevermined/utils/JwtUtils.ts:323](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/JwtUtils.ts#L323) + +--- + +### generateDownloadGrantToken + +▸ **generateDownloadGrantToken**(`account`, `did`, `buyer?`, `babysig?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------ | +| `account` | [`Account`](Account.md) | +| `did` | `string` | +| `buyer?` | `string` | +| `babysig?` | [`Babysig`](../interfaces/Babysig.md) | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/nevermined/utils/JwtUtils.ts:261](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/JwtUtils.ts#L261) + +--- + +### generateExecuteGrantToken + +▸ **generateExecuteGrantToken**(`account`, `serviceAgreementId`, `workflowId`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------- | +| `account` | [`Account`](Account.md) | +| `serviceAgreementId` | `string` | +| `workflowId` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/nevermined/utils/JwtUtils.ts:302](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/JwtUtils.ts#L302) + +--- + +### generateNftAccessGrantToken + +▸ **generateNftAccessGrantToken**(`agreementId`, `did`, `serviceIndex`, `account`, `buyer?`, `babysig?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------- | :------------------------------------ | +| `agreementId` | `string` | +| `did` | `string` | +| `serviceIndex` | `number` | +| `account` | [`Account`](Account.md) | +| `buyer?` | `string` | +| `babysig?` | [`Babysig`](../interfaces/Babysig.md) | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/nevermined/utils/JwtUtils.ts:344](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/JwtUtils.ts#L344) + +--- + +### generateToken + +▸ **generateToken**(`account`, `serviceAgreementId`, `did`, `aud`, `obj`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------- | +| `account` | [`Account`](Account.md) | +| `serviceAgreementId` | `string` | +| `did` | `string` | +| `aud` | `string` | +| `obj` | `any` | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/nevermined/utils/JwtUtils.ts:237](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/JwtUtils.ts#L237) + +--- + +### getDownloadGrantToken + +▸ **getDownloadGrantToken**(`did`, `account`, `buyer?`, `babysig?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------ | +| `did` | `string` | +| `account` | [`Account`](Account.md) | +| `buyer?` | `string` | +| `babysig?` | [`Babysig`](../interfaces/Babysig.md) | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/nevermined/utils/JwtUtils.ts:283](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/JwtUtils.ts#L283) + +--- + +### getNftAccessGrantToken + +▸ **getNftAccessGrantToken**(`agreementId`, `did`, `serviceIndex`, `account`, `buyer?`, `babysig?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------- | :------------------------------------ | +| `agreementId` | `string` | +| `did` | `string` | +| `serviceIndex` | `number` | +| `account` | [`Account`](Account.md) | +| `buyer?` | `string` | +| `babysig?` | [`Babysig`](../interfaces/Babysig.md) | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/nevermined/utils/JwtUtils.ts:372](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/JwtUtils.ts#L372) + +--- + +### getSigner + +▸ **getSigner**(`account`): `Promise`<`Signer` \| `ZeroDevAccountSigner`<`"ECDSA"`\>\> + +#### Parameters + +| Name | Type | +| :-------- | :---------------------- | +| `account` | [`Account`](Account.md) | + +#### Returns + +`Promise`<`Signer` \| `ZeroDevAccountSigner`<`"ECDSA"`\>\> + +#### Defined in + +[src/nevermined/utils/JwtUtils.ts:160](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/JwtUtils.ts#L160) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### getInstance + +▸ `Static` **getInstance**(`..._args`): `any` + +#### Parameters + +| Name | Type | +| :--------- | :---- | +| `..._args` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[Instantiable](Instantiable.md).[getInstance](Instantiable.md#getinstance) + +#### Defined in + +[src/Instantiable.abstract.ts:86](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L86) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/Keeper.md b/docs/api-reference/classes/Keeper.md index 672976fb7..e1b9b7853 100644 --- a/docs/api-reference/classes/Keeper.md +++ b/docs/api-reference/classes/Keeper.md @@ -11,7 +11,7 @@ Nevermined Keeper implementation where we put the following modules together: ## Hierarchy -- `Instantiable` +- [`Instantiable`](Instantiable.md) ↳ **`Keeper`** @@ -41,11 +41,11 @@ Nevermined Keeper implementation where we put the following modules together: - [templates](Keeper.md#templates) - [token](Keeper.md#token) - [utils](Keeper.md#utils) -- [version](Keeper.md#version) ### Accessors - [artifactsFolder](Keeper.md#artifactsfolder) +- [circuitsFolder](Keeper.md#circuitsfolder) - [config](Keeper.md#config) - [instanceConfig](Keeper.md#instanceconfig) - [instantiableConfig](Keeper.md#instantiableconfig) @@ -55,20 +55,18 @@ Nevermined Keeper implementation where we put the following modules together: ### Methods -- [addresses](Keeper.md#addresses) -- [checkExists](Keeper.md#checkexists) -- [findSigner](Keeper.md#findsigner) - [getAccessTemplateByName](Keeper.md#getaccesstemplatebyname) - [getAllInstances](Keeper.md#getallinstances) - [getConditionByAddress](Keeper.md#getconditionbyaddress) - [getNetworkId](Keeper.md#getnetworkid) - [getNetworkName](Keeper.md#getnetworkname) +- [getNetworkVersion](Keeper.md#getnetworkversion) - [getTemplateByAddress](Keeper.md#gettemplatebyaddress) - [getTemplateByName](Keeper.md#gettemplatebyname) - [init](Keeper.md#init) +- [loadAaveInstances](Keeper.md#loadaaveinstances) +- [loadCurveRoyaltiesInstance](Keeper.md#loadcurveroyaltiesinstance) - [setInstanceConfig](Keeper.md#setinstanceconfig) -- [addressesStatic](Keeper.md#addressesstatic) -- [findSignerStatic](Keeper.md#findsignerstatic) - [getInstance](Keeper.md#getinstance) - [setInstanceConfig](Keeper.md#setinstanceconfig-1) @@ -80,31 +78,31 @@ Nevermined Keeper implementation where we put the following modules together: #### Inherited from -Instantiable.constructor +[Instantiable](Instantiable.md).[constructor](Instantiable.md#constructor) ## Properties ### agreementStoreManager -• **agreementStoreManager**: `AgreementStoreManager` +• **agreementStoreManager**: [`AgreementStoreManager`](AgreementStoreManager.md) Template store manager smart contract instance. #### Defined in -[src/keeper/Keeper.ts:316](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/Keeper.ts#L316) +[src/keeper/Keeper.ts:268](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/Keeper.ts#L268) --- ### conditionStoreManager -• **conditionStoreManager**: `ConditionStoreManager` +• **conditionStoreManager**: [`ConditionStoreManager`](ConditionStoreManager.md) Template store manager smart contract instance. #### Defined in -[src/keeper/Keeper.ts:321](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/Keeper.ts#L321) +[src/keeper/Keeper.ts:273](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/Keeper.ts#L273) --- @@ -116,39 +114,39 @@ Conditions instances. #### Type declaration -| Name | Type | -| :--------------------------------- | :----------------------------------------------------------------------------------- | -| `aaveBorrowCondition` | [`AaveBorrowCondition`](conditions.AaveBorrowCondition.md) | -| `aaveCollateralDepositCondition` | [`AaveCollateralDepositCondition`](conditions.AaveCollateralDepositCondition.md) | -| `aaveCollateralWithdrawCondition` | [`AaveCollateralWithdrawCondition`](conditions.AaveCollateralWithdrawCondition.md) | -| `aaveRepayCondition` | [`AaveRepayCondition`](conditions.AaveRepayCondition.md) | -| `accessCondition` | [`AccessCondition`](conditions.AccessCondition.md) | -| `computeExecutionCondition` | [`ComputeExecutionCondition`](conditions.ComputeExecutionCondition.md) | -| `distributeNftCollateralCondition` | [`DistributeNFTCollateralCondition`](conditions.DistributeNFTCollateralCondition.md) | -| `escrowPaymentCondition` | [`EscrowPaymentCondition`](conditions.EscrowPaymentCondition.md) | -| `lockPaymentCondition` | [`LockPaymentCondition`](conditions.LockPaymentCondition.md) | -| `nft721HolderCondition` | [`NFT721HolderCondition`](conditions.NFT721HolderCondition.md) | -| `nft721LockCondition` | [`NFT721LockCondition`](conditions.NFT721LockCondition.md) | -| `nftAccessCondition` | [`NFTAccessCondition`](conditions.NFTAccessCondition.md) | -| `nftHolderCondition` | [`NFTHolderCondition`](conditions.NFTHolderCondition.md) | -| `nftLockCondition` | [`NFTLockCondition`](conditions.NFTLockCondition.md) | -| `transferDidOwnershipCondition` | [`TransferDIDOwnershipCondition`](conditions.TransferDIDOwnershipCondition.md) | -| `transferNft721Condition` | [`TransferNFT721Condition`](conditions.TransferNFT721Condition.md) | -| `transferNftCondition` | [`TransferNFTCondition`](conditions.TransferNFTCondition.md) | +| Name | Type | +| :--------------------------------- | :------------------------------------------------------------------------ | +| `aaveBorrowCondition` | [`AaveBorrowCondition`](AaveBorrowCondition.md) | +| `aaveCollateralDepositCondition` | [`AaveCollateralDepositCondition`](AaveCollateralDepositCondition.md) | +| `aaveCollateralWithdrawCondition` | [`AaveCollateralWithdrawCondition`](AaveCollateralWithdrawCondition.md) | +| `aaveRepayCondition` | [`AaveRepayCondition`](AaveRepayCondition.md) | +| `accessCondition` | [`AccessCondition`](AccessCondition.md) | +| `computeExecutionCondition` | [`ComputeExecutionCondition`](ComputeExecutionCondition.md) | +| `distributeNftCollateralCondition` | [`DistributeNFTCollateralCondition`](DistributeNFTCollateralCondition.md) | +| `escrowPaymentCondition` | [`EscrowPaymentCondition`](EscrowPaymentCondition.md) | +| `lockPaymentCondition` | [`LockPaymentCondition`](LockPaymentCondition.md) | +| `nft721HolderCondition` | [`NFT721HolderCondition`](NFT721HolderCondition.md) | +| `nft721LockCondition` | [`NFT721LockCondition`](NFT721LockCondition.md) | +| `nftAccessCondition` | [`NFTAccessCondition`](NFTAccessCondition.md) | +| `nftHolderCondition` | [`NFTHolderCondition`](NFTHolderCondition.md) | +| `nftLockCondition` | [`NFTLockCondition`](NFTLockCondition.md) | +| `transferDidOwnershipCondition` | [`TransferDIDOwnershipCondition`](TransferDIDOwnershipCondition.md) | +| `transferNft721Condition` | [`TransferNFT721Condition`](TransferNFT721Condition.md) | +| `transferNftCondition` | [`TransferNFTCondition`](TransferNFTCondition.md) | #### Defined in -[src/keeper/Keeper.ts:326](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/Keeper.ts#L326) +[src/keeper/Keeper.ts:278](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/Keeper.ts#L278) --- ### conditionsList -• **conditionsList**: [`ConditionSmall`](conditions.ConditionSmall.md)[] +• **conditionsList**: [`ConditionSmall`](ConditionSmall.md)[] #### Defined in -[src/keeper/Keeper.ts:346](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/Keeper.ts#L346) +[src/keeper/Keeper.ts:298](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/Keeper.ts#L298) --- @@ -160,31 +158,31 @@ Is connected to the correct network or not. #### Defined in -[src/keeper/Keeper.ts:281](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/Keeper.ts#L281) +[src/keeper/Keeper.ts:233](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/Keeper.ts#L233) --- ### didRegistry -• **didRegistry**: `default` +• **didRegistry**: [`DIDRegistry`](DIDRegistry.md) DID registry smart contract instance. #### Defined in -[src/keeper/Keeper.ts:301](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/Keeper.ts#L301) +[src/keeper/Keeper.ts:253](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/Keeper.ts#L253) --- ### dispenser -• **dispenser**: `default` +• **dispenser**: [`Dispenser`](Dispenser.md) Market smart contract instance. #### Defined in -[src/keeper/Keeper.ts:291](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/Keeper.ts#L291) +[src/keeper/Keeper.ts:243](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/Keeper.ts#L243) --- @@ -194,11 +192,11 @@ Market smart contract instance. #### Index signature -▪ [contractRef: `string`]: `ContractBase` & `any` +▪ [contractRef: `string`]: [`ContractBase`](ContractBase.md) & `any` #### Defined in -[src/keeper/Keeper.ts:392](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/Keeper.ts#L392) +[src/keeper/Keeper.ts:353](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/Keeper.ts#L353) --- @@ -210,26 +208,28 @@ Network id loaded from web3 #### Type declaration -| Name | Type | -| :-------- | :-------- | -| `id?` | `number` | -| `loading` | `boolean` | +| Name | Type | Description | +| :--------- | :-------- | :--------------------------------- | +| `chainId?` | `number` | chainId of the network | +| `loading` | `boolean` | True if keeper is still connecting | +| `name?` | `string` | Name of the network | +| `version?` | `string` | Version of the artifacts in use | #### Defined in -[src/keeper/Keeper.ts:385](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/Keeper.ts#L385) +[src/keeper/Keeper.ts:332](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/Keeper.ts#L332) --- ### nftUpgradeable -• **nftUpgradeable**: `NFT1155Upgradeable` +• **nftUpgradeable**: [`Nft1155Contract`](Nft1155Contract.md) NFT upgradeable smart contract instance. #### Defined in -[src/keeper/Keeper.ts:306](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/Keeper.ts#L306) +[src/keeper/Keeper.ts:258](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/Keeper.ts#L258) --- @@ -241,17 +241,17 @@ Nevermined Config smart contract instance. #### Defined in -[src/keeper/Keeper.ts:296](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/Keeper.ts#L296) +[src/keeper/Keeper.ts:248](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/Keeper.ts#L248) --- ### rewardsDistributor -• **rewardsDistributor**: `RewardsDistributor` +• **rewardsDistributor**: [`RewardsDistributor`](RewardsDistributor.md) #### Defined in -[src/keeper/Keeper.ts:368](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/Keeper.ts#L368) +[src/keeper/Keeper.ts:320](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/Keeper.ts#L320) --- @@ -261,36 +261,36 @@ Nevermined Config smart contract instance. #### Type declaration -| Name | Type | -| :--------- | :------------------ | -| `curve` | `CurveRoyalties` | -| `standard` | `StandardRoyalties` | +| Name | Type | +| :--------- | :------------------------------------------ | +| `curve` | [`CurveRoyalties`](CurveRoyalties.md) | +| `standard` | [`StandardRoyalties`](StandardRoyalties.md) | #### Defined in -[src/keeper/Keeper.ts:363](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/Keeper.ts#L363) +[src/keeper/Keeper.ts:315](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/Keeper.ts#L315) --- ### templateList -• **templateList**: `GenericAccess`[] +• **templateList**: [`GenericAccess`](../interfaces/GenericAccess.md)[] #### Defined in -[src/keeper/Keeper.ts:347](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/Keeper.ts#L347) +[src/keeper/Keeper.ts:299](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/Keeper.ts#L299) --- ### templateStoreManager -• **templateStoreManager**: `TemplateStoreManager` +• **templateStoreManager**: [`TemplateStoreManager`](TemplateStoreManager.md) Template store manager smart contract instance. #### Defined in -[src/keeper/Keeper.ts:311](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/Keeper.ts#L311) +[src/keeper/Keeper.ts:263](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/Keeper.ts#L263) --- @@ -302,32 +302,32 @@ Templates instances. #### Type declaration -| Name | Type | -| :------------------------------- | :------------------------------------------------------------------------------ | -| `aaveCreditTemplate` | [`AaveCreditTemplate`](templates.AaveCreditTemplate.md) | -| `accessTemplate` | [`AccessTemplate`](templates.AccessTemplate.md) | -| `didSalesTemplate` | [`DIDSalesTemplate`](templates.DIDSalesTemplate.md) | -| `escrowComputeExecutionTemplate` | [`EscrowComputeExecutionTemplate`](templates.EscrowComputeExecutionTemplate.md) | -| `nft721AccessTemplate` | [`NFT721AccessTemplate`](templates.NFT721AccessTemplate.md) | -| `nft721SalesTemplate` | [`NFT721SalesTemplate`](templates.NFT721SalesTemplate.md) | -| `nftAccessTemplate` | [`NFTAccessTemplate`](templates.NFTAccessTemplate.md) | -| `nftSalesTemplate` | [`NFTSalesTemplate`](templates.NFTSalesTemplate.md) | +| Name | Type | +| :------------------------------- | :-------------------------------------------------------------------- | +| `aaveCreditTemplate` | [`AaveCreditTemplate`](AaveCreditTemplate.md) | +| `accessTemplate` | [`AccessTemplate`](AccessTemplate.md) | +| `didSalesTemplate` | [`DIDSalesTemplate`](DIDSalesTemplate.md) | +| `escrowComputeExecutionTemplate` | [`EscrowComputeExecutionTemplate`](EscrowComputeExecutionTemplate.md) | +| `nft721AccessTemplate` | [`NFT721AccessTemplate`](NFT721AccessTemplate.md) | +| `nft721SalesTemplate` | [`NFT721SalesTemplate`](NFT721SalesTemplate.md) | +| `nftAccessTemplate` | [`NFTAccessTemplate`](NFTAccessTemplate.md) | +| `nftSalesTemplate` | [`NFTSalesTemplate`](NFTSalesTemplate.md) | #### Defined in -[src/keeper/Keeper.ts:352](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/Keeper.ts#L352) +[src/keeper/Keeper.ts:304](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/Keeper.ts#L304) --- ### token -• **token**: `default` +• **token**: [`Token`](Token.md) Nevermined Token smart contract instance. #### Defined in -[src/keeper/Keeper.ts:286](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/Keeper.ts#L286) +[src/keeper/Keeper.ts:238](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/Keeper.ts#L238) --- @@ -339,31 +339,37 @@ Helpers for contracts. #### Type declaration -| Name | Type | -| :------------- | :--------------------------------------- | -| `eventHandler` | [`EventHandler`](events.EventHandler.md) | +| Name | Type | +| :------------- | :-------------------------------- | +| `eventHandler` | [`EventHandler`](EventHandler.md) | #### Defined in -[src/keeper/Keeper.ts:373](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/Keeper.ts#L373) +[src/keeper/Keeper.ts:325](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/Keeper.ts#L325) ---- +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` -### version +#### Returns + +`string` -• **version**: `string` +#### Inherited from -Version of the artifacts in use +Instantiable.artifactsFolder #### Defined in -[src/keeper/Keeper.ts:380](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/Keeper.ts#L380) +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) -## Accessors +--- -### artifactsFolder +### circuitsFolder -• `Protected` `get` **artifactsFolder**(): `string` +• `Protected` `get` **circuitsFolder**(): `string` #### Returns @@ -371,21 +377,21 @@ Version of the artifacts in use #### Inherited from -Instantiable.artifactsFolder +Instantiable.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) --- ### config -• `Protected` `get` **config**(): [`Config`](Config.md) +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) #### Returns -[`Config`](Config.md) +[`NeverminedOptions`](NeverminedOptions.md) #### Inherited from @@ -393,17 +399,17 @@ Instantiable.config #### Defined in -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) --- ### instanceConfig -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) #### Returns -`InstantiableConfig` +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) #### Inherited from @@ -411,17 +417,17 @@ Instantiable.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) --- ### instantiableConfig -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) #### Returns -`InstantiableConfig` +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) #### Inherited from @@ -429,17 +435,17 @@ Instantiable.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) --- ### logger -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) +• `Protected` `get` **logger**(): `Logger` #### Returns -[`Logger`](utils.Logger.md) +`Logger` #### Inherited from @@ -447,7 +453,7 @@ Instantiable.logger #### Defined in -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) --- @@ -465,17 +471,17 @@ Instantiable.nevermined #### Defined in -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) --- ### web3 -• `Protected` `get` **web3**(): `JsonRpcProvider` +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` #### Returns -`JsonRpcProvider` +`JsonRpcProvider` \| `BrowserProvider` #### Inherited from @@ -483,83 +489,13 @@ Instantiable.web3 #### Defined in -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) ## Methods -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -Instantiable.addresses - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - ---- - -### 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](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - ---- - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -Instantiable.findSigner - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - ---- - ### getAccessTemplateByName -▸ **getAccessTemplateByName**(`name`): `GenericAccess` +▸ **getAccessTemplateByName**(`name`): [`GenericAccess`](../interfaces/GenericAccess.md) Returns a Access template by name. @@ -571,13 +507,13 @@ Returns a Access template by name. #### Returns -`GenericAccess` +[`GenericAccess`](../interfaces/GenericAccess.md) Agreement template instance. #### Defined in -[src/keeper/Keeper.ts:419](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/Keeper.ts#L419) +[src/keeper/Keeper.ts:417](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/Keeper.ts#L417) --- @@ -591,13 +527,13 @@ Agreement template instance. #### Defined in -[src/keeper/Keeper.ts:459](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/Keeper.ts#L459) +[src/keeper/Keeper.ts:430](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/Keeper.ts#L430) --- ### getConditionByAddress -▸ **getConditionByAddress**(`address`): [`ConditionSmall`](conditions.ConditionSmall.md) +▸ **getConditionByAddress**(`address`): [`ConditionSmall`](ConditionSmall.md) Returns a condition by address. @@ -609,13 +545,13 @@ Returns a condition by address. #### Returns -[`ConditionSmall`](conditions.ConditionSmall.md) +[`ConditionSmall`](ConditionSmall.md) Condition instance. #### Defined in -[src/keeper/Keeper.ts:399](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/Keeper.ts#L399) +[src/keeper/Keeper.ts:360](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/Keeper.ts#L360) --- @@ -633,7 +569,7 @@ Network ID. #### Defined in -[src/keeper/Keeper.ts:446](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/Keeper.ts#L446) +[src/keeper/Keeper.ts:388](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/Keeper.ts#L388) --- @@ -651,13 +587,31 @@ Network name. #### Defined in -[src/keeper/Keeper.ts:438](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/Keeper.ts#L438) +[src/keeper/Keeper.ts:377](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/Keeper.ts#L377) + +--- + +### getNetworkVersion + +▸ **getNetworkVersion**(): `string` + +Returns the network version. + +#### Returns + +`string` + +Network version. + +#### Defined in + +[src/keeper/Keeper.ts:405](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/Keeper.ts#L405) --- ### getTemplateByAddress -▸ **getTemplateByAddress**(`address`): [`AccessTemplate`](templates.AccessTemplate.md) \| [`EscrowComputeExecutionTemplate`](templates.EscrowComputeExecutionTemplate.md) \| [`DIDSalesTemplate`](templates.DIDSalesTemplate.md) \| [`NFTAccessTemplate`](templates.NFTAccessTemplate.md) \| [`NFT721AccessTemplate`](templates.NFT721AccessTemplate.md) \| [`NFTSalesTemplate`](templates.NFTSalesTemplate.md) \| [`NFT721SalesTemplate`](templates.NFT721SalesTemplate.md) \| [`AaveCreditTemplate`](templates.AaveCreditTemplate.md) +▸ **getTemplateByAddress**(`address`): [`AccessTemplate`](AccessTemplate.md) \| [`EscrowComputeExecutionTemplate`](EscrowComputeExecutionTemplate.md) \| [`DIDSalesTemplate`](DIDSalesTemplate.md) \| [`NFTAccessTemplate`](NFTAccessTemplate.md) \| [`NFT721AccessTemplate`](NFT721AccessTemplate.md) \| [`NFTSalesTemplate`](NFTSalesTemplate.md) \| [`NFT721SalesTemplate`](NFT721SalesTemplate.md) \| [`AaveCreditTemplate`](AaveCreditTemplate.md) Returns a template by address. @@ -669,19 +623,19 @@ Returns a template by address. #### Returns -[`AccessTemplate`](templates.AccessTemplate.md) \| [`EscrowComputeExecutionTemplate`](templates.EscrowComputeExecutionTemplate.md) \| [`DIDSalesTemplate`](templates.DIDSalesTemplate.md) \| [`NFTAccessTemplate`](templates.NFTAccessTemplate.md) \| [`NFT721AccessTemplate`](templates.NFT721AccessTemplate.md) \| [`NFTSalesTemplate`](templates.NFTSalesTemplate.md) \| [`NFT721SalesTemplate`](templates.NFT721SalesTemplate.md) \| [`AaveCreditTemplate`](templates.AaveCreditTemplate.md) +[`AccessTemplate`](AccessTemplate.md) \| [`EscrowComputeExecutionTemplate`](EscrowComputeExecutionTemplate.md) \| [`DIDSalesTemplate`](DIDSalesTemplate.md) \| [`NFTAccessTemplate`](NFTAccessTemplate.md) \| [`NFT721AccessTemplate`](NFT721AccessTemplate.md) \| [`NFTSalesTemplate`](NFTSalesTemplate.md) \| [`NFT721SalesTemplate`](NFT721SalesTemplate.md) \| [`AaveCreditTemplate`](AaveCreditTemplate.md) Agreement template instance. #### Defined in -[src/keeper/Keeper.ts:428](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/Keeper.ts#L428) +[src/keeper/Keeper.ts:426](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/Keeper.ts#L426) --- ### getTemplateByName -▸ **getTemplateByName**(`name`): [`AccessTemplate`](templates.AccessTemplate.md) \| [`EscrowComputeExecutionTemplate`](templates.EscrowComputeExecutionTemplate.md) \| [`DIDSalesTemplate`](templates.DIDSalesTemplate.md) \| [`NFTAccessTemplate`](templates.NFTAccessTemplate.md) \| [`NFT721AccessTemplate`](templates.NFT721AccessTemplate.md) \| [`NFTSalesTemplate`](templates.NFTSalesTemplate.md) \| [`NFT721SalesTemplate`](templates.NFT721SalesTemplate.md) \| [`AaveCreditTemplate`](templates.AaveCreditTemplate.md) +▸ **getTemplateByName**(`name`): [`AccessTemplate`](AccessTemplate.md) \| [`EscrowComputeExecutionTemplate`](EscrowComputeExecutionTemplate.md) \| [`DIDSalesTemplate`](DIDSalesTemplate.md) \| [`NFTAccessTemplate`](NFTAccessTemplate.md) \| [`NFT721AccessTemplate`](NFT721AccessTemplate.md) \| [`NFTSalesTemplate`](NFTSalesTemplate.md) \| [`NFT721SalesTemplate`](NFT721SalesTemplate.md) \| [`AaveCreditTemplate`](AaveCreditTemplate.md) Returns a template by name. @@ -693,13 +647,13 @@ Returns a template by name. #### Returns -[`AccessTemplate`](templates.AccessTemplate.md) \| [`EscrowComputeExecutionTemplate`](templates.EscrowComputeExecutionTemplate.md) \| [`DIDSalesTemplate`](templates.DIDSalesTemplate.md) \| [`NFTAccessTemplate`](templates.NFTAccessTemplate.md) \| [`NFT721AccessTemplate`](templates.NFT721AccessTemplate.md) \| [`NFTSalesTemplate`](templates.NFTSalesTemplate.md) \| [`NFT721SalesTemplate`](templates.NFT721SalesTemplate.md) \| [`AaveCreditTemplate`](templates.AaveCreditTemplate.md) +[`AccessTemplate`](AccessTemplate.md) \| [`EscrowComputeExecutionTemplate`](EscrowComputeExecutionTemplate.md) \| [`DIDSalesTemplate`](DIDSalesTemplate.md) \| [`NFTAccessTemplate`](NFTAccessTemplate.md) \| [`NFT721AccessTemplate`](NFT721AccessTemplate.md) \| [`NFTSalesTemplate`](NFTSalesTemplate.md) \| [`NFT721SalesTemplate`](NFT721SalesTemplate.md) \| [`AaveCreditTemplate`](AaveCreditTemplate.md) Agreement template instance. #### Defined in -[src/keeper/Keeper.ts:408](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/Keeper.ts#L408) +[src/keeper/Keeper.ts:369](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/Keeper.ts#L369) --- @@ -713,82 +667,59 @@ Agreement template instance. #### Defined in -[src/keeper/Keeper.ts:74](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/Keeper.ts#L74) +[src/keeper/Keeper.ts:68](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/Keeper.ts#L68) --- -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters +### loadAaveInstances -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | +▸ **loadAaveInstances**(): `Promise`<[`Keeper`](Keeper.md)\> #### Returns -`void` - -#### Inherited from - -Instantiable.setInstanceConfig +`Promise`<[`Keeper`](Keeper.md)\> #### Defined in -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) +[src/keeper/Keeper.ts:434](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/Keeper.ts#L434) --- -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> +### loadCurveRoyaltiesInstance -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | +▸ **loadCurveRoyaltiesInstance**(): `Promise`<[`CurveRoyalties`](CurveRoyalties.md)\> #### Returns -`Promise`<`string`[]\> - -#### Inherited from - -Instantiable.addressesStatic +`Promise`<[`CurveRoyalties`](CurveRoyalties.md)\> #### Defined in -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) +[src/keeper/Keeper.ts:457](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/Keeper.ts#L457) --- -### findSignerStatic +### setInstanceConfig -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> +▸ `Protected` **setInstanceConfig**(`config`): `void` #### Parameters -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns -`Promise`<`Signer`\> +`void` #### Inherited from -Instantiable.findSignerStatic +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig) #### Defined in -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) --- @@ -800,9 +731,9 @@ Returns Keeper instance. #### Parameters -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -812,11 +743,11 @@ Returns Keeper instance. #### Overrides -Instantiable.getInstance +[Instantiable](Instantiable.md).[getInstance](Instantiable.md#getinstance) #### Defined in -[src/keeper/Keeper.ts:68](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/Keeper.ts#L68) +[src/keeper/Keeper.ts:62](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/Keeper.ts#L62) --- @@ -826,16 +757,16 @@ Instantiable.getInstance #### Type parameters -| Name | Type | -| :--- | :--------------------------- | -| `T` | extends `Instantiable`<`T`\> | +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :------------------- | -| `instance` | `T` | -| `instantiableConfig` | `InstantiableConfig` | +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -843,8 +774,8 @@ Instantiable.getInstance #### Inherited from -Instantiable.setInstanceConfig +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig-1) #### Defined in -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/KeeperError.md b/docs/api-reference/classes/KeeperError.md new file mode 100644 index 000000000..0379a410a --- /dev/null +++ b/docs/api-reference/classes/KeeperError.md @@ -0,0 +1,165 @@ +[@nevermined-io/sdk](../code-reference.md) / KeeperError + +# Class: KeeperError + +## Hierarchy + +- `Error` + + ↳ **`KeeperError`** + +## Table of contents + +### Constructors + +- [constructor](KeeperError.md#constructor) + +### Properties + +- [message](KeeperError.md#message) +- [name](KeeperError.md#name) +- [stack](KeeperError.md#stack) +- [prepareStackTrace](KeeperError.md#preparestacktrace) +- [stackTraceLimit](KeeperError.md#stacktracelimit) + +### Methods + +- [captureStackTrace](KeeperError.md#capturestacktrace) + +## Constructors + +### constructor + +• **new KeeperError**(`message`) + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `message` | `string` | + +#### Overrides + +Error.constructor + +#### Defined in + +[src/errors/KeeperError.ts:2](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/errors/KeeperError.ts#L2) + +## Properties + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1068 + +--- + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1067 + +--- + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1069 + +--- + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +Optional override for formatting stack traces + +##### Parameters + +| Name | Type | +| :------------ | :----------- | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:11 + +--- + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:13 + +## Methods + +### captureStackTrace + +▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :---------------- | :--------- | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:4 diff --git a/docs/api-reference/classes/LockPaymentCondition.md b/docs/api-reference/classes/LockPaymentCondition.md new file mode 100644 index 000000000..2211f9d76 --- /dev/null +++ b/docs/api-reference/classes/LockPaymentCondition.md @@ -0,0 +1,949 @@ +[@nevermined-io/sdk](../code-reference.md) / LockPaymentCondition + +# Class: LockPaymentCondition + +## Hierarchy + +- [`ConsumerCondition`](ConsumerCondition.md)<[`ConditionContext`](../interfaces/ConditionContext.md)\> + + ↳ **`LockPaymentCondition`** + +## Table of contents + +### Constructors + +- [constructor](LockPaymentCondition.md#constructor) + +### Properties + +- [address](LockPaymentCondition.md#address) +- [contract](LockPaymentCondition.md#contract) +- [contractName](LockPaymentCondition.md#contractname) +- [events](LockPaymentCondition.md#events) +- [version](LockPaymentCondition.md#version) + +### Accessors + +- [artifactsFolder](LockPaymentCondition.md#artifactsfolder) +- [circuitsFolder](LockPaymentCondition.md#circuitsfolder) +- [config](LockPaymentCondition.md#config) +- [instanceConfig](LockPaymentCondition.md#instanceconfig) +- [instantiableConfig](LockPaymentCondition.md#instantiableconfig) +- [logger](LockPaymentCondition.md#logger) +- [nevermined](LockPaymentCondition.md#nevermined) +- [web3](LockPaymentCondition.md#web3) + +### Methods + +- [abortByTimeOut](LockPaymentCondition.md#abortbytimeout) +- [call](LockPaymentCondition.md#call) +- [fulfill](LockPaymentCondition.md#fulfill) +- [fulfillInstance](LockPaymentCondition.md#fulfillinstance) +- [fulfillPlain](LockPaymentCondition.md#fulfillplain) +- [fulfillWithNode](LockPaymentCondition.md#fulfillwithnode) +- [generateId](LockPaymentCondition.md#generateid) +- [generateIdHash](LockPaymentCondition.md#generateidhash) +- [generateIdWithSeed](LockPaymentCondition.md#generateidwithseed) +- [getConditionFulfilledEvent](LockPaymentCondition.md#getconditionfulfilledevent) +- [getFromAddress](LockPaymentCondition.md#getfromaddress) +- [getInputsOfMethod](LockPaymentCondition.md#getinputsofmethod) +- [getSignatureOfMethod](LockPaymentCondition.md#getsignatureofmethod) +- [hashValues](LockPaymentCondition.md#hashvalues) +- [hashValuesPlain](LockPaymentCondition.md#hashvaluesplain) +- [init](LockPaymentCondition.md#init) +- [instance](LockPaymentCondition.md#instance) +- [instanceFromDDO](LockPaymentCondition.md#instancefromddo) +- [params](LockPaymentCondition.md#params) +- [paramsFromDDO](LockPaymentCondition.md#paramsfromddo) +- [send](LockPaymentCondition.md#send) +- [sendFrom](LockPaymentCondition.md#sendfrom) +- [setInstanceConfig](LockPaymentCondition.md#setinstanceconfig) +- [getInstance](LockPaymentCondition.md#getinstance) +- [setInstanceConfig](LockPaymentCondition.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new LockPaymentCondition**(`contractName`) + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[constructor](ConsumerCondition.md#constructor) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L34) + +## Properties + +### address + +• **address**: `string` + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[address](ConsumerCondition.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[contract](ConsumerCondition.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[contractName](ConsumerCondition.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[events](ConsumerCondition.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[version](ConsumerCondition.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ConsumerCondition.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ConsumerCondition.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +ConsumerCondition.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ConsumerCondition.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ConsumerCondition.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +ConsumerCondition.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +ConsumerCondition.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +ConsumerCondition.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### abortByTimeOut + +▸ **abortByTimeOut**(`conditionId`, `from?`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------------ | :---------------------------------------------- | +| `conditionId` | `string` | +| `from?` | [`Account`](Account.md) | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[abortByTimeOut](ConsumerCondition.md#abortbytimeout) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L88) + +--- + +### 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 + +[ConsumerCondition](ConsumerCondition.md).[call](ConsumerCondition.md#call) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### fulfill + +▸ **fulfill**(`agreementId`, `did`, `rewardAddress`, `tokenAddress`, `amounts`, `receivers`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :-------------- | :---------------------------------------------- | +| `agreementId` | `string` | +| `did` | `string` | +| `rewardAddress` | `string` | +| `tokenAddress` | `string` | +| `amounts` | `bigint`[] | +| `receivers` | `string`[] | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Overrides + +[ConsumerCondition](ConsumerCondition.md).[fulfill](ConsumerCondition.md#fulfill) + +#### Defined in + +[src/keeper/contracts/conditions/LockPaymentCondition.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/LockPaymentCondition.ts#L42) + +--- + +### fulfillInstance + +▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `txParams?`, `method?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | Default value | +| :----------------- | :----------------------------------------------------------------------------------------- | :------------ | +| `cond` | [`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | +| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | +| `from?` | [`Account`](Account.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[fulfillInstance](ConsumerCondition.md#fulfillinstance) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:150](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L150) + +--- + +### fulfillPlain + +▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `txParams?`, `method?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | Default value | +| :------------ | :-------------------------------------------------------- | :------------ | +| `agreementId` | `string` | `undefined` | +| `args` | `any`[] | `undefined` | +| `from?` | [`Account`](Account.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[fulfillPlain](ConsumerCondition.md#fulfillplain) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L63) + +--- + +### fulfillWithNode + +▸ **fulfillWithNode**(`_cond`, `_additionalParams`, `_from?`, `_txParams?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------------ | :----------------------------------------------------------------------------------------- | +| `_cond` | [`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | +| `_additionalParams` | `Record`<`string`, `unknown`\> | +| `_from?` | [`Account`](Account.md) | +| `_txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[fulfillWithNode](ConsumerCondition.md#fulfillwithnode) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:217](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L217) + +--- + +### generateId + +▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `valueHash` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[generateId](ConsumerCondition.md#generateid) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L77) + +--- + +### generateIdHash + +▸ **generateIdHash**(`agreementId`, `...values`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `...values` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[generateIdHash](ConsumerCondition.md#generateidhash) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L73) + +--- + +### generateIdWithSeed + +▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `valueHash` | `string` | + +#### Returns + +`Promise`<[`string`, `string`]\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[generateIdWithSeed](ConsumerCondition.md#generateidwithseed) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L81) + +--- + +### getConditionFulfilledEvent + +▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../code-reference.md#eventresult) + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | + +#### Returns + +[`EventResult`](../code-reference.md#eventresult) + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[getConditionFulfilledEvent](ConsumerCondition.md#getconditionfulfilledevent) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L92) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[getFromAddress](ConsumerCondition.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[getInputsOfMethod](ConsumerCondition.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[getSignatureOfMethod](ConsumerCondition.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### hashValues + +▸ **hashValues**(`...args`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[hashValues](ConsumerCondition.md#hashvalues) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L129) + +--- + +### hashValuesPlain + +▸ **hashValuesPlain**(`...args`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[hashValuesPlain](ConsumerCondition.md#hashvaluesplain) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:133](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L133) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[init](ConsumerCondition.md#init) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### instance + +▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :------------ | :--------------------------------------------------------------------------------------------- | +| `agreementId` | `string` | +| `params` | [`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | + +#### Returns + +`Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[instance](ConsumerCondition.md#instance) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:174](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L174) + +--- + +### instanceFromDDO + +▸ **instanceFromDDO**(`agreementId`, `ctx`, `...args`): `Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------------------------------------------- | +| `agreementId` | `string` | +| `ctx` | [`ConditionContext`](../interfaces/ConditionContext.md) | +| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | + +#### Returns + +`Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[instanceFromDDO](ConsumerCondition.md#instancefromddo) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L142) + +--- + +### params + +▸ **params**(`did`, `rewardAddress`, `tokenAddress`, `amounts`, `receivers`): [`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> + +#### Parameters + +| Name | Type | +| :-------------- | :--------- | +| `did` | `string` | +| `rewardAddress` | `string` | +| `tokenAddress` | `string` | +| `amounts` | `bigint`[] | +| `receivers` | `string`[] | + +#### Returns + +[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> + +#### Overrides + +[ConsumerCondition](ConsumerCondition.md).[params](ConsumerCondition.md#params) + +#### Defined in + +[src/keeper/contracts/conditions/LockPaymentCondition.ts:13](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/LockPaymentCondition.ts#L13) + +--- + +### paramsFromDDO + +▸ **paramsFromDDO**(`«destructured»`): `Promise`<[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :--------------- | :------------------------------------------------------ | +| `«destructured»` | [`ConditionContext`](../interfaces/ConditionContext.md) | + +#### Returns + +`Promise`<[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> + +#### Overrides + +[ConsumerCondition](ConsumerCondition.md).[paramsFromDDO](ConsumerCondition.md#paramsfromddo) + +#### Defined in + +[src/keeper/contracts/conditions/LockPaymentCondition.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/LockPaymentCondition.ts#L31) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[send](ConsumerCondition.md#send) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[sendFrom](ConsumerCondition.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[setInstanceConfig](ConsumerCondition.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`): `Promise`<[`LockPaymentCondition`](LockPaymentCondition.md)\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`Promise`<[`LockPaymentCondition`](LockPaymentCondition.md)\> + +#### Overrides + +[ConsumerCondition](ConsumerCondition.md).[getInstance](ConsumerCondition.md#getinstance) + +#### Defined in + +[src/keeper/contracts/conditions/LockPaymentCondition.ts:9](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/LockPaymentCondition.ts#L9) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[setInstanceConfig](ConsumerCondition.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/MarketplaceApi.md b/docs/api-reference/classes/MarketplaceApi.md new file mode 100644 index 000000000..0f0c40a1f --- /dev/null +++ b/docs/api-reference/classes/MarketplaceApi.md @@ -0,0 +1,340 @@ +[@nevermined-io/sdk](../code-reference.md) / MarketplaceApi + +# Class: MarketplaceApi + +## Hierarchy + +- [`Instantiable`](Instantiable.md) + + ↳ **`MarketplaceApi`** + + ↳↳ [`Bookmarks`](Bookmarks.md) + + ↳↳ [`MetadataService`](MetadataService.md) + + ↳↳ [`Permissions`](Permissions.md) + + ↳↳ [`Profiles`](Profiles.md) + +## Table of contents + +### Constructors + +- [constructor](MarketplaceApi.md#constructor) + +### Accessors + +- [artifactsFolder](MarketplaceApi.md#artifactsfolder) +- [circuitsFolder](MarketplaceApi.md#circuitsfolder) +- [config](MarketplaceApi.md#config) +- [instanceConfig](MarketplaceApi.md#instanceconfig) +- [instantiableConfig](MarketplaceApi.md#instantiableconfig) +- [logger](MarketplaceApi.md#logger) +- [nevermined](MarketplaceApi.md#nevermined) +- [url](MarketplaceApi.md#url) +- [web3](MarketplaceApi.md#web3) + +### Methods + +- [addNewAddress](MarketplaceApi.md#addnewaddress) +- [login](MarketplaceApi.md#login) +- [setInstanceConfig](MarketplaceApi.md#setinstanceconfig) +- [getInstance](MarketplaceApi.md#getinstance) +- [setInstanceConfig](MarketplaceApi.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new MarketplaceApi**(`config`) + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Overrides + +[Instantiable](Instantiable.md).[constructor](Instantiable.md#constructor) + +#### Defined in + +[src/services/metadata/MarketplaceAPI.ts:7](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MarketplaceAPI.ts#L7) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +Instantiable.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +Instantiable.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +Instantiable.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### url + +• `Protected` `get` **url**(): `string` + +#### Returns + +`string` + +#### Defined in + +[src/services/metadata/MarketplaceAPI.ts:12](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MarketplaceAPI.ts#L12) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +Instantiable.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### addNewAddress + +▸ **addNewAddress**(`clientAssertion`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :---------------- | :------- | +| `clientAssertion` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/services/metadata/MarketplaceAPI.ts:36](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MarketplaceAPI.ts#L36) + +--- + +### login + +▸ **login**(`clientAssertion`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :---------------- | :------- | +| `clientAssertion` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/services/metadata/MarketplaceAPI.ts:16](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MarketplaceAPI.ts#L16) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### getInstance + +▸ `Static` **getInstance**(`..._args`): `any` + +#### Parameters + +| Name | Type | +| :--------- | :---- | +| `..._args` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[Instantiable](Instantiable.md).[getInstance](Instantiable.md#getinstance) + +#### Defined in + +[src/Instantiable.abstract.ts:86](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L86) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/MetadataService.md b/docs/api-reference/classes/MetadataService.md new file mode 100644 index 000000000..04af128dd --- /dev/null +++ b/docs/api-reference/classes/MetadataService.md @@ -0,0 +1,671 @@ +[@nevermined-io/sdk](../code-reference.md) / MetadataService + +# Class: MetadataService + +Provides a interface with Metadata. +Metadata provides an off-chain database store for metadata about data assets. + +## Hierarchy + +- [`MarketplaceApi`](MarketplaceApi.md) + + ↳ **`MetadataService`** + +## Table of contents + +### Constructors + +- [constructor](MetadataService.md#constructor) + +### Accessors + +- [artifactsFolder](MetadataService.md#artifactsfolder) +- [circuitsFolder](MetadataService.md#circuitsfolder) +- [config](MetadataService.md#config) +- [instanceConfig](MetadataService.md#instanceconfig) +- [instantiableConfig](MetadataService.md#instantiableconfig) +- [logger](MetadataService.md#logger) +- [nevermined](MetadataService.md#nevermined) +- [url](MetadataService.md#url) +- [web3](MetadataService.md#web3) + +### Methods + +- [addNewAddress](MetadataService.md#addnewaddress) +- [delete](MetadataService.md#delete) +- [getAccessUrl](MetadataService.md#getaccessurl) +- [getServiceEndpoint](MetadataService.md#getserviceendpoint) +- [getVersionInfo](MetadataService.md#getversioninfo) +- [login](MetadataService.md#login) +- [queryMetadata](MetadataService.md#querymetadata) +- [queryServiceMetadata](MetadataService.md#queryservicemetadata) +- [retrieveDDO](MetadataService.md#retrieveddo) +- [retrieveDDOByUrl](MetadataService.md#retrieveddobyurl) +- [retrieveDDOFromImmutableBackend](MetadataService.md#retrieveddofromimmutablebackend) +- [retrieveService](MetadataService.md#retrieveservice) +- [setInstanceConfig](MetadataService.md#setinstanceconfig) +- [status](MetadataService.md#status) +- [storeDDO](MetadataService.md#storeddo) +- [storeService](MetadataService.md#storeservice) +- [updateDDO](MetadataService.md#updateddo) +- [getInstance](MetadataService.md#getinstance) +- [setInstanceConfig](MetadataService.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new MetadataService**(`config`) + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Inherited from + +[MarketplaceApi](MarketplaceApi.md).[constructor](MarketplaceApi.md#constructor) + +#### Defined in + +[src/services/metadata/MarketplaceAPI.ts:7](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MarketplaceAPI.ts#L7) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +MarketplaceApi.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +MarketplaceApi.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +MarketplaceApi.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +MarketplaceApi.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +MarketplaceApi.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +MarketplaceApi.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +MarketplaceApi.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### url + +• `Protected` `get` **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +MarketplaceApi.url + +#### Defined in + +[src/services/metadata/MarketplaceAPI.ts:12](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MarketplaceAPI.ts#L12) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +MarketplaceApi.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### addNewAddress + +▸ **addNewAddress**(`clientAssertion`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :---------------- | :------- | +| `clientAssertion` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[MarketplaceApi](MarketplaceApi.md).[addNewAddress](MarketplaceApi.md#addnewaddress) + +#### Defined in + +[src/services/metadata/MarketplaceAPI.ts:36](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MarketplaceAPI.ts#L36) + +--- + +### delete + +▸ **delete**(`did`): `Promise`<`Response`\> + +#### Parameters + +| Name | Type | +| :---- | :-------------------------- | +| `did` | `string` \| [`DID`](DID.md) | + +#### Returns + +`Promise`<`Response`\> + +#### Defined in + +[src/services/metadata/MetadataService.ts:240](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MetadataService.ts#L240) + +--- + +### getAccessUrl + +▸ **getAccessUrl**(`accessToken`, `payload`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :---- | +| `accessToken` | `any` | +| `payload` | `any` | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/services/metadata/MetadataService.ts:46](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MetadataService.ts#L46) + +--- + +### getServiceEndpoint + +▸ **getServiceEndpoint**(`did`): `string` + +#### Parameters + +| Name | Type | +| :---- | :-------------- | +| `did` | [`DID`](DID.md) | + +#### Returns + +`string` + +#### Defined in + +[src/services/metadata/MetadataService.ts:356](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MetadataService.ts#L356) + +--- + +### getVersionInfo + +▸ **getVersionInfo**(): `Promise`<`any`\> + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +[src/services/metadata/MetadataService.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MetadataService.ts#L42) + +--- + +### login + +▸ **login**(`clientAssertion`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :---------------- | :------- | +| `clientAssertion` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[MarketplaceApi](MarketplaceApi.md).[login](MarketplaceApi.md#login) + +#### Defined in + +[src/services/metadata/MarketplaceAPI.ts:16](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MarketplaceAPI.ts#L16) + +--- + +### queryMetadata + +▸ **queryMetadata**(`query`): `Promise`<[`QueryResult`](../interfaces/QueryResult.md)\> + +Search over the DDOs using a query. + +#### Parameters + +| Name | Type | Description | +| :------ | :-------------------------------------------- | :------------------------ | +| `query` | [`SearchQuery`](../interfaces/SearchQuery.md) | Query to filter the DDOs. | + +#### Returns + +`Promise`<[`QueryResult`](../interfaces/QueryResult.md)\> + +A list of [QueryResult](../interfaces/QueryResult.md)s. + +#### Defined in + +[src/services/metadata/MetadataService.ts:74](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MetadataService.ts#L74) + +--- + +### queryServiceMetadata + +▸ **queryServiceMetadata**(`query`): `Promise`<[`ServiceSecondary`](../interfaces/ServiceSecondary.md)[]\> + +Search over the Services using a query. + +#### Parameters + +| Name | Type | Description | +| :------ | :------- | :---------------------------- | +| `query` | `Object` | Query to filter the Services. | + +#### Returns + +`Promise`<[`ServiceSecondary`](../interfaces/ServiceSecondary.md)[]\> + +A list of [ServiceSecondary](../interfaces/ServiceSecondary.md). + +#### Defined in + +[src/services/metadata/MetadataService.ts:106](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MetadataService.ts#L106) + +--- + +### retrieveDDO + +▸ **retrieveDDO**(`did?`, `metadataServiceEndpoint?`): `Promise`<[`DDO`](DDO.md)\> + +Retrieves a DDO by DID. + +#### Parameters + +| Name | Type | Description | +| :------------------------- | :-------------------------- | :------------------------- | +| `did?` | `string` \| [`DID`](DID.md) | DID of the asset. | +| `metadataServiceEndpoint?` | `string` | Metadata service endpoint. | + +#### Returns + +`Promise`<[`DDO`](DDO.md)\> + +DDO of the asset. + +#### Defined in + +[src/services/metadata/MetadataService.ts:196](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MetadataService.ts#L196) + +--- + +### retrieveDDOByUrl + +▸ **retrieveDDOByUrl**(`metadataServiceEndpoint?`): `Promise`<[`DDO`](DDO.md)\> + +#### Parameters + +| Name | Type | +| :------------------------- | :------- | +| `metadataServiceEndpoint?` | `string` | + +#### Returns + +`Promise`<[`DDO`](DDO.md)\> + +#### Defined in + +[src/services/metadata/MetadataService.ts:252](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MetadataService.ts#L252) + +--- + +### retrieveDDOFromImmutableBackend + +▸ **retrieveDDOFromImmutableBackend**(`immutableUrl`): `Promise`<[`DDO`](DDO.md)\> + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `immutableUrl` | `string` | + +#### Returns + +`Promise`<[`DDO`](DDO.md)\> + +#### Defined in + +[src/services/metadata/MetadataService.ts:229](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MetadataService.ts#L229) + +--- + +### retrieveService + +▸ **retrieveService**(`agreementId`, `metadataServiceEndpoint?`): `Promise`<[`ServiceSecondary`](../interfaces/ServiceSecondary.md)\> + +Retrieves a service by its agreementId. + +#### Parameters + +| Name | Type | Description | +| :------------------------- | :------- | :-------------------------- | +| `agreementId` | `string` | agreementId of the service. | +| `metadataServiceEndpoint?` | `string` | - | + +#### Returns + +`Promise`<[`ServiceSecondary`](../interfaces/ServiceSecondary.md)\> + +Service object. + +#### Defined in + +[src/services/metadata/MetadataService.ts:291](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MetadataService.ts#L291) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[MarketplaceApi](MarketplaceApi.md).[setInstanceConfig](MarketplaceApi.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### status + +▸ **status**(`did`, `metadataServiceEndpoint?`): `Promise`<[`DDOStatus`](../interfaces/DDOStatus.md)\> + +Retrieves a DDO by DID. + +#### Parameters + +| Name | Type | Description | +| :------------------------- | :-------------------------- | :---------------- | +| `did` | `string` \| [`DID`](DID.md) | DID of the asset. | +| `metadataServiceEndpoint?` | `string` | - | + +#### Returns + +`Promise`<[`DDOStatus`](../interfaces/DDOStatus.md)\> + +DDO of the asset. + +#### Defined in + +[src/services/metadata/MetadataService.ts:261](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MetadataService.ts#L261) + +--- + +### storeDDO + +▸ **storeDDO**(`ddo`): `Promise`<[`DDO`](DDO.md)\> + +Stores a DDO in Metadata. + +#### Parameters + +| Name | Type | Description | +| :---- | :-------------- | :---------------- | +| `ddo` | [`DDO`](DDO.md) | DDO to be stored. | + +#### Returns + +`Promise`<[`DDO`](DDO.md)\> + +Final DDO. + +#### Defined in + +[src/services/metadata/MetadataService.ts:164](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MetadataService.ts#L164) + +--- + +### storeService + +▸ **storeService**(`agreementId`, `agreement`): `Promise`<[`ServiceSecondary`](../interfaces/ServiceSecondary.md)\> + +#### Parameters + +| Name | Type | Description | +| :------------ | :------------------------------------------------------ | :--------------------------------------------- | +| `agreementId` | `string` | The agreement ID of the service. | +| `agreement` | [`ServiceSecondary`](../interfaces/ServiceSecondary.md) | Stores the Service object with its agreementId | + +#### Returns + +`Promise`<[`ServiceSecondary`](../interfaces/ServiceSecondary.md)\> + +the newly stored service object + +#### Defined in + +[src/services/metadata/MetadataService.ts:324](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MetadataService.ts#L324) + +--- + +### updateDDO + +▸ **updateDDO**(`did`, `ddo`): `Promise`<[`DDO`](DDO.md)\> + +Update a DDO in Metadata. + +#### Parameters + +| Name | Type | Description | +| :---- | :-------------------------- | :---------------- | +| `did` | `string` \| [`DID`](DID.md) | - | +| `ddo` | [`DDO`](DDO.md) | DDO to be stored. | + +#### Returns + +`Promise`<[`DDO`](DDO.md)\> + +Final DDO. + +#### Defined in + +[src/services/metadata/MetadataService.ts:132](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MetadataService.ts#L132) + +--- + +### getInstance + +▸ `Static` **getInstance**(`..._args`): `any` + +#### Parameters + +| Name | Type | +| :--------- | :---- | +| `..._args` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[MarketplaceApi](MarketplaceApi.md).[getInstance](MarketplaceApi.md#getinstance) + +#### Defined in + +[src/Instantiable.abstract.ts:86](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L86) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[MarketplaceApi](MarketplaceApi.md).[setInstanceConfig](MarketplaceApi.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/KeyTransfer.MimcCipher.md b/docs/api-reference/classes/MimcCipher.md similarity index 58% rename from docs/api-reference/classes/KeyTransfer.MimcCipher.md rename to docs/api-reference/classes/MimcCipher.md index 5f57f8926..328b4a152 100644 --- a/docs/api-reference/classes/KeyTransfer.MimcCipher.md +++ b/docs/api-reference/classes/MimcCipher.md @@ -1,23 +1,21 @@ -[@nevermined-io/sdk](../code-reference.md) / [KeyTransfer](../modules/KeyTransfer.md) / MimcCipher +[@nevermined-io/sdk](../code-reference.md) / MimcCipher # Class: MimcCipher -[KeyTransfer](../modules/KeyTransfer.md).MimcCipher - ## Table of contents ### Constructors -- [constructor](KeyTransfer.MimcCipher.md#constructor) +- [constructor](MimcCipher.md#constructor) ### Properties -- [x](KeyTransfer.MimcCipher.md#x) -- [y](KeyTransfer.MimcCipher.md#y) +- [x](MimcCipher.md#x) +- [y](MimcCipher.md#y) ### Methods -- [param](KeyTransfer.MimcCipher.md#param) +- [param](MimcCipher.md#param) ## Constructors @@ -34,7 +32,7 @@ #### Defined in -[src/models/KeyTransfer.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/KeyTransfer.ts#L23) +[src/models/KeyTransfer.ts:23](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/KeyTransfer.ts#L23) ## Properties @@ -44,7 +42,7 @@ #### Defined in -[src/models/KeyTransfer.ts:20](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/KeyTransfer.ts#L20) +[src/models/KeyTransfer.ts:20](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/KeyTransfer.ts#L20) --- @@ -54,7 +52,7 @@ #### Defined in -[src/models/KeyTransfer.ts:21](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/KeyTransfer.ts#L21) +[src/models/KeyTransfer.ts:21](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/KeyTransfer.ts#L21) ## Methods @@ -68,4 +66,4 @@ #### Defined in -[src/models/KeyTransfer.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/KeyTransfer.ts#L28) +[src/models/KeyTransfer.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/KeyTransfer.ts#L28) diff --git a/docs/api-reference/classes/NFT1155Api.md b/docs/api-reference/classes/NFT1155Api.md new file mode 100644 index 000000000..918cb9965 --- /dev/null +++ b/docs/api-reference/classes/NFT1155Api.md @@ -0,0 +1,1598 @@ +[@nevermined-io/sdk](../code-reference.md) / NFT1155Api + +# Class: NFT1155Api + +Allows the interaction with external ERC-1155 NFT contracts built on top of the Nevermined NFT extra features. + +## Hierarchy + +- [`NFTsBaseApi`](NFTsBaseApi.md) + + ↳ **`NFT1155Api`** + + ↳↳ [`SubscriptionCreditsNFTApi`](SubscriptionCreditsNFTApi.md) + +## Table of contents + +### Constructors + +- [constructor](NFT1155Api.md#constructor) + +### Properties + +- [nftContract](NFT1155Api.md#nftcontract) +- [servicePlugin](NFT1155Api.md#serviceplugin) + +### Accessors + +- [address](NFT1155Api.md#address) +- [artifactsFolder](NFT1155Api.md#artifactsfolder) +- [circuitsFolder](NFT1155Api.md#circuitsfolder) +- [config](NFT1155Api.md#config) +- [getContract](NFT1155Api.md#getcontract) +- [instanceConfig](NFT1155Api.md#instanceconfig) +- [instantiableConfig](NFT1155Api.md#instantiableconfig) +- [logger](NFT1155Api.md#logger) +- [nevermined](NFT1155Api.md#nevermined) +- [web3](NFT1155Api.md#web3) + +### Methods + +- [\_details](NFT1155Api.md#_details) +- [access](NFT1155Api.md#access) +- [addRating](NFT1155Api.md#addrating) +- [balance](NFT1155Api.md#balance) +- [burn](NFT1155Api.md#burn) +- [burnFromHolder](NFT1155Api.md#burnfromholder) +- [buySecondaryMarketNft](NFT1155Api.md#buysecondarymarketnft) +- [claim](NFT1155Api.md#claim) +- [claimNFT](NFT1155Api.md#claimnft) +- [create](NFT1155Api.md#create) +- [details](NFT1155Api.md#details) +- [getSubscriptionToken](NFT1155Api.md#getsubscriptiontoken) +- [grantOperatorRole](NFT1155Api.md#grantoperatorrole) +- [isApprovedForAll](NFT1155Api.md#isapprovedforall) +- [isOperator](NFT1155Api.md#isoperator) +- [isOperatorOfDID](NFT1155Api.md#isoperatorofdid) +- [list](NFT1155Api.md#list) +- [listOnSecondaryMarkets](NFT1155Api.md#listonsecondarymarkets) +- [mint](NFT1155Api.md#mint) +- [order](NFT1155Api.md#order) +- [orderAsset](NFT1155Api.md#orderasset) +- [owner](NFT1155Api.md#owner) +- [registerNeverminedAsset](NFT1155Api.md#registerneverminedasset) +- [releaseRewards](NFT1155Api.md#releaserewards) +- [releaseSecondaryMarketRewards](NFT1155Api.md#releasesecondarymarketrewards) +- [resolveAsset](NFT1155Api.md#resolveasset) +- [revokeOperatorRole](NFT1155Api.md#revokeoperatorrole) +- [setApprovalForAll](NFT1155Api.md#setapprovalforall) +- [setInstanceConfig](NFT1155Api.md#setinstanceconfig) +- [transfer](NFT1155Api.md#transfer) +- [updateAsset](NFT1155Api.md#updateasset) +- [getInstance](NFT1155Api.md#getinstance) +- [getNFTContractAddress](NFT1155Api.md#getnftcontractaddress) +- [getServicePlugin](NFT1155Api.md#getserviceplugin) +- [setInstanceConfig](NFT1155Api.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new NFT1155Api**() + +#### Inherited from + +[NFTsBaseApi](NFTsBaseApi.md).[constructor](NFTsBaseApi.md#constructor) + +## Properties + +### nftContract + +• **nftContract**: [`Nft1155Contract`](Nft1155Contract.md) + +#### Defined in + +[src/nevermined/api/nfts/NFT1155Api.ts:22](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT1155Api.ts#L22) + +--- + +### servicePlugin + +• **servicePlugin**: `Object` + +#### Index signature + +▪ [key: `string`]: [`ServicePlugin`](../interfaces/ServicePlugin.md)<[`Service`](../code-reference.md#service)\> + +#### Inherited from + +[NFTsBaseApi](NFTsBaseApi.md).[servicePlugin](NFTsBaseApi.md#serviceplugin) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L29) + +## Accessors + +### address + +• `get` **address**(): `string` + +Gets the ERC-721 NFT Contract address + +#### Returns + +`string` + +The NFT contract address + +#### Defined in + +[src/nevermined/api/nfts/NFT1155Api.ts:60](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT1155Api.ts#L60) + +--- + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +NFTsBaseApi.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +NFTsBaseApi.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +NFTsBaseApi.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### getContract + +• `get` **getContract**(): [`Nft1155Contract`](Nft1155Contract.md) + +Gets the instance of the ERC-1155 NFT Contract where the API is connected + +#### Returns + +[`Nft1155Contract`](Nft1155Contract.md) + +The `Nft1155Contract` instance + +#### Defined in + +[src/nevermined/api/nfts/NFT1155Api.ts:68](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT1155Api.ts#L68) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +NFTsBaseApi.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +NFTsBaseApi.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +NFTsBaseApi.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +NFTsBaseApi.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +NFTsBaseApi.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### \_details + +▸ `Protected` **\_details**(`did`, `ercType`): `Promise`<{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> + +Get the details of an NFT + +#### Parameters + +| Name | Type | Description | +| :-------- | :------------------------------- | :--------------------------------------------- | +| `did` | `string` | The Decentralized Identifier of the NFT asset. | +| `ercType` | [`ERCType`](../enums/ERCType.md) | The type of NFT used | + +#### Returns + +`Promise`<{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> + +The details of the NFT. + +**`Example`** + +```ts +const details = await nevermined.nfts1155.details(ddo.id) + +// The `details` object includes the NFT information + +assert.equal(details.mintCap, 5) +assert.equal(details.nftSupply, 5) +assert.equal(details.royaltyScheme, RoyaltyKind.Standard) +assert.equal(details.royalties, 100000) +assert.equal(details.owner, artist.getId()) +``` + +#### Inherited from + +[NFTsBaseApi](NFTsBaseApi.md).[\_details](NFTsBaseApi.md#_details) + +#### Defined in + +[src/nevermined/api/nfts/NFTsBaseApi.ts:150](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFTsBaseApi.ts#L150) + +--- + +### access + +▸ **access**(`did`, `consumer`, `destination?`, `fileIndex?`, `agreementId?`, `buyer?`, `babysig?`, `serviceReference?`): `Promise`<`boolean`\> + +Access the files associated with an NFT. + +#### Parameters + +| Name | Type | Default value | Description | +| :----------------- | :------------------------------------------------------------ | :------------- | :------------------------------------------------------------------------ | +| `did` | `string` | `undefined` | The Decentralized Identifier of the NFT asset. | +| `consumer` | [`Account`](Account.md) | `undefined` | The NFT holder account. | +| `destination?` | `string` | `undefined` | The download destination for the files. | +| `fileIndex?` | `number` | `undefined` | The index of the file. If unset will download all the files in the asset. | +| `agreementId` | `string` | `'0x'` | The NFT sales agreement id. | +| `buyer?` | `string` | `undefined` | Key which represent the buyer | +| `babysig?` | [`Babysig`](../interfaces/Babysig.md) | `undefined` | - | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-access'` | The service reference to use. By default is nft-access. | + +#### Returns + +`Promise`<`boolean`\> + +true if the access was successful or file if isToDownload is false. + +**`Remarks`** + +This function will call the Node that will check if all the access conditions where fulfilled +before providing the files. + +**`Example`** + +```ts +const result = await nevermined.nfts1155.access(ddo.id, collector, '/tmp/') +``` + +#### Inherited from + +[NFTsBaseApi](NFTsBaseApi.md).[access](NFTsBaseApi.md#access) + +#### Defined in + +[src/nevermined/api/nfts/NFTsBaseApi.ts:419](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFTsBaseApi.ts#L419) + +--- + +### addRating + +▸ **addRating**(`did`, `newRating`, `numVotesAdded?`, `publisher`, `publishMetadata?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +Given a DID, it adds a vote to the asset curation information. + +#### Parameters + +| Name | Type | Default value | Description | +| :---------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `newRating` | `number` | `undefined` | New average rating of the asset | +| `numVotesAdded` | `number` | `1` | Number of new votes added to the rating, typically just 1 | +| `publisher` | [`Account`](Account.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +[DDO](DDO.md) The DDO updated + +#### Inherited from + +[NFTsBaseApi](NFTsBaseApi.md).[addRating](NFTsBaseApi.md#addrating) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:514](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L514) + +--- + +### balance + +▸ **balance**(`did`, `account`): `Promise`<`bigint`\> + +Get the NFT balance for a particular did associated to an account/address + +#### Parameters + +| Name | Type | Description | +| :-------- | :---------------------------------- | :--------------------------------------------- | +| `did` | `string` | The Decentralized Identifier of the NFT asset. | +| `account` | `string` \| [`Account`](Account.md) | The account/address to check the balance of. | + +#### Returns + +`Promise`<`bigint`\> + +The number of editions of a NFT owned by the account/address. + +**`Example`** + +```ts +const balance = await nevermined.nfts1155.balance(ddo.id, artist) +``` + +#### Defined in + +[src/nevermined/api/nfts/NFT1155Api.ts:466](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT1155Api.ts#L466) + +--- + +### burn + +▸ **burn**(`tokenId`, `nftAmount`, `account`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +Burn NFTs associated with an asset. + +#### Parameters + +| Name | Type | Description | +| :---------- | :---------------------------------------------- | :--------------------------------------------- | +| `tokenId` | `string` | The Decentralized Identifier of the NFT asset. | +| `nftAmount` | `bigint` | The amount of NFTs to burn. | +| `account` | [`Account`](Account.md) | The account of the publisher of the NFT. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +The ethers.ContractTransactionReceipt + +**`Remarks`** + +The publisher can only burn NFTs that it owns. NFTs that were already transferred cannot be burned by the publisher. + +**`Example`** + +```ts +await nevermined.nfts1155.burn(did, 2n, artist) +``` + +#### Defined in + +[src/nevermined/api/nfts/NFT1155Api.ts:185](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT1155Api.ts#L185) + +--- + +### burnFromHolder + +▸ **burnFromHolder**(`holder`, `tokenId`, `nftAmount`, `account`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +Burn NFTs associated with an asset of a specific account. + +#### Parameters + +| Name | Type | Description | +| :---------- | :---------------------------------------------- | :---------------------------------------------- | +| `holder` | `string` | The address of the account that holds the NFTs. | +| `tokenId` | `string` | The TokenId of the NFT | +| `nftAmount` | `bigint` | The amount of NFTs to burn. | +| `account` | `string` \| [`Account`](Account.md) | The account of the publisher of the NFT. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +The ethers.ContractTransactionReceipt + +**`Remarks`** + +The publisher can only burn NFTs of an account if is an operator. NFTs that were already transferred cannot be burned by the publisher. + +**`Example`** + +```ts +await nevermined.nfts1155.burnTo(holder, tokenId, 2n, artist) +``` + +#### Defined in + +[src/nevermined/api/nfts/NFT1155Api.ts:213](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT1155Api.ts#L213) + +--- + +### buySecondaryMarketNft + +▸ **buySecondaryMarketNft**(`consumer`, `nftAmount?`, `agreementIdSeed`, `conditionsTimeout?`, `txParams?`): `Promise`<`boolean`\> + +Buys a number of listed NFTs on secondary markets. + +#### Parameters + +| Name | Type | Description | +| :------------------ | :---------------------------------------------- | :----------------------------------------- | +| `consumer` | [`Account`](Account.md) | The account of the buyer/consumer. | +| `nftAmount` | `bigint` | The number of assets to buy. 1 by default. | +| `agreementIdSeed` | `string` | - | +| `conditionsTimeout` | `number`[] | - | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | + +#### Returns + +`Promise`<`boolean`\> + +true if the buy was successful. + +**`Example`** + +```ts +const result = await nevermined.nfts1155.buySecondaryMarketNft(collector, 1n, agreementId) +``` + +**`Throws`** + +[NFTError](NFTError.md) +Thrown if there is an error buying the NFT. + +#### Inherited from + +[NFTsBaseApi](NFTsBaseApi.md).[buySecondaryMarketNft](NFTsBaseApi.md#buysecondarymarketnft) + +#### Defined in + +[src/nevermined/api/nfts/NFTsBaseApi.ts:341](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFTsBaseApi.ts#L341) + +--- + +### claim + +▸ **claim**(`agreementId`, `nftHolder`, `nftReceiver`, `numberEditions?`, `did?`, `serviceIndex?`): `Promise`<`boolean`\> + +Claims the transfer of a NFT to the Nevermined Node on behalf of the publisher. + +#### Parameters + +| Name | Type | Description | +| :--------------- | :------- | :--------------------------------------------------------------------------- | +| `agreementId` | `string` | The NFT sales agreement id. | +| `nftHolder` | `string` | The address of the current owner of the NFT. | +| `nftReceiver` | `string` | The address where the NFT should be transferred. | +| `numberEditions` | `bigint` | The number of NFT editions to transfer. If the NFT is ERC-721 it should be 1 | +| `did?` | `string` | The Decentralized Identifier of the asset. | +| `serviceIndex?` | `number` | The index of the service in the DDO that will be claimed | + +#### Returns + +`Promise`<`boolean`\> + +true if the transfer was successful. + +**`Remarks`** + +This is useful when the consumer does not want to wait for the publisher +to transfer the NFT once the payment is made. Assuming the publisher delegated +transfer permissions to the Node. + +One example would be a marketplace where the user wants to get access to the NFT +as soon as the payment is made + +**`Example`** + +```ts +const receipt = await nevermined.nfts721.claim(agreementId, editor.getId(), subscriber.getId(), 1n) +``` + +#### Defined in + +[src/nevermined/api/nfts/NFT1155Api.ts:321](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT1155Api.ts#L321) + +--- + +### claimNFT + +▸ `Protected` **claimNFT**(`agreementId`, `nftHolder`, `nftReceiver`, `numberEditions?`, `ercType?`, `did?`, `serviceIndex?`): `Promise`<`boolean`\> + +Claims the transfer of a NFT to the Nevermined Node on behalf of the publisher. + +#### Parameters + +| Name | Type | Default value | Description | +| :--------------- | :------------------------------- | :------------ | :--------------------------------------------------------------------------- | +| `agreementId` | `string` | `undefined` | The NFT sales agreement id. | +| `nftHolder` | `string` | `undefined` | The address of the current owner of the NFT. | +| `nftReceiver` | `string` | `undefined` | The address where the NFT should be transferred. | +| `numberEditions` | `bigint` | `undefined` | The number of NFT editions to transfer. If the NFT is ERC-721 it should be 1 | +| `ercType` | [`ERCType`](../enums/ERCType.md) | `1155` | The Type of the NFT ERC (1155 or 721). | +| `did?` | `string` | `undefined` | The DID of the asset. | +| `serviceIndex?` | `number` | `undefined` | The index of the service in the DDO that will be claimed | + +#### Returns + +`Promise`<`boolean`\> + +true if the transfer was successful. + +**`Remarks`** + +This is useful when the consumer does not want to wait for the publisher +to transfer the NFT once the payment is made. Assuming the publisher delegated +transfer permissions to the Node. + +One example would be a marketplace where the user wants to get access to the NFT +as soon as the payment is made + +**`Example`** + +```ts +const receipt = await nevermined.nfts721.claim( + agreementId, + editor.getId(), + subscriber.getId(), + nftAmount, + 721, +) +``` + +**`Throws`** + +[NFTError](NFTError.md) if Nevermined is not an operator for this NFT + +#### Inherited from + +[NFTsBaseApi](NFTsBaseApi.md).[claimNFT](NFTsBaseApi.md#claimnft) + +#### Defined in + +[src/nevermined/api/nfts/NFTsBaseApi.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFTsBaseApi.ts#L50) + +--- + +### create + +▸ **create**(`nftAttributes`, `publisher`, `publicationOptions?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`CreateProgressStep`](../enums/CreateProgressStep.md), [`DDO`](DDO.md)\> + +Creates a new Nevermined asset associated to a NFT (ERC-1155). + +#### Parameters + +| Name | Type | Description | +| :------------------- | :------------------------------------------------------ | :-------------------------------------------------------------------------------- | +| `nftAttributes` | [`NFTAttributes`](NFTAttributes.md) | Attributes describing the NFT (ERC-721) associated to the asset | +| `publisher` | [`Account`](Account.md) | The account publishing the asset | +| `publicationOptions` | [`AssetPublicationOptions`](AssetPublicationOptions.md) | Allows to specify the publication options of the off-chain and the on-chain data. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`CreateProgressStep`](../enums/CreateProgressStep.md), [`DDO`](DDO.md)\> + +The newly registered [DDO](DDO.md). + +**`Example`** + +```ts +const assetAttributes = AssetAttributes.getInstance({ + metadata, + price: assetPrice, + serviceTypes: ['nft-sales', 'nft-access'], +}) +const nftAttributes = NFTAttributes.getNFT1155Instance({ + ...assetAttributes, + nftContractAddress: nftUpgradeable.address, + cap: cappedAmount, + amount: numberNFTs, + royaltyAttributes, + preMint, +}) +const ddo = await nevermined.nfts1155.create(nftAttributes, publisher) +``` + +**`See`** + +[PublishOnChainOptions](../enums/PublishOnChainOptions.md) and [PublishMetadataOptions](../enums/PublishMetadataOptions.md) + +#### Defined in + +[src/nevermined/api/nfts/NFT1155Api.ts:103](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT1155Api.ts#L103) + +--- + +### details + +▸ **details**(`did`): `Promise`<{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> + +Get the details of an NFT + +#### Parameters + +| Name | Type | Description | +| :---- | :------- | :--------------------------------------------- | +| `did` | `string` | The Decentralized Identifier of the NFT asset. | + +#### Returns + +`Promise`<{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> + +The details of the NFT. + +**`Example`** + +```ts +const details = await nevermined.nfts1155.details(ddo.id) + +// The `details` object includes the NFT information + +assert.equal(details.mintCap, 5) +assert.equal(details.nftSupply, 5) +assert.equal(details.royaltyScheme, RoyaltyKind.Standard) +assert.equal(details.royalties, 100000) +assert.equal(details.owner, artist.getId()) +``` + +#### Defined in + +[src/nevermined/api/nfts/NFT1155Api.ts:679](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT1155Api.ts#L679) + +--- + +### getSubscriptionToken + +▸ **getSubscriptionToken**(`did`, `account`): `Promise`<[`SubscriptionToken`](../interfaces/SubscriptionToken.md)\> + +Get a JWT token for an asset associated with a webService + +#### Parameters + +| Name | Type | Description | +| :-------- | :---------------------- | :----------------------------------------------------------------------------- | +| `did` | `string` | The did of the asset with a webService resource and an associated subscription | +| `account` | [`Account`](Account.md) | Account of the user requesting the token | + +#### Returns + +`Promise`<[`SubscriptionToken`](../interfaces/SubscriptionToken.md)\> + +[SubscriptionToken](../interfaces/SubscriptionToken.md) + +**`Example`** + +```ts +const response = await nevermined.nfts721.getSubscriptionToken(serviceDDO.id, subscriber) + +assert.isDefined(response.accessToken) +assert.isDefined(response.neverminedProxyUri) +``` + +#### Inherited from + +[NFTsBaseApi](NFTsBaseApi.md).[getSubscriptionToken](NFTsBaseApi.md#getsubscriptiontoken) + +#### Defined in + +[src/nevermined/api/nfts/NFTsBaseApi.ts:478](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFTsBaseApi.ts#L478) + +--- + +### grantOperatorRole + +▸ **grantOperatorRole**(`operatorAddress`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +Adds a minter (`minterAddress`) to the NFT Contract. +Granting and revoking minting permissions only can be done by the NFT Contract owner + +#### Parameters + +| Name | Type | Description | +| :---------------- | :---------------------------------------------- | :--------------------------------------------------------------------- | +| `operatorAddress` | `string` | The address of the account to be added as operator in the NFT Contract | +| `from?` | [`Account`](Account.md) | The account giving operator permissions | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +The ethers.ContractTransactionReceipt + +**`Example`** + +```ts +await nevermined.nfts1155.grantOperatorRole(someoneElse, artist) +``` + +#### Defined in + +[src/nevermined/api/nfts/NFT1155Api.ts:625](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT1155Api.ts#L625) + +--- + +### isApprovedForAll + +▸ **isApprovedForAll**(`operatorAddress`, `from`): `Promise`<`unknown`\> + +Returns if the `operatorAddress` is approved + +#### Parameters + +| Name | Type | Description | +| :---------------- | :------- | :--------------------------------------------------------------------------------------- | +| `operatorAddress` | `string` | The address to check the permissions | +| `from` | `string` | The address of the account granting or revoking the permissions via `setApprovalForAll`. | + +#### Returns + +`Promise`<`unknown`\> + +Boolean saying if the `operatorAddress` is approved + +**`See`** + +[claim](NFT1155Api.md#claim) + +**`Example`** + +```ts +await nevermined.nfts1155.isApprovedForAll(someoneElse, artist.getId()) +``` + +#### Defined in + +[src/nevermined/api/nfts/NFT1155Api.ts:540](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT1155Api.ts#L540) + +--- + +### isOperator + +▸ **isOperator**(`nftContractAddress`, `operatorAddress`, `ercType?`): `Promise`<`boolean`\> + +Check if a particular address is the operator of given a NFT address. + +#### Parameters + +| Name | Type | Default value | Description | +| :------------------- | :------------------------------- | :------------ | :-------------------------------------- | +| `nftContractAddress` | `string` | `undefined` | The DID of the NFT to check | +| `operatorAddress` | `string` | `undefined` | The address to check if operator status | +| `ercType` | [`ERCType`](../enums/ERCType.md) | `1155` | The erc type of the NFT. | + +#### Returns + +`Promise`<`boolean`\> + +operator status of address as a boolean + +#### Inherited from + +[NFTsBaseApi](NFTsBaseApi.md).[isOperator](NFTsBaseApi.md#isoperator) + +#### Defined in + +[src/nevermined/api/nfts/NFTsBaseApi.ts:116](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFTsBaseApi.ts#L116) + +--- + +### isOperatorOfDID + +▸ **isOperatorOfDID**(`did`, `address`, `ercType?`): `Promise`<`boolean`\> + +Check if a particular address is the operator of a DID. + +#### Parameters + +| Name | Type | Default value | Description | +| :-------- | :------------------------------- | :------------ | :-------------------------------------- | +| `did` | `string` | `undefined` | The DID of the NFT to check | +| `address` | `string` | `undefined` | The address to check if operator status | +| `ercType` | [`ERCType`](../enums/ERCType.md) | `1155` | The erc type of the NFT. | + +#### Returns + +`Promise`<`boolean`\> + +operator status of address as a boolean + +#### Inherited from + +[NFTsBaseApi](NFTsBaseApi.md).[isOperatorOfDID](NFTsBaseApi.md#isoperatorofdid) + +#### Defined in + +[src/nevermined/api/nfts/NFTsBaseApi.ts:91](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFTsBaseApi.ts#L91) + +--- + +### list + +▸ **list**(`did`, `list`, `publisher`, `publishMetadata?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +Given a DID, updates the metadata associated to the asset allowing to list or unlist it. It also can upload this metadata to a remote decentralized stored depending on the `publishMetadata` parameter. +In a Nevermined environment, when an asset is unlisted, it is not possible to be found and accessed by any user. + +#### Parameters + +| Name | Type | Default value | Description | +| :---------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `list` | `boolean` | `undefined` | Needs the asset to be listed or unlisted | +| `publisher` | [`Account`](Account.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +[DDO](DDO.md) The DDO updated + +#### Inherited from + +[NFTsBaseApi](NFTsBaseApi.md).[list](NFTsBaseApi.md#list) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:462](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L462) + +--- + +### listOnSecondaryMarkets + +▸ **listOnSecondaryMarkets**(`ddo`, `assetPrice`, `nftAmount`, `nftTransfer`, `provider`, `token`, `owner`): `Promise`<`string`\> + +After purchase re-list an NFT to enable secondary market sales. + +#### Parameters + +| Name | Type | Description | +| :------------ | :---------------------------- | :----------------------------------------------------------- | +| `ddo` | [`DDO`](DDO.md) | The DDO of the asset. | +| `assetPrice` | [`AssetPrice`](AssetPrice.md) | The current setup of asset rewards. | +| `nftAmount` | `bigint` | The number of NFTs put up for secondary sale. | +| `nftTransfer` | `boolean` | - | +| `provider` | `string` | The address that will be the provider of the secondary sale. | +| `token` | [`Token`](Token.md) | - | +| `owner` | [`Account`](Account.md) | The account of the current owner. | + +#### Returns + +`Promise`<`string`\> + +the agreementId of the secondary sale. + +**`Example`** + +```ts +const agreementId = await nevermined.nfts1155.listOnSecondaryMarkets( + ddo, + assetPrice, + numberNFTs, + collector.getId(), + token, + collector.getId(), +) +``` + +**`Throws`** + +[NFTError](NFTError.md) +Thrown if there is an error listing the NFT. + +#### Inherited from + +[NFTsBaseApi](NFTsBaseApi.md).[listOnSecondaryMarkets](NFTsBaseApi.md#listonsecondarymarkets) + +#### Defined in + +[src/nevermined/api/nfts/NFTsBaseApi.ts:260](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFTsBaseApi.ts#L260) + +--- + +### mint + +▸ **mint**(`did`, `nftAmount`, `receiver`, `account`, `data?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +Mint NFTs associated with an asset. + +#### Parameters + +| Name | Type | Description | +| :---------- | :---------------------------------------------- | :-------------------------------------------------------------------------------------------- | +| `did` | `string` | The Decentralized Identifier of the NFT asset. | +| `nftAmount` | `bigint` | The amount of NFTs to mint. | +| `receiver` | `string` | Account address of the NFT receiver, if `undefined` the minter account will receive the NFT/s | +| `account` | [`Account`](Account.md) | The account to mint the NFT. \* | +| `data?` | `string` | Data | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +The ethers.ContractTransactionReceipt + +**`Remarks`** + +This function can be called multiple times as long as the minting does not exceed the maximum cap set during creation. + +**`Example`** + +```ts +await nevermined.nfts1155.mint(did, 10n, artist) +``` + +#### Defined in + +[src/nevermined/api/nfts/NFT1155Api.ts:145](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT1155Api.ts#L145) + +--- + +### order + +▸ **order**(`did`, `numberEditions`, `consumer`, `serviceReference?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`OrderProgressStep`](../enums/OrderProgressStep.md), `string`\> + +Buy NFTs. + +#### Parameters + +| Name | Type | Default value | Description | +| :----------------- | :------------------------------------------------------------ | :------------ | :------------------------------------------------------------- | +| `did` | `string` | `undefined` | The Decentralized Identifier of the NFT asset. | +| `numberEditions` | `bigint` | `undefined` | The amount of NFTs to buy. | +| `consumer` | [`Account`](Account.md) | `undefined` | The account of the NFT buyer. | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-sales'` | The reference to identify wich service within the DDO to order | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters. | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`OrderProgressStep`](../enums/OrderProgressStep.md), `string`\> + +The agreement ID. + +**`Remarks`** + +This will lock the funds of the consumer in escrow pending the transfer of the NFTs +from the publisher. + +**`Example`** + +```ts +agreementId = await nevermined.nfts1155.order(ddo.id, numberNFTs, collector) +``` + +#### Defined in + +[src/nevermined/api/nfts/NFT1155Api.ts:252](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT1155Api.ts#L252) + +--- + +### orderAsset + +▸ **orderAsset**(`did`, `serviceReference`, `consumer`, `params?`): [`SubscribablePromise`](SubscribablePromise.md)<[`OrderProgressStep`](../enums/OrderProgressStep.md), `string`\> + +Start the purchase/order of an asset's service. Starts by signing the service agreement +then sends the request to the publisher via the service endpoint (Node http service). + +#### Parameters + +| Name | Type | Description | +| :----------------- | :------------------------------------------------------------ | :---------------- | +| `did` | `string` | Decentralized ID. | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | Service. | +| `consumer` | [`Account`](Account.md) | Consumer account. | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | - | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`OrderProgressStep`](../enums/OrderProgressStep.md), `string`\> + +The agreement ID. + +#### Inherited from + +[NFTsBaseApi](NFTsBaseApi.md).[orderAsset](NFTsBaseApi.md#orderasset) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:563](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L563) + +--- + +### owner + +▸ **owner**(): `Promise`<`string`\> + +Gets the contract owner + +#### Returns + +`Promise`<`string`\> + +Address of the contract owner + +**`Example`** + +```ts +const nftContractOwner = new Account(await nevermined.nfts1155.owner()) +``` + +#### Defined in + +[src/nevermined/api/nfts/NFT1155Api.ts:485](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT1155Api.ts#L485) + +--- + +### registerNeverminedAsset + +▸ `Protected` **registerNeverminedAsset**(`assetAttributes`, `publisher`, `publicationOptions`, `nftAttributes?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`CreateProgressStep`](../enums/CreateProgressStep.md), [`DDO`](DDO.md)\> + +It registers a new asset in a Nevermined network. This method is protected and not exposed +via the Nevermined APIs directly. It must accessed via the `assets`, `compute`, and `nfts` APIs. + +#### Parameters + +| Name | Type | Description | +| :------------------- | :------------------------------------------------------ | :-------------------------------------------------------------------------------- | +| `assetAttributes` | [`AssetAttributes`](AssetAttributes.md) | Attributes describing the asset | +| `publisher` | [`Account`](Account.md) | The account publishing the asset | +| `publicationOptions` | [`AssetPublicationOptions`](AssetPublicationOptions.md) | Allows to specify the publication options of the off-chain and the on-chain data. | +| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | Attributes describing the NFT (ERC-721) associated to the asset | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`CreateProgressStep`](../enums/CreateProgressStep.md), [`DDO`](DDO.md)\> + +The metadata of the asset created (DDO) + +**`See`** + +[PublishOnChainOptions](../enums/PublishOnChainOptions.md) and [PublishMetadataOptions](../enums/PublishMetadataOptions.md) + +#### Inherited from + +[NFTsBaseApi](NFTsBaseApi.md).[registerNeverminedAsset](NFTsBaseApi.md#registerneverminedasset) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L42) + +--- + +### releaseRewards + +▸ **releaseRewards**(`agreementId`, `did`, `serviceReference?`, `nftAmount`, `publisher`, `txParams?`): `Promise`<`boolean`\> + +Release the funds from escrow. + +#### Parameters + +| Name | Type | Default value | Description | +| :----------------- | :------------------------------------------------------------ | :------------ | :----------------------------------------------------------------------- | +| `agreementId` | `string` | `undefined` | The NFT sales agreement id. | +| `did` | `string` | `undefined` | The Decentralized identifier of the NFT asset. | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-sales'` | The reference to identify wich service within the DDO to release rewards | +| `nftAmount` | `bigint` | `undefined` | The amount of NFTs to transfer. | +| `publisher` | [`Account`](Account.md) | `undefined` | The current owner of the NFTs. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters. | + +#### Returns + +`Promise`<`boolean`\> + +true if the funds release was successful. + +**`Remarks`** + +A publisher is able to release the funds put on escrow by the consumer after transferring the NFTs. + +**`Example`** + +```ts +const receipt = await nevermined.nfts1155.releaseRewards(agreementId, ddo.id, numberNFTs, artist) +``` + +**`Throws`** + +[NFTError](NFTError.md) +Thrown if there is an error releasing the rewards + +#### Defined in + +[src/nevermined/api/nfts/NFT1155Api.ts:424](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT1155Api.ts#L424) + +--- + +### releaseSecondaryMarketRewards + +▸ **releaseSecondaryMarketRewards**(`owner`, `consumer`, `agreementIdSeed`, `serviceReference?`, `txParams?`): `Promise`<`boolean`\> + +Used to release the secondary market NFT & the locked rewards. + +#### Parameters + +| Name | Type | Default value | Description | +| :----------------- | :------------------------------------------------------------ | :------------ | :----------------------------------------------------------------------- | +| `owner` | [`Account`](Account.md) | `undefined` | The owner account. | +| `consumer` | [`Account`](Account.md) | `undefined` | The consumer account. | +| `agreementIdSeed` | `string` | `undefined` | the Id of the underlying service agreement seed. | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-sales'` | The reference to identify wich service within the DDO to release rewards | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters. | + +#### Returns + +`Promise`<`boolean`\> + +true if the transaction was successful. + +**`Example`** + +```ts +// TODO +``` + +**`Throws`** + +[NFTError](NFTError.md) +Thrown if there is an error releasing the rewards. + +#### Defined in + +[src/nevermined/api/nfts/NFT1155Api.ts:562](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT1155Api.ts#L562) + +--- + +### resolveAsset + +▸ `Protected` **resolveAsset**(`did`, `policy?`): `Promise`<[`DDO`](DDO.md)\> + +Returns a DDO by DID. Depending of the resolution policy it prioritize the Metadata API or Immutable urls. + +#### Parameters + +| Name | Type | Default value | Description | +| :------- | :------------------------------------------------- | :---------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `did` | `string` | `undefined` | Decentralized ID. | +| `policy` | [`DIDResolvePolicy`](../enums/DIDResolvePolicy.md) | `DIDResolvePolicy.MetadataAPIFirst` | It specifies the resolve policy to apply. It allows to select that priorities during the asset resolution via Metadata API or Immutable URLs (IPFS, Filecoin, etc) | + +#### Returns + +`Promise`<[`DDO`](DDO.md)\> + +[DDO](DDO.md) + +#### Inherited from + +[NFTsBaseApi](NFTsBaseApi.md).[resolveAsset](NFTsBaseApi.md#resolveasset) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:310](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L310) + +--- + +### revokeOperatorRole + +▸ **revokeOperatorRole**(`operatorAddress`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +Revokes an address (`operatorAddress`) of the NFT Contract as operator. +Granting and revoking minting permissions only can be done by the NFT Contract owner + +#### Parameters + +| Name | Type | Description | +| :---------------- | :---------------------------------------------- | :----------------------------------------------------------------------- | +| `operatorAddress` | `string` | The address of the account to be revoked as operator in the NFT Contract | +| `from?` | [`Account`](Account.md) | The account revoking operator permissions | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +The ethers.ContractTransactionReceipt + +**`Example`** + +```ts +await nevermined.nfts1155.revokeOperatorRole(someoneElse, artist) +``` + +#### Defined in + +[src/nevermined/api/nfts/NFT1155Api.ts:651](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT1155Api.ts#L651) + +--- + +### setApprovalForAll + +▸ **setApprovalForAll**(`operatorAddress`, `approved`, `from`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +Enable or disable NFT permissions for an operator. + +#### Parameters + +| Name | Type | Description | +| :---------------- | :---------------------------------------------- | :------------------------------------------------------------------- | +| `operatorAddress` | `string` | The address that of the operator we want to give transfer rights to. | +| `approved` | `boolean` | Give or remove transfer rights from the operator. | +| `from` | [`Account`](Account.md) | The account that wants to give transfer rights to the operator. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction additional parameters | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +The ethers.ContractTransactionReceiptnReceiptnReceipt + +**`See`** + +[claim](NFT1155Api.md#claim) + +**`Example`** + +```ts +await nevermined.nfts1155.setApprovalForAll(someoneElse, true, artist) +``` + +#### Defined in + +[src/nevermined/api/nfts/NFT1155Api.ts:510](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT1155Api.ts#L510) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[NFTsBaseApi](NFTsBaseApi.md).[setInstanceConfig](NFTsBaseApi.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### transfer + +▸ **transfer**(`agreementId`, `did`, `nftAmount`, `publisher`, `serviceReference?`, `txParams?`): `Promise`<`boolean`\> + +Transfer NFTs to the consumer. + +#### Parameters + +| Name | Type | Default value | Description | +| :----------------- | :------------------------------------------------------------ | :------------ | :---------------------------------------------------------------- | +| `agreementId` | `string` | `undefined` | The NFT sales agreement id. | +| `did` | `string` | `undefined` | The Decentralized identifier of the NFT asset. | +| `nftAmount` | `bigint` | `undefined` | The number of NFTs to transfer. | +| `publisher` | [`Account`](Account.md) | `undefined` | The current owner of the NFTs. | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-sales'` | The reference to identify wich service within the DDO to transfer | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters. | + +#### Returns + +`Promise`<`boolean`\> + +true if the transfer was successful. + +**`Remarks`** + +A publisher/provider will check if the consumer put the funds in escrow and +execute the transfer in order to be able to release the rewards. + +**`Example`** + +```ts +const receipt = await nevermined.nfts1155.transfer(agreementId, ddo.id, numberNFTs, artist) +``` + +**`Throws`** + +[NFTError](NFTError.md) +Thrown if there is an error transferring the NFT + +#### Defined in + +[src/nevermined/api/nfts/NFT1155Api.ts:368](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT1155Api.ts#L368) + +--- + +### updateAsset + +▸ `Protected` **updateAsset**(`did`, `metadata`, `publisher`, `publishMetadataOptions?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +Given a DID, updates the metadata associated to the asset. It also can upload this metadata to a remote decentralized stored depending on the `publishMetadata` parameter. + +#### Parameters + +| Name | Type | Default value | Description | +| :----------------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | Metadata describing the asset | +| `publisher` | [`Account`](Account.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadataOptions` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +[DDO](DDO.md) The DDO updated + +#### Inherited from + +[NFTsBaseApi](NFTsBaseApi.md).[updateAsset](NFTsBaseApi.md#updateasset) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:353](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L353) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`, `nftContractInstance?`, `nftContractAddress?`): `Promise`<[`NFT1155Api`](NFT1155Api.md)\> + +Create a new Nevermined NFTs (ERC-1155) instance allowing to interact with that kind of NFTs. + +#### Parameters + +| Name | Type | Description | +| :--------------------- | :---------------------------------------------------------- | :---------------------------------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | - | +| `nftContractInstance?` | [`Nft1155Contract`](Nft1155Contract.md) | If there is already deployed an instance of `Nft1155Contract` | +| `nftContractAddress?` | `string` | If the `Nft1155Contract` is deployed in an address it will connect to that contract | + +#### Returns + +`Promise`<[`NFT1155Api`](NFT1155Api.md)\> + +The NFTs 1155 API instance [NFT1155Api](NFT1155Api.md). + +**`Example`** + +```ts +nfts1155 = await Nft1155Api.getInstance(instanceConfig, nft1155Contract) +``` + +#### Overrides + +[NFTsBaseApi](NFTsBaseApi.md).[getInstance](NFTsBaseApi.md#getinstance) + +#### Defined in + +[src/nevermined/api/nfts/NFT1155Api.ts:40](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT1155Api.ts#L40) + +--- + +### getNFTContractAddress + +▸ `Static` **getNFTContractAddress**(`ddo`, `serviceReference?`): `any` + +Gets the NFT contract address associated with a Nevermined asset from the DDO. + +#### Parameters + +| Name | Type | Default value | Description | +| :----------------- | :------------------------------------------------------------ | :------------- | :------------------------------------------------ | +| `ddo` | [`DDO`](DDO.md) | `undefined` | The DDO of the asset. | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-access'` | The service type to look for the contract address | + +#### Returns + +`any` + +The NFT contract address. + +**`Example`** + +```ts +const nftContractAddress = NFT1155Api.getNFTContractAddress(ddo) +``` + +#### Inherited from + +[NFTsBaseApi](NFTsBaseApi.md).[getNFTContractAddress](NFTsBaseApi.md#getnftcontractaddress) + +#### Defined in + +[src/nevermined/api/nfts/NFTsBaseApi.ts:219](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFTsBaseApi.ts#L219) + +--- + +### getServicePlugin + +▸ `Static` `Protected` **getServicePlugin**(`config`): `Object` + +Initializes the default Nevermined service plugins and return that instance + +#### Parameters + +| Name | Type | Description | +| :------- | :---------------------------------------------------------- | :---------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | Nevermined config | + +#### Returns + +`Object` + +The Nevermined Service Plugin instance + +| Name | Type | +| :------------ | :------------------------------------------------------------------------------------------------------------ | +| `aave-credit` | [`ServicePlugin`](../interfaces/ServicePlugin.md)<[`ServiceAaveCredit`](../interfaces/ServiceAaveCredit.md)\> | +| `access` | [`AccessService`](AccessService.md) | +| `compute` | [`EscrowComputeExecutionTemplate`](EscrowComputeExecutionTemplate.md) | +| `nft-access` | [`NFTAccessService`](NFTAccessService.md) | +| `nft-sales` | [`NFTSalesService`](NFTSalesService.md) | + +#### Inherited from + +[NFTsBaseApi](NFTsBaseApi.md).[getServicePlugin](NFTsBaseApi.md#getserviceplugin) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:618](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L618) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[NFTsBaseApi](NFTsBaseApi.md).[setInstanceConfig](NFTsBaseApi.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/NFT721AccessTemplate.md b/docs/api-reference/classes/NFT721AccessTemplate.md new file mode 100644 index 000000000..ad642e226 --- /dev/null +++ b/docs/api-reference/classes/NFT721AccessTemplate.md @@ -0,0 +1,1438 @@ +[@nevermined-io/sdk](../code-reference.md) / NFT721AccessTemplate + +# Class: NFT721AccessTemplate + +## Hierarchy + +- [`BaseTemplate`](BaseTemplate.md)<`NFT721AccessTemplateParams`, [`ServiceNFTAccess`](../interfaces/ServiceNFTAccess.md)\> + + ↳ **`NFT721AccessTemplate`** + +## Table of contents + +### Constructors + +- [constructor](NFT721AccessTemplate.md#constructor) + +### Properties + +- [address](NFT721AccessTemplate.md#address) +- [contract](NFT721AccessTemplate.md#contract) +- [contractName](NFT721AccessTemplate.md#contractname) +- [events](NFT721AccessTemplate.md#events) +- [version](NFT721AccessTemplate.md#version) + +### Accessors + +- [artifactsFolder](NFT721AccessTemplate.md#artifactsfolder) +- [circuitsFolder](NFT721AccessTemplate.md#circuitsfolder) +- [config](NFT721AccessTemplate.md#config) +- [instanceConfig](NFT721AccessTemplate.md#instanceconfig) +- [instantiableConfig](NFT721AccessTemplate.md#instantiableconfig) +- [logger](NFT721AccessTemplate.md#logger) +- [nevermined](NFT721AccessTemplate.md#nevermined) +- [web3](NFT721AccessTemplate.md#web3) + +### Methods + +- [accept](NFT721AccessTemplate.md#accept) +- [agreementId](NFT721AccessTemplate.md#agreementid) +- [call](NFT721AccessTemplate.md#call) +- [conditions](NFT721AccessTemplate.md#conditions) +- [createAgreement](NFT721AccessTemplate.md#createagreement) +- [createAgreementAndPay](NFT721AccessTemplate.md#createagreementandpay) +- [createAgreementFromDDO](NFT721AccessTemplate.md#createagreementfromddo) +- [createAgreementWithPaymentFromDDO](NFT721AccessTemplate.md#createagreementwithpaymentfromddo) +- [createService](NFT721AccessTemplate.md#createservice) +- [description](NFT721AccessTemplate.md#description) +- [extraGen](NFT721AccessTemplate.md#extragen) +- [getAgreementCreatedEvent](NFT721AccessTemplate.md#getagreementcreatedevent) +- [getAgreementData](NFT721AccessTemplate.md#getagreementdata) +- [getAgreementIdsFromDDO](NFT721AccessTemplate.md#getagreementidsfromddo) +- [getAgreementStatus](NFT721AccessTemplate.md#getagreementstatus) +- [getAgreementsForDID](NFT721AccessTemplate.md#getagreementsfordid) +- [getConditionTypes](NFT721AccessTemplate.md#getconditiontypes) +- [getConditions](NFT721AccessTemplate.md#getconditions) +- [getFromAddress](NFT721AccessTemplate.md#getfromaddress) +- [getInputsOfMethod](NFT721AccessTemplate.md#getinputsofmethod) +- [getServiceAgreementTemplate](NFT721AccessTemplate.md#getserviceagreementtemplate) +- [getServiceAgreementTemplateConditionByRef](NFT721AccessTemplate.md#getserviceagreementtemplateconditionbyref) +- [getServiceAgreementTemplateConditions](NFT721AccessTemplate.md#getserviceagreementtemplateconditions) +- [getServiceAgreementTemplateDependencies](NFT721AccessTemplate.md#getserviceagreementtemplatedependencies) +- [getSignatureOfMethod](NFT721AccessTemplate.md#getsignatureofmethod) +- [init](NFT721AccessTemplate.md#init) +- [instanceFromDDO](NFT721AccessTemplate.md#instancefromddo) +- [lockConditionIndex](NFT721AccessTemplate.md#lockconditionindex) +- [lockTokens](NFT721AccessTemplate.md#locktokens) +- [name](NFT721AccessTemplate.md#name) +- [params](NFT721AccessTemplate.md#params) +- [paramsGen](NFT721AccessTemplate.md#paramsgen) +- [paymentData](NFT721AccessTemplate.md#paymentdata) +- [printAgreementStatus](NFT721AccessTemplate.md#printagreementstatus) +- [process](NFT721AccessTemplate.md#process) +- [send](NFT721AccessTemplate.md#send) +- [sendFrom](NFT721AccessTemplate.md#sendfrom) +- [service](NFT721AccessTemplate.md#service) +- [serviceEndpoint](NFT721AccessTemplate.md#serviceendpoint) +- [setInstanceConfig](NFT721AccessTemplate.md#setinstanceconfig) +- [standardContext](NFT721AccessTemplate.md#standardcontext) +- [track](NFT721AccessTemplate.md#track) +- [validateAgreement](NFT721AccessTemplate.md#validateagreement) +- [getInstance](NFT721AccessTemplate.md#getinstance) +- [setInstanceConfig](NFT721AccessTemplate.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• `Protected` **new NFT721AccessTemplate**(`contractName`) + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[constructor](BaseTemplate.md#constructor) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:68](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L68) + +## Properties + +### address + +• **address**: `string` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[address](BaseTemplate.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[contract](BaseTemplate.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[contractName](BaseTemplate.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[events](BaseTemplate.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[version](BaseTemplate.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +BaseTemplate.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +BaseTemplate.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +BaseTemplate.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +BaseTemplate.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +BaseTemplate.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +BaseTemplate.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +BaseTemplate.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +BaseTemplate.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### accept + +▸ **accept**(`params`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :------- | :------------------------------------------------------ | +| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | + +#### Returns + +`Promise`<`boolean`\> + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[accept](BaseTemplate.md#accept) + +#### Defined in + +[src/keeper/contracts/templates/NFT721AccessTemplate.ts:82](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L82) + +--- + +### agreementId + +▸ **agreementId**(`agreementIdSeed`, `creator`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :---------------- | :------- | +| `agreementIdSeed` | `string` | +| `creator` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[agreementId](BaseTemplate.md#agreementid) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:213](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L213) + +--- + +### 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 + +[BaseTemplate](BaseTemplate.md).[call](BaseTemplate.md#call) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### conditions + +▸ **conditions**(): [[`NFT721HolderCondition`](NFT721HolderCondition.md), [`NFTAccessCondition`](NFTAccessCondition.md)] + +#### Returns + +[[`NFT721HolderCondition`](NFT721HolderCondition.md), [`NFTAccessCondition`](NFTAccessCondition.md)] + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[conditions](BaseTemplate.md#conditions) + +#### Defined in + +[src/keeper/contracts/templates/NFT721AccessTemplate.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L49) + +--- + +### createAgreement + +▸ **createAgreement**(`agreementId`, `did`, `conditionIds`, `timeLocks`, `timeOuts`, `extraArgs`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `agreementId` | `string` | +| `did` | `string` | +| `conditionIds` | `string`[] | +| `timeLocks` | `number`[] | +| `timeOuts` | `number`[] | +| `extraArgs` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[createAgreement](BaseTemplate.md#createagreement) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L90) + +--- + +### createAgreementAndPay + +▸ **createAgreementAndPay**(`agreementId`, `did`, `conditionIds`, `timeLocks`, `timeOuts`, `accessConsumer`, `condIdx`, `rewardAddress`, `tokenAddress`, `amounts`, `receivers`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :--------------- | :---------------------------------------------- | +| `agreementId` | `string` | +| `did` | `string` | +| `conditionIds` | `string`[] | +| `timeLocks` | `number`[] | +| `timeOuts` | `number`[] | +| `accessConsumer` | `string` | +| `condIdx` | `number` | +| `rewardAddress` | `string` | +| `tokenAddress` | `string` | +| `amounts` | `bigint`[] | +| `receivers` | `string`[] | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[createAgreementAndPay](BaseTemplate.md#createagreementandpay) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L115) + +--- + +### createAgreementFromDDO + +▸ **createAgreementFromDDO**(`agreementIdSeed`, `ddo`, `parameters`, `consumer`, `from`, `timeOuts?`, `txParams?`): `Promise`<`string`\> + +Create a new agreement using the data of a DDO. + +#### Parameters + +| Name | Type | Description | +| :---------------- | :---------------------------------------------- | :---------- | +| `agreementIdSeed` | `string` | - | +| `ddo` | [`DDO`](DDO.md) | DDO. | +| `parameters` | `NFT721AccessTemplateParams` | | +| `consumer` | [`Account`](Account.md) | - | +| `from` | [`Account`](Account.md) | - | +| `timeOuts?` | `number`[] | - | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | + +#### Returns + +`Promise`<`string`\> + +true if the call was successful. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[createAgreementFromDDO](BaseTemplate.md#createagreementfromddo) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:222](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L222) + +--- + +### createAgreementWithPaymentFromDDO + +▸ **createAgreementWithPaymentFromDDO**(`agreementIdSeed`, `ddo`, `serviceReference`, `parameters`, `consumer`, `from`, `txParams?`, `observer?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :----------------- | :------------------------------------------------------------------------------------ | +| `agreementIdSeed` | `string` | +| `ddo` | [`DDO`](DDO.md) | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | +| `parameters` | `NFT721AccessTemplateParams` | +| `consumer` | [`Account`](Account.md) | +| `from` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| `observer?` | (`orderProgressStep`: [`OrderProgressStep`](../enums/OrderProgressStep.md)) => `void` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[createAgreementWithPaymentFromDDO](BaseTemplate.md#createagreementwithpaymentfromddo) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:252](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L252) + +--- + +### createService + +▸ **createService**(`publisher`, `metadata`, `serviceAttributes`, `nftAttributes?`, `priceData?`): [`ServiceNFTAccess`](../interfaces/ServiceNFTAccess.md) + +#### Parameters + +| Name | Type | +| :------------------ | :---------------------------------------------------------------------------- | +| `publisher` | [`Account`](Account.md) | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | +| `serviceAttributes` | [`ServiceAttributes`](../interfaces/ServiceAttributes.md) | +| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | +| `priceData?` | [`PricedMetadataInformation`](../code-reference.md#pricedmetadatainformation) | + +#### Returns + +[`ServiceNFTAccess`](../interfaces/ServiceNFTAccess.md) + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[createService](BaseTemplate.md#createservice) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L35) + +--- + +### description + +▸ **description**(): `string` + +#### Returns + +`string` + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[description](BaseTemplate.md#description) + +#### Defined in + +[src/keeper/contracts/templates/NFT721AccessTemplate.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L34) + +--- + +### extraGen + +▸ **extraGen**(`_params`): `Promise`<`any`\> + +#### Parameters + +| Name | Type | +| :-------- | :------------------------------------------------------ | +| `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | + +#### Returns + +`Promise`<`any`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[extraGen](BaseTemplate.md#extragen) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:94](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L94) + +--- + +### 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. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getAgreementCreatedEvent](BaseTemplate.md#getagreementcreatedevent) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:459](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L459) + +--- + +### getAgreementData + +▸ **getAgreementData**(`agreementId`): `Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | + +#### Returns + +`Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getAgreementData](BaseTemplate.md#getagreementdata) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:21](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L21) + +--- + +### getAgreementIdsFromDDO + +▸ **getAgreementIdsFromDDO**(`agreementId`, `ddo`, `creator`, `params`): `Promise`<`string`[]\> + +Get agreement conditions IDs. + +#### Parameters + +| Name | Type | Description | +| :------------ | :--------------------------- | :------------ | +| `agreementId` | `string` | Agreement ID. | +| `ddo` | [`DDO`](DDO.md) | DDO. | +| `creator` | `string` | - | +| `params` | `NFT721AccessTemplateParams` | - | + +#### Returns + +`Promise`<`string`[]\> + +The condition IDs. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getAgreementIdsFromDDO](BaseTemplate.md#getagreementidsfromddo) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:180](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L180) + +--- + +### getAgreementStatus + +▸ **getAgreementStatus**(`agreementId`): `Promise`<`false` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> + +Returns the status of the conditions. + +#### Parameters + +| Name | Type | Description | +| :------------ | :------- | :------------ | +| `agreementId` | `string` | Agreement ID. | + +#### Returns + +`Promise`<`false` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> + +The conditions status. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getAgreementStatus](BaseTemplate.md#getagreementstatus) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:346](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L346) + +--- + +### getAgreementsForDID + +▸ **getAgreementsForDID**(`did`): `Promise`<`string`[]\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `did` | `string` | + +#### Returns + +`Promise`<`string`[]\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getAgreementsForDID](BaseTemplate.md#getagreementsfordid) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:485](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L485) + +--- + +### getConditionTypes + +▸ **getConditionTypes**(): `Promise`<`string`[]\> + +Conditions address list. + +#### Returns + +`Promise`<`string`[]\> + +A list of condition addresses. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getConditionTypes](BaseTemplate.md#getconditiontypes) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L154) + +--- + +### getConditions + +▸ **getConditions**(): `Promise`<[`ConditionSmall`](ConditionSmall.md)[]\> + +List of condition contracts. + +#### Returns + +`Promise`<[`ConditionSmall`](ConditionSmall.md)[]\> + +A list of condition contracts. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getConditions](BaseTemplate.md#getconditions) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:165](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L165) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getFromAddress](BaseTemplate.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getInputsOfMethod](BaseTemplate.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getServiceAgreementTemplate + +▸ **getServiceAgreementTemplate**(): [`ServiceAgreementTemplate`](../interfaces/ServiceAgreementTemplate.md) + +#### Returns + +[`ServiceAgreementTemplate`](../interfaces/ServiceAgreementTemplate.md) + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[getServiceAgreementTemplate](BaseTemplate.md#getserviceagreementtemplate) + +#### Defined in + +[src/keeper/contracts/templates/NFT721AccessTemplate.ts:78](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L78) + +--- + +### getServiceAgreementTemplateConditionByRef + +▸ **getServiceAgreementTemplateConditionByRef**(`ref`): `Promise`<[`ConditionSmall`](ConditionSmall.md)\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `ref` | `string` | + +#### Returns + +`Promise`<[`ConditionSmall`](ConditionSmall.md)\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getServiceAgreementTemplateConditionByRef](BaseTemplate.md#getserviceagreementtemplateconditionbyref) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:329](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L329) + +--- + +### getServiceAgreementTemplateConditions + +▸ **getServiceAgreementTemplateConditions**(): [`ServiceAgreementTemplateCondition`](../interfaces/ServiceAgreementTemplateCondition.md)[] + +#### Returns + +[`ServiceAgreementTemplateCondition`](../interfaces/ServiceAgreementTemplateCondition.md)[] + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getServiceAgreementTemplateConditions](BaseTemplate.md#getserviceagreementtemplateconditions) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:324](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L324) + +--- + +### getServiceAgreementTemplateDependencies + +▸ **getServiceAgreementTemplateDependencies**(): `Promise`<{ `[condition: string]`: `string`[]; }\> + +#### Returns + +`Promise`<{ `[condition: string]`: `string`[]; }\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getServiceAgreementTemplateDependencies](BaseTemplate.md#getserviceagreementtemplatedependencies) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:336](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L336) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getSignatureOfMethod](BaseTemplate.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[init](BaseTemplate.md#init) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### instanceFromDDO + +▸ **instanceFromDDO**(`agreementIdSeed`, `ddo`, `creator`, `parameters`): `Promise`<[`AgreementInstance`](../interfaces/AgreementInstance.md)<`NFT721AccessTemplateParams`\>\> + +#### Parameters + +| Name | Type | +| :---------------- | :--------------------------- | +| `agreementIdSeed` | `string` | +| `ddo` | [`DDO`](DDO.md) | +| `creator` | `string` | +| `parameters` | `NFT721AccessTemplateParams` | + +#### Returns + +`Promise`<[`AgreementInstance`](../interfaces/AgreementInstance.md)<`NFT721AccessTemplateParams`\>\> + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[instanceFromDDO](BaseTemplate.md#instancefromddo) + +#### Defined in + +[src/keeper/contracts/templates/NFT721AccessTemplate.ts:54](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L54) + +--- + +### lockConditionIndex + +▸ **lockConditionIndex**(): `number` + +#### Returns + +`number` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[lockConditionIndex](BaseTemplate.md#lockconditionindex) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:74](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L74) + +--- + +### lockTokens + +▸ **lockTokens**(`tokenAddress`, `amounts`, `from`, `txParams`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `tokenAddress` | `any` | +| `amounts` | `any` | +| `from` | [`Account`](Account.md) | +| `txParams` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[lockTokens](BaseTemplate.md#locktokens) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:393](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L393) + +--- + +### name + +▸ **name**(): `string` + +#### Returns + +`string` + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[name](BaseTemplate.md#name) + +#### Defined in + +[src/keeper/contracts/templates/NFT721AccessTemplate.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L31) + +--- + +### params + +▸ **params**(`holderAddress`): `NFT721AccessTemplateParams` + +#### Parameters + +| Name | Type | +| :-------------- | :------- | +| `holderAddress` | `string` | + +#### Returns + +`NFT721AccessTemplateParams` + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[params](BaseTemplate.md#params) + +#### Defined in + +[src/keeper/contracts/templates/NFT721AccessTemplate.ts:45](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L45) + +--- + +### paramsGen + +▸ **paramsGen**(`«destructured»`): `Promise`<`NFT721AccessTemplateParams`\> + +Specialize params + +#### Parameters + +| Name | Type | Description | +| :--------------- | :------------------------------------------------------ | :----------------- | +| `«destructured»` | [`ValidationParams`](../interfaces/ValidationParams.md) | Generic parameters | + +#### Returns + +`Promise`<`NFT721AccessTemplateParams`\> + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[paramsGen](BaseTemplate.md#paramsgen) + +#### Defined in + +[src/keeper/contracts/templates/NFT721AccessTemplate.ts:23](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L23) + +--- + +### paymentData + +▸ **paymentData**(`service`): `Promise`<[`PaymentData`](../interfaces/PaymentData.md)\> + +#### Parameters + +| Name | Type | +| :-------- | :------------------------------------------------ | +| `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | + +#### Returns + +`Promise`<[`PaymentData`](../interfaces/PaymentData.md)\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[paymentData](BaseTemplate.md#paymentdata) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:78](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L78) + +--- + +### printAgreementStatus + +▸ **printAgreementStatus**(`agreementId`): `Promise`<`void`\> + +Prints the agreement status. + +#### Parameters + +| Name | Type | Description | +| :------------ | :------- | :------------ | +| `agreementId` | `string` | Agreement ID. | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[printAgreementStatus](BaseTemplate.md#printagreementstatus) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:429](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L429) + +--- + +### process + +▸ **process**(`params`, `from`, `txparams?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :---------- | :------------------------------------------------------ | +| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `from` | [`Account`](Account.md) | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[process](BaseTemplate.md#process) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:110](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L110) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[send](BaseTemplate.md#send) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[sendFrom](BaseTemplate.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### service + +▸ **service**(): [`ServiceType`](../code-reference.md#servicetype) + +#### Returns + +[`ServiceType`](../code-reference.md#servicetype) + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[service](BaseTemplate.md#service) + +#### Defined in + +[src/keeper/contracts/templates/NFT721AccessTemplate.ts:38](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L38) + +--- + +### serviceEndpoint + +▸ **serviceEndpoint**(): [`ServiceType`](../code-reference.md#servicetype) + +#### Returns + +[`ServiceType`](../code-reference.md#servicetype) + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[serviceEndpoint](BaseTemplate.md#serviceendpoint) + +#### Defined in + +[src/keeper/contracts/templates/NFT721AccessTemplate.ts:41](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L41) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[setInstanceConfig](BaseTemplate.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### standardContext + +▸ **standardContext**(`ddo`, `creator`, `serviceIndex?`): [`ConditionContext`](../interfaces/ConditionContext.md) + +#### Parameters + +| Name | Type | +| :-------------- | :-------------- | +| `ddo` | [`DDO`](DDO.md) | +| `creator` | `string` | +| `serviceIndex?` | `number` | + +#### Returns + +[`ConditionContext`](../interfaces/ConditionContext.md) + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[standardContext](BaseTemplate.md#standardcontext) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:200](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L200) + +--- + +### track + +▸ **track**(`_params`, `_from`, `_txparams?`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :----------- | :------------------------------------------------------ | +| `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `_from` | [`Account`](Account.md) | +| `_txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`boolean`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[track](BaseTemplate.md#track) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:102](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L102) + +--- + +### validateAgreement + +▸ **validateAgreement**(`agreement_id`, `did`, `params`, `from`, `extra?`, `txparams?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `agreement_id` | `string` | +| `did` | `string` | +| `params` | `NFT721AccessTemplateParams` | +| `from` | [`Account`](Account.md) | +| `extra` | `any` | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[validateAgreement](BaseTemplate.md#validateagreement) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:125](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L125) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`): `Promise`<[`NFT721AccessTemplate`](NFT721AccessTemplate.md)\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`Promise`<[`NFT721AccessTemplate`](NFT721AccessTemplate.md)\> + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[getInstance](BaseTemplate.md#getinstance) + +#### Defined in + +[src/keeper/contracts/templates/NFT721AccessTemplate.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L28) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[setInstanceConfig](BaseTemplate.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/NFT721Api.md b/docs/api-reference/classes/NFT721Api.md new file mode 100644 index 000000000..ffc3cfc32 --- /dev/null +++ b/docs/api-reference/classes/NFT721Api.md @@ -0,0 +1,1676 @@ +[@nevermined-io/sdk](../code-reference.md) / NFT721Api + +# Class: NFT721Api + +Allows the interaction with external ERC-721 NFT contracts built on top of the Nevermined NFT extra features. + +## Hierarchy + +- [`NFTsBaseApi`](NFTsBaseApi.md) + + ↳ **`NFT721Api`** + + ↳↳ [`SubscriptionNFTApi`](SubscriptionNFTApi.md) + +## Table of contents + +### Constructors + +- [constructor](NFT721Api.md#constructor) + +### Properties + +- [nftContract](NFT721Api.md#nftcontract) +- [servicePlugin](NFT721Api.md#serviceplugin) + +### Accessors + +- [address](NFT721Api.md#address) +- [artifactsFolder](NFT721Api.md#artifactsfolder) +- [circuitsFolder](NFT721Api.md#circuitsfolder) +- [config](NFT721Api.md#config) +- [getContract](NFT721Api.md#getcontract) +- [instanceConfig](NFT721Api.md#instanceconfig) +- [instantiableConfig](NFT721Api.md#instantiableconfig) +- [logger](NFT721Api.md#logger) +- [nevermined](NFT721Api.md#nevermined) +- [web3](NFT721Api.md#web3) + +### Methods + +- [\_details](NFT721Api.md#_details) +- [access](NFT721Api.md#access) +- [addRating](NFT721Api.md#addrating) +- [balanceOf](NFT721Api.md#balanceof) +- [burn](NFT721Api.md#burn) +- [buySecondaryMarketNft](NFT721Api.md#buysecondarymarketnft) +- [claim](NFT721Api.md#claim) +- [claimNFT](NFT721Api.md#claimnft) +- [create](NFT721Api.md#create) +- [details](NFT721Api.md#details) +- [getSubscriptionToken](NFT721Api.md#getsubscriptiontoken) +- [grantOperatorRole](NFT721Api.md#grantoperatorrole) +- [isApprovedForAll](NFT721Api.md#isapprovedforall) +- [isOperator](NFT721Api.md#isoperator) +- [isOperatorOfDID](NFT721Api.md#isoperatorofdid) +- [list](NFT721Api.md#list) +- [listOnSecondaryMarkets](NFT721Api.md#listonsecondarymarkets) +- [mint](NFT721Api.md#mint) +- [mintWithURL](NFT721Api.md#mintwithurl) +- [order](NFT721Api.md#order) +- [orderAsset](NFT721Api.md#orderasset) +- [ownerOf](NFT721Api.md#ownerof) +- [ownerOfAsset](NFT721Api.md#ownerofasset) +- [ownerOfAssetByAgreement](NFT721Api.md#ownerofassetbyagreement) +- [ownerOfTokenId](NFT721Api.md#owneroftokenid) +- [registerNeverminedAsset](NFT721Api.md#registerneverminedasset) +- [releaseRewards](NFT721Api.md#releaserewards) +- [releaseSecondaryMarketRewards](NFT721Api.md#releasesecondarymarketrewards) +- [resolveAsset](NFT721Api.md#resolveasset) +- [revokeOperatorRole](NFT721Api.md#revokeoperatorrole) +- [setApprovalForAll](NFT721Api.md#setapprovalforall) +- [setInstanceConfig](NFT721Api.md#setinstanceconfig) +- [transfer](NFT721Api.md#transfer) +- [updateAsset](NFT721Api.md#updateasset) +- [getInstance](NFT721Api.md#getinstance) +- [getNFTContractAddress](NFT721Api.md#getnftcontractaddress) +- [getServicePlugin](NFT721Api.md#getserviceplugin) +- [setInstanceConfig](NFT721Api.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new NFT721Api**() + +#### Inherited from + +[NFTsBaseApi](NFTsBaseApi.md).[constructor](NFTsBaseApi.md#constructor) + +## Properties + +### nftContract + +• **nftContract**: [`Nft721Contract`](Nft721Contract.md) + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:22](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L22) + +--- + +### servicePlugin + +• **servicePlugin**: `Object` + +#### Index signature + +▪ [key: `string`]: [`ServicePlugin`](../interfaces/ServicePlugin.md)<[`Service`](../code-reference.md#service)\> + +#### Inherited from + +[NFTsBaseApi](NFTsBaseApi.md).[servicePlugin](NFTsBaseApi.md#serviceplugin) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L29) + +## Accessors + +### address + +• `get` **address**(): `string` + +Gets the ERC-721 NFT Contract address + +#### Returns + +`string` + +The NFT contract address + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:55](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L55) + +--- + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +NFTsBaseApi.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +NFTsBaseApi.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +NFTsBaseApi.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### getContract + +• `get` **getContract**(): [`Nft721Contract`](Nft721Contract.md) + +Gets the instance of the ERC-721 NFT Contract where the API is connected + +#### Returns + +[`Nft721Contract`](Nft721Contract.md) + +The `Nft721Contract` instance + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:63](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L63) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +NFTsBaseApi.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +NFTsBaseApi.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +NFTsBaseApi.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +NFTsBaseApi.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +NFTsBaseApi.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### \_details + +▸ `Protected` **\_details**(`did`, `ercType`): `Promise`<{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> + +Get the details of an NFT + +#### Parameters + +| Name | Type | Description | +| :-------- | :------------------------------- | :--------------------------------------------- | +| `did` | `string` | The Decentralized Identifier of the NFT asset. | +| `ercType` | [`ERCType`](../enums/ERCType.md) | The type of NFT used | + +#### Returns + +`Promise`<{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> + +The details of the NFT. + +**`Example`** + +```ts +const details = await nevermined.nfts1155.details(ddo.id) + +// The `details` object includes the NFT information + +assert.equal(details.mintCap, 5) +assert.equal(details.nftSupply, 5) +assert.equal(details.royaltyScheme, RoyaltyKind.Standard) +assert.equal(details.royalties, 100000) +assert.equal(details.owner, artist.getId()) +``` + +#### Inherited from + +[NFTsBaseApi](NFTsBaseApi.md).[\_details](NFTsBaseApi.md#_details) + +#### Defined in + +[src/nevermined/api/nfts/NFTsBaseApi.ts:150](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFTsBaseApi.ts#L150) + +--- + +### access + +▸ **access**(`did`, `consumer`, `destination?`, `fileIndex?`, `agreementId?`, `buyer?`, `babysig?`, `serviceReference?`): `Promise`<`boolean`\> + +Access the files associated with an NFT. + +#### Parameters + +| Name | Type | Default value | Description | +| :----------------- | :------------------------------------------------------------ | :------------- | :------------------------------------------------------------------------ | +| `did` | `string` | `undefined` | The Decentralized Identifier of the NFT asset. | +| `consumer` | [`Account`](Account.md) | `undefined` | The NFT holder account. | +| `destination?` | `string` | `undefined` | The download destination for the files. | +| `fileIndex?` | `number` | `undefined` | The index of the file. If unset will download all the files in the asset. | +| `agreementId` | `string` | `'0x'` | The NFT sales agreement id. | +| `buyer?` | `string` | `undefined` | Key which represent the buyer | +| `babysig?` | [`Babysig`](../interfaces/Babysig.md) | `undefined` | - | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-access'` | The service reference to use. By default is nft-access. | + +#### Returns + +`Promise`<`boolean`\> + +true if the access was successful or file if isToDownload is false. + +**`Remarks`** + +This function will call the Node that will check if all the access conditions where fulfilled +before providing the files. + +**`Example`** + +```ts +const result = await nevermined.nfts1155.access(ddo.id, collector, '/tmp/') +``` + +#### Inherited from + +[NFTsBaseApi](NFTsBaseApi.md).[access](NFTsBaseApi.md#access) + +#### Defined in + +[src/nevermined/api/nfts/NFTsBaseApi.ts:419](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFTsBaseApi.ts#L419) + +--- + +### addRating + +▸ **addRating**(`did`, `newRating`, `numVotesAdded?`, `publisher`, `publishMetadata?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +Given a DID, it adds a vote to the asset curation information. + +#### Parameters + +| Name | Type | Default value | Description | +| :---------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `newRating` | `number` | `undefined` | New average rating of the asset | +| `numVotesAdded` | `number` | `1` | Number of new votes added to the rating, typically just 1 | +| `publisher` | [`Account`](Account.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +[DDO](DDO.md) The DDO updated + +#### Inherited from + +[NFTsBaseApi](NFTsBaseApi.md).[addRating](NFTsBaseApi.md#addrating) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:514](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L514) + +--- + +### balanceOf + +▸ **balanceOf**(`account`): `Promise`<`bigint`\> + +Get the NFT balance for a particular account/address + +#### Parameters + +| Name | Type | Description | +| :-------- | :---------------------------------- | :------------------------------------------- | +| `account` | `string` \| [`Account`](Account.md) | The account/address to check the balance of. | + +#### Returns + +`Promise`<`bigint`\> + +The balance of NFTs owned by the account. + +**`Example`** + +```ts +const balance = await nevermined.nfts721.balance(artist) +``` + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:506](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L506) + +--- + +### burn + +▸ **burn**(`tokenId`, `account`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +Burn NFTs associated with an asset. + +#### Parameters + +| Name | Type | Description | +| :---------- | :---------------------------------------------- | :--------------------------------------- | +| `tokenId` | `string` | The identifier of the token to burn | +| `account` | [`Account`](Account.md) | The account of the publisher of the NFT. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +The ethers.ContractTransactionReceipt + +**`Remarks`** + +The publisher can only burn NFTs that it owns. NFTs that were already transferred cannot be burned by the publisher. + +**`Example`** + +```ts +await nevermined.nfts721.burn(tokenId, artist) +``` + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:347](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L347) + +--- + +### buySecondaryMarketNft + +▸ **buySecondaryMarketNft**(`consumer`, `nftAmount?`, `agreementIdSeed`, `conditionsTimeout?`, `txParams?`): `Promise`<`boolean`\> + +Buys a number of listed NFTs on secondary markets. + +#### Parameters + +| Name | Type | Description | +| :------------------ | :---------------------------------------------- | :----------------------------------------- | +| `consumer` | [`Account`](Account.md) | The account of the buyer/consumer. | +| `nftAmount` | `bigint` | The number of assets to buy. 1 by default. | +| `agreementIdSeed` | `string` | - | +| `conditionsTimeout` | `number`[] | - | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | + +#### Returns + +`Promise`<`boolean`\> + +true if the buy was successful. + +**`Example`** + +```ts +const result = await nevermined.nfts1155.buySecondaryMarketNft(collector, 1n, agreementId) +``` + +**`Throws`** + +[NFTError](NFTError.md) +Thrown if there is an error buying the NFT. + +#### Inherited from + +[NFTsBaseApi](NFTsBaseApi.md).[buySecondaryMarketNft](NFTsBaseApi.md#buysecondarymarketnft) + +#### Defined in + +[src/nevermined/api/nfts/NFTsBaseApi.ts:341](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFTsBaseApi.ts#L341) + +--- + +### claim + +▸ **claim**(`agreementId`, `nftHolder`, `nftReceiver`, `did?`, `serviceIndex?`): `Promise`<`boolean`\> + +Claims the transfer of a NFT to the Nevermined Node on behalf of the publisher. + +#### Parameters + +| Name | Type | Description | +| :-------------- | :------- | :------------------------------------------------------- | +| `agreementId` | `string` | The NFT sales agreement id. | +| `nftHolder` | `string` | The address of the current owner of the NFT. | +| `nftReceiver` | `string` | The address where the NFT should be transferred. | +| `did?` | `string` | The Decentralized Identifier of the asset. | +| `serviceIndex?` | `any` | The index of the service in the DDO that will be claimed | + +#### Returns + +`Promise`<`boolean`\> + +true if the transfer was successful. + +**`Remarks`** + +This is useful when the consumer does not want to wait for the publisher +to transfer the NFT once the payment is made. Assuming the publisher delegated +transfer permissions to the Node. + +One example would be a marketplace where the user wants to get access to the NFT +as soon as the payment is made + +**`Example`** + +```ts +const receipt = await nevermined.nfts721.claim(agreementId, editor.getId(), subscriber.getId()) +``` + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:193](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L193) + +--- + +### claimNFT + +▸ `Protected` **claimNFT**(`agreementId`, `nftHolder`, `nftReceiver`, `numberEditions?`, `ercType?`, `did?`, `serviceIndex?`): `Promise`<`boolean`\> + +Claims the transfer of a NFT to the Nevermined Node on behalf of the publisher. + +#### Parameters + +| Name | Type | Default value | Description | +| :--------------- | :------------------------------- | :------------ | :--------------------------------------------------------------------------- | +| `agreementId` | `string` | `undefined` | The NFT sales agreement id. | +| `nftHolder` | `string` | `undefined` | The address of the current owner of the NFT. | +| `nftReceiver` | `string` | `undefined` | The address where the NFT should be transferred. | +| `numberEditions` | `bigint` | `undefined` | The number of NFT editions to transfer. If the NFT is ERC-721 it should be 1 | +| `ercType` | [`ERCType`](../enums/ERCType.md) | `1155` | The Type of the NFT ERC (1155 or 721). | +| `did?` | `string` | `undefined` | The DID of the asset. | +| `serviceIndex?` | `number` | `undefined` | The index of the service in the DDO that will be claimed | + +#### Returns + +`Promise`<`boolean`\> + +true if the transfer was successful. + +**`Remarks`** + +This is useful when the consumer does not want to wait for the publisher +to transfer the NFT once the payment is made. Assuming the publisher delegated +transfer permissions to the Node. + +One example would be a marketplace where the user wants to get access to the NFT +as soon as the payment is made + +**`Example`** + +```ts +const receipt = await nevermined.nfts721.claim( + agreementId, + editor.getId(), + subscriber.getId(), + nftAmount, + 721, +) +``` + +**`Throws`** + +[NFTError](NFTError.md) if Nevermined is not an operator for this NFT + +#### Inherited from + +[NFTsBaseApi](NFTsBaseApi.md).[claimNFT](NFTsBaseApi.md#claimnft) + +#### Defined in + +[src/nevermined/api/nfts/NFTsBaseApi.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFTsBaseApi.ts#L50) + +--- + +### create + +▸ **create**(`nftAttributes`, `publisher`, `publicationOptions?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`CreateProgressStep`](../enums/CreateProgressStep.md), [`DDO`](DDO.md)\> + +Creates a new Nevermined asset associated to a NFT (ERC-721). + +#### Parameters + +| Name | Type | Description | +| :------------------- | :------------------------------------------------------ | :-------------------------------------------------------------------------------- | +| `nftAttributes` | [`NFTAttributes`](NFTAttributes.md) | Attributes describing the NFT (ERC-721) associated to the asset | +| `publisher` | [`Account`](Account.md) | The account publishing the asset | +| `publicationOptions` | [`AssetPublicationOptions`](AssetPublicationOptions.md) | Allows to specify the publication options of the off-chain and the on-chain data. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`CreateProgressStep`](../enums/CreateProgressStep.md), [`DDO`](DDO.md)\> + +The newly registered [DDO](DDO.md). + +**`Example`** + +```ts + +// We define how the Asset is and the properties +// of the NFT attached to it +const nftAttributes = NFTAttributes.getNFT721Instance({ + metadata, + price: assetPrice1, + serviceTypes: ['nft-sales', 'nft-access'] + nftContractAddress: nftContract.address +}) + +// And register the asset +ddo = await nevermined.nfts721.create( + nftAttributes, + artist, + { metadata: PublishMetadata.IPFS } +) +``` + +**`See`** + +[PublishOnChainOptions](../enums/PublishOnChainOptions.md) and [PublishMetadataOptions](../enums/PublishMetadataOptions.md) + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:97](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L97) + +--- + +### details + +▸ **details**(`did`): `Promise`<{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> + +Get the details of an NFT + +#### Parameters + +| Name | Type | Description | +| :---- | :------- | :--------------------------------------------- | +| `did` | `string` | The Decentralized Identifier of the NFT asset. | + +#### Returns + +`Promise`<{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> + +The details of the NFT. + +**`Example`** + +```ts +const details = await nevermined.nfts1155.details(ddo.id) + +// The `details` object includes the NFT information + +assert.equal(details.mintCap, 5) +assert.equal(details.nftSupply, 5) +assert.equal(details.royaltyScheme, RoyaltyKind.Standard) +assert.equal(details.royalties, 100000) +assert.equal(details.owner, artist.getId()) +``` + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:639](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L639) + +--- + +### getSubscriptionToken + +▸ **getSubscriptionToken**(`did`, `account`): `Promise`<[`SubscriptionToken`](../interfaces/SubscriptionToken.md)\> + +Get a JWT token for an asset associated with a webService + +#### Parameters + +| Name | Type | Description | +| :-------- | :---------------------- | :----------------------------------------------------------------------------- | +| `did` | `string` | The did of the asset with a webService resource and an associated subscription | +| `account` | [`Account`](Account.md) | Account of the user requesting the token | + +#### Returns + +`Promise`<[`SubscriptionToken`](../interfaces/SubscriptionToken.md)\> + +[SubscriptionToken](../interfaces/SubscriptionToken.md) + +**`Example`** + +```ts +const response = await nevermined.nfts721.getSubscriptionToken(serviceDDO.id, subscriber) + +assert.isDefined(response.accessToken) +assert.isDefined(response.neverminedProxyUri) +``` + +#### Inherited from + +[NFTsBaseApi](NFTsBaseApi.md).[getSubscriptionToken](NFTsBaseApi.md#getsubscriptiontoken) + +#### Defined in + +[src/nevermined/api/nfts/NFTsBaseApi.ts:478](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFTsBaseApi.ts#L478) + +--- + +### grantOperatorRole + +▸ **grantOperatorRole**(`operatorAddress`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +Adds a operator (`operatorAddress`) to the NFT Contract. +Granting and revoking operator permissions only can be done by the NFT Contract owner + +#### Parameters + +| Name | Type | Description | +| :---------------- | :---------------------------------------------- | :--------------------------------------------------------------------- | +| `operatorAddress` | `string` | The address of the account to be added as operator in the NFT Contract | +| `from?` | [`Account`](Account.md) | The account giving operator permissions | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +The ethers.ContractTransactionReceipt + +**`Example`** + +```ts +await nevermined.nfts721.grantOperatorRole(someoneElse, artist) +``` + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:585](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L585) + +--- + +### isApprovedForAll + +▸ **isApprovedForAll**(`operatorAddress`, `from`): `Promise`<`unknown`\> + +Returns if the `operatorAddress` is approved + +#### Parameters + +| Name | Type | Description | +| :---------------- | :------- | :--------------------------------------------------------------------------------------- | +| `operatorAddress` | `string` | The address to check the permissions | +| `from` | `string` | The address of the account granting or revoking the permissions via `setApprovalForAll`. | + +#### Returns + +`Promise`<`unknown`\> + +Boolean saying if the `operatorAddress` is approved + +**`Example`** + +```ts +await nevermined.nfts721.isApprovedForAll(someoneElse, artist.getId()) +``` + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:490](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L490) + +--- + +### isOperator + +▸ **isOperator**(`nftContractAddress`, `operatorAddress`, `ercType?`): `Promise`<`boolean`\> + +Check if a particular address is the operator of given a NFT address. + +#### Parameters + +| Name | Type | Default value | Description | +| :------------------- | :------------------------------- | :------------ | :-------------------------------------- | +| `nftContractAddress` | `string` | `undefined` | The DID of the NFT to check | +| `operatorAddress` | `string` | `undefined` | The address to check if operator status | +| `ercType` | [`ERCType`](../enums/ERCType.md) | `1155` | The erc type of the NFT. | + +#### Returns + +`Promise`<`boolean`\> + +operator status of address as a boolean + +#### Inherited from + +[NFTsBaseApi](NFTsBaseApi.md).[isOperator](NFTsBaseApi.md#isoperator) + +#### Defined in + +[src/nevermined/api/nfts/NFTsBaseApi.ts:116](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFTsBaseApi.ts#L116) + +--- + +### isOperatorOfDID + +▸ **isOperatorOfDID**(`did`, `address`): `Promise`<`boolean`\> + +Check if a particular address is the operator of a DID. + +#### Parameters + +| Name | Type | Description | +| :-------- | :------- | :-------------------------------------- | +| `did` | `string` | The DID of the NFT to check | +| `address` | `string` | The address to check if operator status | + +#### Returns + +`Promise`<`boolean`\> + +operator status of address as a boolean + +#### Overrides + +[NFTsBaseApi](NFTsBaseApi.md).[isOperatorOfDID](NFTsBaseApi.md#isoperatorofdid) + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:643](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L643) + +--- + +### list + +▸ **list**(`did`, `list`, `publisher`, `publishMetadata?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +Given a DID, updates the metadata associated to the asset allowing to list or unlist it. It also can upload this metadata to a remote decentralized stored depending on the `publishMetadata` parameter. +In a Nevermined environment, when an asset is unlisted, it is not possible to be found and accessed by any user. + +#### Parameters + +| Name | Type | Default value | Description | +| :---------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `list` | `boolean` | `undefined` | Needs the asset to be listed or unlisted | +| `publisher` | [`Account`](Account.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +[DDO](DDO.md) The DDO updated + +#### Inherited from + +[NFTsBaseApi](NFTsBaseApi.md).[list](NFTsBaseApi.md#list) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:462](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L462) + +--- + +### listOnSecondaryMarkets + +▸ **listOnSecondaryMarkets**(`ddo`, `assetPrice`, `nftAmount`, `nftTransfer`, `provider`, `token`, `owner`): `Promise`<`string`\> + +After purchase re-list an NFT to enable secondary market sales. + +#### Parameters + +| Name | Type | Description | +| :------------ | :---------------------------- | :----------------------------------------------------------- | +| `ddo` | [`DDO`](DDO.md) | The DDO of the asset. | +| `assetPrice` | [`AssetPrice`](AssetPrice.md) | The current setup of asset rewards. | +| `nftAmount` | `bigint` | The number of NFTs put up for secondary sale. | +| `nftTransfer` | `boolean` | - | +| `provider` | `string` | The address that will be the provider of the secondary sale. | +| `token` | [`Token`](Token.md) | - | +| `owner` | [`Account`](Account.md) | The account of the current owner. | + +#### Returns + +`Promise`<`string`\> + +the agreementId of the secondary sale. + +**`Example`** + +```ts +const agreementId = await nevermined.nfts1155.listOnSecondaryMarkets( + ddo, + assetPrice, + numberNFTs, + collector.getId(), + token, + collector.getId(), +) +``` + +**`Throws`** + +[NFTError](NFTError.md) +Thrown if there is an error listing the NFT. + +#### Inherited from + +[NFTsBaseApi](NFTsBaseApi.md).[listOnSecondaryMarkets](NFTsBaseApi.md#listonsecondarymarkets) + +#### Defined in + +[src/nevermined/api/nfts/NFTsBaseApi.ts:260](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFTsBaseApi.ts#L260) + +--- + +### mint + +▸ **mint**(`did`, `publisher`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +Mint NFTs associated with an asset. + +This function can be called multiple times as long as the minting does not exceed the maximum cap set during creation. + +#### Parameters + +| Name | Type | Description | +| :---------- | :---------------------------------------------- | :--------------------------------------------- | +| `did` | `string` | The Decentralized Identifier of the NFT asset. | +| `publisher` | [`Account`](Account.md) | The account of the minter | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +The ethers.ContractTransactionReceipt + +**`Example`** + +```ts +await nevermined.nfts721.mint(ddo.id, artist) +``` + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:319](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L319) + +--- + +### mintWithURL + +▸ **mintWithURL**(`to`, `did`, `url`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +Mint NFTs associated with an asset allowing to specify some metadata + +This function can be called multiple times as long as the minting does not exceed the maximum cap set during creation. + +#### Parameters + +| Name | Type | Description | +| :---------- | :---------------------------------------------- | :--------------------------------------------- | +| `to` | `string` | The address receiving the NFT minted | +| `did` | `string` | The Decentralized Identifier of the NFT asset. | +| `url` | `string` | The URL with NFT metadata | +| `from?` | [`Account`](Account.md) | The account of the minter | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +The ethers.ContractTransactionReceipt + +**`Example`** + +```ts +await nevermined.nfts721.mintWithURL(receiverAddress, ddo.id, nftMetadata, artist) +``` + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:367](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L367) + +--- + +### order + +▸ **order**(`did`, `consumer`, `serviceReference?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`OrderProgressStep`](../enums/OrderProgressStep.md), `string`\> + +Order a NFT-721. + +#### Parameters + +| Name | Type | Default value | Description | +| :----------------- | :------------------------------------------------------------ | :------------ | :------------------------------------------------------------- | +| `did` | `string` | `undefined` | The Decentralized Identifier of the NFT asset. | +| `consumer` | [`Account`](Account.md) | `undefined` | The account of the NFT buyer. | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-sales'` | The reference to identify wich service within the DDO to order | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters. | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`OrderProgressStep`](../enums/OrderProgressStep.md), `string`\> + +The agreement ID. + +**`Remarks`** + +This will lock the funds of the consumer in escrow pending the transfer of the NFTs +from the publisher. + +**`Example`** + +```ts +const agreementId = await nevermined.nfts721.order(ddo.id, collector) +``` + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:134](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L134) + +--- + +### orderAsset + +▸ **orderAsset**(`did`, `serviceReference`, `consumer`, `params?`): [`SubscribablePromise`](SubscribablePromise.md)<[`OrderProgressStep`](../enums/OrderProgressStep.md), `string`\> + +Start the purchase/order of an asset's service. Starts by signing the service agreement +then sends the request to the publisher via the service endpoint (Node http service). + +#### Parameters + +| Name | Type | Description | +| :----------------- | :------------------------------------------------------------ | :---------------- | +| `did` | `string` | Decentralized ID. | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | Service. | +| `consumer` | [`Account`](Account.md) | Consumer account. | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | - | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`OrderProgressStep`](../enums/OrderProgressStep.md), `string`\> + +The agreement ID. + +#### Inherited from + +[NFTsBaseApi](NFTsBaseApi.md).[orderAsset](NFTsBaseApi.md#orderasset) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:563](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L563) + +--- + +### ownerOf + +▸ **ownerOf**(`did`): `Promise`<`string`\> + +Gets the contract owner + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `did` | `string` | + +#### Returns + +`Promise`<`string`\> + +Address of the contract owner + +**`Example`** + +```ts +const nftContractOwner = new Account(await nevermined.nfts721.ownerOf()) +``` + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:416](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L416) + +--- + +### ownerOfAsset + +▸ **ownerOfAsset**(`did`): `Promise`<`string`\> + +Given a DID it gets the owner of the NFT if that DID is used as tokenId + +#### Parameters + +| Name | Type | Description | +| :---- | :------- | :--------------------------------------------- | +| `did` | `string` | The Decentralized identifier of the NFT asset. | + +#### Returns + +`Promise`<`string`\> + +The address of the NFT owner. + +**`Example`** + +```ts +const owner = await nevermined.nfts721.ownerOfAsset(ddo.id, nftTokenAddress) +``` + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:450](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L450) + +--- + +### ownerOfAssetByAgreement + +▸ **ownerOfAssetByAgreement**(`did`, `agreementId`): `Promise`<`string`\> + +Given a DID and an agreement id it gets the owner of the NFT + +#### Parameters + +| Name | Type | Description | +| :------------ | :------- | :--------------------------------------------- | +| `did` | `string` | The Decentralized identifier of the NFT asset. | +| `agreementId` | `string` | The NFT sales agreement id. | + +#### Returns + +`Promise`<`string`\> + +The address of the NFT owner. + +**`Example`** + +```ts +const owner = await nevermined.nfts721.ownerOfAssetByAgreement(ddo.id, agreementId) +``` + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:468](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L468) + +--- + +### ownerOfTokenId + +▸ **ownerOfTokenId**(`tokenId`): `Promise`<`string`\> + +Given some information, it gets the owner of the NFT + +#### Parameters + +| Name | Type | Description | +| :-------- | :------- | :----------- | +| `tokenId` | `string` | The token id | + +#### Returns + +`Promise`<`string`\> + +The address of the NFT owner. + +**`Example`** + +```ts +const owner = await nevermined.nfts721.ownerOfTokenId(tokenId) +``` + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:433](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L433) + +--- + +### registerNeverminedAsset + +▸ `Protected` **registerNeverminedAsset**(`assetAttributes`, `publisher`, `publicationOptions`, `nftAttributes?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`CreateProgressStep`](../enums/CreateProgressStep.md), [`DDO`](DDO.md)\> + +It registers a new asset in a Nevermined network. This method is protected and not exposed +via the Nevermined APIs directly. It must accessed via the `assets`, `compute`, and `nfts` APIs. + +#### Parameters + +| Name | Type | Description | +| :------------------- | :------------------------------------------------------ | :-------------------------------------------------------------------------------- | +| `assetAttributes` | [`AssetAttributes`](AssetAttributes.md) | Attributes describing the asset | +| `publisher` | [`Account`](Account.md) | The account publishing the asset | +| `publicationOptions` | [`AssetPublicationOptions`](AssetPublicationOptions.md) | Allows to specify the publication options of the off-chain and the on-chain data. | +| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | Attributes describing the NFT (ERC-721) associated to the asset | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`CreateProgressStep`](../enums/CreateProgressStep.md), [`DDO`](DDO.md)\> + +The metadata of the asset created (DDO) + +**`See`** + +[PublishOnChainOptions](../enums/PublishOnChainOptions.md) and [PublishMetadataOptions](../enums/PublishMetadataOptions.md) + +#### Inherited from + +[NFTsBaseApi](NFTsBaseApi.md).[registerNeverminedAsset](NFTsBaseApi.md#registerneverminedasset) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L42) + +--- + +### releaseRewards + +▸ **releaseRewards**(`agreementId`, `did`, `publisher`, `serviceReference?`, `txParams?`): `Promise`<`boolean`\> + +Release the funds from escrow. + +#### Parameters + +| Name | Type | Default value | Description | +| :----------------- | :------------------------------------------------------------ | :------------ | :----------------------------------------------------------------------- | +| `agreementId` | `string` | `undefined` | The NFT sales agreement id. | +| `did` | `string` | `undefined` | The Decentralized identifier of the NFT asset. | +| `publisher` | [`Account`](Account.md) | `undefined` | The current owner of the NFTs. | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-sales'` | The reference to identify wich service within the DDO to release rewards | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters. | + +#### Returns + +`Promise`<`boolean`\> + +true if the funds release was successful. + +**`Remarks`** + +A publisher is able to release the funds put on escrow by the consumer after transferring the NFTs. + +**`Example`** + +```ts +const receipt = await nevermined.nfts721.releaseRewards(agreementId, ddo.id, artist) +``` + +**`Throws`** + +[NFTError](NFTError.md) +Thrown if there is an error releasing the rewards. + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:277](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L277) + +--- + +### releaseSecondaryMarketRewards + +▸ **releaseSecondaryMarketRewards**(`owner`, `account`, `agreementIdSeed`, `txParams?`): `Promise`<`boolean`\> + +Used to release the secondary market NFT & the locked rewards. + +#### Parameters + +| Name | Type | Description | +| :---------------- | :---------------------------------------------- | :---------------------------------------------------------------- | +| `owner` | [`Account`](Account.md) | The owner account. | +| `account` | [`Account`](Account.md) | Account of the user sending the transaction | +| `agreementIdSeed` | `string` | the seed of the Agreement Id of the underlying service agreement. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | + +#### Returns + +`Promise`<`boolean`\> + +true if the transaction was successful. + +**`Example`** + +```ts +// TODO +``` + +**`Throws`** + +[NFTError](NFTError.md) +Thrown if there is an error releasing the rewards. + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:529](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L529) + +--- + +### resolveAsset + +▸ `Protected` **resolveAsset**(`did`, `policy?`): `Promise`<[`DDO`](DDO.md)\> + +Returns a DDO by DID. Depending of the resolution policy it prioritize the Metadata API or Immutable urls. + +#### Parameters + +| Name | Type | Default value | Description | +| :------- | :------------------------------------------------- | :---------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `did` | `string` | `undefined` | Decentralized ID. | +| `policy` | [`DIDResolvePolicy`](../enums/DIDResolvePolicy.md) | `DIDResolvePolicy.MetadataAPIFirst` | It specifies the resolve policy to apply. It allows to select that priorities during the asset resolution via Metadata API or Immutable URLs (IPFS, Filecoin, etc) | + +#### Returns + +`Promise`<[`DDO`](DDO.md)\> + +[DDO](DDO.md) + +#### Inherited from + +[NFTsBaseApi](NFTsBaseApi.md).[resolveAsset](NFTsBaseApi.md#resolveasset) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:310](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L310) + +--- + +### revokeOperatorRole + +▸ **revokeOperatorRole**(`operatorAddress`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +Revokes a minter (`operatorAddress`) of the NFT Contract. +Granting and revoking minting permissions only can be done by the NFT Contract owner + +#### Parameters + +| Name | Type | Description | +| :---------------- | :---------------------------------------------- | :----------------------------------------------------------------------- | +| `operatorAddress` | `string` | The address of the account to be revoked as operator in the NFT Contract | +| `from?` | [`Account`](Account.md) | The account revoking operator permissions | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +The ethers.ContractTransactionReceipt + +**`Example`** + +```ts +await nevermined.nfts721.revokeOperatorRole(someoneElse, artist) +``` + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:611](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L611) + +--- + +### setApprovalForAll + +▸ **setApprovalForAll**(`target`, `approved`, `from`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +Enable or disable NFT permissions for an operator. + +#### Parameters + +| Name | Type | Description | +| :---------- | :---------------------------------------------- | :------------------------------------------------------------------- | +| `target` | `string` | The address that of the operator we want to give transfer rights to. | +| `approved` | `boolean` | Give or remove transfer rights from the operator. | +| `from` | [`Account`](Account.md) | The account that wants to give transfer rights to the operator. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +The ethers.ContractTransactionReceipt + +**`Example`** + +```ts +await nevermined.nfts721.setApprovalForAll(someoneElse, true, artist) +``` + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:395](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L395) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[NFTsBaseApi](NFTsBaseApi.md).[setInstanceConfig](NFTsBaseApi.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### transfer + +▸ **transfer**(`agreementId`, `did`, `publisher`, `serviceReference?`, `txParams?`): `Promise`<`boolean`\> + +Transfer NFT-721 to the consumer. + +#### Parameters + +| Name | Type | Default value | Description | +| :----------------- | :------------------------------------------------------------ | :------------ | :---------------------------------------------------------------- | +| `agreementId` | `string` | `undefined` | The NFT sales agreement id. | +| `did` | `string` | `undefined` | The Decentralized identifier of the NFT asset. | +| `publisher` | [`Account`](Account.md) | `undefined` | The current owner of the NFTs. | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-sales'` | The reference to identify wich service within the DDO to transfer | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters. | + +#### Returns + +`Promise`<`boolean`\> + +true if the transfer was successful. + +**`Remarks`** + +A publisher/provider will check if the consumer put the funds in escrow and +execute the transfer in order to be able to release the rewards. + +**`Example`** + +```ts +const receipt = await nevermined.nfts721.transfer(agreementId, ddo.id, artist) +``` + +**`Throws`** + +[NFTError](NFTError.md) +Thrown if there is an error transferring the NFT + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:226](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L226) + +--- + +### updateAsset + +▸ `Protected` **updateAsset**(`did`, `metadata`, `publisher`, `publishMetadataOptions?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +Given a DID, updates the metadata associated to the asset. It also can upload this metadata to a remote decentralized stored depending on the `publishMetadata` parameter. + +#### Parameters + +| Name | Type | Default value | Description | +| :----------------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | Metadata describing the asset | +| `publisher` | [`Account`](Account.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadataOptions` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +[DDO](DDO.md) The DDO updated + +#### Inherited from + +[NFTsBaseApi](NFTsBaseApi.md).[updateAsset](NFTsBaseApi.md#updateasset) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:353](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L353) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`, `nftContractAddress`): `Promise`<[`NFT721Api`](NFT721Api.md)\> + +Create a new Nevermined NFTs (ERC-721) instance allowing to interact with that kind of NFTs. + +#### Parameters + +| Name | Type | Description | +| :------------------- | :---------------------------------------------------------- | :-------------------------------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | The Nevermined config | +| `nftContractAddress` | `string` | If the Nft721 Contract is deployed in an address it will connect to that contract | + +#### Returns + +`Promise`<[`NFT721Api`](NFT721Api.md)\> + +The NFTs 721 API instance [NFT721Api](NFT721Api.md). + +**`Example`** + +```ts +nfts721 = await Nft721Api.getInstance(instanceConfig, nftContractAddress) +``` + +#### Overrides + +[NFTsBaseApi](NFTsBaseApi.md).[getInstance](NFTsBaseApi.md#getinstance) + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L39) + +--- + +### getNFTContractAddress + +▸ `Static` **getNFTContractAddress**(`ddo`, `serviceReference?`): `any` + +Gets the NFT contract address associated with a Nevermined asset from the DDO. + +#### Parameters + +| Name | Type | Default value | Description | +| :----------------- | :------------------------------------------------------------ | :------------- | :------------------------------------------------ | +| `ddo` | [`DDO`](DDO.md) | `undefined` | The DDO of the asset. | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-access'` | The service type to look for the contract address | + +#### Returns + +`any` + +The NFT contract address. + +**`Example`** + +```ts +const nftContractAddress = NFT1155Api.getNFTContractAddress(ddo) +``` + +#### Inherited from + +[NFTsBaseApi](NFTsBaseApi.md).[getNFTContractAddress](NFTsBaseApi.md#getnftcontractaddress) + +#### Defined in + +[src/nevermined/api/nfts/NFTsBaseApi.ts:219](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFTsBaseApi.ts#L219) + +--- + +### getServicePlugin + +▸ `Static` `Protected` **getServicePlugin**(`config`): `Object` + +Initializes the default Nevermined service plugins and return that instance + +#### Parameters + +| Name | Type | Description | +| :------- | :---------------------------------------------------------- | :---------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | Nevermined config | + +#### Returns + +`Object` + +The Nevermined Service Plugin instance + +| Name | Type | +| :------------ | :------------------------------------------------------------------------------------------------------------ | +| `aave-credit` | [`ServicePlugin`](../interfaces/ServicePlugin.md)<[`ServiceAaveCredit`](../interfaces/ServiceAaveCredit.md)\> | +| `access` | [`AccessService`](AccessService.md) | +| `compute` | [`EscrowComputeExecutionTemplate`](EscrowComputeExecutionTemplate.md) | +| `nft-access` | [`NFTAccessService`](NFTAccessService.md) | +| `nft-sales` | [`NFTSalesService`](NFTSalesService.md) | + +#### Inherited from + +[NFTsBaseApi](NFTsBaseApi.md).[getServicePlugin](NFTsBaseApi.md#getserviceplugin) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:618](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L618) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[NFTsBaseApi](NFTsBaseApi.md).[setInstanceConfig](NFTsBaseApi.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/NFT721HolderCondition.md b/docs/api-reference/classes/NFT721HolderCondition.md new file mode 100644 index 000000000..cc33fc9df --- /dev/null +++ b/docs/api-reference/classes/NFT721HolderCondition.md @@ -0,0 +1,976 @@ +[@nevermined-io/sdk](../code-reference.md) / NFT721HolderCondition + +# Class: NFT721HolderCondition + +Allows to fulfill a condition to users holding some amount of NFTs for a specific DID. + +## Hierarchy + +- [`ConsumerCondition`](ConsumerCondition.md)<`NFT721HolderConditionContext`\> + + ↳ **`NFT721HolderCondition`** + +## Table of contents + +### Constructors + +- [constructor](NFT721HolderCondition.md#constructor) + +### Properties + +- [address](NFT721HolderCondition.md#address) +- [contract](NFT721HolderCondition.md#contract) +- [contractName](NFT721HolderCondition.md#contractname) +- [events](NFT721HolderCondition.md#events) +- [version](NFT721HolderCondition.md#version) + +### Accessors + +- [artifactsFolder](NFT721HolderCondition.md#artifactsfolder) +- [circuitsFolder](NFT721HolderCondition.md#circuitsfolder) +- [config](NFT721HolderCondition.md#config) +- [instanceConfig](NFT721HolderCondition.md#instanceconfig) +- [instantiableConfig](NFT721HolderCondition.md#instantiableconfig) +- [logger](NFT721HolderCondition.md#logger) +- [nevermined](NFT721HolderCondition.md#nevermined) +- [web3](NFT721HolderCondition.md#web3) + +### Methods + +- [abortByTimeOut](NFT721HolderCondition.md#abortbytimeout) +- [call](NFT721HolderCondition.md#call) +- [fulfill](NFT721HolderCondition.md#fulfill) +- [fulfillInstance](NFT721HolderCondition.md#fulfillinstance) +- [fulfillPlain](NFT721HolderCondition.md#fulfillplain) +- [fulfillWithNode](NFT721HolderCondition.md#fulfillwithnode) +- [generateId](NFT721HolderCondition.md#generateid) +- [generateIdHash](NFT721HolderCondition.md#generateidhash) +- [generateIdWithSeed](NFT721HolderCondition.md#generateidwithseed) +- [getConditionFulfilledEvent](NFT721HolderCondition.md#getconditionfulfilledevent) +- [getFromAddress](NFT721HolderCondition.md#getfromaddress) +- [getInputsOfMethod](NFT721HolderCondition.md#getinputsofmethod) +- [getSignatureOfMethod](NFT721HolderCondition.md#getsignatureofmethod) +- [hashValues](NFT721HolderCondition.md#hashvalues) +- [hashValuesPlain](NFT721HolderCondition.md#hashvaluesplain) +- [init](NFT721HolderCondition.md#init) +- [instance](NFT721HolderCondition.md#instance) +- [instanceFromDDO](NFT721HolderCondition.md#instancefromddo) +- [nftContractFromService](NFT721HolderCondition.md#nftcontractfromservice) +- [params](NFT721HolderCondition.md#params) +- [paramsFromDDO](NFT721HolderCondition.md#paramsfromddo) +- [send](NFT721HolderCondition.md#send) +- [sendFrom](NFT721HolderCondition.md#sendfrom) +- [setInstanceConfig](NFT721HolderCondition.md#setinstanceconfig) +- [getInstance](NFT721HolderCondition.md#getinstance) +- [setInstanceConfig](NFT721HolderCondition.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new NFT721HolderCondition**(`contractName`) + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[constructor](ConsumerCondition.md#constructor) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L34) + +## Properties + +### address + +• **address**: `string` + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[address](ConsumerCondition.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[contract](ConsumerCondition.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[contractName](ConsumerCondition.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[events](ConsumerCondition.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[version](ConsumerCondition.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ConsumerCondition.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ConsumerCondition.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +ConsumerCondition.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ConsumerCondition.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ConsumerCondition.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +ConsumerCondition.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +ConsumerCondition.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +ConsumerCondition.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### abortByTimeOut + +▸ **abortByTimeOut**(`conditionId`, `from?`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------------ | :---------------------------------------------- | +| `conditionId` | `string` | +| `from?` | [`Account`](Account.md) | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[abortByTimeOut](ConsumerCondition.md#abortbytimeout) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L88) + +--- + +### 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 + +[ConsumerCondition](ConsumerCondition.md).[call](ConsumerCondition.md#call) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### fulfill + +▸ **fulfill**(`agreementId`, `did`, `holderAddress`, `nftTokenAddress`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +Fulfill requires a validation that holder as enough NFTs for a specific DID. + +#### Parameters + +| Name | Type | Description | +| :---------------- | :---------------------------------------------- | :----------------------------------------------- | +| `agreementId` | `string` | SEA agreement identifier. | +| `did` | `string` | The Decentralized Identifier of the asset. | +| `holderAddress` | `string` | The contract address where the reward is locked. | +| `nftTokenAddress` | `string` | The contract address of the nft to use. | +| `from?` | [`Account`](Account.md) | Account sending the transaction | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transacion parameters | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +condition state + +#### Overrides + +[ConsumerCondition](ConsumerCondition.md).[fulfill](ConsumerCondition.md#fulfill) + +#### Defined in + +[src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts:52](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts#L52) + +--- + +### fulfillInstance + +▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `txParams?`, `method?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | Default value | +| :----------------- | :----------------------------------------------------------------------------------------- | :------------ | +| `cond` | [`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | +| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | +| `from?` | [`Account`](Account.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[fulfillInstance](ConsumerCondition.md#fulfillinstance) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:150](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L150) + +--- + +### fulfillPlain + +▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `txParams?`, `method?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | Default value | +| :------------ | :-------------------------------------------------------- | :------------ | +| `agreementId` | `string` | `undefined` | +| `args` | `any`[] | `undefined` | +| `from?` | [`Account`](Account.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[fulfillPlain](ConsumerCondition.md#fulfillplain) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L63) + +--- + +### fulfillWithNode + +▸ **fulfillWithNode**(`_cond`, `_additionalParams`, `_from?`, `_txParams?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------------ | :----------------------------------------------------------------------------------------- | +| `_cond` | [`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | +| `_additionalParams` | `Record`<`string`, `unknown`\> | +| `_from?` | [`Account`](Account.md) | +| `_txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[fulfillWithNode](ConsumerCondition.md#fulfillwithnode) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:217](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L217) + +--- + +### generateId + +▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `valueHash` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[generateId](ConsumerCondition.md#generateid) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L77) + +--- + +### generateIdHash + +▸ **generateIdHash**(`agreementId`, `...values`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `...values` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[generateIdHash](ConsumerCondition.md#generateidhash) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L73) + +--- + +### generateIdWithSeed + +▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `valueHash` | `string` | + +#### Returns + +`Promise`<[`string`, `string`]\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[generateIdWithSeed](ConsumerCondition.md#generateidwithseed) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L81) + +--- + +### getConditionFulfilledEvent + +▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../code-reference.md#eventresult) + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | + +#### Returns + +[`EventResult`](../code-reference.md#eventresult) + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[getConditionFulfilledEvent](ConsumerCondition.md#getconditionfulfilledevent) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L92) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[getFromAddress](ConsumerCondition.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[getInputsOfMethod](ConsumerCondition.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[getSignatureOfMethod](ConsumerCondition.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### hashValues + +▸ **hashValues**(`...args`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[hashValues](ConsumerCondition.md#hashvalues) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L129) + +--- + +### hashValuesPlain + +▸ **hashValuesPlain**(`...args`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[hashValuesPlain](ConsumerCondition.md#hashvaluesplain) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:133](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L133) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[init](ConsumerCondition.md#init) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### instance + +▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :------------ | :--------------------------------------------------------------------------------------------- | +| `agreementId` | `string` | +| `params` | [`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | + +#### Returns + +`Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[instance](ConsumerCondition.md#instance) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:174](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L174) + +--- + +### instanceFromDDO + +▸ **instanceFromDDO**(`agreementId`, `ctx`, `...args`): `Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------------------------------------------- | +| `agreementId` | `string` | +| `ctx` | `NFT721HolderConditionContext` | +| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | + +#### Returns + +`Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[instanceFromDDO](ConsumerCondition.md#instancefromddo) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L142) + +--- + +### nftContractFromService + +▸ **nftContractFromService**(`service`): `string` + +#### Parameters + +| Name | Type | +| :-------- | :------------------------------------------------ | +| `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | + +#### Returns + +`string` + +#### Defined in + +[src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts#L32) + +--- + +### params + +▸ **params**(`did`, `holderAddress`, `nftTokenAddress`): [`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> + +Generate the hash of condition inputs with the following parameters. + +#### Parameters + +| Name | Type | Description | +| :---------------- | :------- | :----------------------------------------- | +| `did` | `string` | The Decentralized Identifier of the asset. | +| `holderAddress` | `string` | The address of the NFT holder . | +| `nftTokenAddress` | `string` | The address of the nft 721 token to use | + +#### Returns + +[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> + +hash of all the values + +#### Overrides + +[ConsumerCondition](ConsumerCondition.md).[params](ConsumerCondition.md#params) + +#### Defined in + +[src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts#L28) + +--- + +### paramsFromDDO + +▸ **paramsFromDDO**(`«destructured»`): `Promise`<[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :--------------- | :----------------------------- | +| `«destructured»` | `NFT721HolderConditionContext` | + +#### Returns + +`Promise`<[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> + +#### Overrides + +[ConsumerCondition](ConsumerCondition.md).[paramsFromDDO](ConsumerCondition.md#paramsfromddo) + +#### Defined in + +[src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts:38](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts#L38) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[send](ConsumerCondition.md#send) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[sendFrom](ConsumerCondition.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[setInstanceConfig](ConsumerCondition.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`): `Promise`<[`NFT721HolderCondition`](NFT721HolderCondition.md)\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`Promise`<[`NFT721HolderCondition`](NFT721HolderCondition.md)\> + +#### Overrides + +[ConsumerCondition](ConsumerCondition.md).[getInstance](ConsumerCondition.md#getinstance) + +#### Defined in + +[src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts:16](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts#L16) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[setInstanceConfig](ConsumerCondition.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/NFT721LockCondition.md b/docs/api-reference/classes/NFT721LockCondition.md new file mode 100644 index 000000000..5f9716f03 --- /dev/null +++ b/docs/api-reference/classes/NFT721LockCondition.md @@ -0,0 +1,975 @@ +[@nevermined-io/sdk](../code-reference.md) / NFT721LockCondition + +# Class: NFT721LockCondition + +Implementation of the NFT Lock Condition + +## Hierarchy + +- [`ProviderCondition`](ProviderCondition.md)<`NFT721LockConditionContext`\> + + ↳ **`NFT721LockCondition`** + +## Table of contents + +### Constructors + +- [constructor](NFT721LockCondition.md#constructor) + +### Properties + +- [address](NFT721LockCondition.md#address) +- [contract](NFT721LockCondition.md#contract) +- [contractName](NFT721LockCondition.md#contractname) +- [events](NFT721LockCondition.md#events) +- [version](NFT721LockCondition.md#version) + +### Accessors + +- [artifactsFolder](NFT721LockCondition.md#artifactsfolder) +- [circuitsFolder](NFT721LockCondition.md#circuitsfolder) +- [config](NFT721LockCondition.md#config) +- [instanceConfig](NFT721LockCondition.md#instanceconfig) +- [instantiableConfig](NFT721LockCondition.md#instantiableconfig) +- [logger](NFT721LockCondition.md#logger) +- [nevermined](NFT721LockCondition.md#nevermined) +- [web3](NFT721LockCondition.md#web3) + +### Methods + +- [abortByTimeOut](NFT721LockCondition.md#abortbytimeout) +- [call](NFT721LockCondition.md#call) +- [fulfill](NFT721LockCondition.md#fulfill) +- [fulfillInstance](NFT721LockCondition.md#fulfillinstance) +- [fulfillPlain](NFT721LockCondition.md#fulfillplain) +- [fulfillWithNode](NFT721LockCondition.md#fulfillwithnode) +- [generateId](NFT721LockCondition.md#generateid) +- [generateIdHash](NFT721LockCondition.md#generateidhash) +- [generateIdWithSeed](NFT721LockCondition.md#generateidwithseed) +- [getConditionFulfilledEvent](NFT721LockCondition.md#getconditionfulfilledevent) +- [getFromAddress](NFT721LockCondition.md#getfromaddress) +- [getInputsOfMethod](NFT721LockCondition.md#getinputsofmethod) +- [getSignatureOfMethod](NFT721LockCondition.md#getsignatureofmethod) +- [hashValues](NFT721LockCondition.md#hashvalues) +- [hashValuesPlain](NFT721LockCondition.md#hashvaluesplain) +- [init](NFT721LockCondition.md#init) +- [instance](NFT721LockCondition.md#instance) +- [instanceFromDDO](NFT721LockCondition.md#instancefromddo) +- [nodeMethod](NFT721LockCondition.md#nodemethod) +- [params](NFT721LockCondition.md#params) +- [paramsFromDDO](NFT721LockCondition.md#paramsfromddo) +- [send](NFT721LockCondition.md#send) +- [sendFrom](NFT721LockCondition.md#sendfrom) +- [setInstanceConfig](NFT721LockCondition.md#setinstanceconfig) +- [getInstance](NFT721LockCondition.md#getinstance) +- [setInstanceConfig](NFT721LockCondition.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new NFT721LockCondition**(`contractName`) + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[constructor](ProviderCondition.md#constructor) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L34) + +## Properties + +### address + +• **address**: `string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[address](ProviderCondition.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[contract](ProviderCondition.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[contractName](ProviderCondition.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[events](ProviderCondition.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[version](ProviderCondition.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ProviderCondition.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ProviderCondition.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +ProviderCondition.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ProviderCondition.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ProviderCondition.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +ProviderCondition.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +ProviderCondition.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +ProviderCondition.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### abortByTimeOut + +▸ **abortByTimeOut**(`conditionId`, `from?`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------------ | :---------------------------------------------- | +| `conditionId` | `string` | +| `from?` | [`Account`](Account.md) | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[abortByTimeOut](ProviderCondition.md#abortbytimeout) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L88) + +--- + +### 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 + +[ProviderCondition](ProviderCondition.md).[call](ProviderCondition.md#call) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### fulfill + +▸ **fulfill**(`agreementId`, `did`, `lockAddress`, `amount`, `nftContractAddress`, `from?`): `Promise`<`ContractTransactionReceipt`\> + +Fulfill requires valid NFT transfer in order to lock the amount of DID NFTs based on SEA. + +#### Parameters + +| Name | Type | Description | +| :------------------- | :---------------------- | :-------------------------------------------- | +| `agreementId` | `string` | SEA agreement identifier. | +| `did` | `string` | Asset Decentralized identifier. | +| `lockAddress` | `string` | The contract address where the NFT is locked. | +| `amount` | `number` | The amount of tokens to be locked. | +| `nftContractAddress` | `string` | The NFT721 contract address | +| `from?` | [`Account`](Account.md) | | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +Condition state. + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[fulfill](ProviderCondition.md#fulfill) + +#### Defined in + +[src/keeper/contracts/defi/NFT721LockCondition.ts:56](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/NFT721LockCondition.ts#L56) + +--- + +### fulfillInstance + +▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `txParams?`, `method?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | Default value | +| :----------------- | :----------------------------------------------------------------------------------------- | :------------ | +| `cond` | [`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | +| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | +| `from?` | [`Account`](Account.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[fulfillInstance](ProviderCondition.md#fulfillinstance) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:150](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L150) + +--- + +### fulfillPlain + +▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `txParams?`, `method?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | Default value | +| :------------ | :-------------------------------------------------------- | :------------ | +| `agreementId` | `string` | `undefined` | +| `args` | `any`[] | `undefined` | +| `from?` | [`Account`](Account.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[fulfillPlain](ProviderCondition.md#fulfillplain) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L63) + +--- + +### fulfillWithNode + +▸ **fulfillWithNode**(`cond`, `additionalParams`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :----------------- | :----------------------------------------------------------------------------------------- | +| `cond` | [`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | +| `additionalParams` | `Record`<`string`, `unknown`\> | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[fulfillWithNode](ProviderCondition.md#fulfillwithnode) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:194](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L194) + +--- + +### generateId + +▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `valueHash` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[generateId](ProviderCondition.md#generateid) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L77) + +--- + +### generateIdHash + +▸ **generateIdHash**(`agreementId`, `...values`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `...values` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[generateIdHash](ProviderCondition.md#generateidhash) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L73) + +--- + +### generateIdWithSeed + +▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `valueHash` | `string` | + +#### Returns + +`Promise`<[`string`, `string`]\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[generateIdWithSeed](ProviderCondition.md#generateidwithseed) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L81) + +--- + +### getConditionFulfilledEvent + +▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../code-reference.md#eventresult) + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | + +#### Returns + +[`EventResult`](../code-reference.md#eventresult) + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getConditionFulfilledEvent](ProviderCondition.md#getconditionfulfilledevent) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L92) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getFromAddress](ProviderCondition.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getInputsOfMethod](ProviderCondition.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getSignatureOfMethod](ProviderCondition.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### hashValues + +▸ **hashValues**(`...args`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[hashValues](ProviderCondition.md#hashvalues) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L129) + +--- + +### hashValuesPlain + +▸ **hashValuesPlain**(`...args`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[hashValuesPlain](ProviderCondition.md#hashvaluesplain) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:133](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L133) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[init](ProviderCondition.md#init) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### instance + +▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :------------ | :--------------------------------------------------------------------------------------------- | +| `agreementId` | `string` | +| `params` | [`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | + +#### Returns + +`Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[instance](ProviderCondition.md#instance) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:174](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L174) + +--- + +### instanceFromDDO + +▸ **instanceFromDDO**(`agreementId`, `ctx`, `...args`): `Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------------------------------------------- | +| `agreementId` | `string` | +| `ctx` | `NFT721LockConditionContext` | +| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | + +#### Returns + +`Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[instanceFromDDO](ProviderCondition.md#instancefromddo) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L142) + +--- + +### nodeMethod + +▸ **nodeMethod**(): [`ConditionMethod`](../code-reference.md#conditionmethod) + +#### Returns + +[`ConditionMethod`](../code-reference.md#conditionmethod) + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[nodeMethod](ProviderCondition.md#nodemethod) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:208](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L208) + +--- + +### params + +▸ **params**(`did`, `lockAddress`, `amount`, `nftContractAddress`): [`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> + +Generates the hash of condition inputs. + +#### Parameters + +| Name | Type | Description | +| :------------------- | :------- | :----------------------------------------------- | +| `did` | `string` | The DID of the asset with NFTs attached to lock. | +| `lockAddress` | `string` | the address to lock the NFT to (vault address) | +| `amount` | `number` | The amount of locked tokens. | +| `nftContractAddress` | `string` | The NFT721 contract address | + +#### Returns + +[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> + +Hash of all the values. + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[params](ProviderCondition.md#params) + +#### Defined in + +[src/keeper/contracts/defi/NFT721LockCondition.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/NFT721LockCondition.ts#L28) + +--- + +### paramsFromDDO + +▸ **paramsFromDDO**(`«destructured»`): `Promise`<[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :--------------- | :--------------------------- | +| `«destructured»` | `NFT721LockConditionContext` | + +#### Returns + +`Promise`<[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[paramsFromDDO](ProviderCondition.md#paramsfromddo) + +#### Defined in + +[src/keeper/contracts/defi/NFT721LockCondition.ts:37](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/NFT721LockCondition.ts#L37) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[send](ProviderCondition.md#send) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[sendFrom](ProviderCondition.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[setInstanceConfig](ProviderCondition.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`): `Promise`<[`NFT721LockCondition`](NFT721LockCondition.md)\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`Promise`<[`NFT721LockCondition`](NFT721LockCondition.md)\> + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[getInstance](ProviderCondition.md#getinstance) + +#### Defined in + +[src/keeper/contracts/defi/NFT721LockCondition.ts:16](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/NFT721LockCondition.ts#L16) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[setInstanceConfig](ProviderCondition.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/NFT721SalesTemplate.md b/docs/api-reference/classes/NFT721SalesTemplate.md new file mode 100644 index 000000000..1e8089f31 --- /dev/null +++ b/docs/api-reference/classes/NFT721SalesTemplate.md @@ -0,0 +1,1440 @@ +[@nevermined-io/sdk](../code-reference.md) / NFT721SalesTemplate + +# Class: NFT721SalesTemplate + +## Hierarchy + +- [`BaseTemplate`](BaseTemplate.md)<`NFT721SalesTemplateParams`, [`ServiceNFTSales`](../interfaces/ServiceNFTSales.md)\> + + ↳ **`NFT721SalesTemplate`** + +## Table of contents + +### Constructors + +- [constructor](NFT721SalesTemplate.md#constructor) + +### Properties + +- [address](NFT721SalesTemplate.md#address) +- [contract](NFT721SalesTemplate.md#contract) +- [contractName](NFT721SalesTemplate.md#contractname) +- [events](NFT721SalesTemplate.md#events) +- [version](NFT721SalesTemplate.md#version) + +### Accessors + +- [artifactsFolder](NFT721SalesTemplate.md#artifactsfolder) +- [circuitsFolder](NFT721SalesTemplate.md#circuitsfolder) +- [config](NFT721SalesTemplate.md#config) +- [instanceConfig](NFT721SalesTemplate.md#instanceconfig) +- [instantiableConfig](NFT721SalesTemplate.md#instantiableconfig) +- [logger](NFT721SalesTemplate.md#logger) +- [nevermined](NFT721SalesTemplate.md#nevermined) +- [web3](NFT721SalesTemplate.md#web3) + +### Methods + +- [accept](NFT721SalesTemplate.md#accept) +- [agreementId](NFT721SalesTemplate.md#agreementid) +- [call](NFT721SalesTemplate.md#call) +- [conditions](NFT721SalesTemplate.md#conditions) +- [createAgreement](NFT721SalesTemplate.md#createagreement) +- [createAgreementAndPay](NFT721SalesTemplate.md#createagreementandpay) +- [createAgreementFromDDO](NFT721SalesTemplate.md#createagreementfromddo) +- [createAgreementWithPaymentFromDDO](NFT721SalesTemplate.md#createagreementwithpaymentfromddo) +- [createService](NFT721SalesTemplate.md#createservice) +- [description](NFT721SalesTemplate.md#description) +- [extraGen](NFT721SalesTemplate.md#extragen) +- [getAgreementCreatedEvent](NFT721SalesTemplate.md#getagreementcreatedevent) +- [getAgreementData](NFT721SalesTemplate.md#getagreementdata) +- [getAgreementIdsFromDDO](NFT721SalesTemplate.md#getagreementidsfromddo) +- [getAgreementStatus](NFT721SalesTemplate.md#getagreementstatus) +- [getAgreementsForDID](NFT721SalesTemplate.md#getagreementsfordid) +- [getConditionTypes](NFT721SalesTemplate.md#getconditiontypes) +- [getConditions](NFT721SalesTemplate.md#getconditions) +- [getFromAddress](NFT721SalesTemplate.md#getfromaddress) +- [getInputsOfMethod](NFT721SalesTemplate.md#getinputsofmethod) +- [getServiceAgreementTemplate](NFT721SalesTemplate.md#getserviceagreementtemplate) +- [getServiceAgreementTemplateConditionByRef](NFT721SalesTemplate.md#getserviceagreementtemplateconditionbyref) +- [getServiceAgreementTemplateConditions](NFT721SalesTemplate.md#getserviceagreementtemplateconditions) +- [getServiceAgreementTemplateDependencies](NFT721SalesTemplate.md#getserviceagreementtemplatedependencies) +- [getSignatureOfMethod](NFT721SalesTemplate.md#getsignatureofmethod) +- [init](NFT721SalesTemplate.md#init) +- [instanceFromDDO](NFT721SalesTemplate.md#instancefromddo) +- [lockConditionIndex](NFT721SalesTemplate.md#lockconditionindex) +- [lockTokens](NFT721SalesTemplate.md#locktokens) +- [name](NFT721SalesTemplate.md#name) +- [params](NFT721SalesTemplate.md#params) +- [paramsGen](NFT721SalesTemplate.md#paramsgen) +- [paymentData](NFT721SalesTemplate.md#paymentdata) +- [printAgreementStatus](NFT721SalesTemplate.md#printagreementstatus) +- [process](NFT721SalesTemplate.md#process) +- [send](NFT721SalesTemplate.md#send) +- [sendFrom](NFT721SalesTemplate.md#sendfrom) +- [service](NFT721SalesTemplate.md#service) +- [serviceEndpoint](NFT721SalesTemplate.md#serviceendpoint) +- [setInstanceConfig](NFT721SalesTemplate.md#setinstanceconfig) +- [standardContext](NFT721SalesTemplate.md#standardcontext) +- [track](NFT721SalesTemplate.md#track) +- [validateAgreement](NFT721SalesTemplate.md#validateagreement) +- [getInstance](NFT721SalesTemplate.md#getinstance) +- [setInstanceConfig](NFT721SalesTemplate.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• `Protected` **new NFT721SalesTemplate**(`contractName`) + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[constructor](BaseTemplate.md#constructor) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:68](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L68) + +## Properties + +### address + +• **address**: `string` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[address](BaseTemplate.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[contract](BaseTemplate.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[contractName](BaseTemplate.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[events](BaseTemplate.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[version](BaseTemplate.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +BaseTemplate.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +BaseTemplate.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +BaseTemplate.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +BaseTemplate.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +BaseTemplate.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +BaseTemplate.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +BaseTemplate.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +BaseTemplate.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### accept + +▸ **accept**(`_params`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :-------- | :------------------------------------------------------ | +| `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | + +#### Returns + +`Promise`<`boolean`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[accept](BaseTemplate.md#accept) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:98](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L98) + +--- + +### agreementId + +▸ **agreementId**(`agreementIdSeed`, `creator`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :---------------- | :------- | +| `agreementIdSeed` | `string` | +| `creator` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[agreementId](BaseTemplate.md#agreementid) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:213](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L213) + +--- + +### 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 + +[BaseTemplate](BaseTemplate.md).[call](BaseTemplate.md#call) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### conditions + +▸ **conditions**(): [[`LockPaymentCondition`](LockPaymentCondition.md), [`TransferNFT721Condition`](TransferNFT721Condition.md), [`EscrowPaymentCondition`](EscrowPaymentCondition.md)] + +#### Returns + +[[`LockPaymentCondition`](LockPaymentCondition.md), [`TransferNFT721Condition`](TransferNFT721Condition.md), [`EscrowPaymentCondition`](EscrowPaymentCondition.md)] + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[conditions](BaseTemplate.md#conditions) + +#### Defined in + +[src/keeper/contracts/templates/NFT721SalesTemplate.ts:56](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L56) + +--- + +### createAgreement + +▸ **createAgreement**(`agreementId`, `did`, `conditionIds`, `timeLocks`, `timeOuts`, `extraArgs`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `agreementId` | `string` | +| `did` | `string` | +| `conditionIds` | `string`[] | +| `timeLocks` | `number`[] | +| `timeOuts` | `number`[] | +| `extraArgs` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[createAgreement](BaseTemplate.md#createagreement) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L90) + +--- + +### createAgreementAndPay + +▸ **createAgreementAndPay**(`agreementId`, `did`, `conditionIds`, `timeLocks`, `timeOuts`, `accessConsumer`, `condIdx`, `rewardAddress`, `tokenAddress`, `amounts`, `receivers`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :--------------- | :---------------------------------------------- | +| `agreementId` | `string` | +| `did` | `string` | +| `conditionIds` | `string`[] | +| `timeLocks` | `number`[] | +| `timeOuts` | `number`[] | +| `accessConsumer` | `string` | +| `condIdx` | `number` | +| `rewardAddress` | `string` | +| `tokenAddress` | `string` | +| `amounts` | `bigint`[] | +| `receivers` | `string`[] | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[createAgreementAndPay](BaseTemplate.md#createagreementandpay) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L115) + +--- + +### createAgreementFromDDO + +▸ **createAgreementFromDDO**(`agreementIdSeed`, `ddo`, `parameters`, `consumer`, `from`, `timeOuts?`, `txParams?`): `Promise`<`string`\> + +Create a new agreement using the data of a DDO. + +#### Parameters + +| Name | Type | Description | +| :---------------- | :---------------------------------------------- | :---------- | +| `agreementIdSeed` | `string` | - | +| `ddo` | [`DDO`](DDO.md) | DDO. | +| `parameters` | `NFT721SalesTemplateParams` | | +| `consumer` | [`Account`](Account.md) | - | +| `from` | [`Account`](Account.md) | - | +| `timeOuts?` | `number`[] | - | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | + +#### Returns + +`Promise`<`string`\> + +true if the call was successful. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[createAgreementFromDDO](BaseTemplate.md#createagreementfromddo) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:222](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L222) + +--- + +### createAgreementWithPaymentFromDDO + +▸ **createAgreementWithPaymentFromDDO**(`agreementIdSeed`, `ddo`, `serviceReference`, `parameters`, `consumer`, `from`, `txParams?`, `observer?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :----------------- | :------------------------------------------------------------------------------------ | +| `agreementIdSeed` | `string` | +| `ddo` | [`DDO`](DDO.md) | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | +| `parameters` | `NFT721SalesTemplateParams` | +| `consumer` | [`Account`](Account.md) | +| `from` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| `observer?` | (`orderProgressStep`: [`OrderProgressStep`](../enums/OrderProgressStep.md)) => `void` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[createAgreementWithPaymentFromDDO](BaseTemplate.md#createagreementwithpaymentfromddo) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:252](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L252) + +--- + +### createService + +▸ **createService**(`publisher`, `metadata`, `serviceAttributes`, `nftAttributes?`, `priceData?`): [`ServiceNFTSales`](../interfaces/ServiceNFTSales.md) + +#### Parameters + +| Name | Type | +| :------------------ | :---------------------------------------------------------------------------- | +| `publisher` | [`Account`](Account.md) | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | +| `serviceAttributes` | [`ServiceAttributes`](../interfaces/ServiceAttributes.md) | +| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | +| `priceData?` | [`PricedMetadataInformation`](../code-reference.md#pricedmetadatainformation) | + +#### Returns + +[`ServiceNFTSales`](../interfaces/ServiceNFTSales.md) + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[createService](BaseTemplate.md#createservice) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L35) + +--- + +### description + +▸ **description**(): `string` + +#### Returns + +`string` + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[description](BaseTemplate.md#description) + +#### Defined in + +[src/keeper/contracts/templates/NFT721SalesTemplate.ts:38](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L38) + +--- + +### extraGen + +▸ **extraGen**(`_params`): `Promise`<`any`\> + +#### Parameters + +| Name | Type | +| :-------- | :------------------------------------------------------ | +| `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | + +#### Returns + +`Promise`<`any`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[extraGen](BaseTemplate.md#extragen) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:94](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L94) + +--- + +### 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. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getAgreementCreatedEvent](BaseTemplate.md#getagreementcreatedevent) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:459](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L459) + +--- + +### getAgreementData + +▸ **getAgreementData**(`agreementId`): `Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | + +#### Returns + +`Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getAgreementData](BaseTemplate.md#getagreementdata) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:21](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L21) + +--- + +### getAgreementIdsFromDDO + +▸ **getAgreementIdsFromDDO**(`agreementId`, `ddo`, `creator`, `params`): `Promise`<`string`[]\> + +Get agreement conditions IDs. + +#### Parameters + +| Name | Type | Description | +| :------------ | :-------------------------- | :------------ | +| `agreementId` | `string` | Agreement ID. | +| `ddo` | [`DDO`](DDO.md) | DDO. | +| `creator` | `string` | - | +| `params` | `NFT721SalesTemplateParams` | - | + +#### Returns + +`Promise`<`string`[]\> + +The condition IDs. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getAgreementIdsFromDDO](BaseTemplate.md#getagreementidsfromddo) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:180](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L180) + +--- + +### getAgreementStatus + +▸ **getAgreementStatus**(`agreementId`): `Promise`<`false` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> + +Returns the status of the conditions. + +#### Parameters + +| Name | Type | Description | +| :------------ | :------- | :------------ | +| `agreementId` | `string` | Agreement ID. | + +#### Returns + +`Promise`<`false` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> + +The conditions status. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getAgreementStatus](BaseTemplate.md#getagreementstatus) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:346](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L346) + +--- + +### getAgreementsForDID + +▸ **getAgreementsForDID**(`did`): `Promise`<`string`[]\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `did` | `string` | + +#### Returns + +`Promise`<`string`[]\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getAgreementsForDID](BaseTemplate.md#getagreementsfordid) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:485](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L485) + +--- + +### getConditionTypes + +▸ **getConditionTypes**(): `Promise`<`string`[]\> + +Conditions address list. + +#### Returns + +`Promise`<`string`[]\> + +A list of condition addresses. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getConditionTypes](BaseTemplate.md#getconditiontypes) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L154) + +--- + +### getConditions + +▸ **getConditions**(): `Promise`<[`ConditionSmall`](ConditionSmall.md)[]\> + +List of condition contracts. + +#### Returns + +`Promise`<[`ConditionSmall`](ConditionSmall.md)[]\> + +A list of condition contracts. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getConditions](BaseTemplate.md#getconditions) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:165](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L165) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getFromAddress](BaseTemplate.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getInputsOfMethod](BaseTemplate.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getServiceAgreementTemplate + +▸ **getServiceAgreementTemplate**(): [`ServiceAgreementTemplate`](../interfaces/ServiceAgreementTemplate.md) + +#### Returns + +[`ServiceAgreementTemplate`](../interfaces/ServiceAgreementTemplate.md) + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[getServiceAgreementTemplate](BaseTemplate.md#getserviceagreementtemplate) + +#### Defined in + +[src/keeper/contracts/templates/NFT721SalesTemplate.ts:105](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L105) + +--- + +### getServiceAgreementTemplateConditionByRef + +▸ **getServiceAgreementTemplateConditionByRef**(`ref`): `Promise`<[`ConditionSmall`](ConditionSmall.md)\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `ref` | `string` | + +#### Returns + +`Promise`<[`ConditionSmall`](ConditionSmall.md)\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getServiceAgreementTemplateConditionByRef](BaseTemplate.md#getserviceagreementtemplateconditionbyref) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:329](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L329) + +--- + +### getServiceAgreementTemplateConditions + +▸ **getServiceAgreementTemplateConditions**(): [`ServiceAgreementTemplateCondition`](../interfaces/ServiceAgreementTemplateCondition.md)[] + +#### Returns + +[`ServiceAgreementTemplateCondition`](../interfaces/ServiceAgreementTemplateCondition.md)[] + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getServiceAgreementTemplateConditions](BaseTemplate.md#getserviceagreementtemplateconditions) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:324](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L324) + +--- + +### getServiceAgreementTemplateDependencies + +▸ **getServiceAgreementTemplateDependencies**(): `Promise`<{ `[condition: string]`: `string`[]; }\> + +#### Returns + +`Promise`<{ `[condition: string]`: `string`[]; }\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getServiceAgreementTemplateDependencies](BaseTemplate.md#getserviceagreementtemplatedependencies) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:336](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L336) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getSignatureOfMethod](BaseTemplate.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[init](BaseTemplate.md#init) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### instanceFromDDO + +▸ **instanceFromDDO**(`agreementIdSeed`, `ddo`, `creator`, `parameters`, `serviceReference?`): `Promise`<[`AgreementInstance`](../interfaces/AgreementInstance.md)<`NFT721SalesTemplateParams`\>\> + +#### Parameters + +| Name | Type | +| :------------------ | :-------------------------- | +| `agreementIdSeed` | `string` | +| `ddo` | [`DDO`](DDO.md) | +| `creator` | `string` | +| `parameters` | `NFT721SalesTemplateParams` | +| `serviceReference?` | `number` | + +#### Returns + +`Promise`<[`AgreementInstance`](../interfaces/AgreementInstance.md)<`NFT721SalesTemplateParams`\>\> + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[instanceFromDDO](BaseTemplate.md#instancefromddo) + +#### Defined in + +[src/keeper/contracts/templates/NFT721SalesTemplate.ts:62](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L62) + +--- + +### lockConditionIndex + +▸ **lockConditionIndex**(): `number` + +#### Returns + +`number` + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[lockConditionIndex](BaseTemplate.md#lockconditionindex) + +#### Defined in + +[src/keeper/contracts/templates/NFT721SalesTemplate.ts:52](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L52) + +--- + +### lockTokens + +▸ **lockTokens**(`tokenAddress`, `amounts`, `from`, `txParams`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `tokenAddress` | `any` | +| `amounts` | `any` | +| `from` | [`Account`](Account.md) | +| `txParams` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[lockTokens](BaseTemplate.md#locktokens) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:393](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L393) + +--- + +### name + +▸ **name**(): `string` + +#### Returns + +`string` + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[name](BaseTemplate.md#name) + +#### Defined in + +[src/keeper/contracts/templates/NFT721SalesTemplate.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L35) + +--- + +### params + +▸ **params**(`consumerId`, `expiration?`): `NFT721SalesTemplateParams` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `consumerId` | `string` | `undefined` | +| `expiration` | `number` | `0` | + +#### Returns + +`NFT721SalesTemplateParams` + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[params](BaseTemplate.md#params) + +#### Defined in + +[src/keeper/contracts/templates/NFT721SalesTemplate.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L42) + +--- + +### paramsGen + +▸ **paramsGen**(`«destructured»`): `Promise`<`NFT721SalesTemplateParams`\> + +Specialize params + +#### Parameters + +| Name | Type | Description | +| :--------------- | :------------------------------------------------------ | :----------------- | +| `«destructured»` | [`ValidationParams`](../interfaces/ValidationParams.md) | Generic parameters | + +#### Returns + +`Promise`<`NFT721SalesTemplateParams`\> + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[paramsGen](BaseTemplate.md#paramsgen) + +#### Defined in + +[src/keeper/contracts/templates/NFT721SalesTemplate.ts:45](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L45) + +--- + +### paymentData + +▸ **paymentData**(`service`): `Promise`<[`PaymentData`](../interfaces/PaymentData.md)\> + +#### Parameters + +| Name | Type | +| :-------- | :------------------------------------------------ | +| `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | + +#### Returns + +`Promise`<[`PaymentData`](../interfaces/PaymentData.md)\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[paymentData](BaseTemplate.md#paymentdata) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:78](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L78) + +--- + +### printAgreementStatus + +▸ **printAgreementStatus**(`agreementId`): `Promise`<`void`\> + +Prints the agreement status. + +#### Parameters + +| Name | Type | Description | +| :------------ | :------- | :------------ | +| `agreementId` | `string` | Agreement ID. | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[printAgreementStatus](BaseTemplate.md#printagreementstatus) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:429](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L429) + +--- + +### process + +▸ **process**(`params`, `from`, `txparams?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :---------- | :------------------------------------------------------ | +| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `from` | [`Account`](Account.md) | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[process](BaseTemplate.md#process) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:110](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L110) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[send](BaseTemplate.md#send) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[sendFrom](BaseTemplate.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### service + +▸ **service**(): [`ServiceType`](../code-reference.md#servicetype) + +#### Returns + +[`ServiceType`](../code-reference.md#servicetype) + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[service](BaseTemplate.md#service) + +#### Defined in + +[src/keeper/contracts/templates/NFT721SalesTemplate.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L28) + +--- + +### serviceEndpoint + +▸ **serviceEndpoint**(): `string` + +#### Returns + +`string` + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[serviceEndpoint](BaseTemplate.md#serviceendpoint) + +#### Defined in + +[src/keeper/contracts/templates/NFT721SalesTemplate.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L31) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[setInstanceConfig](BaseTemplate.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### standardContext + +▸ **standardContext**(`ddo`, `creator`, `serviceIndex?`): [`ConditionContext`](../interfaces/ConditionContext.md) + +#### Parameters + +| Name | Type | +| :-------------- | :-------------- | +| `ddo` | [`DDO`](DDO.md) | +| `creator` | `string` | +| `serviceIndex?` | `number` | + +#### Returns + +[`ConditionContext`](../interfaces/ConditionContext.md) + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[standardContext](BaseTemplate.md#standardcontext) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:200](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L200) + +--- + +### track + +▸ **track**(`_params`, `_from`, `_txparams?`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :----------- | :------------------------------------------------------ | +| `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `_from` | [`Account`](Account.md) | +| `_txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`boolean`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[track](BaseTemplate.md#track) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:102](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L102) + +--- + +### validateAgreement + +▸ **validateAgreement**(`agreement_id`, `did`, `params`, `from`, `extra?`, `txparams?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `agreement_id` | `string` | +| `did` | `string` | +| `params` | `NFT721SalesTemplateParams` | +| `from` | [`Account`](Account.md) | +| `extra` | `any` | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[validateAgreement](BaseTemplate.md#validateagreement) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:125](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L125) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`): `Promise`<[`NFT721SalesTemplate`](NFT721SalesTemplate.md)\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`Promise`<[`NFT721SalesTemplate`](NFT721SalesTemplate.md)\> + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[getInstance](BaseTemplate.md#getinstance) + +#### Defined in + +[src/keeper/contracts/templates/NFT721SalesTemplate.ts:24](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L24) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[setInstanceConfig](BaseTemplate.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/NFTAccessCondition.md b/docs/api-reference/classes/NFTAccessCondition.md new file mode 100644 index 000000000..4e014989b --- /dev/null +++ b/docs/api-reference/classes/NFTAccessCondition.md @@ -0,0 +1,985 @@ +[@nevermined-io/sdk](../code-reference.md) / NFTAccessCondition + +# Class: NFTAccessCondition + +## Hierarchy + +- [`ProviderCondition`](ProviderCondition.md)<`NFTAccessConditionContext`\> + + ↳ **`NFTAccessCondition`** + +## Table of contents + +### Constructors + +- [constructor](NFTAccessCondition.md#constructor) + +### Properties + +- [address](NFTAccessCondition.md#address) +- [contract](NFTAccessCondition.md#contract) +- [contractName](NFTAccessCondition.md#contractname) +- [events](NFTAccessCondition.md#events) +- [version](NFTAccessCondition.md#version) + +### Accessors + +- [artifactsFolder](NFTAccessCondition.md#artifactsfolder) +- [circuitsFolder](NFTAccessCondition.md#circuitsfolder) +- [config](NFTAccessCondition.md#config) +- [instanceConfig](NFTAccessCondition.md#instanceconfig) +- [instantiableConfig](NFTAccessCondition.md#instantiableconfig) +- [logger](NFTAccessCondition.md#logger) +- [nevermined](NFTAccessCondition.md#nevermined) +- [web3](NFTAccessCondition.md#web3) + +### Methods + +- [abortByTimeOut](NFTAccessCondition.md#abortbytimeout) +- [call](NFTAccessCondition.md#call) +- [checkPermissions](NFTAccessCondition.md#checkpermissions) +- [fulfill](NFTAccessCondition.md#fulfill) +- [fulfillInstance](NFTAccessCondition.md#fulfillinstance) +- [fulfillPlain](NFTAccessCondition.md#fulfillplain) +- [fulfillWithNode](NFTAccessCondition.md#fulfillwithnode) +- [generateId](NFTAccessCondition.md#generateid) +- [generateIdHash](NFTAccessCondition.md#generateidhash) +- [generateIdWithSeed](NFTAccessCondition.md#generateidwithseed) +- [getConditionFulfilledEvent](NFTAccessCondition.md#getconditionfulfilledevent) +- [getFromAddress](NFTAccessCondition.md#getfromaddress) +- [getInputsOfMethod](NFTAccessCondition.md#getinputsofmethod) +- [getSignatureOfMethod](NFTAccessCondition.md#getsignatureofmethod) +- [hashValues](NFTAccessCondition.md#hashvalues) +- [hashValuesPlain](NFTAccessCondition.md#hashvaluesplain) +- [init](NFTAccessCondition.md#init) +- [instance](NFTAccessCondition.md#instance) +- [instanceFromDDO](NFTAccessCondition.md#instancefromddo) +- [nodeMethod](NFTAccessCondition.md#nodemethod) +- [params](NFTAccessCondition.md#params) +- [paramsFromDDO](NFTAccessCondition.md#paramsfromddo) +- [send](NFTAccessCondition.md#send) +- [sendFrom](NFTAccessCondition.md#sendfrom) +- [setInstanceConfig](NFTAccessCondition.md#setinstanceconfig) +- [getInstance](NFTAccessCondition.md#getinstance) +- [setInstanceConfig](NFTAccessCondition.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new NFTAccessCondition**(`contractName`) + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[constructor](ProviderCondition.md#constructor) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L34) + +## Properties + +### address + +• **address**: `string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[address](ProviderCondition.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[contract](ProviderCondition.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[contractName](ProviderCondition.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[events](ProviderCondition.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[version](ProviderCondition.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ProviderCondition.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ProviderCondition.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +ProviderCondition.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ProviderCondition.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ProviderCondition.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +ProviderCondition.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +ProviderCondition.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +ProviderCondition.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### abortByTimeOut + +▸ **abortByTimeOut**(`conditionId`, `from?`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------------ | :---------------------------------------------- | +| `conditionId` | `string` | +| `from?` | [`Account`](Account.md) | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[abortByTimeOut](ProviderCondition.md#abortbytimeout) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L88) + +--- + +### 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 + +[ProviderCondition](ProviderCondition.md).[call](ProviderCondition.md#call) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### checkPermissions + +▸ **checkPermissions**(`grantee`, `did`, `from?`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :-------- | :---------------------- | +| `grantee` | `string` | +| `did` | `string` | +| `from?` | [`Account`](Account.md) | + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts#L34) + +--- + +### fulfill + +▸ **fulfill**(`agreementId`, `did`, `grantee`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------------ | :---------------------------------------------- | +| `agreementId` | `string` | +| `did` | `string` | +| `grantee` | `string` | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[fulfill](ProviderCondition.md#fulfill) + +#### Defined in + +[src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts:24](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts#L24) + +--- + +### fulfillInstance + +▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `txParams?`, `method?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | Default value | +| :----------------- | :----------------------------------------------------------------------------------------- | :------------ | +| `cond` | [`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | +| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | +| `from?` | [`Account`](Account.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[fulfillInstance](ProviderCondition.md#fulfillinstance) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:150](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L150) + +--- + +### fulfillPlain + +▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `txParams?`, `method?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | Default value | +| :------------ | :-------------------------------------------------------- | :------------ | +| `agreementId` | `string` | `undefined` | +| `args` | `any`[] | `undefined` | +| `from?` | [`Account`](Account.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[fulfillPlain](ProviderCondition.md#fulfillplain) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L63) + +--- + +### fulfillWithNode + +▸ **fulfillWithNode**(`cond`, `additionalParams`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :----------------- | :----------------------------------------------------------------------------------------- | +| `cond` | [`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | +| `additionalParams` | `Record`<`string`, `unknown`\> | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[fulfillWithNode](ProviderCondition.md#fulfillwithnode) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:194](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L194) + +--- + +### generateId + +▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `valueHash` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[generateId](ProviderCondition.md#generateid) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L77) + +--- + +### generateIdHash + +▸ **generateIdHash**(`agreementId`, `...values`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `...values` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[generateIdHash](ProviderCondition.md#generateidhash) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L73) + +--- + +### generateIdWithSeed + +▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `valueHash` | `string` | + +#### Returns + +`Promise`<[`string`, `string`]\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[generateIdWithSeed](ProviderCondition.md#generateidwithseed) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L81) + +--- + +### getConditionFulfilledEvent + +▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../code-reference.md#eventresult) + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | + +#### Returns + +[`EventResult`](../code-reference.md#eventresult) + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getConditionFulfilledEvent](ProviderCondition.md#getconditionfulfilledevent) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L92) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getFromAddress](ProviderCondition.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getInputsOfMethod](ProviderCondition.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getSignatureOfMethod](ProviderCondition.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### hashValues + +▸ **hashValues**(`...args`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[hashValues](ProviderCondition.md#hashvalues) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L129) + +--- + +### hashValuesPlain + +▸ **hashValuesPlain**(`...args`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[hashValuesPlain](ProviderCondition.md#hashvaluesplain) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:133](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L133) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[init](ProviderCondition.md#init) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### instance + +▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :------------ | :--------------------------------------------------------------------------------------------- | +| `agreementId` | `string` | +| `params` | [`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | + +#### Returns + +`Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[instance](ProviderCondition.md#instance) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:174](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L174) + +--- + +### instanceFromDDO + +▸ **instanceFromDDO**(`agreementId`, `ctx`, `...args`): `Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------------------------------------------- | +| `agreementId` | `string` | +| `ctx` | `NFTAccessConditionContext` | +| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | + +#### Returns + +`Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[instanceFromDDO](ProviderCondition.md#instancefromddo) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L142) + +--- + +### nodeMethod + +▸ **nodeMethod**(): [`ConditionMethod`](../code-reference.md#conditionmethod) + +#### Returns + +[`ConditionMethod`](../code-reference.md#conditionmethod) + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[nodeMethod](ProviderCondition.md#nodemethod) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:208](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L208) + +--- + +### params + +▸ **params**(`did`, `grantee`): [`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `did` | `string` | +| `grantee` | `string` | + +#### Returns + +[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[params](ProviderCondition.md#params) + +#### Defined in + +[src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts:16](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts#L16) + +--- + +### paramsFromDDO + +▸ **paramsFromDDO**(`«destructured»`): `Promise`<[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :--------------- | :-------------------------- | +| `«destructured»` | `NFTAccessConditionContext` | + +#### Returns + +`Promise`<[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[paramsFromDDO](ProviderCondition.md#paramsfromddo) + +#### Defined in + +[src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts:20](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts#L20) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[send](ProviderCondition.md#send) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[sendFrom](ProviderCondition.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[setInstanceConfig](ProviderCondition.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`): `Promise`<[`NFTAccessCondition`](NFTAccessCondition.md)\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`Promise`<[`NFTAccessCondition`](NFTAccessCondition.md)\> + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[getInstance](ProviderCondition.md#getinstance) + +#### Defined in + +[src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts:12](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts#L12) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[setInstanceConfig](ProviderCondition.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/NFTAccessService.md b/docs/api-reference/classes/NFTAccessService.md new file mode 100644 index 000000000..d5774f2fa --- /dev/null +++ b/docs/api-reference/classes/NFTAccessService.md @@ -0,0 +1,433 @@ +[@nevermined-io/sdk](../code-reference.md) / NFTAccessService + +# Class: NFTAccessService + +## Hierarchy + +- [`Instantiable`](Instantiable.md) + + ↳ **`NFTAccessService`** + +## Implements + +- [`ServicePlugin`](../interfaces/ServicePlugin.md)<[`ServiceNFTAccess`](../interfaces/ServiceNFTAccess.md)\> + +## Table of contents + +### Constructors + +- [constructor](NFTAccessService.md#constructor) + +### Properties + +- [normal](NFTAccessService.md#normal) +- [normal721](NFTAccessService.md#normal721) + +### Accessors + +- [artifactsFolder](NFTAccessService.md#artifactsfolder) +- [circuitsFolder](NFTAccessService.md#circuitsfolder) +- [config](NFTAccessService.md#config) +- [instanceConfig](NFTAccessService.md#instanceconfig) +- [instantiableConfig](NFTAccessService.md#instantiableconfig) +- [logger](NFTAccessService.md#logger) +- [nevermined](NFTAccessService.md#nevermined) +- [web3](NFTAccessService.md#web3) + +### Methods + +- [accept](NFTAccessService.md#accept) +- [createService](NFTAccessService.md#createservice) +- [process](NFTAccessService.md#process) +- [select](NFTAccessService.md#select) +- [setInstanceConfig](NFTAccessService.md#setinstanceconfig) +- [track](NFTAccessService.md#track) +- [getInstance](NFTAccessService.md#getinstance) +- [setInstanceConfig](NFTAccessService.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new NFTAccessService**(`config`) + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Overrides + +[Instantiable](Instantiable.md).[constructor](Instantiable.md#constructor) + +#### Defined in + +[src/nevermined/AccessService.ts:78](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/AccessService.ts#L78) + +## Properties + +### normal + +• **normal**: [`NFTAccessTemplate`](NFTAccessTemplate.md) + +#### Defined in + +[src/nevermined/AccessService.ts:75](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/AccessService.ts#L75) + +--- + +### normal721 + +• **normal721**: [`NFT721AccessTemplate`](NFT721AccessTemplate.md) + +#### Defined in + +[src/nevermined/AccessService.ts:76](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/AccessService.ts#L76) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +Instantiable.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +Instantiable.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +Instantiable.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +Instantiable.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### accept + +▸ **accept**(`params`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :------- | :------------------------------------------------------ | +| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | + +#### Returns + +`Promise`<`boolean`\> + +#### Implementation of + +[ServicePlugin](../interfaces/ServicePlugin.md).[accept](../interfaces/ServicePlugin.md#accept) + +#### Defined in + +[src/nevermined/AccessService.ts:115](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/AccessService.ts#L115) + +--- + +### createService + +▸ **createService**(`publisher`, `metadata`, `serviceAttributes`, `nftAttributes?`, `pricedData?`): [`ServiceNFTAccess`](../interfaces/ServiceNFTAccess.md) + +#### Parameters + +| Name | Type | +| :------------------ | :---------------------------------------------------------------------------- | +| `publisher` | [`Account`](Account.md) | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | +| `serviceAttributes` | [`ServiceAttributes`](../interfaces/ServiceAttributes.md) | +| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | +| `pricedData?` | [`PricedMetadataInformation`](../code-reference.md#pricedmetadatainformation) | + +#### Returns + +[`ServiceNFTAccess`](../interfaces/ServiceNFTAccess.md) + +#### Implementation of + +[ServicePlugin](../interfaces/ServicePlugin.md).[createService](../interfaces/ServicePlugin.md#createservice) + +#### Defined in + +[src/nevermined/AccessService.ts:85](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/AccessService.ts#L85) + +--- + +### process + +▸ **process**(`params`, `from`, `txparams?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :---------- | :------------------------------------------------------ | +| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `from` | [`Account`](Account.md) | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`void`\> + +#### Implementation of + +[ServicePlugin](../interfaces/ServicePlugin.md).[process](../interfaces/ServicePlugin.md#process) + +#### Defined in + +[src/nevermined/AccessService.ts:106](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/AccessService.ts#L106) + +--- + +### select + +▸ **select**(`main`): [`ServicePlugin`](../interfaces/ServicePlugin.md)<[`ServiceNFTAccess`](../interfaces/ServiceNFTAccess.md)\> + +#### Parameters + +| Name | Type | +| :----- | :---------------------------------------------- | +| `main` | [`MetaDataMain`](../interfaces/MetaDataMain.md) | + +#### Returns + +[`ServicePlugin`](../interfaces/ServicePlugin.md)<[`ServiceNFTAccess`](../interfaces/ServiceNFTAccess.md)\> + +#### Defined in + +[src/nevermined/AccessService.ts:102](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/AccessService.ts#L102) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### track + +▸ **track**(`params`, `from`, `txparams?`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :---------- | :------------------------------------------------------ | +| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `from` | [`Account`](Account.md) | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`boolean`\> + +#### Implementation of + +[ServicePlugin](../interfaces/ServicePlugin.md).[track](../interfaces/ServicePlugin.md#track) + +#### Defined in + +[src/nevermined/AccessService.ts:120](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/AccessService.ts#L120) + +--- + +### getInstance + +▸ `Static` **getInstance**(`..._args`): `any` + +#### Parameters + +| Name | Type | +| :--------- | :---- | +| `..._args` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[Instantiable](Instantiable.md).[getInstance](Instantiable.md#getinstance) + +#### Defined in + +[src/Instantiable.abstract.ts:86](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L86) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/NFTAccessTemplate.md b/docs/api-reference/classes/NFTAccessTemplate.md new file mode 100644 index 000000000..316920ce3 --- /dev/null +++ b/docs/api-reference/classes/NFTAccessTemplate.md @@ -0,0 +1,1439 @@ +[@nevermined-io/sdk](../code-reference.md) / NFTAccessTemplate + +# Class: NFTAccessTemplate + +## Hierarchy + +- [`BaseTemplate`](BaseTemplate.md)<`NFTAccessTemplateParams`, [`ServiceNFTAccess`](../interfaces/ServiceNFTAccess.md)\> + + ↳ **`NFTAccessTemplate`** + +## Table of contents + +### Constructors + +- [constructor](NFTAccessTemplate.md#constructor) + +### Properties + +- [address](NFTAccessTemplate.md#address) +- [contract](NFTAccessTemplate.md#contract) +- [contractName](NFTAccessTemplate.md#contractname) +- [events](NFTAccessTemplate.md#events) +- [version](NFTAccessTemplate.md#version) + +### Accessors + +- [artifactsFolder](NFTAccessTemplate.md#artifactsfolder) +- [circuitsFolder](NFTAccessTemplate.md#circuitsfolder) +- [config](NFTAccessTemplate.md#config) +- [instanceConfig](NFTAccessTemplate.md#instanceconfig) +- [instantiableConfig](NFTAccessTemplate.md#instantiableconfig) +- [logger](NFTAccessTemplate.md#logger) +- [nevermined](NFTAccessTemplate.md#nevermined) +- [web3](NFTAccessTemplate.md#web3) + +### Methods + +- [accept](NFTAccessTemplate.md#accept) +- [agreementId](NFTAccessTemplate.md#agreementid) +- [call](NFTAccessTemplate.md#call) +- [conditions](NFTAccessTemplate.md#conditions) +- [createAgreement](NFTAccessTemplate.md#createagreement) +- [createAgreementAndPay](NFTAccessTemplate.md#createagreementandpay) +- [createAgreementFromDDO](NFTAccessTemplate.md#createagreementfromddo) +- [createAgreementWithPaymentFromDDO](NFTAccessTemplate.md#createagreementwithpaymentfromddo) +- [createService](NFTAccessTemplate.md#createservice) +- [description](NFTAccessTemplate.md#description) +- [extraGen](NFTAccessTemplate.md#extragen) +- [getAgreementCreatedEvent](NFTAccessTemplate.md#getagreementcreatedevent) +- [getAgreementData](NFTAccessTemplate.md#getagreementdata) +- [getAgreementIdsFromDDO](NFTAccessTemplate.md#getagreementidsfromddo) +- [getAgreementStatus](NFTAccessTemplate.md#getagreementstatus) +- [getAgreementsForDID](NFTAccessTemplate.md#getagreementsfordid) +- [getConditionTypes](NFTAccessTemplate.md#getconditiontypes) +- [getConditions](NFTAccessTemplate.md#getconditions) +- [getFromAddress](NFTAccessTemplate.md#getfromaddress) +- [getInputsOfMethod](NFTAccessTemplate.md#getinputsofmethod) +- [getServiceAgreementTemplate](NFTAccessTemplate.md#getserviceagreementtemplate) +- [getServiceAgreementTemplateConditionByRef](NFTAccessTemplate.md#getserviceagreementtemplateconditionbyref) +- [getServiceAgreementTemplateConditions](NFTAccessTemplate.md#getserviceagreementtemplateconditions) +- [getServiceAgreementTemplateDependencies](NFTAccessTemplate.md#getserviceagreementtemplatedependencies) +- [getSignatureOfMethod](NFTAccessTemplate.md#getsignatureofmethod) +- [init](NFTAccessTemplate.md#init) +- [instanceFromDDO](NFTAccessTemplate.md#instancefromddo) +- [lockConditionIndex](NFTAccessTemplate.md#lockconditionindex) +- [lockTokens](NFTAccessTemplate.md#locktokens) +- [name](NFTAccessTemplate.md#name) +- [params](NFTAccessTemplate.md#params) +- [paramsGen](NFTAccessTemplate.md#paramsgen) +- [paymentData](NFTAccessTemplate.md#paymentdata) +- [printAgreementStatus](NFTAccessTemplate.md#printagreementstatus) +- [process](NFTAccessTemplate.md#process) +- [send](NFTAccessTemplate.md#send) +- [sendFrom](NFTAccessTemplate.md#sendfrom) +- [service](NFTAccessTemplate.md#service) +- [serviceEndpoint](NFTAccessTemplate.md#serviceendpoint) +- [setInstanceConfig](NFTAccessTemplate.md#setinstanceconfig) +- [standardContext](NFTAccessTemplate.md#standardcontext) +- [track](NFTAccessTemplate.md#track) +- [validateAgreement](NFTAccessTemplate.md#validateagreement) +- [getInstance](NFTAccessTemplate.md#getinstance) +- [setInstanceConfig](NFTAccessTemplate.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• `Protected` **new NFTAccessTemplate**(`contractName`) + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[constructor](BaseTemplate.md#constructor) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:68](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L68) + +## Properties + +### address + +• **address**: `string` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[address](BaseTemplate.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[contract](BaseTemplate.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[contractName](BaseTemplate.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[events](BaseTemplate.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[version](BaseTemplate.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +BaseTemplate.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +BaseTemplate.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +BaseTemplate.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +BaseTemplate.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +BaseTemplate.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +BaseTemplate.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +BaseTemplate.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +BaseTemplate.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### accept + +▸ **accept**(`params`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :------- | :------------------------------------------------------ | +| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | + +#### Returns + +`Promise`<`boolean`\> + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[accept](BaseTemplate.md#accept) + +#### Defined in + +[src/keeper/contracts/templates/NFTAccessTemplate.ts:107](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFTAccessTemplate.ts#L107) + +--- + +### agreementId + +▸ **agreementId**(`agreementIdSeed`, `creator`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :---------------- | :------- | +| `agreementIdSeed` | `string` | +| `creator` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[agreementId](BaseTemplate.md#agreementid) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:213](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L213) + +--- + +### 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 + +[BaseTemplate](BaseTemplate.md).[call](BaseTemplate.md#call) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### conditions + +▸ **conditions**(): [[`NFTHolderCondition`](NFTHolderCondition.md), [`NFTAccessCondition`](NFTAccessCondition.md)] + +#### Returns + +[[`NFTHolderCondition`](NFTHolderCondition.md), [`NFTAccessCondition`](NFTAccessCondition.md)] + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[conditions](BaseTemplate.md#conditions) + +#### Defined in + +[src/keeper/contracts/templates/NFTAccessTemplate.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFTAccessTemplate.ts#L42) + +--- + +### createAgreement + +▸ **createAgreement**(`agreementId`, `did`, `conditionIds`, `timeLocks`, `timeOuts`, `extraArgs`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `agreementId` | `string` | +| `did` | `string` | +| `conditionIds` | `string`[] | +| `timeLocks` | `number`[] | +| `timeOuts` | `number`[] | +| `extraArgs` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[createAgreement](BaseTemplate.md#createagreement) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L90) + +--- + +### createAgreementAndPay + +▸ **createAgreementAndPay**(`agreementId`, `did`, `conditionIds`, `timeLocks`, `timeOuts`, `accessConsumer`, `condIdx`, `rewardAddress`, `tokenAddress`, `amounts`, `receivers`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :--------------- | :---------------------------------------------- | +| `agreementId` | `string` | +| `did` | `string` | +| `conditionIds` | `string`[] | +| `timeLocks` | `number`[] | +| `timeOuts` | `number`[] | +| `accessConsumer` | `string` | +| `condIdx` | `number` | +| `rewardAddress` | `string` | +| `tokenAddress` | `string` | +| `amounts` | `bigint`[] | +| `receivers` | `string`[] | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[createAgreementAndPay](BaseTemplate.md#createagreementandpay) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L115) + +--- + +### createAgreementFromDDO + +▸ **createAgreementFromDDO**(`agreementIdSeed`, `ddo`, `parameters`, `consumer`, `from`, `timeOuts?`, `txParams?`): `Promise`<`string`\> + +Create a new agreement using the data of a DDO. + +#### Parameters + +| Name | Type | Description | +| :---------------- | :---------------------------------------------- | :---------- | +| `agreementIdSeed` | `string` | - | +| `ddo` | [`DDO`](DDO.md) | DDO. | +| `parameters` | `NFTAccessTemplateParams` | | +| `consumer` | [`Account`](Account.md) | - | +| `from` | [`Account`](Account.md) | - | +| `timeOuts?` | `number`[] | - | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | + +#### Returns + +`Promise`<`string`\> + +true if the call was successful. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[createAgreementFromDDO](BaseTemplate.md#createagreementfromddo) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:222](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L222) + +--- + +### createAgreementWithPaymentFromDDO + +▸ **createAgreementWithPaymentFromDDO**(`agreementIdSeed`, `ddo`, `serviceReference`, `parameters`, `consumer`, `from`, `txParams?`, `observer?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :----------------- | :------------------------------------------------------------------------------------ | +| `agreementIdSeed` | `string` | +| `ddo` | [`DDO`](DDO.md) | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | +| `parameters` | `NFTAccessTemplateParams` | +| `consumer` | [`Account`](Account.md) | +| `from` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| `observer?` | (`orderProgressStep`: [`OrderProgressStep`](../enums/OrderProgressStep.md)) => `void` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[createAgreementWithPaymentFromDDO](BaseTemplate.md#createagreementwithpaymentfromddo) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:252](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L252) + +--- + +### createService + +▸ **createService**(`publisher`, `metadata`, `serviceAttributes`, `nftAttributes?`, `priceData?`): [`ServiceNFTAccess`](../interfaces/ServiceNFTAccess.md) + +#### Parameters + +| Name | Type | +| :------------------ | :---------------------------------------------------------------------------- | +| `publisher` | [`Account`](Account.md) | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | +| `serviceAttributes` | [`ServiceAttributes`](../interfaces/ServiceAttributes.md) | +| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | +| `priceData?` | [`PricedMetadataInformation`](../code-reference.md#pricedmetadatainformation) | + +#### Returns + +[`ServiceNFTAccess`](../interfaces/ServiceNFTAccess.md) + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[createService](BaseTemplate.md#createservice) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L35) + +--- + +### description + +▸ **description**(): `string` + +#### Returns + +`string` + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[description](BaseTemplate.md#description) + +#### Defined in + +[src/keeper/contracts/templates/NFTAccessTemplate.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFTAccessTemplate.ts#L31) + +--- + +### extraGen + +▸ **extraGen**(`_params`): `Promise`<`any`\> + +#### Parameters + +| Name | Type | +| :-------- | :------------------------------------------------------ | +| `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | + +#### Returns + +`Promise`<`any`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[extraGen](BaseTemplate.md#extragen) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:94](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L94) + +--- + +### 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. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getAgreementCreatedEvent](BaseTemplate.md#getagreementcreatedevent) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:459](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L459) + +--- + +### getAgreementData + +▸ **getAgreementData**(`agreementId`): `Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | + +#### Returns + +`Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getAgreementData](BaseTemplate.md#getagreementdata) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:21](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L21) + +--- + +### getAgreementIdsFromDDO + +▸ **getAgreementIdsFromDDO**(`agreementId`, `ddo`, `creator`, `params`): `Promise`<`string`[]\> + +Get agreement conditions IDs. + +#### Parameters + +| Name | Type | Description | +| :------------ | :------------------------ | :------------ | +| `agreementId` | `string` | Agreement ID. | +| `ddo` | [`DDO`](DDO.md) | DDO. | +| `creator` | `string` | - | +| `params` | `NFTAccessTemplateParams` | - | + +#### Returns + +`Promise`<`string`[]\> + +The condition IDs. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getAgreementIdsFromDDO](BaseTemplate.md#getagreementidsfromddo) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:180](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L180) + +--- + +### getAgreementStatus + +▸ **getAgreementStatus**(`agreementId`): `Promise`<`false` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> + +Returns the status of the conditions. + +#### Parameters + +| Name | Type | Description | +| :------------ | :------- | :------------ | +| `agreementId` | `string` | Agreement ID. | + +#### Returns + +`Promise`<`false` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> + +The conditions status. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getAgreementStatus](BaseTemplate.md#getagreementstatus) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:346](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L346) + +--- + +### getAgreementsForDID + +▸ **getAgreementsForDID**(`did`): `Promise`<`string`[]\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `did` | `string` | + +#### Returns + +`Promise`<`string`[]\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getAgreementsForDID](BaseTemplate.md#getagreementsfordid) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:485](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L485) + +--- + +### getConditionTypes + +▸ **getConditionTypes**(): `Promise`<`string`[]\> + +Conditions address list. + +#### Returns + +`Promise`<`string`[]\> + +A list of condition addresses. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getConditionTypes](BaseTemplate.md#getconditiontypes) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L154) + +--- + +### getConditions + +▸ **getConditions**(): `Promise`<[`ConditionSmall`](ConditionSmall.md)[]\> + +List of condition contracts. + +#### Returns + +`Promise`<[`ConditionSmall`](ConditionSmall.md)[]\> + +A list of condition contracts. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getConditions](BaseTemplate.md#getconditions) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:165](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L165) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getFromAddress](BaseTemplate.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getInputsOfMethod](BaseTemplate.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getServiceAgreementTemplate + +▸ **getServiceAgreementTemplate**(): [`ServiceAgreementTemplate`](../interfaces/ServiceAgreementTemplate.md) + +#### Returns + +[`ServiceAgreementTemplate`](../interfaces/ServiceAgreementTemplate.md) + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[getServiceAgreementTemplate](BaseTemplate.md#getserviceagreementtemplate) + +#### Defined in + +[src/keeper/contracts/templates/NFTAccessTemplate.ts:71](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFTAccessTemplate.ts#L71) + +--- + +### getServiceAgreementTemplateConditionByRef + +▸ **getServiceAgreementTemplateConditionByRef**(`ref`): `Promise`<[`ConditionSmall`](ConditionSmall.md)\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `ref` | `string` | + +#### Returns + +`Promise`<[`ConditionSmall`](ConditionSmall.md)\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getServiceAgreementTemplateConditionByRef](BaseTemplate.md#getserviceagreementtemplateconditionbyref) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:329](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L329) + +--- + +### getServiceAgreementTemplateConditions + +▸ **getServiceAgreementTemplateConditions**(): [`ServiceAgreementTemplateCondition`](../interfaces/ServiceAgreementTemplateCondition.md)[] + +#### Returns + +[`ServiceAgreementTemplateCondition`](../interfaces/ServiceAgreementTemplateCondition.md)[] + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getServiceAgreementTemplateConditions](BaseTemplate.md#getserviceagreementtemplateconditions) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:324](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L324) + +--- + +### getServiceAgreementTemplateDependencies + +▸ **getServiceAgreementTemplateDependencies**(): `Promise`<{ `[condition: string]`: `string`[]; }\> + +#### Returns + +`Promise`<{ `[condition: string]`: `string`[]; }\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getServiceAgreementTemplateDependencies](BaseTemplate.md#getserviceagreementtemplatedependencies) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:336](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L336) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getSignatureOfMethod](BaseTemplate.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[init](BaseTemplate.md#init) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### instanceFromDDO + +▸ **instanceFromDDO**(`agreementIdSeed`, `ddo`, `creator`, `parameters`): `Promise`<[`AgreementInstance`](../interfaces/AgreementInstance.md)<`NFTAccessTemplateParams`\>\> + +#### Parameters + +| Name | Type | +| :---------------- | :------------------------ | +| `agreementIdSeed` | `string` | +| `ddo` | [`DDO`](DDO.md) | +| `creator` | `string` | +| `parameters` | `NFTAccessTemplateParams` | + +#### Returns + +`Promise`<[`AgreementInstance`](../interfaces/AgreementInstance.md)<`NFTAccessTemplateParams`\>\> + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[instanceFromDDO](BaseTemplate.md#instancefromddo) + +#### Defined in + +[src/keeper/contracts/templates/NFTAccessTemplate.ts:47](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFTAccessTemplate.ts#L47) + +--- + +### lockConditionIndex + +▸ **lockConditionIndex**(): `number` + +#### Returns + +`number` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[lockConditionIndex](BaseTemplate.md#lockconditionindex) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:74](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L74) + +--- + +### lockTokens + +▸ **lockTokens**(`tokenAddress`, `amounts`, `from`, `txParams`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `tokenAddress` | `any` | +| `amounts` | `any` | +| `from` | [`Account`](Account.md) | +| `txParams` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[lockTokens](BaseTemplate.md#locktokens) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:393](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L393) + +--- + +### name + +▸ **name**(): `string` + +#### Returns + +`string` + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[name](BaseTemplate.md#name) + +#### Defined in + +[src/keeper/contracts/templates/NFTAccessTemplate.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFTAccessTemplate.ts#L28) + +--- + +### params + +▸ **params**(`holderAddress`, `amount?`): `NFTAccessTemplateParams` + +#### Parameters + +| Name | Type | +| :-------------- | :------- | +| `holderAddress` | `string` | +| `amount?` | `bigint` | + +#### Returns + +`NFTAccessTemplateParams` + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[params](BaseTemplate.md#params) + +#### Defined in + +[src/keeper/contracts/templates/NFTAccessTemplate.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFTAccessTemplate.ts#L35) + +--- + +### paramsGen + +▸ **paramsGen**(`«destructured»`): `Promise`<`NFTAccessTemplateParams`\> + +Specialize params + +#### Parameters + +| Name | Type | Description | +| :--------------- | :------------------------------------------------------ | :----------------- | +| `«destructured»` | [`ValidationParams`](../interfaces/ValidationParams.md) | Generic parameters | + +#### Returns + +`Promise`<`NFTAccessTemplateParams`\> + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[paramsGen](BaseTemplate.md#paramsgen) + +#### Defined in + +[src/keeper/contracts/templates/NFTAccessTemplate.ts:38](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFTAccessTemplate.ts#L38) + +--- + +### paymentData + +▸ **paymentData**(`service`): `Promise`<[`PaymentData`](../interfaces/PaymentData.md)\> + +#### Parameters + +| Name | Type | +| :-------- | :------------------------------------------------ | +| `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | + +#### Returns + +`Promise`<[`PaymentData`](../interfaces/PaymentData.md)\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[paymentData](BaseTemplate.md#paymentdata) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:78](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L78) + +--- + +### printAgreementStatus + +▸ **printAgreementStatus**(`agreementId`): `Promise`<`void`\> + +Prints the agreement status. + +#### Parameters + +| Name | Type | Description | +| :------------ | :------- | :------------ | +| `agreementId` | `string` | Agreement ID. | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[printAgreementStatus](BaseTemplate.md#printagreementstatus) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:429](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L429) + +--- + +### process + +▸ **process**(`params`, `from`, `txparams?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :---------- | :------------------------------------------------------ | +| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `from` | [`Account`](Account.md) | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`void`\> + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[process](BaseTemplate.md#process) + +#### Defined in + +[src/keeper/contracts/templates/NFTAccessTemplate.ts:75](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFTAccessTemplate.ts#L75) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[send](BaseTemplate.md#send) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[sendFrom](BaseTemplate.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### service + +▸ **service**(): [`ServiceType`](../code-reference.md#servicetype) + +#### Returns + +[`ServiceType`](../code-reference.md#servicetype) + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[service](BaseTemplate.md#service) + +#### Defined in + +[src/keeper/contracts/templates/NFTAccessTemplate.ts:25](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFTAccessTemplate.ts#L25) + +--- + +### serviceEndpoint + +▸ **serviceEndpoint**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[serviceEndpoint](BaseTemplate.md#serviceendpoint) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L31) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[setInstanceConfig](BaseTemplate.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### standardContext + +▸ **standardContext**(`ddo`, `creator`, `serviceIndex?`): [`ConditionContext`](../interfaces/ConditionContext.md) + +#### Parameters + +| Name | Type | +| :-------------- | :-------------- | +| `ddo` | [`DDO`](DDO.md) | +| `creator` | `string` | +| `serviceIndex?` | `number` | + +#### Returns + +[`ConditionContext`](../interfaces/ConditionContext.md) + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[standardContext](BaseTemplate.md#standardcontext) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:200](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L200) + +--- + +### track + +▸ **track**(`params`, `from`, `txparams?`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :---------- | :------------------------------------------------------ | +| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `from` | [`Account`](Account.md) | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`boolean`\> + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[track](BaseTemplate.md#track) + +#### Defined in + +[src/keeper/contracts/templates/NFTAccessTemplate.ts:143](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFTAccessTemplate.ts#L143) + +--- + +### validateAgreement + +▸ **validateAgreement**(`agreement_id`, `did`, `params`, `from`, `extra?`, `txparams?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `agreement_id` | `string` | +| `did` | `string` | +| `params` | `NFTAccessTemplateParams` | +| `from` | [`Account`](Account.md) | +| `extra` | `any` | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`void`\> + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[validateAgreement](BaseTemplate.md#validateagreement) + +#### Defined in + +[src/keeper/contracts/templates/NFTAccessTemplate.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFTAccessTemplate.ts#L90) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`): `Promise`<[`NFTAccessTemplate`](NFTAccessTemplate.md)\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`Promise`<[`NFTAccessTemplate`](NFTAccessTemplate.md)\> + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[getInstance](BaseTemplate.md#getinstance) + +#### Defined in + +[src/keeper/contracts/templates/NFTAccessTemplate.ts:21](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFTAccessTemplate.ts#L21) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[setInstanceConfig](BaseTemplate.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/NFTAttributes.md b/docs/api-reference/classes/NFTAttributes.md new file mode 100644 index 000000000..f6cec2c7b --- /dev/null +++ b/docs/api-reference/classes/NFTAttributes.md @@ -0,0 +1,501 @@ +[@nevermined-io/sdk](../code-reference.md) / NFTAttributes + +# Class: NFTAttributes + +## Hierarchy + +- [`AssetAttributes`](AssetAttributes.md) + + ↳ **`NFTAttributes`** + +## Table of contents + +### Constructors + +- [constructor](NFTAttributes.md#constructor) + +### Properties + +- [appId](NFTAttributes.md#appid) +- [cap](NFTAttributes.md#cap) +- [encryptionMethod](NFTAttributes.md#encryptionmethod) +- [ercType](NFTAttributes.md#erctype) +- [fulfillAccessTimelock](NFTAttributes.md#fulfillaccesstimelock) +- [fulfillAccessTimeout](NFTAttributes.md#fulfillaccesstimeout) +- [metadata](NFTAttributes.md#metadata) +- [nftContractAddress](NFTAttributes.md#nftcontractaddress) +- [nftMetadataUrl](NFTAttributes.md#nftmetadataurl) +- [nftType](NFTAttributes.md#nfttype) +- [preMint](NFTAttributes.md#premint) +- [predefinedAssetServices](NFTAttributes.md#predefinedassetservices) +- [providers](NFTAttributes.md#providers) +- [royaltyAttributes](NFTAttributes.md#royaltyattributes) +- [services](NFTAttributes.md#services) +- [DEFAULT_ENCRYPTION_METHOD](NFTAttributes.md#default_encryption_method) +- [defaultValues](NFTAttributes.md#defaultvalues) + +### Methods + +- [getCreditsSubscriptionInstance](NFTAttributes.md#getcreditssubscriptioninstance) +- [getInstance](NFTAttributes.md#getinstance) +- [getNFT1155Instance](NFTAttributes.md#getnft1155instance) +- [getNFT721Instance](NFTAttributes.md#getnft721instance) +- [getPOAPInstance](NFTAttributes.md#getpoapinstance) +- [getSoulBoundInstance](NFTAttributes.md#getsoulboundinstance) +- [getSubscriptionInstance](NFTAttributes.md#getsubscriptioninstance) + +## Constructors + +### constructor + +• **new NFTAttributes**() + +#### Inherited from + +[AssetAttributes](AssetAttributes.md).[constructor](AssetAttributes.md#constructor) + +## Properties + +### appId + +• `Optional` **appId**: `string` + +Unique identifier of the application/domain/vertical where the asset belong to. +That asset association typically helps to search and filter between assets part of a domain via Marketplace API + +#### Inherited from + +[AssetAttributes](AssetAttributes.md).[appId](AssetAttributes.md#appid) + +#### Defined in + +[src/models/AssetAttributes.ts:47](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetAttributes.ts#L47) + +--- + +### cap + +• `Optional` **cap**: `bigint` + +Max number of nfts that can be minted, 0 means uncapped + +#### Defined in + +[src/models/NFTAttributes.ts:87](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/NFTAttributes.ts#L87) + +--- + +### encryptionMethod + +• `Optional` **encryptionMethod**: [`EncryptionMethod`](../code-reference.md#encryptionmethod) + +When an asset is published in a Nevermined network, some internal Metadata attributes are encrypted so they can't be accessed. +This method allows to specify the encryption method to be used. + +**`See`** + +[EncryptionMethod](../code-reference.md#encryptionmethod) + +#### Inherited from + +[AssetAttributes](AssetAttributes.md).[encryptionMethod](AssetAttributes.md#encryptionmethod) + +#### Defined in + +[src/models/AssetAttributes.ts:20](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetAttributes.ts#L20) + +--- + +### ercType + +• **ercType**: [`ERCType`](../enums/ERCType.md) + +The type of ERC used (721 or 1155) + +**`See`** + +- [https://ethereum.org/en/developers/docs/standards/tokens/erc-721/](https://ethereum.org/en/developers/docs/standards/tokens/erc-721/) +- [https://ethereum.org/en/developers/docs/standards/tokens/erc-1155/](https://ethereum.org/en/developers/docs/standards/tokens/erc-1155/) + +#### Defined in + +[src/models/NFTAttributes.ts:55](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/NFTAttributes.ts#L55) + +--- + +### fulfillAccessTimelock + +• `Optional` **fulfillAccessTimelock**: `number` + +An asset can offer different services. Each service can have different conditions that need to be fulfilled +to provide that service. These conditions can expire if they are not fulfilled in a certain period of time. +This attribute allows to specify a period of time the condition can not be fullfilled +Setting up a timelock of 0 means that the condition can be fulfilled at any time. +Setting a timelock greater than 0 means that the condition can not be fulfilled until that number of blocks after the agreement is created are mined. +This would allow to create an agreement that can not fulfilled until certain period of time. + +#### Inherited from + +[AssetAttributes](AssetAttributes.md).[fulfillAccessTimelock](AssetAttributes.md#fulfillaccesstimelock) + +#### Defined in + +[src/models/AssetAttributes.ts:67](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetAttributes.ts#L67) + +--- + +### fulfillAccessTimeout + +• `Optional` **fulfillAccessTimeout**: `number` + +An asset can offer different services. Each service can have different conditions that need to be fulfilled +to provide that service. These conditions can expire if they are not fulfilled in a certain period of time. +This attribute allows to specify the timeouts for the access condition associated to the service. +Setting up a timeout of 0 means that the condition will never expire. +Setting a timeout greater than 0 means that the condition will expire after that number of blocks after the agreement is created. +This would allow to create an agreement that is not fulfilled after a certain period of time, the user can claim back funds locked if the condition is any. + +#### Inherited from + +[AssetAttributes](AssetAttributes.md).[fulfillAccessTimeout](AssetAttributes.md#fulfillaccesstimeout) + +#### Defined in + +[src/models/AssetAttributes.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetAttributes.ts#L57) + +--- + +### metadata + +• **metadata**: [`MetaData`](../interfaces/MetaData.md) + +Metadata describing the asset + +**`See`** + +[MetaData](../interfaces/MetaData.md) + +#### Inherited from + +[AssetAttributes](AssetAttributes.md).[metadata](AssetAttributes.md#metadata) + +#### Defined in + +[src/models/AssetAttributes.ts:13](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetAttributes.ts#L13) + +--- + +### nftContractAddress + +• **nftContractAddress**: `string` + +The address of the deployed NFT Contract + +#### Defined in + +[src/models/NFTAttributes.ts:67](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/NFTAttributes.ts#L67) + +--- + +### nftMetadataUrl + +• `Optional` **nftMetadataUrl**: `string` + +URL to the metadata definition of the NFT contract + +#### Defined in + +[src/models/NFTAttributes.ts:82](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/NFTAttributes.ts#L82) + +--- + +### nftType + +• **nftType**: [`NeverminedNFTType`](../code-reference.md#neverminednfttype) + +The Nevermined implementation of the NFT used. +A part of what type of ERC is based, Nevermined provides different NFT implementations to fit in different scenarios. +This attribute allow to specify between the different Nevermined NFT types + +#### Defined in + +[src/models/NFTAttributes.ts:62](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/NFTAttributes.ts#L62) + +--- + +### preMint + +• `Optional` **preMint**: `boolean` + +If the asset is pre-minted + +#### Defined in + +[src/models/NFTAttributes.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/NFTAttributes.ts#L77) + +--- + +### predefinedAssetServices + +• `Optional` **predefinedAssetServices**: [`ServiceCommon`](../interfaces/ServiceCommon.md)[] + +List of additional asset services to be included as part of an asset + +**`See`** + +[Service](../code-reference.md#service) + +#### Inherited from + +[AssetAttributes](AssetAttributes.md).[predefinedAssetServices](AssetAttributes.md#predefinedassetservices) + +#### Defined in + +[src/models/AssetAttributes.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetAttributes.ts#L32) + +--- + +### providers + +• `Optional` **providers**: `string`[] + +A provider of an asset identify the public address of an account with some privileges over that asset. +Typically these permissions are granted to Nevermined Nodes to allow them to give access to some services without +the direct interaction of the final user. +Here a user publishing an asset can define a list of all the addresses with these permissions. +Typically just the address of one Nevermined Node trusted by the user. + +#### Inherited from + +[AssetAttributes](AssetAttributes.md).[providers](AssetAttributes.md#providers) + +#### Defined in + +[src/models/AssetAttributes.ts:41](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetAttributes.ts#L41) + +--- + +### royaltyAttributes + +• `Optional` **royaltyAttributes**: [`RoyaltyAttributes`](../interfaces/RoyaltyAttributes.md) + +Attributes describing the royalties attached to the NFT in the secondary market + +#### Defined in + +[src/models/NFTAttributes.ts:72](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/NFTAttributes.ts#L72) + +--- + +### services + +• `Optional` **services**: [`ServiceAttributes`](../interfaces/ServiceAttributes.md)[] + +List of services and their attributes offered by an asset. + +**`See`** + +[ServiceAttributes](../interfaces/ServiceAttributes.md) + +#### Inherited from + +[AssetAttributes](AssetAttributes.md).[services](AssetAttributes.md#services) + +#### Defined in + +[src/models/AssetAttributes.ts:26](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetAttributes.ts#L26) + +--- + +### DEFAULT_ENCRYPTION_METHOD + +▪ `Static` **DEFAULT_ENCRYPTION_METHOD**: [`EncryptionMethod`](../code-reference.md#encryptionmethod) + +#### Inherited from + +[AssetAttributes](AssetAttributes.md).[DEFAULT_ENCRYPTION_METHOD](AssetAttributes.md#default_encryption_method) + +#### Defined in + +[src/models/AssetAttributes.ts:7](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/AssetAttributes.ts#L7) + +--- + +### defaultValues + +▪ `Static` **defaultValues**: `Object` + +#### Type declaration + +| Name | Type | +| :------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `appId` | `string` | +| `cap` | `bigint` | +| `encryptionMethod` | [`EncryptionMethod`](../code-reference.md#encryptionmethod) | +| `fulfillAccessTimelock` | `number` | +| `fulfillAccessTimeout` | `number` | +| `nft` | { `amount`: `bigint` ; `duration`: `number` = 0; `isSubscription`: `boolean` = false; `nftTransfer`: `boolean` = true; `serviceType`: [`ServiceType`](../code-reference.md#servicetype) ; `tokenId`: `string` = '' } | +| `nft.amount` | `bigint` | +| `nft.duration` | `number` | +| `nft.isSubscription` | `boolean` | +| `nft.nftTransfer` | `boolean` | +| `nft.serviceType` | [`ServiceType`](../code-reference.md#servicetype) | +| `nft.tokenId` | `string` | +| `nftMetadataUrl` | `string` | +| `preMint` | `boolean` | +| `predefinedAssetServices` | [`ServiceCommon`](../interfaces/ServiceCommon.md)[] | +| `providers` | `any`[] | +| `royaltyAttributes` | `any` | +| `services` | { `price`: [`AssetPrice`](AssetPrice.md) ; `serviceType`: [`ServiceType`](../code-reference.md#servicetype) }[] | + +#### Overrides + +[AssetAttributes](AssetAttributes.md).[defaultValues](AssetAttributes.md#defaultvalues) + +#### Defined in + +[src/models/NFTAttributes.ts:89](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/NFTAttributes.ts#L89) + +## Methods + +### getCreditsSubscriptionInstance + +▸ `Static` **getCreditsSubscriptionInstance**(`nftAttributes`): `Required`<[`NFTAttributes`](NFTAttributes.md)\> + +#### Parameters + +| Name | Type | +| :-------------- | :---------------------------------------------- | +| `nftAttributes` | `Partial`<[`NFTAttributes`](NFTAttributes.md)\> | + +#### Returns + +`Required`<[`NFTAttributes`](NFTAttributes.md)\> + +#### Defined in + +[src/models/NFTAttributes.ts:116](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/NFTAttributes.ts#L116) + +--- + +### getInstance + +▸ `Static` **getInstance**(`nftAttributes`): `Required`<[`NFTAttributes`](NFTAttributes.md)\> + +#### Parameters + +| Name | Type | +| :-------------- | :---------------------------------- | +| `nftAttributes` | [`NFTAttributes`](NFTAttributes.md) | + +#### Returns + +`Required`<[`NFTAttributes`](NFTAttributes.md)\> + +#### Overrides + +[AssetAttributes](AssetAttributes.md).[getInstance](AssetAttributes.md#getinstance) + +#### Defined in + +[src/models/NFTAttributes.ts:98](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/NFTAttributes.ts#L98) + +--- + +### getNFT1155Instance + +▸ `Static` **getNFT1155Instance**(`nftAttributes`): `Required`<[`NFTAttributes`](NFTAttributes.md)\> + +#### Parameters + +| Name | Type | +| :-------------- | :---------------------------------------------- | +| `nftAttributes` | `Partial`<[`NFTAttributes`](NFTAttributes.md)\> | + +#### Returns + +`Required`<[`NFTAttributes`](NFTAttributes.md)\> + +#### Defined in + +[src/models/NFTAttributes.ts:105](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/NFTAttributes.ts#L105) + +--- + +### getNFT721Instance + +▸ `Static` **getNFT721Instance**(`nftAttributes`): `Required`<[`NFTAttributes`](NFTAttributes.md)\> + +#### Parameters + +| Name | Type | +| :-------------- | :---------------------------------------------- | +| `nftAttributes` | `Partial`<[`NFTAttributes`](NFTAttributes.md)\> | + +#### Returns + +`Required`<[`NFTAttributes`](NFTAttributes.md)\> + +#### Defined in + +[src/models/NFTAttributes.ts:134](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/NFTAttributes.ts#L134) + +--- + +### getPOAPInstance + +▸ `Static` **getPOAPInstance**(`nftAttributes`): `Required`<[`NFTAttributes`](NFTAttributes.md)\> + +#### Parameters + +| Name | Type | +| :-------------- | :---------------------------------------------- | +| `nftAttributes` | `Partial`<[`NFTAttributes`](NFTAttributes.md)\> | + +#### Returns + +`Required`<[`NFTAttributes`](NFTAttributes.md)\> + +#### Defined in + +[src/models/NFTAttributes.ts:161](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/NFTAttributes.ts#L161) + +--- + +### getSoulBoundInstance + +▸ `Static` **getSoulBoundInstance**(`nftAttributes`): `Required`<[`NFTAttributes`](NFTAttributes.md)\> + +#### Parameters + +| Name | Type | +| :-------------- | :---------------------------------------------- | +| `nftAttributes` | `Partial`<[`NFTAttributes`](NFTAttributes.md)\> | + +#### Returns + +`Required`<[`NFTAttributes`](NFTAttributes.md)\> + +#### Defined in + +[src/models/NFTAttributes.ts:173](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/NFTAttributes.ts#L173) + +--- + +### getSubscriptionInstance + +▸ `Static` **getSubscriptionInstance**(`nftAttributes`): `Required`<[`NFTAttributes`](NFTAttributes.md)\> + +#### Parameters + +| Name | Type | +| :-------------- | :---------------------------------------------- | +| `nftAttributes` | `Partial`<[`NFTAttributes`](NFTAttributes.md)\> | + +#### Returns + +`Required`<[`NFTAttributes`](NFTAttributes.md)\> + +#### Defined in + +[src/models/NFTAttributes.ts:145](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/NFTAttributes.ts#L145) diff --git a/docs/api-reference/classes/NFTContractsBase.md b/docs/api-reference/classes/NFTContractsBase.md new file mode 100644 index 000000000..786901e86 --- /dev/null +++ b/docs/api-reference/classes/NFTContractsBase.md @@ -0,0 +1,725 @@ +[@nevermined-io/sdk](../code-reference.md) / NFTContractsBase + +# Class: NFTContractsBase + +## Hierarchy + +- [`ContractBase`](ContractBase.md) + + ↳ **`NFTContractsBase`** + + ↳↳ [`Nft721Contract`](Nft721Contract.md) + + ↳↳ [`Nft1155Contract`](Nft1155Contract.md) + +## Table of contents + +### Constructors + +- [constructor](NFTContractsBase.md#constructor) + +### Properties + +- [address](NFTContractsBase.md#address) +- [contract](NFTContractsBase.md#contract) +- [contractName](NFTContractsBase.md#contractname) +- [events](NFTContractsBase.md#events) +- [version](NFTContractsBase.md#version) + +### Accessors + +- [artifactsFolder](NFTContractsBase.md#artifactsfolder) +- [circuitsFolder](NFTContractsBase.md#circuitsfolder) +- [config](NFTContractsBase.md#config) +- [instanceConfig](NFTContractsBase.md#instanceconfig) +- [instantiableConfig](NFTContractsBase.md#instantiableconfig) +- [logger](NFTContractsBase.md#logger) +- [nevermined](NFTContractsBase.md#nevermined) +- [web3](NFTContractsBase.md#web3) + +### Methods + +- [\_createClone](NFTContractsBase.md#_createclone) +- [call](NFTContractsBase.md#call) +- [getFromAddress](NFTContractsBase.md#getfromaddress) +- [getInputsOfMethod](NFTContractsBase.md#getinputsofmethod) +- [getMintedEntries](NFTContractsBase.md#getmintedentries) +- [getNFTAttributes](NFTContractsBase.md#getnftattributes) +- [getSignatureOfMethod](NFTContractsBase.md#getsignatureofmethod) +- [grantOperatorRole](NFTContractsBase.md#grantoperatorrole) +- [init](NFTContractsBase.md#init) +- [isOperator](NFTContractsBase.md#isoperator) +- [owner](NFTContractsBase.md#owner) +- [revokeOperatorRole](NFTContractsBase.md#revokeoperatorrole) +- [send](NFTContractsBase.md#send) +- [sendFrom](NFTContractsBase.md#sendfrom) +- [setInstanceConfig](NFTContractsBase.md#setinstanceconfig) +- [getInstance](NFTContractsBase.md#getinstance) +- [setInstanceConfig](NFTContractsBase.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new NFTContractsBase**(`contractName`) + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Inherited from + +[ContractBase](ContractBase.md).[constructor](ContractBase.md#constructor) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L34) + +## Properties + +### address + +• **address**: `string` + +#### Inherited from + +[ContractBase](ContractBase.md).[address](ContractBase.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[ContractBase](ContractBase.md).[contract](ContractBase.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[ContractBase](ContractBase.md).[contractName](ContractBase.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[ContractBase](ContractBase.md).[events](ContractBase.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[ContractBase](ContractBase.md).[version](ContractBase.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ContractBase.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ContractBase.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +ContractBase.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ContractBase.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ContractBase.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +ContractBase.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +ContractBase.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +ContractBase.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### \_createClone + +▸ `Protected` **\_createClone**(`ercType`, `name`, `symbol`, `uri`, `cap`, `operators?`, `from?`, `txParams?`): `Promise`<`any`\> + +Creates a contract clone of an existing contract instance + +#### Parameters + +| Name | Type | Default value | Description | +| :---------- | :---------------------------------------------- | :------------ | :------------------------------------------------------ | +| `ercType` | `721` \| `1155` | `undefined` | - | +| `name` | `string` | `undefined` | NFT Contract name | +| `symbol` | `string` | `undefined` | NFT Contract symbol | +| `uri` | `string` | `undefined` | NFT Contract metadata uri | +| `cap` | `bigint` | `undefined` | NFT cap (just for ERC-721) | +| `operators` | `string`[] | `[]` | Array of account addresses to be added as NFT operators | +| `from?` | [`Account`](Account.md) | `undefined` | Sender account | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | - | + +#### Returns + +`Promise`<`any`\> + +Contract Receipt + +#### Defined in + +[src/keeper/contracts/NFTContractsBase.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/NFTContractsBase.ts#L34) + +--- + +### 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](ContractBase.md).[call](ContractBase.md#call) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ContractBase](ContractBase.md).[getFromAddress](ContractBase.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[ContractBase](ContractBase.md).[getInputsOfMethod](ContractBase.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getMintedEntries + +▸ **getMintedEntries**(`owner`, `did?`): `Promise`<[`MintedEntry`](../interfaces/MintedEntry.md)[]\> + +It gets all the `MintedEntries` events from the NFT Contract + +#### Parameters + +| Name | Type | Description | +| :------ | :------- | :---------------------- | +| `owner` | `string` | the user owning the NFT | +| `did?` | `string` | the tokenId of the NFT | + +#### Returns + +`Promise`<[`MintedEntry`](../interfaces/MintedEntry.md)[]\> + +An array of `MintedEntry` objects + +#### Defined in + +[src/keeper/contracts/NFTContractsBase.ts:125](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/NFTContractsBase.ts#L125) + +--- + +### getNFTAttributes + +▸ **getNFTAttributes**(`did`): `Promise`<{ `mintCap`: `bigint` ; `nftInitialized`: `boolean` ; `nftSupply`: `bigint` ; `nftURI`: `string` }\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `did` | `string` | + +#### Returns + +`Promise`<{ `mintCap`: `bigint` ; `nftInitialized`: `boolean` ; `nftSupply`: `bigint` ; `nftURI`: `string` }\> + +#### Defined in + +[src/keeper/contracts/NFTContractsBase.ts:82](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/NFTContractsBase.ts#L82) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[ContractBase](ContractBase.md).[getSignatureOfMethod](ContractBase.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### grantOperatorRole + +▸ **grantOperatorRole**(`operatorAddress`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +Add an address as operator in the NFT Contract + +#### Parameters + +| Name | Type | Description | +| :---------------- | :---------------------------------------------- | :----------------- | +| `operatorAddress` | `string` | New minter address | +| `from?` | [`Account`](Account.md) | Sender account | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +Contract Receipt + +#### Defined in + +[src/keeper/contracts/NFTContractsBase.ts:69](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/NFTContractsBase.ts#L69) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[ContractBase](ContractBase.md).[init](ContractBase.md#init) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### isOperator + +▸ **isOperator**(`address`): `Promise`<`boolean`\> + +Checks if an account is an operator in the NFT contract + +#### Parameters + +| Name | Type | Description | +| :-------- | :------- | :----------------------------------------- | +| `address` | `string` | Account address to check if is an operator | + +#### Returns + +`Promise`<`boolean`\> + +true if is an operator + +#### Defined in + +[src/keeper/contracts/NFTContractsBase.ts:78](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/NFTContractsBase.ts#L78) + +--- + +### owner + +▸ **owner**(): `Promise`<`string`\> + +Gets the contract owner + +#### Returns + +`Promise`<`string`\> + +Address of the contract owner + +#### Defined in + +[src/keeper/contracts/NFTContractsBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/NFTContractsBase.ts#L19) + +--- + +### revokeOperatorRole + +▸ **revokeOperatorRole**(`operatorAddress`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +Revoke an address as operator in the NFT Contract + +#### Parameters + +| Name | Type | Description | +| :---------------- | :---------------------------------------------- | :----------------------- | +| `operatorAddress` | `string` | Minter address to revoke | +| `from?` | [`Account`](Account.md) | Sender account | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +Contract Receipt + +#### Defined in + +[src/keeper/contracts/NFTContractsBase.ts:115](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/NFTContractsBase.ts#L115) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ContractBase](ContractBase.md).[send](ContractBase.md#send) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ContractBase](ContractBase.md).[sendFrom](ContractBase.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ContractBase](ContractBase.md).[setInstanceConfig](ContractBase.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### getInstance + +▸ `Static` **getInstance**(`..._args`): `any` + +#### Parameters + +| Name | Type | +| :--------- | :---- | +| `..._args` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[ContractBase](ContractBase.md).[getInstance](ContractBase.md#getinstance) + +#### Defined in + +[src/Instantiable.abstract.ts:86](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L86) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ContractBase](ContractBase.md).[setInstanceConfig](ContractBase.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/NFTError.md b/docs/api-reference/classes/NFTError.md new file mode 100644 index 000000000..023f30b11 --- /dev/null +++ b/docs/api-reference/classes/NFTError.md @@ -0,0 +1,165 @@ +[@nevermined-io/sdk](../code-reference.md) / NFTError + +# Class: NFTError + +## Hierarchy + +- `Error` + + ↳ **`NFTError`** + +## Table of contents + +### Constructors + +- [constructor](NFTError.md#constructor) + +### Properties + +- [message](NFTError.md#message) +- [name](NFTError.md#name) +- [stack](NFTError.md#stack) +- [prepareStackTrace](NFTError.md#preparestacktrace) +- [stackTraceLimit](NFTError.md#stacktracelimit) + +### Methods + +- [captureStackTrace](NFTError.md#capturestacktrace) + +## Constructors + +### constructor + +• **new NFTError**(`message`) + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `message` | `string` | + +#### Overrides + +Error.constructor + +#### Defined in + +[src/errors/NFTError.ts:2](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/errors/NFTError.ts#L2) + +## Properties + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1068 + +--- + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1067 + +--- + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1069 + +--- + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +Optional override for formatting stack traces + +##### Parameters + +| Name | Type | +| :------------ | :----------- | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:11 + +--- + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:13 + +## Methods + +### captureStackTrace + +▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :---------------- | :--------- | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:4 diff --git a/docs/api-reference/classes/NFTHolderCondition.md b/docs/api-reference/classes/NFTHolderCondition.md new file mode 100644 index 000000000..3f6787078 --- /dev/null +++ b/docs/api-reference/classes/NFTHolderCondition.md @@ -0,0 +1,999 @@ +[@nevermined-io/sdk](../code-reference.md) / NFTHolderCondition + +# Class: NFTHolderCondition + +Allows to fulfill a condition to users holding some amount of NFTs for a specific DID. + +## Hierarchy + +- [`ConsumerCondition`](ConsumerCondition.md)<`NFTHolderConditionContext`\> + + ↳ **`NFTHolderCondition`** + +## Table of contents + +### Constructors + +- [constructor](NFTHolderCondition.md#constructor) + +### Properties + +- [address](NFTHolderCondition.md#address) +- [contract](NFTHolderCondition.md#contract) +- [contractName](NFTHolderCondition.md#contractname) +- [events](NFTHolderCondition.md#events) +- [version](NFTHolderCondition.md#version) + +### Accessors + +- [artifactsFolder](NFTHolderCondition.md#artifactsfolder) +- [circuitsFolder](NFTHolderCondition.md#circuitsfolder) +- [config](NFTHolderCondition.md#config) +- [instanceConfig](NFTHolderCondition.md#instanceconfig) +- [instantiableConfig](NFTHolderCondition.md#instantiableconfig) +- [logger](NFTHolderCondition.md#logger) +- [nevermined](NFTHolderCondition.md#nevermined) +- [web3](NFTHolderCondition.md#web3) + +### Methods + +- [abortByTimeOut](NFTHolderCondition.md#abortbytimeout) +- [amountFromService](NFTHolderCondition.md#amountfromservice) +- [call](NFTHolderCondition.md#call) +- [fulfill](NFTHolderCondition.md#fulfill) +- [fulfillInstance](NFTHolderCondition.md#fulfillinstance) +- [fulfillPlain](NFTHolderCondition.md#fulfillplain) +- [fulfillWithNode](NFTHolderCondition.md#fulfillwithnode) +- [generateId](NFTHolderCondition.md#generateid) +- [generateIdHash](NFTHolderCondition.md#generateidhash) +- [generateIdWithSeed](NFTHolderCondition.md#generateidwithseed) +- [getConditionFulfilledEvent](NFTHolderCondition.md#getconditionfulfilledevent) +- [getFromAddress](NFTHolderCondition.md#getfromaddress) +- [getInputsOfMethod](NFTHolderCondition.md#getinputsofmethod) +- [getSignatureOfMethod](NFTHolderCondition.md#getsignatureofmethod) +- [hashValues](NFTHolderCondition.md#hashvalues) +- [hashValuesPlain](NFTHolderCondition.md#hashvaluesplain) +- [init](NFTHolderCondition.md#init) +- [instance](NFTHolderCondition.md#instance) +- [instanceFromDDO](NFTHolderCondition.md#instancefromddo) +- [nftContractFromService](NFTHolderCondition.md#nftcontractfromservice) +- [params](NFTHolderCondition.md#params) +- [paramsFromDDO](NFTHolderCondition.md#paramsfromddo) +- [send](NFTHolderCondition.md#send) +- [sendFrom](NFTHolderCondition.md#sendfrom) +- [setInstanceConfig](NFTHolderCondition.md#setinstanceconfig) +- [getInstance](NFTHolderCondition.md#getinstance) +- [setInstanceConfig](NFTHolderCondition.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new NFTHolderCondition**(`contractName`) + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[constructor](ConsumerCondition.md#constructor) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L34) + +## Properties + +### address + +• **address**: `string` + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[address](ConsumerCondition.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[contract](ConsumerCondition.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[contractName](ConsumerCondition.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[events](ConsumerCondition.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[version](ConsumerCondition.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ConsumerCondition.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ConsumerCondition.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +ConsumerCondition.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ConsumerCondition.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ConsumerCondition.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +ConsumerCondition.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +ConsumerCondition.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +ConsumerCondition.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### abortByTimeOut + +▸ **abortByTimeOut**(`conditionId`, `from?`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------------ | :---------------------------------------------- | +| `conditionId` | `string` | +| `from?` | [`Account`](Account.md) | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[abortByTimeOut](ConsumerCondition.md#abortbytimeout) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L88) + +--- + +### amountFromService + +▸ **amountFromService**(`service`): `bigint` + +#### Parameters + +| Name | Type | +| :-------- | :------------------------------------------------ | +| `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | + +#### Returns + +`bigint` + +#### Defined in + +[src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts#L39) + +--- + +### 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 + +[ConsumerCondition](ConsumerCondition.md).[call](ConsumerCondition.md#call) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### fulfill + +▸ **fulfill**(`agreementId`, `did`, `holderAddress`, `amount`, `nftContractAddress`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +Fulfill requires a validation that holder as enough NFTs for a specific DID. + +#### Parameters + +| Name | Type | Description | +| :------------------- | :---------------------------------------------- | :----------------------------------------------- | +| `agreementId` | `string` | SEA agreement identifier. | +| `did` | `string` | The Decentralized Identifier of the asset. | +| `holderAddress` | `string` | The contract address where the reward is locked. | +| `amount` | `bigint` | The amount of NFT to be hold | +| `nftContractAddress` | `string` | Address of the nft contract | +| `from?` | [`Account`](Account.md) | Account sending the transaction | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transacion parameters | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +condition state + +#### Overrides + +[ConsumerCondition](ConsumerCondition.md).[fulfill](ConsumerCondition.md#fulfill) + +#### Defined in + +[src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts:74](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts#L74) + +--- + +### fulfillInstance + +▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `txParams?`, `method?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | Default value | +| :----------------- | :----------------------------------------------------------------------------------------- | :------------ | +| `cond` | [`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | +| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | +| `from?` | [`Account`](Account.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[fulfillInstance](ConsumerCondition.md#fulfillinstance) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:150](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L150) + +--- + +### fulfillPlain + +▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `txParams?`, `method?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | Default value | +| :------------ | :-------------------------------------------------------- | :------------ | +| `agreementId` | `string` | `undefined` | +| `args` | `any`[] | `undefined` | +| `from?` | [`Account`](Account.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[fulfillPlain](ConsumerCondition.md#fulfillplain) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L63) + +--- + +### fulfillWithNode + +▸ **fulfillWithNode**(`_cond`, `_additionalParams`, `_from?`, `_txParams?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------------ | :----------------------------------------------------------------------------------------- | +| `_cond` | [`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | +| `_additionalParams` | `Record`<`string`, `unknown`\> | +| `_from?` | [`Account`](Account.md) | +| `_txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[fulfillWithNode](ConsumerCondition.md#fulfillwithnode) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:217](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L217) + +--- + +### generateId + +▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `valueHash` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[generateId](ConsumerCondition.md#generateid) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L77) + +--- + +### generateIdHash + +▸ **generateIdHash**(`agreementId`, `...values`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `...values` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[generateIdHash](ConsumerCondition.md#generateidhash) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L73) + +--- + +### generateIdWithSeed + +▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `valueHash` | `string` | + +#### Returns + +`Promise`<[`string`, `string`]\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[generateIdWithSeed](ConsumerCondition.md#generateidwithseed) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L81) + +--- + +### getConditionFulfilledEvent + +▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../code-reference.md#eventresult) + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | + +#### Returns + +[`EventResult`](../code-reference.md#eventresult) + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[getConditionFulfilledEvent](ConsumerCondition.md#getconditionfulfilledevent) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L92) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[getFromAddress](ConsumerCondition.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[getInputsOfMethod](ConsumerCondition.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[getSignatureOfMethod](ConsumerCondition.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### hashValues + +▸ **hashValues**(`...args`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[hashValues](ConsumerCondition.md#hashvalues) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L129) + +--- + +### hashValuesPlain + +▸ **hashValuesPlain**(`...args`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[hashValuesPlain](ConsumerCondition.md#hashvaluesplain) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:133](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L133) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[init](ConsumerCondition.md#init) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### instance + +▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :------------ | :--------------------------------------------------------------------------------------------- | +| `agreementId` | `string` | +| `params` | [`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | + +#### Returns + +`Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[instance](ConsumerCondition.md#instance) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:174](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L174) + +--- + +### instanceFromDDO + +▸ **instanceFromDDO**(`agreementId`, `ctx`, `...args`): `Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------------------------------------------- | +| `agreementId` | `string` | +| `ctx` | `NFTHolderConditionContext` | +| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | + +#### Returns + +`Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[instanceFromDDO](ConsumerCondition.md#instancefromddo) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L142) + +--- + +### nftContractFromService + +▸ **nftContractFromService**(`service`): `string` + +#### Parameters + +| Name | Type | +| :-------- | :------------------------------------------------ | +| `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | + +#### Returns + +`string` + +#### Defined in + +[src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts:45](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts#L45) + +--- + +### params + +▸ **params**(`did`, `holderAddress`, `amount`, `nftContractAddress?`): [`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> + +Generate the hash of condition inputs with the following parameters. + +#### Parameters + +| Name | Type | Description | +| :-------------------- | :------- | :---------------------------------------------------- | +| `did` | `string` | The Decentralized Identifier of the asset. | +| `holderAddress` | `string` | The address of the NFT holder . | +| `amount` | `bigint` | The amount of NFTs that need to be hold by the holder | +| `nftContractAddress?` | `string` | The address of the NFT token to use. | + +#### Returns + +[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> + +hash of all the values + +#### Overrides + +[ConsumerCondition](ConsumerCondition.md).[params](ConsumerCondition.md#params) + +#### Defined in + +[src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts#L30) + +--- + +### paramsFromDDO + +▸ **paramsFromDDO**(`«destructured»`): `Promise`<[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :--------------- | :-------------------------- | +| `«destructured»` | `NFTHolderConditionContext` | + +#### Returns + +`Promise`<[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> + +#### Overrides + +[ConsumerCondition](ConsumerCondition.md).[paramsFromDDO](ConsumerCondition.md#paramsfromddo) + +#### Defined in + +[src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts:52](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts#L52) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[send](ConsumerCondition.md#send) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[sendFrom](ConsumerCondition.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[setInstanceConfig](ConsumerCondition.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`): `Promise`<[`NFTHolderCondition`](NFTHolderCondition.md)\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`Promise`<[`NFTHolderCondition`](NFTHolderCondition.md)\> + +#### Overrides + +[ConsumerCondition](ConsumerCondition.md).[getInstance](ConsumerCondition.md#getinstance) + +#### Defined in + +[src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts:17](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts#L17) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[setInstanceConfig](ConsumerCondition.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/NFTLockCondition.md b/docs/api-reference/classes/NFTLockCondition.md new file mode 100644 index 000000000..33cbefca7 --- /dev/null +++ b/docs/api-reference/classes/NFTLockCondition.md @@ -0,0 +1,955 @@ +[@nevermined-io/sdk](../code-reference.md) / NFTLockCondition + +# Class: NFTLockCondition + +Implementation of the NFT Lock Condition + +## Hierarchy + +- [`ConsumerCondition`](ConsumerCondition.md)<`NFTLockConditionContext`\> + + ↳ **`NFTLockCondition`** + +## Table of contents + +### Constructors + +- [constructor](NFTLockCondition.md#constructor) + +### Properties + +- [address](NFTLockCondition.md#address) +- [contract](NFTLockCondition.md#contract) +- [contractName](NFTLockCondition.md#contractname) +- [events](NFTLockCondition.md#events) +- [version](NFTLockCondition.md#version) + +### Accessors + +- [artifactsFolder](NFTLockCondition.md#artifactsfolder) +- [circuitsFolder](NFTLockCondition.md#circuitsfolder) +- [config](NFTLockCondition.md#config) +- [instanceConfig](NFTLockCondition.md#instanceconfig) +- [instantiableConfig](NFTLockCondition.md#instantiableconfig) +- [logger](NFTLockCondition.md#logger) +- [nevermined](NFTLockCondition.md#nevermined) +- [web3](NFTLockCondition.md#web3) + +### Methods + +- [abortByTimeOut](NFTLockCondition.md#abortbytimeout) +- [call](NFTLockCondition.md#call) +- [fulfill](NFTLockCondition.md#fulfill) +- [fulfillInstance](NFTLockCondition.md#fulfillinstance) +- [fulfillPlain](NFTLockCondition.md#fulfillplain) +- [fulfillWithNode](NFTLockCondition.md#fulfillwithnode) +- [generateId](NFTLockCondition.md#generateid) +- [generateIdHash](NFTLockCondition.md#generateidhash) +- [generateIdWithSeed](NFTLockCondition.md#generateidwithseed) +- [getConditionFulfilledEvent](NFTLockCondition.md#getconditionfulfilledevent) +- [getFromAddress](NFTLockCondition.md#getfromaddress) +- [getInputsOfMethod](NFTLockCondition.md#getinputsofmethod) +- [getSignatureOfMethod](NFTLockCondition.md#getsignatureofmethod) +- [hashValues](NFTLockCondition.md#hashvalues) +- [hashValuesPlain](NFTLockCondition.md#hashvaluesplain) +- [init](NFTLockCondition.md#init) +- [instance](NFTLockCondition.md#instance) +- [instanceFromDDO](NFTLockCondition.md#instancefromddo) +- [params](NFTLockCondition.md#params) +- [paramsFromDDO](NFTLockCondition.md#paramsfromddo) +- [send](NFTLockCondition.md#send) +- [sendFrom](NFTLockCondition.md#sendfrom) +- [setInstanceConfig](NFTLockCondition.md#setinstanceconfig) +- [getInstance](NFTLockCondition.md#getinstance) +- [setInstanceConfig](NFTLockCondition.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new NFTLockCondition**(`contractName`) + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[constructor](ConsumerCondition.md#constructor) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L34) + +## Properties + +### address + +• **address**: `string` + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[address](ConsumerCondition.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[contract](ConsumerCondition.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[contractName](ConsumerCondition.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[events](ConsumerCondition.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[version](ConsumerCondition.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ConsumerCondition.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ConsumerCondition.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +ConsumerCondition.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ConsumerCondition.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ConsumerCondition.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +ConsumerCondition.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +ConsumerCondition.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +ConsumerCondition.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### abortByTimeOut + +▸ **abortByTimeOut**(`conditionId`, `from?`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------------ | :---------------------------------------------- | +| `conditionId` | `string` | +| `from?` | [`Account`](Account.md) | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[abortByTimeOut](ConsumerCondition.md#abortbytimeout) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L88) + +--- + +### 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 + +[ConsumerCondition](ConsumerCondition.md).[call](ConsumerCondition.md#call) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### fulfill + +▸ **fulfill**(`agreementId`, `did`, `rewardAddress`, `amount`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +Fulfill requires valid NFT transfer in order to lock the amount of DID NFTs based on SEA. + +#### Parameters + +| Name | Type | Description | +| :-------------- | :---------------------------------------------- | :----------------------------------------------- | +| `agreementId` | `string` | SEA agreement identifier. | +| `did` | `string` | Asset Decentralized identifier. | +| `rewardAddress` | `string` | The contract address where the reward is locked. | +| `amount` | `bigint` | The amount of tokens to be transferred. | +| `from?` | [`Account`](Account.md) | Account sending the transaction | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +Condition state. + +#### Overrides + +[ConsumerCondition](ConsumerCondition.md).[fulfill](ConsumerCondition.md#fulfill) + +#### Defined in + +[src/keeper/contracts/conditions/NFTs/NFTLockCondition.ts:45](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/NFTs/NFTLockCondition.ts#L45) + +--- + +### fulfillInstance + +▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `txParams?`, `method?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | Default value | +| :----------------- | :----------------------------------------------------------------------------------------- | :------------ | +| `cond` | [`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | +| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | +| `from?` | [`Account`](Account.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[fulfillInstance](ConsumerCondition.md#fulfillinstance) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:150](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L150) + +--- + +### fulfillPlain + +▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `txParams?`, `method?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | Default value | +| :------------ | :-------------------------------------------------------- | :------------ | +| `agreementId` | `string` | `undefined` | +| `args` | `any`[] | `undefined` | +| `from?` | [`Account`](Account.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[fulfillPlain](ConsumerCondition.md#fulfillplain) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L63) + +--- + +### fulfillWithNode + +▸ **fulfillWithNode**(`_cond`, `_additionalParams`, `_from?`, `_txParams?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------------ | :----------------------------------------------------------------------------------------- | +| `_cond` | [`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | +| `_additionalParams` | `Record`<`string`, `unknown`\> | +| `_from?` | [`Account`](Account.md) | +| `_txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[fulfillWithNode](ConsumerCondition.md#fulfillwithnode) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:217](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L217) + +--- + +### generateId + +▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `valueHash` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[generateId](ConsumerCondition.md#generateid) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L77) + +--- + +### generateIdHash + +▸ **generateIdHash**(`agreementId`, `...values`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `...values` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[generateIdHash](ConsumerCondition.md#generateidhash) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L73) + +--- + +### generateIdWithSeed + +▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `valueHash` | `string` | + +#### Returns + +`Promise`<[`string`, `string`]\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[generateIdWithSeed](ConsumerCondition.md#generateidwithseed) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L81) + +--- + +### getConditionFulfilledEvent + +▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../code-reference.md#eventresult) + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | + +#### Returns + +[`EventResult`](../code-reference.md#eventresult) + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[getConditionFulfilledEvent](ConsumerCondition.md#getconditionfulfilledevent) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L92) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[getFromAddress](ConsumerCondition.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[getInputsOfMethod](ConsumerCondition.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[getSignatureOfMethod](ConsumerCondition.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### hashValues + +▸ **hashValues**(`...args`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[hashValues](ConsumerCondition.md#hashvalues) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L129) + +--- + +### hashValuesPlain + +▸ **hashValuesPlain**(`...args`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[hashValuesPlain](ConsumerCondition.md#hashvaluesplain) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:133](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L133) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[init](ConsumerCondition.md#init) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### instance + +▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :------------ | :--------------------------------------------------------------------------------------------- | +| `agreementId` | `string` | +| `params` | [`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | + +#### Returns + +`Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[instance](ConsumerCondition.md#instance) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:174](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L174) + +--- + +### instanceFromDDO + +▸ **instanceFromDDO**(`agreementId`, `ctx`, `...args`): `Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------------------------------------------- | +| `agreementId` | `string` | +| `ctx` | `NFTLockConditionContext` | +| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | + +#### Returns + +`Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[instanceFromDDO](ConsumerCondition.md#instancefromddo) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L142) + +--- + +### params + +▸ **params**(`did`, `rewardAddress`, `amount`): [`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> + +Generates the hash of condition inputs. + +#### Parameters + +| Name | Type | Description | +| :-------------- | :------- | :----------------------------------------------- | +| `did` | `string` | The DID of the asset with NFTs attached to lock. | +| `rewardAddress` | `string` | The final address to receive the NFTs. | +| `amount` | `number` | The amount of locked tokens. | + +#### Returns + +[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> + +Hash of all the values. + +#### Overrides + +[ConsumerCondition](ConsumerCondition.md).[params](ConsumerCondition.md#params) + +#### Defined in + +[src/keeper/contracts/conditions/NFTs/NFTLockCondition.ts:27](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/NFTs/NFTLockCondition.ts#L27) + +--- + +### paramsFromDDO + +▸ **paramsFromDDO**(`«destructured»`): `Promise`<[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :--------------- | :------------------------ | +| `«destructured»` | `NFTLockConditionContext` | + +#### Returns + +`Promise`<[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> + +#### Overrides + +[ConsumerCondition](ConsumerCondition.md).[paramsFromDDO](ConsumerCondition.md#paramsfromddo) + +#### Defined in + +[src/keeper/contracts/conditions/NFTs/NFTLockCondition.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/NFTs/NFTLockCondition.ts#L31) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[send](ConsumerCondition.md#send) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[sendFrom](ConsumerCondition.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[setInstanceConfig](ConsumerCondition.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`): `Promise`<[`NFTLockCondition`](NFTLockCondition.md)\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`Promise`<[`NFTLockCondition`](NFTLockCondition.md)\> + +#### Overrides + +[ConsumerCondition](ConsumerCondition.md).[getInstance](ConsumerCondition.md#getinstance) + +#### Defined in + +[src/keeper/contracts/conditions/NFTs/NFTLockCondition.ts:16](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/NFTs/NFTLockCondition.ts#L16) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ConsumerCondition](ConsumerCondition.md).[setInstanceConfig](ConsumerCondition.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/NFTSalesService.md b/docs/api-reference/classes/NFTSalesService.md new file mode 100644 index 000000000..17507bcb2 --- /dev/null +++ b/docs/api-reference/classes/NFTSalesService.md @@ -0,0 +1,433 @@ +[@nevermined-io/sdk](../code-reference.md) / NFTSalesService + +# Class: NFTSalesService + +## Hierarchy + +- [`Instantiable`](Instantiable.md) + + ↳ **`NFTSalesService`** + +## Implements + +- [`ServicePlugin`](../interfaces/ServicePlugin.md)<[`ServiceNFTSales`](../interfaces/ServiceNFTSales.md)\> + +## Table of contents + +### Constructors + +- [constructor](NFTSalesService.md#constructor) + +### Properties + +- [normal](NFTSalesService.md#normal) +- [normal721](NFTSalesService.md#normal721) + +### Accessors + +- [artifactsFolder](NFTSalesService.md#artifactsfolder) +- [circuitsFolder](NFTSalesService.md#circuitsfolder) +- [config](NFTSalesService.md#config) +- [instanceConfig](NFTSalesService.md#instanceconfig) +- [instantiableConfig](NFTSalesService.md#instantiableconfig) +- [logger](NFTSalesService.md#logger) +- [nevermined](NFTSalesService.md#nevermined) +- [web3](NFTSalesService.md#web3) + +### Methods + +- [accept](NFTSalesService.md#accept) +- [createService](NFTSalesService.md#createservice) +- [process](NFTSalesService.md#process) +- [select](NFTSalesService.md#select) +- [setInstanceConfig](NFTSalesService.md#setinstanceconfig) +- [track](NFTSalesService.md#track) +- [getInstance](NFTSalesService.md#getinstance) +- [setInstanceConfig](NFTSalesService.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new NFTSalesService**(`config`) + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Overrides + +[Instantiable](Instantiable.md).[constructor](Instantiable.md#constructor) + +#### Defined in + +[src/nevermined/AccessService.ts:135](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/AccessService.ts#L135) + +## Properties + +### normal + +• **normal**: [`NFTSalesTemplate`](NFTSalesTemplate.md) + +#### Defined in + +[src/nevermined/AccessService.ts:132](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/AccessService.ts#L132) + +--- + +### normal721 + +• **normal721**: [`NFT721SalesTemplate`](NFT721SalesTemplate.md) + +#### Defined in + +[src/nevermined/AccessService.ts:133](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/AccessService.ts#L133) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +Instantiable.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +Instantiable.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +Instantiable.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +Instantiable.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### accept + +▸ **accept**(`params`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :------- | :------------------------------------------------------ | +| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | + +#### Returns + +`Promise`<`boolean`\> + +#### Implementation of + +[ServicePlugin](../interfaces/ServicePlugin.md).[accept](../interfaces/ServicePlugin.md#accept) + +#### Defined in + +[src/nevermined/AccessService.ts:172](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/AccessService.ts#L172) + +--- + +### createService + +▸ **createService**(`publisher`, `metadata`, `serviceAttributes`, `nftAttributes?`, `pricedData?`): [`ServiceNFTSales`](../interfaces/ServiceNFTSales.md) + +#### Parameters + +| Name | Type | +| :------------------ | :---------------------------------------------------------------------------- | +| `publisher` | [`Account`](Account.md) | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | +| `serviceAttributes` | [`ServiceAttributes`](../interfaces/ServiceAttributes.md) | +| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | +| `pricedData?` | [`PricedMetadataInformation`](../code-reference.md#pricedmetadatainformation) | + +#### Returns + +[`ServiceNFTSales`](../interfaces/ServiceNFTSales.md) + +#### Implementation of + +[ServicePlugin](../interfaces/ServicePlugin.md).[createService](../interfaces/ServicePlugin.md#createservice) + +#### Defined in + +[src/nevermined/AccessService.ts:142](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/AccessService.ts#L142) + +--- + +### process + +▸ **process**(`params`, `from`, `txparams?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :---------- | :------------------------------------------------------ | +| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `from` | [`Account`](Account.md) | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`void`\> + +#### Implementation of + +[ServicePlugin](../interfaces/ServicePlugin.md).[process](../interfaces/ServicePlugin.md#process) + +#### Defined in + +[src/nevermined/AccessService.ts:163](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/AccessService.ts#L163) + +--- + +### select + +▸ **select**(`main`): [`ServicePlugin`](../interfaces/ServicePlugin.md)<[`ServiceNFTSales`](../interfaces/ServiceNFTSales.md)\> + +#### Parameters + +| Name | Type | +| :----- | :---------------------------------------------- | +| `main` | [`MetaDataMain`](../interfaces/MetaDataMain.md) | + +#### Returns + +[`ServicePlugin`](../interfaces/ServicePlugin.md)<[`ServiceNFTSales`](../interfaces/ServiceNFTSales.md)\> + +#### Defined in + +[src/nevermined/AccessService.ts:159](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/AccessService.ts#L159) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### track + +▸ **track**(`params`, `from`, `txparams?`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :---------- | :------------------------------------------------------ | +| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `from` | [`Account`](Account.md) | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`boolean`\> + +#### Implementation of + +[ServicePlugin](../interfaces/ServicePlugin.md).[track](../interfaces/ServicePlugin.md#track) + +#### Defined in + +[src/nevermined/AccessService.ts:177](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/AccessService.ts#L177) + +--- + +### getInstance + +▸ `Static` **getInstance**(`..._args`): `any` + +#### Parameters + +| Name | Type | +| :--------- | :---- | +| `..._args` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[Instantiable](Instantiable.md).[getInstance](Instantiable.md#getinstance) + +#### Defined in + +[src/Instantiable.abstract.ts:86](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L86) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/NFTSalesTemplate.md b/docs/api-reference/classes/NFTSalesTemplate.md new file mode 100644 index 000000000..3a31092b6 --- /dev/null +++ b/docs/api-reference/classes/NFTSalesTemplate.md @@ -0,0 +1,1467 @@ +[@nevermined-io/sdk](../code-reference.md) / NFTSalesTemplate + +# Class: NFTSalesTemplate + +## Hierarchy + +- [`BaseTemplate`](BaseTemplate.md)<`NFTSalesTemplateParams`, [`ServiceNFTSales`](../interfaces/ServiceNFTSales.md)\> + + ↳ **`NFTSalesTemplate`** + +## Table of contents + +### Constructors + +- [constructor](NFTSalesTemplate.md#constructor) + +### Properties + +- [address](NFTSalesTemplate.md#address) +- [contract](NFTSalesTemplate.md#contract) +- [contractName](NFTSalesTemplate.md#contractname) +- [events](NFTSalesTemplate.md#events) +- [version](NFTSalesTemplate.md#version) + +### Accessors + +- [artifactsFolder](NFTSalesTemplate.md#artifactsfolder) +- [circuitsFolder](NFTSalesTemplate.md#circuitsfolder) +- [config](NFTSalesTemplate.md#config) +- [instanceConfig](NFTSalesTemplate.md#instanceconfig) +- [instantiableConfig](NFTSalesTemplate.md#instantiableconfig) +- [logger](NFTSalesTemplate.md#logger) +- [nevermined](NFTSalesTemplate.md#nevermined) +- [web3](NFTSalesTemplate.md#web3) + +### Methods + +- [accept](NFTSalesTemplate.md#accept) +- [agreementId](NFTSalesTemplate.md#agreementid) +- [call](NFTSalesTemplate.md#call) +- [conditions](NFTSalesTemplate.md#conditions) +- [createAgreement](NFTSalesTemplate.md#createagreement) +- [createAgreementAndPay](NFTSalesTemplate.md#createagreementandpay) +- [createAgreementFromDDO](NFTSalesTemplate.md#createagreementfromddo) +- [createAgreementWithPaymentFromDDO](NFTSalesTemplate.md#createagreementwithpaymentfromddo) +- [createService](NFTSalesTemplate.md#createservice) +- [description](NFTSalesTemplate.md#description) +- [extraGen](NFTSalesTemplate.md#extragen) +- [getAgreementCreatedEvent](NFTSalesTemplate.md#getagreementcreatedevent) +- [getAgreementData](NFTSalesTemplate.md#getagreementdata) +- [getAgreementIdsFromDDO](NFTSalesTemplate.md#getagreementidsfromddo) +- [getAgreementStatus](NFTSalesTemplate.md#getagreementstatus) +- [getAgreementsForDID](NFTSalesTemplate.md#getagreementsfordid) +- [getConditionTypes](NFTSalesTemplate.md#getconditiontypes) +- [getConditions](NFTSalesTemplate.md#getconditions) +- [getFromAddress](NFTSalesTemplate.md#getfromaddress) +- [getInputsOfMethod](NFTSalesTemplate.md#getinputsofmethod) +- [getParamsFromService](NFTSalesTemplate.md#getparamsfromservice) +- [getServiceAgreementTemplate](NFTSalesTemplate.md#getserviceagreementtemplate) +- [getServiceAgreementTemplateConditionByRef](NFTSalesTemplate.md#getserviceagreementtemplateconditionbyref) +- [getServiceAgreementTemplateConditions](NFTSalesTemplate.md#getserviceagreementtemplateconditions) +- [getServiceAgreementTemplateDependencies](NFTSalesTemplate.md#getserviceagreementtemplatedependencies) +- [getSignatureOfMethod](NFTSalesTemplate.md#getsignatureofmethod) +- [init](NFTSalesTemplate.md#init) +- [instanceFromDDO](NFTSalesTemplate.md#instancefromddo) +- [lockConditionIndex](NFTSalesTemplate.md#lockconditionindex) +- [lockTokens](NFTSalesTemplate.md#locktokens) +- [name](NFTSalesTemplate.md#name) +- [params](NFTSalesTemplate.md#params) +- [paramsGen](NFTSalesTemplate.md#paramsgen) +- [paymentData](NFTSalesTemplate.md#paymentdata) +- [printAgreementStatus](NFTSalesTemplate.md#printagreementstatus) +- [process](NFTSalesTemplate.md#process) +- [send](NFTSalesTemplate.md#send) +- [sendFrom](NFTSalesTemplate.md#sendfrom) +- [service](NFTSalesTemplate.md#service) +- [serviceEndpoint](NFTSalesTemplate.md#serviceendpoint) +- [setInstanceConfig](NFTSalesTemplate.md#setinstanceconfig) +- [standardContext](NFTSalesTemplate.md#standardcontext) +- [track](NFTSalesTemplate.md#track) +- [validateAgreement](NFTSalesTemplate.md#validateagreement) +- [getInstance](NFTSalesTemplate.md#getinstance) +- [setInstanceConfig](NFTSalesTemplate.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• `Protected` **new NFTSalesTemplate**(`contractName`) + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[constructor](BaseTemplate.md#constructor) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:68](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L68) + +## Properties + +### address + +• **address**: `string` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[address](BaseTemplate.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[contract](BaseTemplate.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[contractName](BaseTemplate.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[events](BaseTemplate.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[version](BaseTemplate.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +BaseTemplate.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +BaseTemplate.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +BaseTemplate.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +BaseTemplate.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +BaseTemplate.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +BaseTemplate.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +BaseTemplate.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +BaseTemplate.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### accept + +▸ **accept**(`_params`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :-------- | :------------------------------------------------------ | +| `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | + +#### Returns + +`Promise`<`boolean`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[accept](BaseTemplate.md#accept) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:98](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L98) + +--- + +### agreementId + +▸ **agreementId**(`agreementIdSeed`, `creator`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :---------------- | :------- | +| `agreementIdSeed` | `string` | +| `creator` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[agreementId](BaseTemplate.md#agreementid) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:213](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L213) + +--- + +### 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 + +[BaseTemplate](BaseTemplate.md).[call](BaseTemplate.md#call) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### conditions + +▸ **conditions**(): [[`LockPaymentCondition`](LockPaymentCondition.md), [`TransferNFTCondition`](TransferNFTCondition.md), [`EscrowPaymentCondition`](EscrowPaymentCondition.md)] + +#### Returns + +[[`LockPaymentCondition`](LockPaymentCondition.md), [`TransferNFTCondition`](TransferNFTCondition.md), [`EscrowPaymentCondition`](EscrowPaymentCondition.md)] + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[conditions](BaseTemplate.md#conditions) + +#### Defined in + +[src/keeper/contracts/templates/NFTSalesTemplate.ts:85](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFTSalesTemplate.ts#L85) + +--- + +### createAgreement + +▸ **createAgreement**(`agreementId`, `did`, `conditionIds`, `timeLocks`, `timeOuts`, `extraArgs`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `agreementId` | `string` | +| `did` | `string` | +| `conditionIds` | `string`[] | +| `timeLocks` | `number`[] | +| `timeOuts` | `number`[] | +| `extraArgs` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[createAgreement](BaseTemplate.md#createagreement) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L90) + +--- + +### createAgreementAndPay + +▸ **createAgreementAndPay**(`agreementId`, `did`, `conditionIds`, `timeLocks`, `timeOuts`, `accessConsumer`, `condIdx`, `rewardAddress`, `tokenAddress`, `amounts`, `receivers`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :--------------- | :---------------------------------------------- | +| `agreementId` | `string` | +| `did` | `string` | +| `conditionIds` | `string`[] | +| `timeLocks` | `number`[] | +| `timeOuts` | `number`[] | +| `accessConsumer` | `string` | +| `condIdx` | `number` | +| `rewardAddress` | `string` | +| `tokenAddress` | `string` | +| `amounts` | `bigint`[] | +| `receivers` | `string`[] | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[createAgreementAndPay](BaseTemplate.md#createagreementandpay) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L115) + +--- + +### createAgreementFromDDO + +▸ **createAgreementFromDDO**(`agreementIdSeed`, `ddo`, `parameters`, `consumer`, `from`, `timeOuts?`, `txParams?`): `Promise`<`string`\> + +Create a new agreement using the data of a DDO. + +#### Parameters + +| Name | Type | Description | +| :---------------- | :---------------------------------------------- | :---------- | +| `agreementIdSeed` | `string` | - | +| `ddo` | [`DDO`](DDO.md) | DDO. | +| `parameters` | `NFTSalesTemplateParams` | | +| `consumer` | [`Account`](Account.md) | - | +| `from` | [`Account`](Account.md) | - | +| `timeOuts?` | `number`[] | - | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | + +#### Returns + +`Promise`<`string`\> + +true if the call was successful. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[createAgreementFromDDO](BaseTemplate.md#createagreementfromddo) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:222](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L222) + +--- + +### createAgreementWithPaymentFromDDO + +▸ **createAgreementWithPaymentFromDDO**(`agreementIdSeed`, `ddo`, `serviceReference`, `parameters`, `consumer`, `from`, `txParams?`, `observer?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :----------------- | :------------------------------------------------------------------------------------ | +| `agreementIdSeed` | `string` | +| `ddo` | [`DDO`](DDO.md) | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | +| `parameters` | `NFTSalesTemplateParams` | +| `consumer` | [`Account`](Account.md) | +| `from` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | +| `observer?` | (`orderProgressStep`: [`OrderProgressStep`](../enums/OrderProgressStep.md)) => `void` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[createAgreementWithPaymentFromDDO](BaseTemplate.md#createagreementwithpaymentfromddo) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:252](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L252) + +--- + +### createService + +▸ **createService**(`publisher`, `metadata`, `serviceAttributes`, `nftAttributes?`, `priceData?`): [`ServiceNFTSales`](../interfaces/ServiceNFTSales.md) + +#### Parameters + +| Name | Type | +| :------------------ | :---------------------------------------------------------------------------- | +| `publisher` | [`Account`](Account.md) | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | +| `serviceAttributes` | [`ServiceAttributes`](../interfaces/ServiceAttributes.md) | +| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | +| `priceData?` | [`PricedMetadataInformation`](../code-reference.md#pricedmetadatainformation) | + +#### Returns + +[`ServiceNFTSales`](../interfaces/ServiceNFTSales.md) + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[createService](BaseTemplate.md#createservice) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L35) + +--- + +### description + +▸ **description**(): `string` + +#### Returns + +`string` + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[description](BaseTemplate.md#description) + +#### Defined in + +[src/keeper/contracts/templates/NFTSalesTemplate.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFTSalesTemplate.ts#L39) + +--- + +### extraGen + +▸ **extraGen**(`_params`): `Promise`<`any`\> + +#### Parameters + +| Name | Type | +| :-------- | :------------------------------------------------------ | +| `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | + +#### Returns + +`Promise`<`any`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[extraGen](BaseTemplate.md#extragen) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:94](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L94) + +--- + +### 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. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getAgreementCreatedEvent](BaseTemplate.md#getagreementcreatedevent) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:459](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L459) + +--- + +### getAgreementData + +▸ **getAgreementData**(`agreementId`): `Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | + +#### Returns + +`Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getAgreementData](BaseTemplate.md#getagreementdata) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:21](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L21) + +--- + +### getAgreementIdsFromDDO + +▸ **getAgreementIdsFromDDO**(`agreementId`, `ddo`, `creator`, `params`): `Promise`<`string`[]\> + +Get agreement conditions IDs. + +#### Parameters + +| Name | Type | Description | +| :------------ | :----------------------- | :------------ | +| `agreementId` | `string` | Agreement ID. | +| `ddo` | [`DDO`](DDO.md) | DDO. | +| `creator` | `string` | - | +| `params` | `NFTSalesTemplateParams` | - | + +#### Returns + +`Promise`<`string`[]\> + +The condition IDs. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getAgreementIdsFromDDO](BaseTemplate.md#getagreementidsfromddo) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:180](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L180) + +--- + +### getAgreementStatus + +▸ **getAgreementStatus**(`agreementId`): `Promise`<`false` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> + +Returns the status of the conditions. + +#### Parameters + +| Name | Type | Description | +| :------------ | :------- | :------------ | +| `agreementId` | `string` | Agreement ID. | + +#### Returns + +`Promise`<`false` \| [`AgreementConditionsStatus`](../interfaces/AgreementConditionsStatus.md)\> + +The conditions status. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getAgreementStatus](BaseTemplate.md#getagreementstatus) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:346](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L346) + +--- + +### getAgreementsForDID + +▸ **getAgreementsForDID**(`did`): `Promise`<`string`[]\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `did` | `string` | + +#### Returns + +`Promise`<`string`[]\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getAgreementsForDID](BaseTemplate.md#getagreementsfordid) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:485](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L485) + +--- + +### getConditionTypes + +▸ **getConditionTypes**(): `Promise`<`string`[]\> + +Conditions address list. + +#### Returns + +`Promise`<`string`[]\> + +A list of condition addresses. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getConditionTypes](BaseTemplate.md#getconditiontypes) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L154) + +--- + +### getConditions + +▸ **getConditions**(): `Promise`<[`ConditionSmall`](ConditionSmall.md)[]\> + +List of condition contracts. + +#### Returns + +`Promise`<[`ConditionSmall`](ConditionSmall.md)[]\> + +A list of condition contracts. + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getConditions](BaseTemplate.md#getconditions) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:165](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L165) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getFromAddress](BaseTemplate.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getInputsOfMethod](BaseTemplate.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getParamsFromService + +▸ **getParamsFromService**(`consumerId`, `nftAmount`, `service`): `Promise`<`NFTSalesTemplateParams`\> + +#### Parameters + +| Name | Type | +| :----------- | :---------------------------------------------------- | +| `consumerId` | `string` | +| `nftAmount` | `bigint` | +| `service` | [`ServiceNFTSales`](../interfaces/ServiceNFTSales.md) | + +#### Returns + +`Promise`<`NFTSalesTemplateParams`\> + +#### Defined in + +[src/keeper/contracts/templates/NFTSalesTemplate.ts:54](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFTSalesTemplate.ts#L54) + +--- + +### getServiceAgreementTemplate + +▸ **getServiceAgreementTemplate**(): [`ServiceAgreementTemplate`](../interfaces/ServiceAgreementTemplate.md) + +#### Returns + +[`ServiceAgreementTemplate`](../interfaces/ServiceAgreementTemplate.md) + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[getServiceAgreementTemplate](BaseTemplate.md#getserviceagreementtemplate) + +#### Defined in + +[src/keeper/contracts/templates/NFTSalesTemplate.ts:136](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFTSalesTemplate.ts#L136) + +--- + +### getServiceAgreementTemplateConditionByRef + +▸ **getServiceAgreementTemplateConditionByRef**(`ref`): `Promise`<[`ConditionSmall`](ConditionSmall.md)\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `ref` | `string` | + +#### Returns + +`Promise`<[`ConditionSmall`](ConditionSmall.md)\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getServiceAgreementTemplateConditionByRef](BaseTemplate.md#getserviceagreementtemplateconditionbyref) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:329](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L329) + +--- + +### getServiceAgreementTemplateConditions + +▸ **getServiceAgreementTemplateConditions**(): [`ServiceAgreementTemplateCondition`](../interfaces/ServiceAgreementTemplateCondition.md)[] + +#### Returns + +[`ServiceAgreementTemplateCondition`](../interfaces/ServiceAgreementTemplateCondition.md)[] + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getServiceAgreementTemplateConditions](BaseTemplate.md#getserviceagreementtemplateconditions) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:324](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L324) + +--- + +### getServiceAgreementTemplateDependencies + +▸ **getServiceAgreementTemplateDependencies**(): `Promise`<{ `[condition: string]`: `string`[]; }\> + +#### Returns + +`Promise`<{ `[condition: string]`: `string`[]; }\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getServiceAgreementTemplateDependencies](BaseTemplate.md#getserviceagreementtemplatedependencies) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:336](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L336) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[getSignatureOfMethod](BaseTemplate.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[init](BaseTemplate.md#init) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### instanceFromDDO + +▸ **instanceFromDDO**(`agreementIdSeed`, `ddo`, `creator`, `parameters`, `serviceIndex?`): `Promise`<[`AgreementInstance`](../interfaces/AgreementInstance.md)<`NFTSalesTemplateParams`\>\> + +#### Parameters + +| Name | Type | +| :---------------- | :----------------------- | +| `agreementIdSeed` | `string` | +| `ddo` | [`DDO`](DDO.md) | +| `creator` | `string` | +| `parameters` | `NFTSalesTemplateParams` | +| `serviceIndex?` | `number` | + +#### Returns + +`Promise`<[`AgreementInstance`](../interfaces/AgreementInstance.md)<`NFTSalesTemplateParams`\>\> + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[instanceFromDDO](BaseTemplate.md#instancefromddo) + +#### Defined in + +[src/keeper/contracts/templates/NFTSalesTemplate.ts:91](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFTSalesTemplate.ts#L91) + +--- + +### lockConditionIndex + +▸ **lockConditionIndex**(): `number` + +#### Returns + +`number` + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[lockConditionIndex](BaseTemplate.md#lockconditionindex) + +#### Defined in + +[src/keeper/contracts/templates/NFTSalesTemplate.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFTSalesTemplate.ts#L81) + +--- + +### lockTokens + +▸ **lockTokens**(`tokenAddress`, `amounts`, `from`, `txParams`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `tokenAddress` | `any` | +| `amounts` | `any` | +| `from` | [`Account`](Account.md) | +| `txParams` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[lockTokens](BaseTemplate.md#locktokens) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:393](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L393) + +--- + +### name + +▸ **name**(): `string` + +#### Returns + +`string` + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[name](BaseTemplate.md#name) + +#### Defined in + +[src/keeper/contracts/templates/NFTSalesTemplate.ts:36](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFTSalesTemplate.ts#L36) + +--- + +### params + +▸ **params**(`consumerId`, `nftAmount`, `duration?`, `expiration?`, `providerId?`, `nftTransfer?`): `NFTSalesTemplateParams` + +#### Parameters + +| Name | Type | +| :------------- | :-------- | +| `consumerId` | `string` | +| `nftAmount` | `bigint` | +| `duration?` | `number` | +| `expiration?` | `number` | +| `providerId?` | `string` | +| `nftTransfer?` | `boolean` | + +#### Returns + +`NFTSalesTemplateParams` + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[params](BaseTemplate.md#params) + +#### Defined in + +[src/keeper/contracts/templates/NFTSalesTemplate.ts:43](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFTSalesTemplate.ts#L43) + +--- + +### paramsGen + +▸ **paramsGen**(`«destructured»`): `Promise`<`NFTSalesTemplateParams`\> + +Specialize params + +#### Parameters + +| Name | Type | Description | +| :--------------- | :------------------------------------------------------ | :----------------- | +| `«destructured»` | [`ValidationParams`](../interfaces/ValidationParams.md) | Generic parameters | + +#### Returns + +`Promise`<`NFTSalesTemplateParams`\> + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[paramsGen](BaseTemplate.md#paramsgen) + +#### Defined in + +[src/keeper/contracts/templates/NFTSalesTemplate.ts:72](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFTSalesTemplate.ts#L72) + +--- + +### paymentData + +▸ **paymentData**(`service`): `Promise`<[`PaymentData`](../interfaces/PaymentData.md)\> + +#### Parameters + +| Name | Type | +| :-------- | :------------------------------------------------ | +| `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | + +#### Returns + +`Promise`<[`PaymentData`](../interfaces/PaymentData.md)\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[paymentData](BaseTemplate.md#paymentdata) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:78](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L78) + +--- + +### printAgreementStatus + +▸ **printAgreementStatus**(`agreementId`): `Promise`<`void`\> + +Prints the agreement status. + +#### Parameters + +| Name | Type | Description | +| :------------ | :------- | :------------ | +| `agreementId` | `string` | Agreement ID. | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[printAgreementStatus](BaseTemplate.md#printagreementstatus) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:429](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L429) + +--- + +### process + +▸ **process**(`params`, `from`, `txparams?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :---------- | :------------------------------------------------------ | +| `params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `from` | [`Account`](Account.md) | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[process](BaseTemplate.md#process) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:110](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L110) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[send](BaseTemplate.md#send) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[sendFrom](BaseTemplate.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### service + +▸ **service**(): [`ServiceType`](../code-reference.md#servicetype) + +#### Returns + +[`ServiceType`](../code-reference.md#servicetype) + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[service](BaseTemplate.md#service) + +#### Defined in + +[src/keeper/contracts/templates/NFTSalesTemplate.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFTSalesTemplate.ts#L28) + +--- + +### serviceEndpoint + +▸ **serviceEndpoint**(): `string` + +#### Returns + +`string` + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[serviceEndpoint](BaseTemplate.md#serviceendpoint) + +#### Defined in + +[src/keeper/contracts/templates/NFTSalesTemplate.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFTSalesTemplate.ts#L32) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[setInstanceConfig](BaseTemplate.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### standardContext + +▸ **standardContext**(`ddo`, `creator`, `serviceIndex?`): [`ConditionContext`](../interfaces/ConditionContext.md) + +#### Parameters + +| Name | Type | +| :-------------- | :-------------- | +| `ddo` | [`DDO`](DDO.md) | +| `creator` | `string` | +| `serviceIndex?` | `number` | + +#### Returns + +[`ConditionContext`](../interfaces/ConditionContext.md) + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[standardContext](BaseTemplate.md#standardcontext) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:200](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L200) + +--- + +### track + +▸ **track**(`_params`, `_from`, `_txparams?`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :----------- | :------------------------------------------------------ | +| `_params` | [`ValidationParams`](../interfaces/ValidationParams.md) | +| `_from` | [`Account`](Account.md) | +| `_txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`boolean`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[track](BaseTemplate.md#track) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:102](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L102) + +--- + +### validateAgreement + +▸ **validateAgreement**(`agreement_id`, `did`, `params`, `from`, `extra?`, `txparams?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `agreement_id` | `string` | +| `did` | `string` | +| `params` | `NFTSalesTemplateParams` | +| `from` | [`Account`](Account.md) | +| `extra` | `any` | +| `txparams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[validateAgreement](BaseTemplate.md#validateagreement) + +#### Defined in + +[src/keeper/contracts/templates/BaseTemplate.abstract.ts:125](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L125) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`): `Promise`<[`NFTSalesTemplate`](NFTSalesTemplate.md)\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`Promise`<[`NFTSalesTemplate`](NFTSalesTemplate.md)\> + +#### Overrides + +[BaseTemplate](BaseTemplate.md).[getInstance](BaseTemplate.md#getinstance) + +#### Defined in + +[src/keeper/contracts/templates/NFTSalesTemplate.ts:24](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/NFTSalesTemplate.ts#L24) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[BaseTemplate](BaseTemplate.md).[setInstanceConfig](BaseTemplate.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/NFTServiceAttributes.md b/docs/api-reference/classes/NFTServiceAttributes.md new file mode 100644 index 000000000..9d08be67b --- /dev/null +++ b/docs/api-reference/classes/NFTServiceAttributes.md @@ -0,0 +1,124 @@ +[@nevermined-io/sdk](../code-reference.md) / NFTServiceAttributes + +# Class: NFTServiceAttributes + +## Table of contents + +### Constructors + +- [constructor](NFTServiceAttributes.md#constructor) + +### Properties + +- [amount](NFTServiceAttributes.md#amount) +- [duration](NFTServiceAttributes.md#duration) +- [isSubscription](NFTServiceAttributes.md#issubscription) +- [nftTransfer](NFTServiceAttributes.md#nfttransfer) +- [tokenId](NFTServiceAttributes.md#tokenid) +- [defaultValues](NFTServiceAttributes.md#defaultvalues) + +### Methods + +- [getDefaultNFTServiceAttributes](NFTServiceAttributes.md#getdefaultnftserviceattributes) + +## Constructors + +### constructor + +• **new NFTServiceAttributes**() + +## Properties + +### amount + +• `Optional` **amount**: `bigint` + +Number of editions + +#### Defined in + +[src/models/NFTAttributes.ts:25](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/NFTAttributes.ts#L25) + +--- + +### duration + +• `Optional` **duration**: `number` + +If is a subscription this means the number of blocks the subscription last. If 0 means unlimited + +#### Defined in + +[src/models/NFTAttributes.ts:20](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/NFTAttributes.ts#L20) + +--- + +### isSubscription + +• `Optional` **isSubscription**: `boolean` + +If true means the NFT works as a subscription + +#### Defined in + +[src/models/NFTAttributes.ts:15](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/NFTAttributes.ts#L15) + +--- + +### nftTransfer + +• `Optional` **nftTransfer**: `boolean` + +The asset is transferred (true) or minted (false) with Nevermined contracts + +#### Defined in + +[src/models/NFTAttributes.ts:10](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/NFTAttributes.ts#L10) + +--- + +### tokenId + +• `Optional` **tokenId**: `string` + +The tokenId of the NFT related with the Service. +For example if is a NFT Access service requiring holding a NFT, this is the tokenId of the NFT + +#### Defined in + +[src/models/NFTAttributes.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/NFTAttributes.ts#L31) + +--- + +### defaultValues + +▪ `Static` **defaultValues**: `Object` + +#### Type declaration + +| Name | Type | +| :--------------- | :------------------------------------------------ | +| `amount` | `bigint` | +| `duration` | `number` | +| `isSubscription` | `boolean` | +| `nftTransfer` | `boolean` | +| `serviceType` | [`ServiceType`](../code-reference.md#servicetype) | +| `tokenId` | `string` | + +#### Defined in + +[src/models/NFTAttributes.ts:33](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/NFTAttributes.ts#L33) + +## Methods + +### getDefaultNFTServiceAttributes + +▸ `Static` **getDefaultNFTServiceAttributes**(): `Required`<[`NFTServiceAttributes`](NFTServiceAttributes.md)\> + +#### Returns + +`Required`<[`NFTServiceAttributes`](NFTServiceAttributes.md)\> + +#### Defined in + +[src/models/NFTAttributes.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/NFTAttributes.ts#L42) diff --git a/docs/api-reference/classes/NFTsBaseApi.md b/docs/api-reference/classes/NFTsBaseApi.md new file mode 100644 index 000000000..39fd16101 --- /dev/null +++ b/docs/api-reference/classes/NFTsBaseApi.md @@ -0,0 +1,881 @@ +[@nevermined-io/sdk](../code-reference.md) / NFTsBaseApi + +# Class: NFTsBaseApi + +Abstract class providing common NFT methods for different ERC implementations. + +## Hierarchy + +- [`RegistryBaseApi`](RegistryBaseApi.md) + + ↳ **`NFTsBaseApi`** + + ↳↳ [`NFT721Api`](NFT721Api.md) + + ↳↳ [`NFT1155Api`](NFT1155Api.md) + +## Table of contents + +### Constructors + +- [constructor](NFTsBaseApi.md#constructor) + +### Properties + +- [servicePlugin](NFTsBaseApi.md#serviceplugin) + +### Accessors + +- [artifactsFolder](NFTsBaseApi.md#artifactsfolder) +- [circuitsFolder](NFTsBaseApi.md#circuitsfolder) +- [config](NFTsBaseApi.md#config) +- [instanceConfig](NFTsBaseApi.md#instanceconfig) +- [instantiableConfig](NFTsBaseApi.md#instantiableconfig) +- [logger](NFTsBaseApi.md#logger) +- [nevermined](NFTsBaseApi.md#nevermined) +- [web3](NFTsBaseApi.md#web3) + +### Methods + +- [\_details](NFTsBaseApi.md#_details) +- [access](NFTsBaseApi.md#access) +- [addRating](NFTsBaseApi.md#addrating) +- [buySecondaryMarketNft](NFTsBaseApi.md#buysecondarymarketnft) +- [claimNFT](NFTsBaseApi.md#claimnft) +- [getSubscriptionToken](NFTsBaseApi.md#getsubscriptiontoken) +- [isOperator](NFTsBaseApi.md#isoperator) +- [isOperatorOfDID](NFTsBaseApi.md#isoperatorofdid) +- [list](NFTsBaseApi.md#list) +- [listOnSecondaryMarkets](NFTsBaseApi.md#listonsecondarymarkets) +- [orderAsset](NFTsBaseApi.md#orderasset) +- [registerNeverminedAsset](NFTsBaseApi.md#registerneverminedasset) +- [resolveAsset](NFTsBaseApi.md#resolveasset) +- [setInstanceConfig](NFTsBaseApi.md#setinstanceconfig) +- [updateAsset](NFTsBaseApi.md#updateasset) +- [getInstance](NFTsBaseApi.md#getinstance) +- [getNFTContractAddress](NFTsBaseApi.md#getnftcontractaddress) +- [getServicePlugin](NFTsBaseApi.md#getserviceplugin) +- [setInstanceConfig](NFTsBaseApi.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new NFTsBaseApi**() + +#### Inherited from + +[RegistryBaseApi](RegistryBaseApi.md).[constructor](RegistryBaseApi.md#constructor) + +## Properties + +### servicePlugin + +• **servicePlugin**: `Object` + +#### Index signature + +▪ [key: `string`]: [`ServicePlugin`](../interfaces/ServicePlugin.md)<[`Service`](../code-reference.md#service)\> + +#### Inherited from + +[RegistryBaseApi](RegistryBaseApi.md).[servicePlugin](RegistryBaseApi.md#serviceplugin) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L29) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +RegistryBaseApi.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +RegistryBaseApi.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +RegistryBaseApi.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +RegistryBaseApi.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +RegistryBaseApi.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +RegistryBaseApi.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +RegistryBaseApi.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +RegistryBaseApi.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### \_details + +▸ `Protected` **\_details**(`did`, `ercType`): `Promise`<{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> + +Get the details of an NFT + +#### Parameters + +| Name | Type | Description | +| :-------- | :------------------------------- | :--------------------------------------------- | +| `did` | `string` | The Decentralized Identifier of the NFT asset. | +| `ercType` | [`ERCType`](../enums/ERCType.md) | The type of NFT used | + +#### Returns + +`Promise`<{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> + +The details of the NFT. + +**`Example`** + +```ts +const details = await nevermined.nfts1155.details(ddo.id) + +// The `details` object includes the NFT information + +assert.equal(details.mintCap, 5) +assert.equal(details.nftSupply, 5) +assert.equal(details.royaltyScheme, RoyaltyKind.Standard) +assert.equal(details.royalties, 100000) +assert.equal(details.owner, artist.getId()) +``` + +#### Defined in + +[src/nevermined/api/nfts/NFTsBaseApi.ts:150](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFTsBaseApi.ts#L150) + +--- + +### access + +▸ **access**(`did`, `consumer`, `destination?`, `fileIndex?`, `agreementId?`, `buyer?`, `babysig?`, `serviceReference?`): `Promise`<`boolean`\> + +Access the files associated with an NFT. + +#### Parameters + +| Name | Type | Default value | Description | +| :----------------- | :------------------------------------------------------------ | :------------- | :------------------------------------------------------------------------ | +| `did` | `string` | `undefined` | The Decentralized Identifier of the NFT asset. | +| `consumer` | [`Account`](Account.md) | `undefined` | The NFT holder account. | +| `destination?` | `string` | `undefined` | The download destination for the files. | +| `fileIndex?` | `number` | `undefined` | The index of the file. If unset will download all the files in the asset. | +| `agreementId` | `string` | `'0x'` | The NFT sales agreement id. | +| `buyer?` | `string` | `undefined` | Key which represent the buyer | +| `babysig?` | [`Babysig`](../interfaces/Babysig.md) | `undefined` | - | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-access'` | The service reference to use. By default is nft-access. | + +#### Returns + +`Promise`<`boolean`\> + +true if the access was successful or file if isToDownload is false. + +**`Remarks`** + +This function will call the Node that will check if all the access conditions where fulfilled +before providing the files. + +**`Example`** + +```ts +const result = await nevermined.nfts1155.access(ddo.id, collector, '/tmp/') +``` + +#### Defined in + +[src/nevermined/api/nfts/NFTsBaseApi.ts:419](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFTsBaseApi.ts#L419) + +--- + +### addRating + +▸ **addRating**(`did`, `newRating`, `numVotesAdded?`, `publisher`, `publishMetadata?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +Given a DID, it adds a vote to the asset curation information. + +#### Parameters + +| Name | Type | Default value | Description | +| :---------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `newRating` | `number` | `undefined` | New average rating of the asset | +| `numVotesAdded` | `number` | `1` | Number of new votes added to the rating, typically just 1 | +| `publisher` | [`Account`](Account.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +[DDO](DDO.md) The DDO updated + +#### Inherited from + +[RegistryBaseApi](RegistryBaseApi.md).[addRating](RegistryBaseApi.md#addrating) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:514](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L514) + +--- + +### buySecondaryMarketNft + +▸ **buySecondaryMarketNft**(`consumer`, `nftAmount?`, `agreementIdSeed`, `conditionsTimeout?`, `txParams?`): `Promise`<`boolean`\> + +Buys a number of listed NFTs on secondary markets. + +#### Parameters + +| Name | Type | Description | +| :------------------ | :---------------------------------------------- | :----------------------------------------- | +| `consumer` | [`Account`](Account.md) | The account of the buyer/consumer. | +| `nftAmount` | `bigint` | The number of assets to buy. 1 by default. | +| `agreementIdSeed` | `string` | - | +| `conditionsTimeout` | `number`[] | - | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | + +#### Returns + +`Promise`<`boolean`\> + +true if the buy was successful. + +**`Example`** + +```ts +const result = await nevermined.nfts1155.buySecondaryMarketNft(collector, 1n, agreementId) +``` + +**`Throws`** + +[NFTError](NFTError.md) +Thrown if there is an error buying the NFT. + +#### Defined in + +[src/nevermined/api/nfts/NFTsBaseApi.ts:341](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFTsBaseApi.ts#L341) + +--- + +### claimNFT + +▸ `Protected` **claimNFT**(`agreementId`, `nftHolder`, `nftReceiver`, `numberEditions?`, `ercType?`, `did?`, `serviceIndex?`): `Promise`<`boolean`\> + +Claims the transfer of a NFT to the Nevermined Node on behalf of the publisher. + +#### Parameters + +| Name | Type | Default value | Description | +| :--------------- | :------------------------------- | :------------ | :--------------------------------------------------------------------------- | +| `agreementId` | `string` | `undefined` | The NFT sales agreement id. | +| `nftHolder` | `string` | `undefined` | The address of the current owner of the NFT. | +| `nftReceiver` | `string` | `undefined` | The address where the NFT should be transferred. | +| `numberEditions` | `bigint` | `undefined` | The number of NFT editions to transfer. If the NFT is ERC-721 it should be 1 | +| `ercType` | [`ERCType`](../enums/ERCType.md) | `1155` | The Type of the NFT ERC (1155 or 721). | +| `did?` | `string` | `undefined` | The DID of the asset. | +| `serviceIndex?` | `number` | `undefined` | The index of the service in the DDO that will be claimed | + +#### Returns + +`Promise`<`boolean`\> + +true if the transfer was successful. + +**`Remarks`** + +This is useful when the consumer does not want to wait for the publisher +to transfer the NFT once the payment is made. Assuming the publisher delegated +transfer permissions to the Node. + +One example would be a marketplace where the user wants to get access to the NFT +as soon as the payment is made + +**`Example`** + +```ts +const receipt = await nevermined.nfts721.claim( + agreementId, + editor.getId(), + subscriber.getId(), + nftAmount, + 721, +) +``` + +**`Throws`** + +[NFTError](NFTError.md) if Nevermined is not an operator for this NFT + +#### Defined in + +[src/nevermined/api/nfts/NFTsBaseApi.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFTsBaseApi.ts#L50) + +--- + +### getSubscriptionToken + +▸ **getSubscriptionToken**(`did`, `account`): `Promise`<[`SubscriptionToken`](../interfaces/SubscriptionToken.md)\> + +Get a JWT token for an asset associated with a webService + +#### Parameters + +| Name | Type | Description | +| :-------- | :---------------------- | :----------------------------------------------------------------------------- | +| `did` | `string` | The did of the asset with a webService resource and an associated subscription | +| `account` | [`Account`](Account.md) | Account of the user requesting the token | + +#### Returns + +`Promise`<[`SubscriptionToken`](../interfaces/SubscriptionToken.md)\> + +[SubscriptionToken](../interfaces/SubscriptionToken.md) + +**`Example`** + +```ts +const response = await nevermined.nfts721.getSubscriptionToken(serviceDDO.id, subscriber) + +assert.isDefined(response.accessToken) +assert.isDefined(response.neverminedProxyUri) +``` + +#### Defined in + +[src/nevermined/api/nfts/NFTsBaseApi.ts:478](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFTsBaseApi.ts#L478) + +--- + +### isOperator + +▸ **isOperator**(`nftContractAddress`, `operatorAddress`, `ercType?`): `Promise`<`boolean`\> + +Check if a particular address is the operator of given a NFT address. + +#### Parameters + +| Name | Type | Default value | Description | +| :------------------- | :------------------------------- | :------------ | :-------------------------------------- | +| `nftContractAddress` | `string` | `undefined` | The DID of the NFT to check | +| `operatorAddress` | `string` | `undefined` | The address to check if operator status | +| `ercType` | [`ERCType`](../enums/ERCType.md) | `1155` | The erc type of the NFT. | + +#### Returns + +`Promise`<`boolean`\> + +operator status of address as a boolean + +#### Defined in + +[src/nevermined/api/nfts/NFTsBaseApi.ts:116](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFTsBaseApi.ts#L116) + +--- + +### isOperatorOfDID + +▸ **isOperatorOfDID**(`did`, `address`, `ercType?`): `Promise`<`boolean`\> + +Check if a particular address is the operator of a DID. + +#### Parameters + +| Name | Type | Default value | Description | +| :-------- | :------------------------------- | :------------ | :-------------------------------------- | +| `did` | `string` | `undefined` | The DID of the NFT to check | +| `address` | `string` | `undefined` | The address to check if operator status | +| `ercType` | [`ERCType`](../enums/ERCType.md) | `1155` | The erc type of the NFT. | + +#### Returns + +`Promise`<`boolean`\> + +operator status of address as a boolean + +#### Defined in + +[src/nevermined/api/nfts/NFTsBaseApi.ts:91](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFTsBaseApi.ts#L91) + +--- + +### list + +▸ **list**(`did`, `list`, `publisher`, `publishMetadata?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +Given a DID, updates the metadata associated to the asset allowing to list or unlist it. It also can upload this metadata to a remote decentralized stored depending on the `publishMetadata` parameter. +In a Nevermined environment, when an asset is unlisted, it is not possible to be found and accessed by any user. + +#### Parameters + +| Name | Type | Default value | Description | +| :---------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `list` | `boolean` | `undefined` | Needs the asset to be listed or unlisted | +| `publisher` | [`Account`](Account.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +[DDO](DDO.md) The DDO updated + +#### Inherited from + +[RegistryBaseApi](RegistryBaseApi.md).[list](RegistryBaseApi.md#list) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:462](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L462) + +--- + +### listOnSecondaryMarkets + +▸ **listOnSecondaryMarkets**(`ddo`, `assetPrice`, `nftAmount`, `nftTransfer`, `provider`, `token`, `owner`): `Promise`<`string`\> + +After purchase re-list an NFT to enable secondary market sales. + +#### Parameters + +| Name | Type | Description | +| :------------ | :---------------------------- | :----------------------------------------------------------- | +| `ddo` | [`DDO`](DDO.md) | The DDO of the asset. | +| `assetPrice` | [`AssetPrice`](AssetPrice.md) | The current setup of asset rewards. | +| `nftAmount` | `bigint` | The number of NFTs put up for secondary sale. | +| `nftTransfer` | `boolean` | - | +| `provider` | `string` | The address that will be the provider of the secondary sale. | +| `token` | [`Token`](Token.md) | - | +| `owner` | [`Account`](Account.md) | The account of the current owner. | + +#### Returns + +`Promise`<`string`\> + +the agreementId of the secondary sale. + +**`Example`** + +```ts +const agreementId = await nevermined.nfts1155.listOnSecondaryMarkets( + ddo, + assetPrice, + numberNFTs, + collector.getId(), + token, + collector.getId(), +) +``` + +**`Throws`** + +[NFTError](NFTError.md) +Thrown if there is an error listing the NFT. + +#### Defined in + +[src/nevermined/api/nfts/NFTsBaseApi.ts:260](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFTsBaseApi.ts#L260) + +--- + +### orderAsset + +▸ **orderAsset**(`did`, `serviceReference`, `consumer`, `params?`): [`SubscribablePromise`](SubscribablePromise.md)<[`OrderProgressStep`](../enums/OrderProgressStep.md), `string`\> + +Start the purchase/order of an asset's service. Starts by signing the service agreement +then sends the request to the publisher via the service endpoint (Node http service). + +#### Parameters + +| Name | Type | Description | +| :----------------- | :------------------------------------------------------------ | :---------------- | +| `did` | `string` | Decentralized ID. | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | Service. | +| `consumer` | [`Account`](Account.md) | Consumer account. | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | - | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`OrderProgressStep`](../enums/OrderProgressStep.md), `string`\> + +The agreement ID. + +#### Inherited from + +[RegistryBaseApi](RegistryBaseApi.md).[orderAsset](RegistryBaseApi.md#orderasset) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:563](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L563) + +--- + +### registerNeverminedAsset + +▸ `Protected` **registerNeverminedAsset**(`assetAttributes`, `publisher`, `publicationOptions`, `nftAttributes?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`CreateProgressStep`](../enums/CreateProgressStep.md), [`DDO`](DDO.md)\> + +It registers a new asset in a Nevermined network. This method is protected and not exposed +via the Nevermined APIs directly. It must accessed via the `assets`, `compute`, and `nfts` APIs. + +#### Parameters + +| Name | Type | Description | +| :------------------- | :------------------------------------------------------ | :-------------------------------------------------------------------------------- | +| `assetAttributes` | [`AssetAttributes`](AssetAttributes.md) | Attributes describing the asset | +| `publisher` | [`Account`](Account.md) | The account publishing the asset | +| `publicationOptions` | [`AssetPublicationOptions`](AssetPublicationOptions.md) | Allows to specify the publication options of the off-chain and the on-chain data. | +| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | Attributes describing the NFT (ERC-721) associated to the asset | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`CreateProgressStep`](../enums/CreateProgressStep.md), [`DDO`](DDO.md)\> + +The metadata of the asset created (DDO) + +**`See`** + +[PublishOnChainOptions](../enums/PublishOnChainOptions.md) and [PublishMetadataOptions](../enums/PublishMetadataOptions.md) + +#### Inherited from + +[RegistryBaseApi](RegistryBaseApi.md).[registerNeverminedAsset](RegistryBaseApi.md#registerneverminedasset) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L42) + +--- + +### resolveAsset + +▸ `Protected` **resolveAsset**(`did`, `policy?`): `Promise`<[`DDO`](DDO.md)\> + +Returns a DDO by DID. Depending of the resolution policy it prioritize the Metadata API or Immutable urls. + +#### Parameters + +| Name | Type | Default value | Description | +| :------- | :------------------------------------------------- | :---------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `did` | `string` | `undefined` | Decentralized ID. | +| `policy` | [`DIDResolvePolicy`](../enums/DIDResolvePolicy.md) | `DIDResolvePolicy.MetadataAPIFirst` | It specifies the resolve policy to apply. It allows to select that priorities during the asset resolution via Metadata API or Immutable URLs (IPFS, Filecoin, etc) | + +#### Returns + +`Promise`<[`DDO`](DDO.md)\> + +[DDO](DDO.md) + +#### Inherited from + +[RegistryBaseApi](RegistryBaseApi.md).[resolveAsset](RegistryBaseApi.md#resolveasset) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:310](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L310) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[RegistryBaseApi](RegistryBaseApi.md).[setInstanceConfig](RegistryBaseApi.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### updateAsset + +▸ `Protected` **updateAsset**(`did`, `metadata`, `publisher`, `publishMetadataOptions?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +Given a DID, updates the metadata associated to the asset. It also can upload this metadata to a remote decentralized stored depending on the `publishMetadata` parameter. + +#### Parameters + +| Name | Type | Default value | Description | +| :----------------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | Metadata describing the asset | +| `publisher` | [`Account`](Account.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadataOptions` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +[DDO](DDO.md) The DDO updated + +#### Inherited from + +[RegistryBaseApi](RegistryBaseApi.md).[updateAsset](RegistryBaseApi.md#updateasset) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:353](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L353) + +--- + +### getInstance + +▸ `Static` **getInstance**(`..._args`): `any` + +#### Parameters + +| Name | Type | +| :--------- | :---- | +| `..._args` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[RegistryBaseApi](RegistryBaseApi.md).[getInstance](RegistryBaseApi.md#getinstance) + +#### Defined in + +[src/Instantiable.abstract.ts:86](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L86) + +--- + +### getNFTContractAddress + +▸ `Static` **getNFTContractAddress**(`ddo`, `serviceReference?`): `any` + +Gets the NFT contract address associated with a Nevermined asset from the DDO. + +#### Parameters + +| Name | Type | Default value | Description | +| :----------------- | :------------------------------------------------------------ | :------------- | :------------------------------------------------ | +| `ddo` | [`DDO`](DDO.md) | `undefined` | The DDO of the asset. | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-access'` | The service type to look for the contract address | + +#### Returns + +`any` + +The NFT contract address. + +**`Example`** + +```ts +const nftContractAddress = NFT1155Api.getNFTContractAddress(ddo) +``` + +#### Defined in + +[src/nevermined/api/nfts/NFTsBaseApi.ts:219](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFTsBaseApi.ts#L219) + +--- + +### getServicePlugin + +▸ `Static` `Protected` **getServicePlugin**(`config`): `Object` + +Initializes the default Nevermined service plugins and return that instance + +#### Parameters + +| Name | Type | Description | +| :------- | :---------------------------------------------------------- | :---------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | Nevermined config | + +#### Returns + +`Object` + +The Nevermined Service Plugin instance + +| Name | Type | +| :------------ | :------------------------------------------------------------------------------------------------------------ | +| `aave-credit` | [`ServicePlugin`](../interfaces/ServicePlugin.md)<[`ServiceAaveCredit`](../interfaces/ServiceAaveCredit.md)\> | +| `access` | [`AccessService`](AccessService.md) | +| `compute` | [`EscrowComputeExecutionTemplate`](EscrowComputeExecutionTemplate.md) | +| `nft-access` | [`NFTAccessService`](NFTAccessService.md) | +| `nft-sales` | [`NFTSalesService`](NFTSalesService.md) | + +#### Inherited from + +[RegistryBaseApi](RegistryBaseApi.md).[getServicePlugin](RegistryBaseApi.md#getserviceplugin) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:618](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L618) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[RegistryBaseApi](RegistryBaseApi.md).[setInstanceConfig](RegistryBaseApi.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/Nevermined.md b/docs/api-reference/classes/Nevermined.md index 74e40ca8c..89cb28caa 100644 --- a/docs/api-reference/classes/Nevermined.md +++ b/docs/api-reference/classes/Nevermined.md @@ -6,7 +6,7 @@ Main interface for Nevermined Protocol. ## Hierarchy -- `Instantiable` +- [`Instantiable`](Instantiable.md) ↳ **`Nevermined`** @@ -18,31 +18,24 @@ Main interface for Nevermined Protocol. ### Properties -- [aaveCredit](Nevermined.md#aavecredit) - [accounts](Nevermined.md#accounts) - [agreements](Nevermined.md#agreements) - [assets](Nevermined.md#assets) -- [auth](Nevermined.md#auth) -- [bookmarks](Nevermined.md#bookmarks) +- [compute](Nevermined.md#compute) - [contracts](Nevermined.md#contracts) -- [faucet](Nevermined.md#faucet) -- [files](Nevermined.md#files) -- [gateway](Nevermined.md#gateway) +- [isKeeperConnected](Nevermined.md#iskeeperconnected) - [keeper](Nevermined.md#keeper) -- [marketplace](Nevermined.md#marketplace) -- [metadata](Nevermined.md#metadata) -- [nfts](Nevermined.md#nfts) -- [permissions](Nevermined.md#permissions) -- [profiles](Nevermined.md#profiles) +- [nfts1155](Nevermined.md#nfts1155) +- [nfts721](Nevermined.md#nfts721) - [provenance](Nevermined.md#provenance) -- [provider](Nevermined.md#provider) -- [token](Nevermined.md#token) +- [search](Nevermined.md#search) +- [services](Nevermined.md#services) - [utils](Nevermined.md#utils) -- [versions](Nevermined.md#versions) ### Accessors - [artifactsFolder](Nevermined.md#artifactsfolder) +- [circuitsFolder](Nevermined.md#circuitsfolder) - [config](Nevermined.md#config) - [instanceConfig](Nevermined.md#instanceconfig) - [instantiableConfig](Nevermined.md#instantiableconfig) @@ -52,12 +45,7 @@ Main interface for Nevermined Protocol. ### Methods -- [addresses](Nevermined.md#addresses) -- [checkExists](Nevermined.md#checkexists) -- [findSigner](Nevermined.md#findsigner) - [setInstanceConfig](Nevermined.md#setinstanceconfig) -- [addressesStatic](Nevermined.md#addressesstatic) -- [findSignerStatic](Nevermined.md#findsignerstatic) - [getInstance](Nevermined.md#getinstance) - [setInstanceConfig](Nevermined.md#setinstanceconfig-1) @@ -69,83 +57,59 @@ Main interface for Nevermined Protocol. #### Overrides -Instantiable.constructor +[Instantiable](Instantiable.md).[constructor](Instantiable.md#constructor) #### Defined in -[src/nevermined.ts:213](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined.ts#L213) +[src/nevermined/Nevermined.ts:211](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Nevermined.ts#L211) ## Properties -### aaveCredit - -• **aaveCredit**: `AaveCredit` - -AaveCredit allows taking loans from Aave protocol using NFT tokens as collateral. - -#### Defined in - -[src/nevermined.ts:196](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined.ts#L196) - ---- - ### accounts -• **accounts**: [`Accounts`](Accounts.md) +• **accounts**: [`AccountsApi`](AccountsApi.md) Accounts submodule #### Defined in -[src/nevermined.ts:156](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined.ts#L156) +[src/nevermined/Nevermined.ts:159](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Nevermined.ts#L159) --- ### agreements -• **agreements**: `Agreements` +• **agreements**: [`AgreementsApi`](AgreementsApi.md) Agreements submodule #### Defined in -[src/nevermined.ts:181](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined.ts#L181) +[src/nevermined/Nevermined.ts:164](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Nevermined.ts#L164) --- ### assets -• **assets**: `Assets` +• **assets**: [`AssetsApi`](AssetsApi.md) -Assets submodule +Assets API #### Defined in -[src/nevermined.ts:166](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined.ts#L166) +[src/nevermined/Nevermined.ts:169](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Nevermined.ts#L169) --- -### auth +### compute -• **auth**: `Auth` +• **compute**: [`ComputeApi`](ComputeApi.md) -Auth submodule +Compute API #### Defined in -[src/nevermined.ts:161](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined.ts#L161) - ---- - -### bookmarks - -• **bookmarks**: `Bookmarks` - -Bookmarks instance - -#### Defined in - -[src/nevermined.ts:141](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined.ts#L141) +[src/nevermined/Nevermined.ts:174](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Nevermined.ts#L174) --- @@ -153,54 +117,35 @@ Bookmarks instance • **contracts**: `Object` -Nevermind very own contract reflector. +Nevermined very own contract reflector. #### Type declaration -| Name | Type | -| :----------- | :--------------------------------------------------------- | -| `loadErc20` | (`address`: `string`) => `Promise`<`default`\> | -| `loadNft721` | (`address`: `string`) => `Promise`<[`Nft721`](Nft721.md)\> | +| Name | Type | +| :-------------------- | :---------------------------------------------------------------------------------- | +| `loadErc20` | (`address`: `string`) => `Promise`<[`CustomToken`](CustomToken.md)\> | +| `loadNft1155` | (`address`: `string`) => `Promise`<[`NFT1155Api`](NFT1155Api.md)\> | +| `loadNft1155Api` | (`api`: [`NFT1155Api`](NFT1155Api.md)) => `Promise`<[`NFT1155Api`](NFT1155Api.md)\> | +| `loadNft1155Contract` | (`address`: `string`) => `Promise`<[`Nft1155Contract`](Nft1155Contract.md)\> | +| `loadNft721` | (`address`: `string`) => `Promise`<[`NFT721Api`](NFT721Api.md)\> | +| `loadNft721Api` | (`api`: [`NFT721Api`](NFT721Api.md)) => `Promise`<[`NFT721Api`](NFT721Api.md)\> | +| `loadNft721Contract` | (`address`: `string`) => `Promise`<[`Nft721Contract`](Nft721Contract.md)\> | #### Defined in -[src/nevermined.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined.ts#L97) +[src/nevermined/Nevermined.ts:74](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Nevermined.ts#L74) --- -### faucet +### isKeeperConnected -• **faucet**: `Faucet` +• **isKeeperConnected**: `boolean` -Metadata instance. +If keeper is connected #### Defined in -[src/nevermined.ts:151](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined.ts#L151) - ---- - -### files - -• **files**: `Files` - -Files submodule - -#### Defined in - -[src/nevermined.ts:176](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined.ts#L176) - ---- - -### gateway - -• **gateway**: `Gateway` - -Gateway instance. - -#### Defined in - -[src/nevermined.ts:121](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined.ts#L121) +[src/nevermined/Nevermined.ts:209](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Nevermined.ts#L209) --- @@ -212,133 +157,103 @@ Keeper instance. #### Defined in -[src/nevermined.ts:92](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined.ts#L92) - ---- - -### marketplace - -• **marketplace**: `MarketplaceApi` - -Marketplace instance. - -#### Defined in - -[src/nevermined.ts:131](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined.ts#L131) +[src/nevermined/Nevermined.ts:154](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Nevermined.ts#L154) --- -### metadata +### nfts1155 -• **metadata**: `Metadata` +• **nfts1155**: [`NFT1155Api`](NFT1155Api.md) -Metadata instance. +ERC-1155 Nfts API #### Defined in -[src/nevermined.ts:126](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined.ts#L126) +[src/nevermined/Nevermined.ts:179](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Nevermined.ts#L179) --- -### nfts +### nfts721 -• **nfts**: [`Nfts`](Nfts.md) +• **nfts721**: [`NFT721Api`](NFT721Api.md) -Nfts submodule +ERC-721 Nfts API #### Defined in -[src/nevermined.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined.ts#L171) - ---- - -### permissions - -• **permissions**: `Permissions` - -Permissions instance - -#### Defined in - -[src/nevermined.ts:146](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined.ts#L146) - ---- - -### profiles - -• **profiles**: `Profiles` - -Profiles instance - -#### Defined in - -[src/nevermined.ts:136](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined.ts#L136) +[src/nevermined/Nevermined.ts:184](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Nevermined.ts#L184) --- ### provenance -• **provenance**: `Provenance` +• **provenance**: [`ProvenanceApi`](ProvenanceApi.md) Provenance submodule #### Defined in -[src/nevermined.ts:206](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined.ts#L206) +[src/nevermined/Nevermined.ts:189](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Nevermined.ts#L189) --- -### provider +### search -• **provider**: `Provider` +• **search**: [`SearchApi`](SearchApi.md) -Nevermined probiders submodule +SearchApi API #### Defined in -[src/nevermined.ts:186](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined.ts#L186) +[src/nevermined/Nevermined.ts:194](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Nevermined.ts#L194) --- -### token +### services -• **token**: `Token` +• **services**: [`ServicesApi`](ServicesApi.md) -Nevermined tokens submodule +SearchApi API #### Defined in -[src/nevermined.ts:191](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined.ts#L191) +[src/nevermined/Nevermined.ts:199](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Nevermined.ts#L199) --- ### utils -• **utils**: `Utils` +• **utils**: [`UtilsApi`](UtilsApi.md) Utils submodule #### Defined in -[src/nevermined.ts:211](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined.ts#L211) +[src/nevermined/Nevermined.ts:204](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Nevermined.ts#L204) ---- +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` -### versions +#### Returns -• **versions**: `Versions` +`string` + +#### Inherited from -Versions submodule +Instantiable.artifactsFolder #### Defined in -[src/nevermined.ts:201](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined.ts#L201) +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) -## Accessors +--- -### artifactsFolder +### circuitsFolder -• `Protected` `get` **artifactsFolder**(): `string` +• `Protected` `get` **circuitsFolder**(): `string` #### Returns @@ -346,21 +261,21 @@ Versions submodule #### Inherited from -Instantiable.artifactsFolder +Instantiable.circuitsFolder #### Defined in -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) --- ### config -• `Protected` `get` **config**(): [`Config`](Config.md) +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) #### Returns -[`Config`](Config.md) +[`NeverminedOptions`](NeverminedOptions.md) #### Inherited from @@ -368,17 +283,17 @@ Instantiable.config #### Defined in -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) --- ### instanceConfig -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) #### Returns -`InstantiableConfig` +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) #### Inherited from @@ -386,17 +301,17 @@ Instantiable.instanceConfig #### Defined in -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) --- ### instantiableConfig -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) #### Returns -`InstantiableConfig` +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) #### Inherited from @@ -404,17 +319,17 @@ Instantiable.instantiableConfig #### Defined in -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) --- ### logger -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) +• `Protected` `get` **logger**(): `Logger` #### Returns -[`Logger`](utils.Logger.md) +`Logger` #### Inherited from @@ -422,7 +337,7 @@ Instantiable.logger #### Defined in -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) --- @@ -440,17 +355,17 @@ Instantiable.nevermined #### Defined in -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) --- ### web3 -• `Protected` `get` **web3**(): `JsonRpcProvider` +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` #### Returns -`JsonRpcProvider` +`JsonRpcProvider` \| `BrowserProvider` #### Inherited from @@ -458,89 +373,19 @@ Instantiable.web3 #### Defined in -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) ## Methods -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -Instantiable.addresses - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - ---- - -### 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](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - ---- - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -Instantiable.findSigner - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - ---- - ### setInstanceConfig ▸ `Protected` **setInstanceConfig**(`config`): `void` #### Parameters -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -548,99 +393,48 @@ Instantiable.findSigner #### Inherited from -Instantiable.setInstanceConfig +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig) #### Defined in -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) --- -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -Instantiable.addressesStatic - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - ---- +### getInstance -### findSignerStatic +▸ `Static` **getInstance**(`config`): `Promise`<[`Nevermined`](Nevermined.md)\> -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> +Returns the instance of Nevermined. #### Parameters -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | +| Name | Type | Description | +| :------- | :------------------------------------------ | :--------------------------------- | +| `config` | [`NeverminedOptions`](NeverminedOptions.md) | Nevermined instance configuration. | #### Returns -`Promise`<`Signer`\> - -#### Inherited from - -Instantiable.findSignerStatic - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - ---- - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`Nevermined`](Nevermined.md)\> +`Promise`<[`Nevermined`](Nevermined.md)\> -Returns the instance of Nevermined. +A [Nevermined](Nevermined.md) instance **`Example`** ```ts -import { Nevermined, Config } from '@nevermined-io/nevermied-sdk-js' +import { Nevermined, Config } from '@nevermined-io/sdk' const config: Config = {...} const nevermined = await Nevermined.getInstance(config) ``` -#### Parameters - -| Name | Type | Description | -| :------- | :-------------------- | :--------------------------------- | -| `config` | [`Config`](Config.md) | Nevermined instance configuration. | - -#### Returns - -`Promise`<[`Nevermined`](Nevermined.md)\> - -A [Nevermined](Nevermined.md) instance - #### Overrides -Instantiable.getInstance +[Instantiable](Instantiable.md).[getInstance](Instantiable.md#getinstance) #### Defined in -[src/nevermined.ts:51](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined.ts#L51) +[src/nevermined/Nevermined.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Nevermined.ts#L34) --- @@ -650,16 +444,16 @@ Instantiable.getInstance #### Type parameters -| Name | Type | -| :--- | :--------------------------- | -| `T` | extends `Instantiable`<`T`\> | +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | #### Parameters -| Name | Type | -| :------------------- | :------------------- | -| `instance` | `T` | -| `instantiableConfig` | `InstantiableConfig` | +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | #### Returns @@ -667,8 +461,8 @@ Instantiable.getInstance #### Inherited from -Instantiable.setInstanceConfig +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig-1) #### Defined in -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/NeverminedEvent.md b/docs/api-reference/classes/NeverminedEvent.md new file mode 100644 index 000000000..23b237b9c --- /dev/null +++ b/docs/api-reference/classes/NeverminedEvent.md @@ -0,0 +1,412 @@ +[@nevermined-io/sdk](../code-reference.md) / NeverminedEvent + +# Class: NeverminedEvent + +## Hierarchy + +- [`Instantiable`](Instantiable.md) + + ↳ **`NeverminedEvent`** + + ↳↳ [`ContractEvent`](ContractEvent.md) + + ↳↳ [`SubgraphEvent`](SubgraphEvent.md) + +## Table of contents + +### Constructors + +- [constructor](NeverminedEvent.md#constructor) + +### Properties + +- [contract](NeverminedEvent.md#contract) +- [eventEmitter](NeverminedEvent.md#eventemitter) + +### Accessors + +- [artifactsFolder](NeverminedEvent.md#artifactsfolder) +- [circuitsFolder](NeverminedEvent.md#circuitsfolder) +- [config](NeverminedEvent.md#config) +- [instanceConfig](NeverminedEvent.md#instanceconfig) +- [instantiableConfig](NeverminedEvent.md#instantiableconfig) +- [logger](NeverminedEvent.md#logger) +- [nevermined](NeverminedEvent.md#nevermined) +- [web3](NeverminedEvent.md#web3) + +### Methods + +- [getBlockNumber](NeverminedEvent.md#getblocknumber) +- [getEventData](NeverminedEvent.md#geteventdata) +- [getPastEvents](NeverminedEvent.md#getpastevents) +- [once](NeverminedEvent.md#once) +- [setInstanceConfig](NeverminedEvent.md#setinstanceconfig) +- [subscribe](NeverminedEvent.md#subscribe) +- [getInstance](NeverminedEvent.md#getinstance) +- [setInstanceConfig](NeverminedEvent.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• `Protected` **new NeverminedEvent**(`contract`, `eventEmitter`) + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `contract` | [`ContractBase`](ContractBase.md) | +| `eventEmitter` | [`EventEmitter`](../interfaces/EventEmitter.md) | + +#### Overrides + +[Instantiable](Instantiable.md).[constructor](Instantiable.md#constructor) + +#### Defined in + +[src/events/NeverminedEvent.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/NeverminedEvent.ts#L34) + +## Properties + +### contract + +• `Protected` **contract**: [`ContractBase`](ContractBase.md) = `null` + +#### Defined in + +[src/events/NeverminedEvent.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/NeverminedEvent.ts#L29) + +--- + +### eventEmitter + +• `Protected` **eventEmitter**: [`EventEmitter`](../interfaces/EventEmitter.md) + +#### Defined in + +[src/events/NeverminedEvent.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/NeverminedEvent.ts#L28) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +Instantiable.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +Instantiable.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +Instantiable.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +Instantiable.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### getBlockNumber + +▸ `Abstract` **getBlockNumber**(`...args`): `Promise`<`number`\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +`Promise`<`number`\> + +#### Defined in + +[src/events/NeverminedEvent.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/NeverminedEvent.ts#L32) + +--- + +### getEventData + +▸ `Abstract` **getEventData**(`options`): [`EventResult`](../code-reference.md#eventresult) + +#### Parameters + +| Name | Type | +| :-------- | :---------------------------------------------- | +| `options` | [`EventOptions`](../interfaces/EventOptions.md) | + +#### Returns + +[`EventResult`](../code-reference.md#eventresult) + +#### Defined in + +[src/events/NeverminedEvent.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/NeverminedEvent.ts#L30) + +--- + +### getPastEvents + +▸ `Abstract` **getPastEvents**(`options`): [`EventResult`](../code-reference.md#eventresult) + +#### Parameters + +| Name | Type | +| :-------- | :---------------------------------------------- | +| `options` | [`EventOptions`](../interfaces/EventOptions.md) | + +#### Returns + +[`EventResult`](../code-reference.md#eventresult) + +#### Defined in + +[src/events/NeverminedEvent.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/NeverminedEvent.ts#L31) + +--- + +### once + +▸ **once**(`callback?`, `options?`): `Promise`<[`EventResult`](../code-reference.md#eventresult)\> + +#### Parameters + +| Name | Type | +| :---------- | :------------------------------------------------------------------------ | +| `callback?` | (`events`: [`EventResult`](../code-reference.md#eventresult)[]) => `void` | +| `options?` | [`EventOptions`](../interfaces/EventOptions.md) | + +#### Returns + +`Promise`<[`EventResult`](../code-reference.md#eventresult)\> + +#### Defined in + +[src/events/NeverminedEvent.ts:54](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/NeverminedEvent.ts#L54) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### subscribe + +▸ **subscribe**(`callback`, `options`): [`ContractEventSubscription`](../interfaces/ContractEventSubscription.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------------------------------------------ | +| `callback` | (`events`: [`EventResult`](../code-reference.md#eventresult)[]) => `void` | +| `options` | [`EventOptions`](../interfaces/EventOptions.md) | + +#### Returns + +[`ContractEventSubscription`](../interfaces/ContractEventSubscription.md) + +#### Defined in + +[src/events/NeverminedEvent.ts:40](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/NeverminedEvent.ts#L40) + +--- + +### getInstance + +▸ `Static` **getInstance**(`..._args`): `any` + +#### Parameters + +| Name | Type | +| :--------- | :---- | +| `..._args` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[Instantiable](Instantiable.md).[getInstance](Instantiable.md#getinstance) + +#### Defined in + +[src/Instantiable.abstract.ts:86](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L86) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/NeverminedNode.md b/docs/api-reference/classes/NeverminedNode.md new file mode 100644 index 000000000..e3600374b --- /dev/null +++ b/docs/api-reference/classes/NeverminedNode.md @@ -0,0 +1,986 @@ +[@nevermined-io/sdk](../code-reference.md) / NeverminedNode + +# Class: NeverminedNode + +Provides a interface with Nevermined Node. +The Nevermined Node is the technical component executed by the Publishers allowing to them to provide extended data services. + +## Hierarchy + +- [`Instantiable`](Instantiable.md) + + ↳ **`NeverminedNode`** + +## Table of contents + +### Constructors + +- [constructor](NeverminedNode.md#constructor) + +### Accessors + +- [artifactsFolder](NeverminedNode.md#artifactsfolder) +- [circuitsFolder](NeverminedNode.md#circuitsfolder) +- [config](NeverminedNode.md#config) +- [instanceConfig](NeverminedNode.md#instanceconfig) +- [instantiableConfig](NeverminedNode.md#instantiableconfig) +- [logger](NeverminedNode.md#logger) +- [nevermined](NeverminedNode.md#nevermined) +- [url](NeverminedNode.md#url) +- [web3](NeverminedNode.md#web3) + +### Methods + +- [claimNFT](NeverminedNode.md#claimnft) +- [computeLogs](NeverminedNode.md#computelogs) +- [computeStatus](NeverminedNode.md#computestatus) +- [consumeService](NeverminedNode.md#consumeservice) +- [downloadService](NeverminedNode.md#downloadservice) +- [encrypt](NeverminedNode.md#encrypt) +- [execute](NeverminedNode.md#execute) +- [fetchToken](NeverminedNode.md#fetchtoken) +- [getAccessEndpoint](NeverminedNode.md#getaccessendpoint) +- [getAccessProofEndpoint](NeverminedNode.md#getaccessproofendpoint) +- [getBabyjubPublicKey](NeverminedNode.md#getbabyjubpublickey) +- [getClaimNftEndpoint](NeverminedNode.md#getclaimnftendpoint) +- [getComputeLogsEndpoint](NeverminedNode.md#getcomputelogsendpoint) +- [getComputeStatusEndpoint](NeverminedNode.md#getcomputestatusendpoint) +- [getConsumeEndpoint](NeverminedNode.md#getconsumeendpoint) +- [getDownloadEndpoint](NeverminedNode.md#getdownloadendpoint) +- [getEcdsaPublicKey](NeverminedNode.md#getecdsapublickey) +- [getEncryptEndpoint](NeverminedNode.md#getencryptendpoint) +- [getExecuteEndpoint](NeverminedNode.md#getexecuteendpoint) +- [getFetchTokenEndpoint](NeverminedNode.md#getfetchtokenendpoint) +- [getNeverminedNodeInfo](NeverminedNode.md#getneverminednodeinfo) +- [getNft721Endpoint](NeverminedNode.md#getnft721endpoint) +- [getNftAccessEndpoint](NeverminedNode.md#getnftaccessendpoint) +- [getNftEndpoint](NeverminedNode.md#getnftendpoint) +- [getProviderAddress](NeverminedNode.md#getprovideraddress) +- [getPurchaseEndpoint](NeverminedNode.md#getpurchaseendpoint) +- [getRsaPublicKey](NeverminedNode.md#getrsapublickey) +- [getServiceEndpoint](NeverminedNode.md#getserviceendpoint) +- [getSubscriptionToken](NeverminedNode.md#getsubscriptiontoken) +- [getSubscriptionsEndpoint](NeverminedNode.md#getsubscriptionsendpoint) +- [getUploadFilecoinEndpoint](NeverminedNode.md#getuploadfilecoinendpoint) +- [getUploadIPFSEndpoint](NeverminedNode.md#getuploadipfsendpoint) +- [getUploadS3Endpoint](NeverminedNode.md#getuploads3endpoint) +- [getVersionInfo](NeverminedNode.md#getversioninfo) +- [initializeServiceAgreement](NeverminedNode.md#initializeserviceagreement) +- [publishImmutableContent](NeverminedNode.md#publishimmutablecontent) +- [setInstanceConfig](NeverminedNode.md#setinstanceconfig) +- [uploadContent](NeverminedNode.md#uploadcontent) +- [getInstance](NeverminedNode.md#getinstance) +- [setInstanceConfig](NeverminedNode.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new NeverminedNode**(`config`) + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Overrides + +[Instantiable](Instantiable.md).[constructor](Instantiable.md#constructor) + +#### Defined in + +[src/services/node/NeverminedNode.ts:38](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L38) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +Instantiable.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +Instantiable.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +Instantiable.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### url + +• `Private` `get` **url**(): `string` + +#### Returns + +`string` + +#### Defined in + +[src/services/node/NeverminedNode.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L34) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +Instantiable.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### claimNFT + +▸ **claimNFT**(`agreementId`, `nftHolder`, `nftReceiver`, `nftAmount`, `ercType?`, `did?`, `serviceIndex?`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | Default value | +| :-------------- | :------------------------------- | :------------ | +| `agreementId` | `string` | `undefined` | +| `nftHolder` | `string` | `undefined` | +| `nftReceiver` | `string` | `undefined` | +| `nftAmount` | `bigint` | `undefined` | +| `ercType` | [`ERCType`](../enums/ERCType.md) | `1155` | +| `did?` | `string` | `undefined` | +| `serviceIndex?` | `number` | `undefined` | + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[src/services/node/NeverminedNode.ts:374](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L374) + +--- + +### computeLogs + +▸ **computeLogs**(`agreementId`, `executionId`, `account`): `Promise`<`any`\> + +#### Parameters + +| Name | Type | +| :------------ | :---------------------- | +| `agreementId` | `string` | +| `executionId` | `string` | +| `account` | [`Account`](Account.md) | + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +[src/services/node/NeverminedNode.ts:304](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L304) + +--- + +### computeStatus + +▸ **computeStatus**(`agreementId`, `executionId`, `account`): `Promise`<`any`\> + +#### Parameters + +| Name | Type | +| :------------ | :---------------------- | +| `agreementId` | `string` | +| `executionId` | `string` | +| `account` | [`Account`](Account.md) | + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +[src/services/node/NeverminedNode.ts:339](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L339) + +--- + +### consumeService + +▸ **consumeService**(`did`, `agreementId`, `serviceEndpoint`, `account`, `files`, `destination`, `index?`, `result?`, `buyer?`, `babysig?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | Default value | +| :---------------- | :------------------------------------------------------------------------ | :----------------- | +| `did` | `string` | `undefined` | +| `agreementId` | `string` | `undefined` | +| `serviceEndpoint` | `string` | `undefined` | +| `account` | [`Account`](Account.md) | `undefined` | +| `files` | [`MetaDataExternalResource`](../interfaces/MetaDataExternalResource.md)[] | `undefined` | +| `destination` | `string` | `undefined` | +| `index` | `number` | `-1` | +| `result` | [`AssetResult`](../enums/AssetResult.md) | `AssetResult.DATA` | +| `buyer?` | `string` | `undefined` | +| `babysig?` | [`Babysig`](../interfaces/Babysig.md) | `undefined` | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/services/node/NeverminedNode.ts:172](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L172) + +--- + +### downloadService + +▸ **downloadService**(`files`, `destination`, `index?`, `headers?`, `result?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | Default value | +| :------------ | :------------------------------------------------------------------------ | :----------------- | +| `files` | [`MetaDataExternalResource`](../interfaces/MetaDataExternalResource.md)[] | `undefined` | +| `destination` | `string` | `undefined` | +| `index` | `number` | `-1` | +| `headers?` | `Object` | `undefined` | +| `result` | [`AssetResult`](../enums/AssetResult.md) | `AssetResult.DATA` | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/services/node/NeverminedNode.ts:239](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L239) + +--- + +### encrypt + +▸ **encrypt**(`did`, `document`, `method`): `Promise`<`any`\> + +#### Parameters + +| Name | Type | +| :--------- | :---- | +| `did` | `any` | +| `document` | `any` | +| `method` | `any` | + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +[src/services/node/NeverminedNode.ts:219](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L219) + +--- + +### execute + +▸ **execute**(`agreementId`, `workflowDid`, `account`): `Promise`<`any`\> + +#### Parameters + +| Name | Type | +| :------------ | :---------------------- | +| `agreementId` | `string` | +| `workflowDid` | `string` | +| `account` | [`Account`](Account.md) | + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +[src/services/node/NeverminedNode.ts:268](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L268) + +--- + +### fetchToken + +▸ **fetchToken**(`grantToken`, `numberTries?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | Default value | +| :------------ | :------- | :------------ | +| `grantToken` | `string` | `undefined` | +| `numberTries` | `number` | `3` | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/services/node/NeverminedNode.ts:419](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L419) + +--- + +### getAccessEndpoint + +▸ **getAccessEndpoint**(): `string` + +#### Returns + +`string` + +#### Defined in + +[src/services/node/NeverminedNode.ts:55](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L55) + +--- + +### getAccessProofEndpoint + +▸ **getAccessProofEndpoint**(): `string` + +#### Returns + +`string` + +#### Defined in + +[src/services/node/NeverminedNode.ts:59](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L59) + +--- + +### getBabyjubPublicKey + +▸ **getBabyjubPublicKey**(): `Promise`<`any`\> + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +[src/services/node/NeverminedNode.ts:138](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L138) + +--- + +### getClaimNftEndpoint + +▸ **getClaimNftEndpoint**(): `string` + +#### Returns + +`string` + +#### Defined in + +[src/services/node/NeverminedNode.ts:111](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L111) + +--- + +### getComputeLogsEndpoint + +▸ **getComputeLogsEndpoint**(`executionId`): `string` + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `executionId` | `string` | + +#### Returns + +`string` + +#### Defined in + +[src/services/node/NeverminedNode.ts:67](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L67) + +--- + +### getComputeStatusEndpoint + +▸ **getComputeStatusEndpoint**(`executionId`): `string` + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `executionId` | `string` | + +#### Returns + +`string` + +#### Defined in + +[src/services/node/NeverminedNode.ts:71](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L71) + +--- + +### getConsumeEndpoint + +▸ **getConsumeEndpoint**(): `string` + +#### Returns + +`string` + +#### Defined in + +[src/services/node/NeverminedNode.ts:51](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L51) + +--- + +### getDownloadEndpoint + +▸ **getDownloadEndpoint**(): `string` + +#### Returns + +`string` + +#### Defined in + +[src/services/node/NeverminedNode.ts:143](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L143) + +--- + +### getEcdsaPublicKey + +▸ **getEcdsaPublicKey**(): `Promise`<`any`\> + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +[src/services/node/NeverminedNode.ts:133](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L133) + +--- + +### getEncryptEndpoint + +▸ **getEncryptEndpoint**(): `string` + +#### Returns + +`string` + +#### Defined in + +[src/services/node/NeverminedNode.ts:79](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L79) + +--- + +### getExecuteEndpoint + +▸ **getExecuteEndpoint**(`serviceAgreementId`): `string` + +#### Parameters + +| Name | Type | +| :------------------- | :------- | +| `serviceAgreementId` | `string` | + +#### Returns + +`string` + +#### Defined in + +[src/services/node/NeverminedNode.ts:75](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L75) + +--- + +### getFetchTokenEndpoint + +▸ **getFetchTokenEndpoint**(): `string` + +#### Returns + +`string` + +#### Defined in + +[src/services/node/NeverminedNode.ts:83](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L83) + +--- + +### getNeverminedNodeInfo + +▸ **getNeverminedNodeInfo**(): `Promise`<`any`\> + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +[src/services/node/NeverminedNode.ts:119](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L119) + +--- + +### getNft721Endpoint + +▸ **getNft721Endpoint**(): `string` + +#### Returns + +`string` + +#### Defined in + +[src/services/node/NeverminedNode.ts:103](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L103) + +--- + +### getNftAccessEndpoint + +▸ **getNftAccessEndpoint**(): `string` + +#### Returns + +`string` + +#### Defined in + +[src/services/node/NeverminedNode.ts:107](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L107) + +--- + +### getNftEndpoint + +▸ **getNftEndpoint**(): `string` + +#### Returns + +`string` + +#### Defined in + +[src/services/node/NeverminedNode.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L99) + +--- + +### getProviderAddress + +▸ **getProviderAddress**(): `Promise`<`any`\> + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +[src/services/node/NeverminedNode.ts:123](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L123) + +--- + +### getPurchaseEndpoint + +▸ **getPurchaseEndpoint**(): `string` + +#### Returns + +`string` + +#### Defined in + +[src/services/node/NeverminedNode.ts:47](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L47) + +--- + +### getRsaPublicKey + +▸ **getRsaPublicKey**(): `Promise`<`any`\> + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +[src/services/node/NeverminedNode.ts:128](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L128) + +--- + +### getServiceEndpoint + +▸ **getServiceEndpoint**(`service`): `string` + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `service` | `string` | + +#### Returns + +`string` + +#### Defined in + +[src/services/node/NeverminedNode.ts:63](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L63) + +--- + +### getSubscriptionToken + +▸ **getSubscriptionToken**(`did`, `account`): `Promise`<[`SubscriptionToken`](../interfaces/SubscriptionToken.md)\> + +#### Parameters + +| Name | Type | +| :-------- | :---------------------- | +| `did` | `string` | +| `account` | [`Account`](Account.md) | + +#### Returns + +`Promise`<[`SubscriptionToken`](../interfaces/SubscriptionToken.md)\> + +#### Defined in + +[src/services/node/NeverminedNode.ts:489](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L489) + +--- + +### getSubscriptionsEndpoint + +▸ **getSubscriptionsEndpoint**(`did`): `string` + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `did` | `string` | + +#### Returns + +`string` + +#### Defined in + +[src/services/node/NeverminedNode.ts:115](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L115) + +--- + +### getUploadFilecoinEndpoint + +▸ **getUploadFilecoinEndpoint**(): `string` + +#### Returns + +`string` + +#### Defined in + +[src/services/node/NeverminedNode.ts:87](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L87) + +--- + +### getUploadIPFSEndpoint + +▸ **getUploadIPFSEndpoint**(): `string` + +#### Returns + +`string` + +#### Defined in + +[src/services/node/NeverminedNode.ts:91](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L91) + +--- + +### getUploadS3Endpoint + +▸ **getUploadS3Endpoint**(): `string` + +#### Returns + +`string` + +#### Defined in + +[src/services/node/NeverminedNode.ts:95](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L95) + +--- + +### getVersionInfo + +▸ **getVersionInfo**(): `Promise`<`any`\> + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +[src/services/node/NeverminedNode.ts:43](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L43) + +--- + +### initializeServiceAgreement + +▸ **initializeServiceAgreement**(`did`, `serviceAgreementId`, `serviceIndex`, `signature`, `consumerAddress`): `Promise`<`any`\> + +#### Parameters + +| Name | Type | +| :------------------- | :------- | +| `did` | `string` | +| `serviceAgreementId` | `string` | +| `serviceIndex` | `number` | +| `signature` | `string` | +| `consumerAddress` | `string` | + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +[src/services/node/NeverminedNode.ts:147](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L147) + +--- + +### publishImmutableContent + +▸ **publishImmutableContent**(`ddo`, `publishMetadata?`): `Promise`<{ `backend`: [`ImmutableBackends`](../enums/ImmutableBackends.md) ; `url`: `string` }\> + +#### Parameters + +| Name | Type | Default value | +| :---------------- | :------------------------------------------------------------- | :---------------------------- | +| `ddo` | [`DDO`](DDO.md) | `undefined` | +| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.IPFS` | + +#### Returns + +`Promise`<{ `backend`: [`ImmutableBackends`](../enums/ImmutableBackends.md) ; `url`: `string` }\> + +#### Defined in + +[src/services/node/NeverminedNode.ts:434](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L434) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### uploadContent + +▸ **uploadContent**(`data`, `encrypt?`, `backend?`): `Promise`<`any`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :----------------------------------------------------- | :---------------------------- | +| `data` | `string` \| `ReadStream` | `undefined` | +| `encrypt?` | `boolean` | `undefined` | +| `backend` | [`NodeUploadBackends`](../enums/NodeUploadBackends.md) | `NodeUploadBackends.Filecoin` | + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +[src/services/node/NeverminedNode.ts:461](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L461) + +--- + +### getInstance + +▸ `Static` **getInstance**(`..._args`): `any` + +#### Parameters + +| Name | Type | +| :--------- | :---- | +| `..._args` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[Instantiable](Instantiable.md).[getInstance](Instantiable.md#getinstance) + +#### Defined in + +[src/Instantiable.abstract.ts:86](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L86) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/NeverminedNodeError.md b/docs/api-reference/classes/NeverminedNodeError.md new file mode 100644 index 000000000..f5244ce5c --- /dev/null +++ b/docs/api-reference/classes/NeverminedNodeError.md @@ -0,0 +1,165 @@ +[@nevermined-io/sdk](../code-reference.md) / NeverminedNodeError + +# Class: NeverminedNodeError + +## Hierarchy + +- `Error` + + ↳ **`NeverminedNodeError`** + +## Table of contents + +### Constructors + +- [constructor](NeverminedNodeError.md#constructor) + +### Properties + +- [message](NeverminedNodeError.md#message) +- [name](NeverminedNodeError.md#name) +- [stack](NeverminedNodeError.md#stack) +- [prepareStackTrace](NeverminedNodeError.md#preparestacktrace) +- [stackTraceLimit](NeverminedNodeError.md#stacktracelimit) + +### Methods + +- [captureStackTrace](NeverminedNodeError.md#capturestacktrace) + +## Constructors + +### constructor + +• **new NeverminedNodeError**(`message`) + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `message` | `string` | + +#### Overrides + +Error.constructor + +#### Defined in + +[src/errors/NeverminedNodeError.ts:2](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/errors/NeverminedNodeError.ts#L2) + +## Properties + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1068 + +--- + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1067 + +--- + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1069 + +--- + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +Optional override for formatting stack traces + +##### Parameters + +| Name | Type | +| :------------ | :----------- | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:11 + +--- + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:13 + +## Methods + +### captureStackTrace + +▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :---------------- | :--------- | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:4 diff --git a/docs/api-reference/classes/NeverminedOptions.md b/docs/api-reference/classes/NeverminedOptions.md new file mode 100644 index 000000000..bc837a27e --- /dev/null +++ b/docs/api-reference/classes/NeverminedOptions.md @@ -0,0 +1,250 @@ +[@nevermined-io/sdk](../code-reference.md) / NeverminedOptions + +# Class: NeverminedOptions + +## Table of contents + +### Constructors + +- [constructor](NeverminedOptions.md#constructor) + +### Properties + +- [aaveConfig](NeverminedOptions.md#aaveconfig) +- [accounts](NeverminedOptions.md#accounts) +- [artifactsFolder](NeverminedOptions.md#artifactsfolder) +- [circuitsFolder](NeverminedOptions.md#circuitsfolder) +- [gasMultiplier](NeverminedOptions.md#gasmultiplier) +- [gasStationUri](NeverminedOptions.md#gasstationuri) +- [graphHttpUri](NeverminedOptions.md#graphhttpuri) +- [ipfsGateway](NeverminedOptions.md#ipfsgateway) +- [ipfsProjectId](NeverminedOptions.md#ipfsprojectid) +- [ipfsProjectSecret](NeverminedOptions.md#ipfsprojectsecret) +- [marketplaceAuthToken](NeverminedOptions.md#marketplaceauthtoken) +- [marketplaceUri](NeverminedOptions.md#marketplaceuri) +- [neverminedNodeAddress](NeverminedOptions.md#neverminednodeaddress) +- [neverminedNodeUri](NeverminedOptions.md#neverminednodeuri) +- [verbose](NeverminedOptions.md#verbose) +- [web3Provider](NeverminedOptions.md#web3provider) +- [web3ProviderUri](NeverminedOptions.md#web3provideruri) + +## Constructors + +### constructor + +• **new NeverminedOptions**() + +## Properties + +### aaveConfig + +• `Optional` **aaveConfig**: [`AaveConfig`](../interfaces/AaveConfig.md) + +#### Defined in + +[src/models/NeverminedOptions.ts:58](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/NeverminedOptions.ts#L58) + +--- + +### accounts + +• `Optional` **accounts**: `Signer`[] + +#### Defined in + +[src/models/NeverminedOptions.ts:69](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/NeverminedOptions.ts#L69) + +--- + +### artifactsFolder + +• `Optional` **artifactsFolder**: `string` + +The folder where the nevermined contract artifacts are located. + +#### Defined in + +[src/models/NeverminedOptions.ts:63](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/NeverminedOptions.ts#L63) + +--- + +### circuitsFolder + +• `Optional` **circuitsFolder**: `string` + +The folder where the nevermined contract circuits are located. + +#### Defined in + +[src/models/NeverminedOptions.ts:67](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/NeverminedOptions.ts#L67) + +--- + +### gasMultiplier + +• `Optional` **gasMultiplier**: `number` + +Gas multiplier for the fees. +Can be used to speed up the transactions. + +#### Defined in + +[src/models/NeverminedOptions.ts:51](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/NeverminedOptions.ts#L51) + +--- + +### gasStationUri + +• `Optional` **gasStationUri**: `string` + +Use a gas station to calculate transaction fees + +#### Defined in + +[src/models/NeverminedOptions.ts:85](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/NeverminedOptions.ts#L85) + +--- + +### graphHttpUri + +• `Optional` **graphHttpUri**: `string` + +Enpoint for the graph-node http query + +#### Defined in + +[src/models/NeverminedOptions.ts:56](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/NeverminedOptions.ts#L56) + +--- + +### ipfsGateway + +• `Optional` **ipfsGateway**: `string` = `'https://ipfs.io'` + +IPFS variables enable the resolution of DDOs (via `assets.resolve`) from CID urls +INFO: For performance purposes, it is recommended to setup a IPFS Infura endpoint to accelerate +the asset resolution requests. + +#### Defined in + +[src/models/NeverminedOptions.ts:76](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/NeverminedOptions.ts#L76) + +--- + +### ipfsProjectId + +• `Optional` **ipfsProjectId**: `string` + +#### Defined in + +[src/models/NeverminedOptions.ts:78](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/NeverminedOptions.ts#L78) + +--- + +### ipfsProjectSecret + +• `Optional` **ipfsProjectSecret**: `string` + +#### Defined in + +[src/models/NeverminedOptions.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/NeverminedOptions.ts#L80) + +--- + +### marketplaceAuthToken + +• `Optional` **marketplaceAuthToken**: `string` + +Marketplace auth token. + +#### Defined in + +[src/models/NeverminedOptions.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/NeverminedOptions.ts#L35) + +--- + +### marketplaceUri + +• **marketplaceUri**: `string` + +URL to the MarketPlace API use to record some Nevermined assets metadata. In a Nevermined network there could be +multiple Marketplace API instances. Each of them typically records the metadata of a specific domain/vertical deployed on a Nevermined network. + +**`See`** + +https://docs.nevermined.io/docs/architecture/marketplace-api/ + +#### Defined in + +[src/models/NeverminedOptions.ts:17](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/NeverminedOptions.ts#L17) + +--- + +### neverminedNodeAddress + +• `Optional` **neverminedNodeAddress**: `string` + +The public address of the Nevermined Node. + +**`See`** + +[neverminedNodeUri](NeverminedOptions.md#neverminednodeuri) + +#### Defined in + +[src/models/NeverminedOptions.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/NeverminedOptions.ts#L30) + +--- + +### neverminedNodeUri + +• **neverminedNodeUri**: `string` + +URL to an existing Nevermined Node. A Nevermined network can have multiple running Nodes. +Each of them facilitate the access control and the data and infrastructure interaction with web2 elements. + +**`See`** + +https://docs.nevermined.io/docs/architecture/node/ + +#### Defined in + +[src/models/NeverminedOptions.ts:24](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/NeverminedOptions.ts#L24) + +--- + +### verbose + +• `Optional` **verbose**: `boolean` \| [`LogLevel`](../enums/LogLevel.md) + +Log level. + +#### Defined in + +[src/models/NeverminedOptions.ts:45](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/NeverminedOptions.ts#L45) + +--- + +### web3Provider + +• `Optional` **web3Provider**: `any` + +Web3 Provider. + +#### Defined in + +[src/models/NeverminedOptions.ts:40](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/NeverminedOptions.ts#L40) + +--- + +### web3ProviderUri + +• `Optional` **web3ProviderUri**: `string` + +Ethereum Web3 Provider URL. This Url allows the SDK to connect to a blockchain. +This provider depends on the network where you want to connect (Ethereum Mainnet, Rinkeby, Polygon Matic, etc). +It's possible to use a public available provider or a private/paid one like Infura, Alchemy, etc. + +#### Defined in + +[src/models/NeverminedOptions.ts:11](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/NeverminedOptions.ts#L11) diff --git a/docs/api-reference/classes/Nft1155Contract.md b/docs/api-reference/classes/Nft1155Contract.md new file mode 100644 index 000000000..a15c8ff94 --- /dev/null +++ b/docs/api-reference/classes/Nft1155Contract.md @@ -0,0 +1,1026 @@ +[@nevermined-io/sdk](../code-reference.md) / Nft1155Contract + +# Class: Nft1155Contract + +NFTs contracts DTO allowing to manage Nevermined ERC-1155 NFTs + +## Hierarchy + +- [`NFTContractsBase`](NFTContractsBase.md) + + ↳ **`Nft1155Contract`** + +## Table of contents + +### Constructors + +- [constructor](Nft1155Contract.md#constructor) + +### Properties + +- [address](Nft1155Contract.md#address) +- [contract](Nft1155Contract.md#contract) +- [contractName](Nft1155Contract.md#contractname) +- [events](Nft1155Contract.md#events) +- [version](Nft1155Contract.md#version) + +### Accessors + +- [artifactsFolder](Nft1155Contract.md#artifactsfolder) +- [circuitsFolder](Nft1155Contract.md#circuitsfolder) +- [config](Nft1155Contract.md#config) +- [instanceConfig](Nft1155Contract.md#instanceconfig) +- [instantiableConfig](Nft1155Contract.md#instantiableconfig) +- [logger](Nft1155Contract.md#logger) +- [nevermined](Nft1155Contract.md#nevermined) +- [web3](Nft1155Contract.md#web3) + +### Methods + +- [\_createClone](Nft1155Contract.md#_createclone) +- [balance](Nft1155Contract.md#balance) +- [burn](Nft1155Contract.md#burn) +- [burnFromHolder](Nft1155Contract.md#burnfromholder) +- [call](Nft1155Contract.md#call) +- [createClone](Nft1155Contract.md#createclone) +- [getFromAddress](Nft1155Contract.md#getfromaddress) +- [getInputsOfMethod](Nft1155Contract.md#getinputsofmethod) +- [getMintedEntries](Nft1155Contract.md#getmintedentries) +- [getNFTAttributes](Nft1155Contract.md#getnftattributes) +- [getSignatureOfMethod](Nft1155Contract.md#getsignatureofmethod) +- [grantOperatorRole](Nft1155Contract.md#grantoperatorrole) +- [init](Nft1155Contract.md#init) +- [isApprovedForAll](Nft1155Contract.md#isapprovedforall) +- [isOperator](Nft1155Contract.md#isoperator) +- [mint](Nft1155Contract.md#mint) +- [owner](Nft1155Contract.md#owner) +- [revokeOperatorRole](Nft1155Contract.md#revokeoperatorrole) +- [send](Nft1155Contract.md#send) +- [sendFrom](Nft1155Contract.md#sendfrom) +- [setApprovalForAll](Nft1155Contract.md#setapprovalforall) +- [setInstanceConfig](Nft1155Contract.md#setinstanceconfig) +- [transferNft](Nft1155Contract.md#transfernft) +- [uri](Nft1155Contract.md#uri) +- [getInstance](Nft1155Contract.md#getinstance) +- [getInstanceUsingABI](Nft1155Contract.md#getinstanceusingabi) +- [setInstanceConfig](Nft1155Contract.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new Nft1155Contract**(`contractName`) + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Inherited from + +[NFTContractsBase](NFTContractsBase.md).[constructor](NFTContractsBase.md#constructor) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L34) + +## Properties + +### address + +• **address**: `string` + +#### Inherited from + +[NFTContractsBase](NFTContractsBase.md).[address](NFTContractsBase.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[NFTContractsBase](NFTContractsBase.md).[contract](NFTContractsBase.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[NFTContractsBase](NFTContractsBase.md).[contractName](NFTContractsBase.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[NFTContractsBase](NFTContractsBase.md).[events](NFTContractsBase.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[NFTContractsBase](NFTContractsBase.md).[version](NFTContractsBase.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +NFTContractsBase.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +NFTContractsBase.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +NFTContractsBase.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +NFTContractsBase.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +NFTContractsBase.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +NFTContractsBase.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +NFTContractsBase.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +NFTContractsBase.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### \_createClone + +▸ `Protected` **\_createClone**(`ercType`, `name`, `symbol`, `uri`, `cap`, `operators?`, `from?`, `txParams?`): `Promise`<`any`\> + +Creates a contract clone of an existing contract instance + +#### Parameters + +| Name | Type | Default value | Description | +| :---------- | :---------------------------------------------- | :------------ | :------------------------------------------------------ | +| `ercType` | `721` \| `1155` | `undefined` | - | +| `name` | `string` | `undefined` | NFT Contract name | +| `symbol` | `string` | `undefined` | NFT Contract symbol | +| `uri` | `string` | `undefined` | NFT Contract metadata uri | +| `cap` | `bigint` | `undefined` | NFT cap (just for ERC-721) | +| `operators` | `string`[] | `[]` | Array of account addresses to be added as NFT operators | +| `from?` | [`Account`](Account.md) | `undefined` | Sender account | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | - | + +#### Returns + +`Promise`<`any`\> + +Contract Receipt + +#### Inherited from + +[NFTContractsBase](NFTContractsBase.md).[\_createClone](NFTContractsBase.md#_createclone) + +#### Defined in + +[src/keeper/contracts/NFTContractsBase.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/NFTContractsBase.ts#L34) + +--- + +### balance + +▸ **balance**(`address`, `did`): `Promise`<`bigint`\> + +Get an address balance for a specific NFT with id `did` + +#### Parameters + +| Name | Type | Description | +| :-------- | :------- | :----------------------------------- | +| `address` | `string` | Account address to check the balance | +| `did` | `string` | The NFT id | + +#### Returns + +`Promise`<`bigint`\> + +#### Defined in + +[src/keeper/contracts/Nft1155Contract.ts:116](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Nft1155Contract.ts#L116) + +--- + +### burn + +▸ **burn**(`from`, `tokenId`, `amount`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +It burns some editions of a NFT (ERC-1155) + +#### Parameters + +| Name | Type | Description | +| :---------- | :---------------------------------------------- | :--------------------------------------- | +| `from` | `string` | Account address burning the NFT editions | +| `tokenId` | `string` | The NFT id to burn | +| `amount` | `bigint` | Number of editions to burn | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction additional parameters | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +Contract Receipt + +#### Defined in + +[src/keeper/contracts/Nft1155Contract.ts:171](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Nft1155Contract.ts#L171) + +--- + +### burnFromHolder + +▸ **burnFromHolder**(`holder`, `tokenId`, `amount`, `from`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +It burns some editions of a NFT (ERC-1155) + +#### Parameters + +| Name | Type | Description | +| :---------- | :---------------------------------------------- | :-------------------------------------------------------------------------- | +| `holder` | `string` | Address of the account holding the NFT editions that are going to be burned | +| `tokenId` | `string` | The NFT id to burn | +| `amount` | `bigint` | Number of editions to burn | +| `from` | `string` | Account address burning the NFT editions | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction additional parameters | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +Contract Receipt + +#### Defined in + +[src/keeper/contracts/Nft1155Contract.ts:185](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Nft1155Contract.ts#L185) + +--- + +### 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 + +[NFTContractsBase](NFTContractsBase.md).[call](NFTContractsBase.md#call) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### createClone + +▸ **createClone**(`name`, `symbol`, `uri`, `operators?`, `from?`, `txParams?`): `Promise`<`any`\> + +Creates a contract clone of an existing contract instance + +#### Parameters + +| Name | Type | Default value | Description | +| :---------- | :---------------------------------------------- | :------------ | :------------------------------------------------------ | +| `name` | `string` | `undefined` | NFT Contract name | +| `symbol` | `string` | `undefined` | NFT Contract symbol | +| `uri` | `string` | `undefined` | NFT Contract metadata uri | +| `operators` | `string`[] | `[]` | Array of account addresses to be added as NFT operators | +| `from?` | [`Account`](Account.md) | `undefined` | Sender account | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | - | + +#### Returns + +`Promise`<`any`\> + +Contract Receipt + +#### Defined in + +[src/keeper/contracts/Nft1155Contract.ts:69](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Nft1155Contract.ts#L69) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[NFTContractsBase](NFTContractsBase.md).[getFromAddress](NFTContractsBase.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[NFTContractsBase](NFTContractsBase.md).[getInputsOfMethod](NFTContractsBase.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getMintedEntries + +▸ **getMintedEntries**(`owner`, `did?`): `Promise`<[`MintedEntry`](../interfaces/MintedEntry.md)[]\> + +It gets all the `MintedEntries` events from the NFT Contract + +#### Parameters + +| Name | Type | Description | +| :------ | :------- | :---------------------- | +| `owner` | `string` | the user owning the NFT | +| `did?` | `string` | the tokenId of the NFT | + +#### Returns + +`Promise`<[`MintedEntry`](../interfaces/MintedEntry.md)[]\> + +An array of `MintedEntry` objects + +#### Inherited from + +[NFTContractsBase](NFTContractsBase.md).[getMintedEntries](NFTContractsBase.md#getmintedentries) + +#### Defined in + +[src/keeper/contracts/NFTContractsBase.ts:125](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/NFTContractsBase.ts#L125) + +--- + +### getNFTAttributes + +▸ **getNFTAttributes**(`did`): `Promise`<{ `mintCap`: `bigint` ; `nftInitialized`: `boolean` ; `nftSupply`: `bigint` ; `nftURI`: `string` }\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `did` | `string` | + +#### Returns + +`Promise`<{ `mintCap`: `bigint` ; `nftInitialized`: `boolean` ; `nftSupply`: `bigint` ; `nftURI`: `string` }\> + +#### Inherited from + +[NFTContractsBase](NFTContractsBase.md).[getNFTAttributes](NFTContractsBase.md#getnftattributes) + +#### Defined in + +[src/keeper/contracts/NFTContractsBase.ts:82](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/NFTContractsBase.ts#L82) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[NFTContractsBase](NFTContractsBase.md).[getSignatureOfMethod](NFTContractsBase.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### grantOperatorRole + +▸ **grantOperatorRole**(`operatorAddress`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +Add an address as operator in the NFT Contract + +#### Parameters + +| Name | Type | Description | +| :---------------- | :---------------------------------------------- | :----------------- | +| `operatorAddress` | `string` | New minter address | +| `from?` | [`Account`](Account.md) | Sender account | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +Contract Receipt + +#### Inherited from + +[NFTContractsBase](NFTContractsBase.md).[grantOperatorRole](NFTContractsBase.md#grantoperatorrole) + +#### Defined in + +[src/keeper/contracts/NFTContractsBase.ts:69](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/NFTContractsBase.ts#L69) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[NFTContractsBase](NFTContractsBase.md).[init](NFTContractsBase.md#init) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### isApprovedForAll + +▸ **isApprovedForAll**(`accountAddress`, `operatorAddress`): `Promise`<`unknown`\> + +Checks if the operator is approved for an account address + +#### Parameters + +| Name | Type | Description | +| :---------------- | :------- | :--------------- | +| `accountAddress` | `string` | Account address | +| `operatorAddress` | `string` | Operator address | + +#### Returns + +`Promise`<`unknown`\> + +Boolean + +#### Defined in + +[src/keeper/contracts/Nft1155Contract.ts:87](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Nft1155Contract.ts#L87) + +--- + +### isOperator + +▸ **isOperator**(`address`): `Promise`<`boolean`\> + +Checks if an account is an operator in the NFT contract + +#### Parameters + +| Name | Type | Description | +| :-------- | :------- | :----------------------------------------- | +| `address` | `string` | Account address to check if is an operator | + +#### Returns + +`Promise`<`boolean`\> + +true if is an operator + +#### Inherited from + +[NFTContractsBase](NFTContractsBase.md).[isOperator](NFTContractsBase.md#isoperator) + +#### Defined in + +[src/keeper/contracts/NFTContractsBase.ts:78](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/NFTContractsBase.ts#L78) + +--- + +### mint + +▸ **mint**(`to`, `did`, `amount`, `from`, `data?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +It mints some editions of a NFT (ERC-1155) + +#### Parameters + +| Name | Type | Description | +| :---------- | :---------------------------------------------- | :---------------------------------- | +| `to` | `string` | Account address of the NFT receiver | +| `did` | `string` | The NFT id to mint | +| `amount` | `bigint` | Number of editions to mint | +| `from` | `string` | Account address minting the NFT | +| `data?` | `string` | Data | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction additional parameters | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +Contract Receipt + +#### Defined in + +[src/keeper/contracts/Nft1155Contract.ts:151](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Nft1155Contract.ts#L151) + +--- + +### owner + +▸ **owner**(): `Promise`<`string`\> + +Gets the contract owner + +#### Returns + +`Promise`<`string`\> + +Address of the contract owner + +#### Inherited from + +[NFTContractsBase](NFTContractsBase.md).[owner](NFTContractsBase.md#owner) + +#### Defined in + +[src/keeper/contracts/NFTContractsBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/NFTContractsBase.ts#L19) + +--- + +### revokeOperatorRole + +▸ **revokeOperatorRole**(`operatorAddress`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +Revoke an address as operator in the NFT Contract + +#### Parameters + +| Name | Type | Description | +| :---------------- | :---------------------------------------------- | :----------------------- | +| `operatorAddress` | `string` | Minter address to revoke | +| `from?` | [`Account`](Account.md) | Sender account | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +Contract Receipt + +#### Inherited from + +[NFTContractsBase](NFTContractsBase.md).[revokeOperatorRole](NFTContractsBase.md#revokeoperatorrole) + +#### Defined in + +[src/keeper/contracts/NFTContractsBase.ts:115](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/NFTContractsBase.ts#L115) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[NFTContractsBase](NFTContractsBase.md).[send](NFTContractsBase.md#send) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[NFTContractsBase](NFTContractsBase.md).[sendFrom](NFTContractsBase.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### setApprovalForAll + +▸ **setApprovalForAll**(`operatorAddress`, `approved`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +Configure approval for a specific operator address + +#### Parameters + +| Name | Type | Description | +| :---------------- | :---------------------------------------------- | :-------------------------------- | +| `operatorAddress` | `string` | Operator address | +| `approved` | `boolean` | Is approved | +| `from?` | [`Account`](Account.md) | Sender account | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction additional parameters | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +Contract Receipt + +#### Defined in + +[src/keeper/contracts/Nft1155Contract.ts:100](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Nft1155Contract.ts#L100) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[NFTContractsBase](NFTContractsBase.md).[setInstanceConfig](NFTContractsBase.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### transferNft + +▸ **transferNft**(`did`, `to`, `amount`, `from`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +It transfers a NFT + +#### Parameters + +| Name | Type | Description | +| :---------- | :---------------------------------------------- | :----------------------------------------------- | +| `did` | `string` | The NFT id | +| `to` | `string` | Account address of the NFT receiver | +| `amount` | `bigint` | Number of editions to transfer. Typically just 1 | +| `from` | `string` | Account address transferring the NFT | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction additional parameters | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +Contract Receipt + +#### Defined in + +[src/keeper/contracts/Nft1155Contract.ts:130](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Nft1155Contract.ts#L130) + +--- + +### uri + +▸ **uri**(`did`): `Promise`<`string`\> + +It returns the NFT metadata uri + +#### Parameters + +| Name | Type | Description | +| :---- | :------- | :---------- | +| `did` | `string` | The NFT id | + +#### Returns + +`Promise`<`string`\> + +The NFT metadata url + +#### Defined in + +[src/keeper/contracts/Nft1155Contract.ts:201](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Nft1155Contract.ts#L201) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`, `address?`, `contractName?`, `artifactsFolder?`): `Promise`<[`Nft1155Contract`](Nft1155Contract.md)\> + +#### Parameters + +| Name | Type | Default value | +| :---------------- | :---------------------------------------------------------- | :----------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `address?` | `string` | `undefined` | +| `contractName` | `string` | `'NFT1155Upgradeable'` | +| `artifactsFolder` | `string` | `config.artifactsFolder` | + +#### Returns + +`Promise`<[`Nft1155Contract`](Nft1155Contract.md)\> + +#### Overrides + +[NFTContractsBase](NFTContractsBase.md).[getInstance](NFTContractsBase.md#getinstance) + +#### Defined in + +[src/keeper/contracts/Nft1155Contract.ts:14](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Nft1155Contract.ts#L14) + +--- + +### getInstanceUsingABI + +▸ `Static` **getInstanceUsingABI**(`config`, `address`, `solidityABI`): `Promise`<[`Nft1155Contract`](Nft1155Contract.md)\> + +#### Parameters + +| Name | Type | +| :------------ | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | +| `address` | `string` | +| `solidityABI` | `any` | + +#### Returns + +`Promise`<[`Nft1155Contract`](Nft1155Contract.md)\> + +#### Defined in + +[src/keeper/contracts/Nft1155Contract.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Nft1155Contract.ts#L39) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[NFTContractsBase](NFTContractsBase.md).[setInstanceConfig](NFTContractsBase.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/Nft721.md b/docs/api-reference/classes/Nft721.md deleted file mode 100644 index 6694b3bc5..000000000 --- a/docs/api-reference/classes/Nft721.md +++ /dev/null @@ -1,542 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / Nft721 - -# Class: Nft721 - -## Hierarchy - -- `Instantiable` - - ↳ **`Nft721`** - -## Table of contents - -### Constructors - -- [constructor](Nft721.md#constructor) - -### Properties - -- [contract](Nft721.md#contract) - -### Accessors - -- [address](Nft721.md#address) -- [artifactsFolder](Nft721.md#artifactsfolder) -- [config](Nft721.md#config) -- [instanceConfig](Nft721.md#instanceconfig) -- [instantiableConfig](Nft721.md#instantiableconfig) -- [logger](Nft721.md#logger) -- [nevermined](Nft721.md#nevermined) -- [web3](Nft721.md#web3) - -### Methods - -- [addresses](Nft721.md#addresses) -- [balanceOf](Nft721.md#balanceof) -- [checkExists](Nft721.md#checkexists) -- [findSigner](Nft721.md#findsigner) -- [isApprovedForAll](Nft721.md#isapprovedforall) -- [mint](Nft721.md#mint) -- [mintWithURL](Nft721.md#mintwithurl) -- [ownerOf](Nft721.md#ownerof) -- [setApprovalForAll](Nft721.md#setapprovalforall) -- [setInstanceConfig](Nft721.md#setinstanceconfig) -- [addressesStatic](Nft721.md#addressesstatic) -- [findSignerStatic](Nft721.md#findsignerstatic) -- [getInstance](Nft721.md#getinstance) -- [setInstanceConfig](Nft721.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new Nft721**() - -#### Inherited from - -Instantiable.constructor - -## Properties - -### contract - -• **contract**: `default` - -#### Defined in - -[src/nevermined/Nft721.ts:7](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nft721.ts#L7) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Defined in - -[src/nevermined/Nft721.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nft721.ts#L69) - ---- - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -Instantiable.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - ---- - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -Instantiable.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - ---- - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -Instantiable.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - ---- - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -Instantiable.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - ---- - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -Instantiable.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - ---- - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -Instantiable.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - ---- - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -Instantiable.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -Instantiable.addresses - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - ---- - -### balanceOf - -▸ **balanceOf**(`owner`): `Promise`<`default`\> - -#### Parameters - -| Name | Type | -| :------ | :---------------------- | -| `owner` | [`Account`](Account.md) | - -#### Returns - -`Promise`<`default`\> - -#### Defined in - -[src/nevermined/Nft721.ts:61](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nft721.ts#L61) - ---- - -### 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](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - ---- - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -Instantiable.findSigner - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - ---- - -### isApprovedForAll - -▸ **isApprovedForAll**(`accountAddress`, `operatorAddress`): `Promise`<`unknown`\> - -#### Parameters - -| Name | Type | -| :---------------- | :------- | -| `accountAddress` | `string` | -| `operatorAddress` | `string` | - -#### Returns - -`Promise`<`unknown`\> - -#### Defined in - -[src/nevermined/Nft721.ts:57](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nft721.ts#L57) - ---- - -### mint - -▸ **mint**(`did`, `publisher`, `txParams?`): `Promise`<`ContractReceipt`\> - -Mint NFTs associated with an asset. - -This function can be called multiple times as long as the minting does not exceed the maximum cap set during creation. - -#### Parameters - -| Name | Type | Description | -| :---------- | :---------------------- | :--------------------------------------------- | -| `did` | `string` | The Decentralized Identifier of the NFT asset. | -| `publisher` | [`Account`](Account.md) | The account of the publisher of the NFT. | -| `txParams?` | `TxParameters` | - | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Defined in - -[src/nevermined/Nft721.ts:29](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nft721.ts#L29) - ---- - -### mintWithURL - -▸ **mintWithURL**(`to`, `did`, `url`, `from?`, `txParams?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :---------- | :---------------------- | -| `to` | `string` | -| `did` | `string` | -| `url` | `string` | -| `from?` | [`Account`](Account.md) | -| `txParams?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Defined in - -[src/nevermined/Nft721.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nft721.ts#L33) - ---- - -### ownerOf - -▸ **ownerOf**(`did`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :---- | :------- | -| `did` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[src/nevermined/Nft721.ts:65](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nft721.ts#L65) - ---- - -### setApprovalForAll - -▸ **setApprovalForAll**(`target`, `state`, `publisher`, `txParams?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :---------- | :---------------------- | -| `target` | `string` | -| `state` | `boolean` | -| `publisher` | [`Account`](Account.md) | -| `txParams?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Defined in - -[src/nevermined/Nft721.ts:43](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nft721.ts#L43) - ---- - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -Instantiable.setInstanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - ---- - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -Instantiable.addressesStatic - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - ---- - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -Instantiable.findSignerStatic - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - ---- - -### getInstance - -▸ `Static` **getInstance**(`config`, `address`): `Promise`<[`Nft721`](Nft721.md)\> - -#### Parameters - -| Name | Type | -| :-------- | :------------------- | -| `config` | `InstantiableConfig` | -| `address` | `string` | - -#### Returns - -`Promise`<[`Nft721`](Nft721.md)\> - -#### Overrides - -Instantiable.getInstance - -#### Defined in - -[src/nevermined/Nft721.ts:9](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nft721.ts#L9) - ---- - -### 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 - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/api-reference/classes/Nft721Contract.md b/docs/api-reference/classes/Nft721Contract.md new file mode 100644 index 000000000..30d370a38 --- /dev/null +++ b/docs/api-reference/classes/Nft721Contract.md @@ -0,0 +1,990 @@ +[@nevermined-io/sdk](../code-reference.md) / Nft721Contract + +# Class: Nft721Contract + +## Hierarchy + +- [`NFTContractsBase`](NFTContractsBase.md) + + ↳ **`Nft721Contract`** + +## Table of contents + +### Constructors + +- [constructor](Nft721Contract.md#constructor) + +### Properties + +- [address](Nft721Contract.md#address) +- [contract](Nft721Contract.md#contract) +- [contractName](Nft721Contract.md#contractname) +- [events](Nft721Contract.md#events) +- [version](Nft721Contract.md#version) + +### Accessors + +- [artifactsFolder](Nft721Contract.md#artifactsfolder) +- [circuitsFolder](Nft721Contract.md#circuitsfolder) +- [config](Nft721Contract.md#config) +- [instanceConfig](Nft721Contract.md#instanceconfig) +- [instantiableConfig](Nft721Contract.md#instantiableconfig) +- [logger](Nft721Contract.md#logger) +- [nevermined](Nft721Contract.md#nevermined) +- [web3](Nft721Contract.md#web3) + +### Methods + +- [\_createClone](Nft721Contract.md#_createclone) +- [balanceOf](Nft721Contract.md#balanceof) +- [burn](Nft721Contract.md#burn) +- [call](Nft721Contract.md#call) +- [createClone](Nft721Contract.md#createclone) +- [getFromAddress](Nft721Contract.md#getfromaddress) +- [getInputsOfMethod](Nft721Contract.md#getinputsofmethod) +- [getMintedEntries](Nft721Contract.md#getmintedentries) +- [getNFTAttributes](Nft721Contract.md#getnftattributes) +- [getSignatureOfMethod](Nft721Contract.md#getsignatureofmethod) +- [grantOperatorRole](Nft721Contract.md#grantoperatorrole) +- [init](Nft721Contract.md#init) +- [isApprovedForAll](Nft721Contract.md#isapprovedforall) +- [isOperator](Nft721Contract.md#isoperator) +- [mint](Nft721Contract.md#mint) +- [mintWithURL](Nft721Contract.md#mintwithurl) +- [owner](Nft721Contract.md#owner) +- [ownerOf](Nft721Contract.md#ownerof) +- [revokeOperatorRole](Nft721Contract.md#revokeoperatorrole) +- [send](Nft721Contract.md#send) +- [sendFrom](Nft721Contract.md#sendfrom) +- [setApprovalForAll](Nft721Contract.md#setapprovalforall) +- [setInstanceConfig](Nft721Contract.md#setinstanceconfig) +- [tokenURI](Nft721Contract.md#tokenuri) +- [getInstance](Nft721Contract.md#getinstance) +- [getInstanceUsingABI](Nft721Contract.md#getinstanceusingabi) +- [setInstanceConfig](Nft721Contract.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new Nft721Contract**(`contractName`) + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Inherited from + +[NFTContractsBase](NFTContractsBase.md).[constructor](NFTContractsBase.md#constructor) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L34) + +## Properties + +### address + +• **address**: `string` + +#### Inherited from + +[NFTContractsBase](NFTContractsBase.md).[address](NFTContractsBase.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[NFTContractsBase](NFTContractsBase.md).[contract](NFTContractsBase.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[NFTContractsBase](NFTContractsBase.md).[contractName](NFTContractsBase.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[NFTContractsBase](NFTContractsBase.md).[events](NFTContractsBase.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[NFTContractsBase](NFTContractsBase.md).[version](NFTContractsBase.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +NFTContractsBase.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +NFTContractsBase.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +NFTContractsBase.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +NFTContractsBase.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +NFTContractsBase.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +NFTContractsBase.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +NFTContractsBase.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +NFTContractsBase.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### \_createClone + +▸ `Protected` **\_createClone**(`ercType`, `name`, `symbol`, `uri`, `cap`, `operators?`, `from?`, `txParams?`): `Promise`<`any`\> + +Creates a contract clone of an existing contract instance + +#### Parameters + +| Name | Type | Default value | Description | +| :---------- | :---------------------------------------------- | :------------ | :------------------------------------------------------ | +| `ercType` | `721` \| `1155` | `undefined` | - | +| `name` | `string` | `undefined` | NFT Contract name | +| `symbol` | `string` | `undefined` | NFT Contract symbol | +| `uri` | `string` | `undefined` | NFT Contract metadata uri | +| `cap` | `bigint` | `undefined` | NFT cap (just for ERC-721) | +| `operators` | `string`[] | `[]` | Array of account addresses to be added as NFT operators | +| `from?` | [`Account`](Account.md) | `undefined` | Sender account | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | - | + +#### Returns + +`Promise`<`any`\> + +Contract Receipt + +#### Inherited from + +[NFTContractsBase](NFTContractsBase.md).[\_createClone](NFTContractsBase.md#_createclone) + +#### Defined in + +[src/keeper/contracts/NFTContractsBase.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/NFTContractsBase.ts#L34) + +--- + +### balanceOf + +▸ **balanceOf**(`owner`): `Promise`<`bigint`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `owner` | `string` | + +#### Returns + +`Promise`<`bigint`\> + +#### Defined in + +[src/keeper/contracts/Nft721Contract.ts:117](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Nft721Contract.ts#L117) + +--- + +### burn + +▸ **burn**(`tokenId`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +It burns some editions of a NFT (ERC-721) + +#### Parameters + +| Name | Type | Description | +| :---------- | :---------------------------------------------- | :-------------------------------- | +| `tokenId` | `string` | The NFT id to burn | +| `from?` | [`Account`](Account.md) | The account burning the NFT | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction additional parameters | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +Contract Receipt + +#### Defined in + +[src/keeper/contracts/Nft721Contract.ts:100](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Nft721Contract.ts#L100) + +--- + +### 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 + +[NFTContractsBase](NFTContractsBase.md).[call](NFTContractsBase.md#call) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### createClone + +▸ **createClone**(`name`, `symbol`, `uri`, `cap`, `operators?`, `from?`, `txParams?`): `Promise`<`any`\> + +Creates a contract clone of an existing contract instance + +#### Parameters + +| Name | Type | Default value | Description | +| :---------- | :---------------------------------------------- | :------------ | :------------------------------------------------------ | +| `name` | `string` | `undefined` | NFT Contract name | +| `symbol` | `string` | `undefined` | NFT Contract symbol | +| `uri` | `string` | `undefined` | NFT Contract metadata uri | +| `cap` | `bigint` | `undefined` | NFT cap | +| `operators` | `string`[] | `[]` | Array of account addresses to be added as NFT operators | +| `from?` | [`Account`](Account.md) | `undefined` | Sender account | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | - | + +#### Returns + +`Promise`<`any`\> + +Contract Receipt + +#### Defined in + +[src/keeper/contracts/Nft721Contract.ts:66](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Nft721Contract.ts#L66) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[NFTContractsBase](NFTContractsBase.md).[getFromAddress](NFTContractsBase.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[NFTContractsBase](NFTContractsBase.md).[getInputsOfMethod](NFTContractsBase.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getMintedEntries + +▸ **getMintedEntries**(`owner`, `did?`): `Promise`<[`MintedEntry`](../interfaces/MintedEntry.md)[]\> + +It gets all the `MintedEntries` events from the NFT Contract + +#### Parameters + +| Name | Type | Description | +| :------ | :------- | :---------------------- | +| `owner` | `string` | the user owning the NFT | +| `did?` | `string` | the tokenId of the NFT | + +#### Returns + +`Promise`<[`MintedEntry`](../interfaces/MintedEntry.md)[]\> + +An array of `MintedEntry` objects + +#### Inherited from + +[NFTContractsBase](NFTContractsBase.md).[getMintedEntries](NFTContractsBase.md#getmintedentries) + +#### Defined in + +[src/keeper/contracts/NFTContractsBase.ts:125](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/NFTContractsBase.ts#L125) + +--- + +### getNFTAttributes + +▸ **getNFTAttributes**(`did`): `Promise`<{ `mintCap`: `bigint` ; `nftInitialized`: `boolean` ; `nftSupply`: `bigint` ; `nftURI`: `string` }\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `did` | `string` | + +#### Returns + +`Promise`<{ `mintCap`: `bigint` ; `nftInitialized`: `boolean` ; `nftSupply`: `bigint` ; `nftURI`: `string` }\> + +#### Inherited from + +[NFTContractsBase](NFTContractsBase.md).[getNFTAttributes](NFTContractsBase.md#getnftattributes) + +#### Defined in + +[src/keeper/contracts/NFTContractsBase.ts:82](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/NFTContractsBase.ts#L82) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[NFTContractsBase](NFTContractsBase.md).[getSignatureOfMethod](NFTContractsBase.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### grantOperatorRole + +▸ **grantOperatorRole**(`operatorAddress`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +Add an address as operator in the NFT Contract + +#### Parameters + +| Name | Type | Description | +| :---------------- | :---------------------------------------------- | :----------------- | +| `operatorAddress` | `string` | New minter address | +| `from?` | [`Account`](Account.md) | Sender account | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +Contract Receipt + +#### Inherited from + +[NFTContractsBase](NFTContractsBase.md).[grantOperatorRole](NFTContractsBase.md#grantoperatorrole) + +#### Defined in + +[src/keeper/contracts/NFTContractsBase.ts:69](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/NFTContractsBase.ts#L69) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[NFTContractsBase](NFTContractsBase.md).[init](NFTContractsBase.md#init) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### isApprovedForAll + +▸ **isApprovedForAll**(`accountAddress`, `operatorAddress`): `Promise`<`unknown`\> + +#### Parameters + +| Name | Type | +| :---------------- | :------- | +| `accountAddress` | `string` | +| `operatorAddress` | `string` | + +#### Returns + +`Promise`<`unknown`\> + +#### Defined in + +[src/keeper/contracts/Nft721Contract.ts:113](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Nft721Contract.ts#L113) + +--- + +### isOperator + +▸ **isOperator**(`address`): `Promise`<`boolean`\> + +Checks if an account is an operator in the NFT contract + +#### Parameters + +| Name | Type | Description | +| :-------- | :------- | :----------------------------------------- | +| `address` | `string` | Account address to check if is an operator | + +#### Returns + +`Promise`<`boolean`\> + +true if is an operator + +#### Inherited from + +[NFTContractsBase](NFTContractsBase.md).[isOperator](NFTContractsBase.md#isoperator) + +#### Defined in + +[src/keeper/contracts/NFTContractsBase.ts:78](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/NFTContractsBase.ts#L78) + +--- + +### mint + +▸ **mint**(`did`, `from`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :---------- | :---------------------------------------------- | +| `did` | `string` | +| `from` | `string` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Defined in + +[src/keeper/contracts/Nft721Contract.ts:78](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Nft721Contract.ts#L78) + +--- + +### mintWithURL + +▸ **mintWithURL**(`to`, `did`, `url`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :---------- | :---------------------------------------------- | +| `to` | `string` | +| `did` | `string` | +| `url` | `string` | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Defined in + +[src/keeper/contracts/Nft721Contract.ts:82](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Nft721Contract.ts#L82) + +--- + +### owner + +▸ **owner**(): `Promise`<`string`\> + +Gets the contract owner + +#### Returns + +`Promise`<`string`\> + +Address of the contract owner + +#### Inherited from + +[NFTContractsBase](NFTContractsBase.md).[owner](NFTContractsBase.md#owner) + +#### Defined in + +[src/keeper/contracts/NFTContractsBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/NFTContractsBase.ts#L19) + +--- + +### ownerOf + +▸ **ownerOf**(`did`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `did` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/keeper/contracts/Nft721Contract.ts:121](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Nft721Contract.ts#L121) + +--- + +### revokeOperatorRole + +▸ **revokeOperatorRole**(`operatorAddress`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +Revoke an address as operator in the NFT Contract + +#### Parameters + +| Name | Type | Description | +| :---------------- | :---------------------------------------------- | :----------------------- | +| `operatorAddress` | `string` | Minter address to revoke | +| `from?` | [`Account`](Account.md) | Sender account | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +Contract Receipt + +#### Inherited from + +[NFTContractsBase](NFTContractsBase.md).[revokeOperatorRole](NFTContractsBase.md#revokeoperatorrole) + +#### Defined in + +[src/keeper/contracts/NFTContractsBase.ts:115](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/NFTContractsBase.ts#L115) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[NFTContractsBase](NFTContractsBase.md).[send](NFTContractsBase.md#send) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[NFTContractsBase](NFTContractsBase.md).[sendFrom](NFTContractsBase.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### setApprovalForAll + +▸ **setApprovalForAll**(`target`, `state`, `from`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :---------- | :---------------------------------------------- | +| `target` | `string` | +| `state` | `boolean` | +| `from` | `string` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Defined in + +[src/keeper/contracts/Nft721Contract.ts:104](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Nft721Contract.ts#L104) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[NFTContractsBase](NFTContractsBase.md).[setInstanceConfig](NFTContractsBase.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### tokenURI + +▸ **tokenURI**(`did`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `did` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/keeper/contracts/Nft721Contract.ts:125](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Nft721Contract.ts#L125) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`, `address`, `contractName?`, `artifactsFolder?`): `Promise`<[`Nft721Contract`](Nft721Contract.md)\> + +#### Parameters + +| Name | Type | Default value | +| :---------------- | :---------------------------------------------------------- | :----------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `address` | `string` | `undefined` | +| `contractName` | `string` | `'NFT721Upgradeable'` | +| `artifactsFolder` | `string` | `config.artifactsFolder` | + +#### Returns + +`Promise`<[`Nft721Contract`](Nft721Contract.md)\> + +#### Overrides + +[NFTContractsBase](NFTContractsBase.md).[getInstance](NFTContractsBase.md#getinstance) + +#### Defined in + +[src/keeper/contracts/Nft721Contract.ts:11](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Nft721Contract.ts#L11) + +--- + +### getInstanceUsingABI + +▸ `Static` **getInstanceUsingABI**(`config`, `address`, `solidityABI`): `Promise`<[`Nft721Contract`](Nft721Contract.md)\> + +#### Parameters + +| Name | Type | +| :------------ | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | +| `address` | `string` | +| `solidityABI` | `any` | + +#### Returns + +`Promise`<[`Nft721Contract`](Nft721Contract.md)\> + +#### Defined in + +[src/keeper/contracts/Nft721Contract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Nft721Contract.ts#L35) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[NFTContractsBase](NFTContractsBase.md).[setInstanceConfig](NFTContractsBase.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/Nfts.md b/docs/api-reference/classes/Nfts.md deleted file mode 100644 index 3b7b00a53..000000000 --- a/docs/api-reference/classes/Nfts.md +++ /dev/null @@ -1,1219 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / Nfts - -# Class: Nfts - -Nevermined Nft module - -## Hierarchy - -- `Instantiable` - - ↳ **`Nfts`** - -## Table of contents - -### Constructors - -- [constructor](Nfts.md#constructor) - -### Accessors - -- [artifactsFolder](Nfts.md#artifactsfolder) -- [config](Nfts.md#config) -- [instanceConfig](Nfts.md#instanceconfig) -- [instantiableConfig](Nfts.md#instantiableconfig) -- [logger](Nfts.md#logger) -- [nevermined](Nfts.md#nevermined) -- [web3](Nfts.md#web3) - -### Methods - -- [access](Nfts.md#access) -- [addresses](Nfts.md#addresses) -- [balance](Nfts.md#balance) -- [burn](Nfts.md#burn) -- [buySecondaryMarketNft](Nfts.md#buysecondarymarketnft) -- [checkExists](Nfts.md#checkexists) -- [create](Nfts.md#create) -- [create721](Nfts.md#create721) -- [createWithRoyalties](Nfts.md#createwithroyalties) -- [details](Nfts.md#details) -- [downloadFiles](Nfts.md#downloadfiles) -- [findSigner](Nfts.md#findsigner) -- [getNftContractAddress](Nfts.md#getnftcontractaddress) -- [listOnSecondaryMarkets](Nfts.md#listonsecondarymarkets) -- [mint](Nfts.md#mint) -- [order](Nfts.md#order) -- [order721](Nfts.md#order721) -- [ownerOf](Nfts.md#ownerof) -- [release721Rewards](Nfts.md#release721rewards) -- [releaseRewards](Nfts.md#releaserewards) -- [releaseSecondaryMarketRewards](Nfts.md#releasesecondarymarketrewards) -- [setApprovalForAll](Nfts.md#setapprovalforall) -- [setInstanceConfig](Nfts.md#setinstanceconfig) -- [transfer](Nfts.md#transfer) -- [transfer721](Nfts.md#transfer721) -- [transferForDelegate](Nfts.md#transferfordelegate) -- [addressesStatic](Nfts.md#addressesstatic) -- [findSignerStatic](Nfts.md#findsignerstatic) -- [getInstance](Nfts.md#getinstance) -- [setInstanceConfig](Nfts.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new Nfts**() - -#### Inherited from - -Instantiable.constructor - -## Accessors - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -Instantiable.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - ---- - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -Instantiable.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - ---- - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -Instantiable.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - ---- - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -Instantiable.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - ---- - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -Instantiable.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - ---- - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -Instantiable.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - ---- - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -Instantiable.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### access - -▸ **access**(`did`, `consumer`, `destination?`, `index?`, `agreementId?`): `Promise`<`boolean`\> - -Access the files associated with an NFT. - -**`Remarks`** - -This function will call the gateway that will check if all the access conditions where fulfilled -before providing the files. - -**`Example`** - -```ts -// TODO -``` - -#### Parameters - -| Name | Type | Default value | Description | -| :------------- | :---------------------- | :------------ | :--------------------------------------------- | -| `did` | `string` | `undefined` | The Decentralized Identifier of the NFT asset. | -| `consumer` | [`Account`](Account.md) | `undefined` | The NFT holder account. | -| `destination?` | `string` | `undefined` | The download destination for the files. | -| `index?` | `number` | `undefined` | - | -| `agreementId` | `string` | `'0x'` | - | - -#### Returns - -`Promise`<`boolean`\> - -true if the access was successful. - -#### Defined in - -[src/nevermined/Nfts.ts:618](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L618) - ---- - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -Instantiable.addresses - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - ---- - -### balance - -▸ **balance**(`did`, `account`): `Promise`<`default`\> - -Get the NFT balance for a particular did - -**`Example`** - -```ts -// TODO -``` - -#### Parameters - -| Name | Type | Description | -| :-------- | :---------------------- | :--------------------------------------------- | -| `did` | `string` | The Decentralized Identifier of the NFT asset. | -| `account` | [`Account`](Account.md) | The account to check the balance of. | - -#### Returns - -`Promise`<`default`\> - -The amount of NFTs owned by the account. - -#### Defined in - -[src/nevermined/Nfts.ts:645](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L645) - ---- - -### burn - -▸ **burn**(`did`, `nftAmount`, `publisher`, `params?`): `Promise`<`ContractReceipt`\> - -Burn NFTs associated with an asset. - -**`Remarks`** - -The publisher can only burn NFTs that it owns. NFTs that were already transferred cannot be burned by the publisher. - -**`Example`** - -```ts -// TODO -``` - -#### Parameters - -| Name | Type | Description | -| :---------- | :---------------------- | :--------------------------------------------- | -| `did` | `string` | The Decentralized Identifier of the NFT asset. | -| `nftAmount` | `default` | The amount of NFTs to burn. | -| `publisher` | [`Account`](Account.md) | The account of the publisher of the NFT. | -| `params?` | `TxParameters` | Optional transaction parameters. | - -#### Returns - -`Promise`<`ContractReceipt`\> - -The ethers.ContractReceipt - -#### Defined in - -[src/nevermined/Nfts.ts:256](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L256) - ---- - -### buySecondaryMarketNft - -▸ **buySecondaryMarketNft**(`consumer`, `nftAmount?`, `agreementIdSeed`, `params?`): `Promise`<`boolean`\> - -Buys a number of listed NFTs on secondary markets. - -**`Example`** - -```ts -// TODO -``` - -**`Throws`** - -NFTError -Thrown if there is an error buying the NFT. - -#### Parameters - -| Name | Type | Description | -| :---------------- | :---------------------- | :----------------------------------------- | -| `consumer` | [`Account`](Account.md) | The account of the buyer/consumer. | -| `nftAmount` | `default` | The number of assets to buy. 1 by default. | -| `agreementIdSeed` | `string` | - | -| `params?` | `TxParameters` | - | - -#### Returns - -`Promise`<`boolean`\> - -true if the buy was successful. - -#### Defined in - -[src/nevermined/Nfts.ts:934](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L934) - ---- - -### 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](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - ---- - -### create - -▸ **create**(`metadata`, `publisher`, `cap`, `royaltyAttributes`, `assetPrice`, `nftAmount?`, `erc20TokenAddress?`, `preMint?`, `nftMetadata?`, `appId?`, `txParams?`): [`SubscribablePromise`](utils.SubscribablePromise.md)<[`CreateProgressStep`](../enums/CreateProgressStep.md), [`DDO`](DDO.md)\> - -Create a new NFT Nevermined NFT. - -**`Example`** - -```ts -// TODO -``` - -#### Parameters - -| Name | Type | Description | -| :------------------- | :-------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------- | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | The metadata associated with the NFT. | -| `publisher` | [`Account`](Account.md) | The account of the creator od the NFT. | -| `cap` | `default` | The max number of nfts. | -| `royaltyAttributes` | `RoyaltyAttributes` | The royalties associated with the NFT. | -| `assetPrice` | `default` | The sales reward distribution. | -| `nftAmount` | `default` | The amount of NFTs that an address needs to hold in order to access the DID's protected assets. Leave it undefined and it will default to 1. | -| `erc20TokenAddress?` | `string` | The ERC-20 Token used to price the NFT. | -| `preMint?` | `boolean` | Set to true to mint _nftAmount_ during creation. | -| `nftMetadata?` | `string` | Url to the NFT metadata. | -| `appId?` | `string` | The id of the application creating the NFT. | -| `txParams?` | `TxParameters` | Optional transaction parameters | - -#### Returns - -[`SubscribablePromise`](utils.SubscribablePromise.md)<[`CreateProgressStep`](../enums/CreateProgressStep.md), [`DDO`](DDO.md)\> - -The newly registered [DDO](DDO.md). - -#### Defined in - -[src/nevermined/Nfts.ts:64](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L64) - ---- - -### create721 - -▸ **create721**(`metadata`, `publisher`, `assetPrice`, `nftTokenAddress`, `erc20TokenAddress?`, `royaltyAttributes?`, `nftMetadata?`, `nftTransfer?`, `duration?`, `appId?`, `txParams?`): [`SubscribablePromise`](utils.SubscribablePromise.md)<[`CreateProgressStep`](../enums/CreateProgressStep.md), [`DDO`](DDO.md)\> - -Create a new Nevermined NFT-721. - -**`Example`** - -```ts -// TODO -``` - -#### Parameters - -| Name | Type | Default value | Description | -| :------------------- | :-------------------------------------- | :------------ | :--------------------------------------- | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | The metadata associated with the NFT. | -| `publisher` | [`Account`](Account.md) | `undefined` | The account of the creator od the NFT. | -| `assetPrice` | `default` | `undefined` | The sales reward distribution. | -| `nftTokenAddress` | `string` | `undefined` | The address of the ERC-721 contract | -| `erc20TokenAddress?` | `string` | `undefined` | The ERC-20 Token used to price the NFT. | -| `royaltyAttributes?` | `RoyaltyAttributes` | `undefined` | The royalties associated with the NFT. | -| `nftMetadata?` | `string` | `undefined` | Url to the NFT metadata. | -| `nftTransfer` | `boolean` | `true` | TODO | -| `duration` | `number` | `0` | TODO | -| `appId?` | `string` | `undefined` | Id of the application creating this NFT. | -| `txParams?` | `TxParameters` | `undefined` | Optional transaction parameters | - -#### Returns - -[`SubscribablePromise`](utils.SubscribablePromise.md)<[`CreateProgressStep`](../enums/CreateProgressStep.md), [`DDO`](DDO.md)\> - -The newly registered [DDO](DDO.md). - -#### Defined in - -[src/nevermined/Nfts.ts:173](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L173) - ---- - -### createWithRoyalties - -▸ **createWithRoyalties**(`metadata`, `publisher`, `cap`, `royaltyAttributes`, `assetPrice`, `nftAmount?`, `erc20TokenAddress?`, `preMint?`, `nftMetadata?`, `nftType?`, `appId?`, `txParams?`): [`SubscribablePromise`](utils.SubscribablePromise.md)<[`CreateProgressStep`](../enums/CreateProgressStep.md), [`DDO`](DDO.md)\> - -Create a new Nevermined NFT with royalties. - -**`Example`** - -```ts -// TODO -``` - -#### Parameters - -| Name | Type | Default value | Description | -| :------------------- | :-------------------------------------- | :------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------- | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | The metadata associated with the NFT. | -| `publisher` | [`Account`](Account.md) | `undefined` | The account of the creator od the NFT. | -| `cap` | `default` | `undefined` | The max number of nfts. | -| `royaltyAttributes` | `RoyaltyAttributes` | `undefined` | The royalties associated with the NFT. | -| `assetPrice` | `default` | `undefined` | The sales reward distribution. | -| `nftAmount` | `default` | `undefined` | The amount of NFTs that an address needs to hold in order to access the DID's protected assets. Leave it undefined and it will default to 1. | -| `erc20TokenAddress?` | `string` | `undefined` | The ERC-20 Token used to price the NFT. | -| `preMint?` | `boolean` | `undefined` | Set to true to mint _nftAmount_ during creation. | -| `nftMetadata?` | `string` | `undefined` | Url to the NFT metadata. | -| `nftType` | `NeverminedNFTType` | `NeverminedNFT1155Type.nft1155` | - | -| `appId?` | `string` | `undefined` | The id of the application creating the NFT. | -| `txParams?` | `TxParameters` | `undefined` | Optional transaction parameters | - -#### Returns - -[`SubscribablePromise`](utils.SubscribablePromise.md)<[`CreateProgressStep`](../enums/CreateProgressStep.md), [`DDO`](DDO.md)\> - -The newly registered [DDO](DDO.md). - -#### Defined in - -[src/nevermined/Nfts.ts:119](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L119) - ---- - -### details - -▸ **details**(`did`): `Promise`<{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `number` ; `nftSupply`: `number` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: `RoyaltyKind` ; `url`: `any` }\> - -Get the details of an NFT - -**`Example`** - -```ts -// TODO -``` - -#### Parameters - -| Name | Type | Description | -| :---- | :------- | :--------------------------------------------- | -| `did` | `string` | The Decentralized Identifier of the NFT asset. | - -#### Returns - -`Promise`<{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `number` ; `nftSupply`: `number` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: `RoyaltyKind` ; `url`: `any` }\> - -The details of the NFT. - -#### Defined in - -[src/nevermined/Nfts.ts:693](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L693) - ---- - -### downloadFiles - -▸ `Private` **downloadFiles**(`agreementId`, `ddo`, `consumer`, `destination?`, `index?`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------------- | :---------------------- | -| `agreementId` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `consumer` | [`Account`](Account.md) | -| `destination?` | `string` | -| `index?` | `number` | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -[src/nevermined/Nfts.ts:752](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L752) - ---- - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -Instantiable.findSigner - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - ---- - -### getNftContractAddress - -▸ **getNftContractAddress**(`ddo`): `string` \| `number` \| `string`[] - -Get the NFT contract address associated with a Nevermined asset. - -**`Example`** - -```ts -// TODO -``` - -#### Parameters - -| Name | Type | Description | -| :---- | :-------------- | :-------------------- | -| `ddo` | [`DDO`](DDO.md) | The DDO of the asset. | - -#### Returns - -`string` \| `number` \| `string`[] - -The NFT contract address. - -#### Defined in - -[src/nevermined/Nfts.ts:739](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L739) - ---- - -### listOnSecondaryMarkets - -▸ **listOnSecondaryMarkets**(`ddo`, `assetPrice`, `nftAmount`, `provider`, `token`, `owner`): `Promise`<`string`\> - -After purchase re-list an NFT to enable secondary market sales. - -**`Example`** - -```ts -// TODO -``` - -**`Throws`** - -NFTError -Thrown if there is an error listing the NFT. - -#### Parameters - -| Name | Type | Description | -| :----------- | :-------------- | :----------------------------------------------------------- | -| `ddo` | [`DDO`](DDO.md) | The DDO of the asset. | -| `assetPrice` | `default` | The current setup of asset rewards. | -| `nftAmount` | `default` | The number of NFTs put up for secondary sale. | -| `provider` | `string` | The address that will be the provider of the secondary sale. | -| `token` | `default` | - | -| `owner` | `string` | The account of the current owner. | - -#### Returns - -`Promise`<`string`\> - -the agreementId of the secondary sale. - -#### Defined in - -[src/nevermined/Nfts.ts:859](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L859) - ---- - -### mint - -▸ **mint**(`did`, `nftAmount`, `publisher`, `params?`): `Promise`<`ContractReceipt`\> - -Mint NFTs associated with an asset. - -**`Remarks`** - -This function can be called multiple times as long as the minting does not exceed the maximum cap set during creation. - -**`Example`** - -```ts -// TODO -``` - -#### Parameters - -| Name | Type | Description | -| :---------- | :---------------------- | :--------------------------------------------- | -| `did` | `string` | The Decentralized Identifier of the NFT asset. | -| `nftAmount` | `default` | The amount of NFTs to mint. | -| `publisher` | [`Account`](Account.md) | The account of the publisher of the NFT. | -| `params?` | `TxParameters` | Optional transaction parameters. | - -#### Returns - -`Promise`<`ContractReceipt`\> - -The ethers.ContractReceipt - -#### Defined in - -[src/nevermined/Nfts.ts:224](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L224) - ---- - -### order - -▸ **order**(`did`, `nftAmount`, `consumer`, `txParams?`): [`SubscribablePromise`](utils.SubscribablePromise.md)<[`OrderProgressStep`](../enums/utils.OrderProgressStep.md), `string`\> - -Buy NFTs. - -**`Remarks`** - -This will lock the funds of the consumer in escrow pending the transfer of the NFTs -from the publisher. - -**`Example`** - -```ts -// TODO -``` - -#### Parameters - -| Name | Type | Description | -| :---------- | :---------------------- | :--------------------------------------------- | -| `did` | `string` | The Decentralized Identifier of the NFT asset. | -| `nftAmount` | `default` | The amount of NFTs to buy. | -| `consumer` | [`Account`](Account.md) | The account of the NFT buyer. | -| `txParams?` | `TxParameters` | Optional transaction parameters. | - -#### Returns - -[`SubscribablePromise`](utils.SubscribablePromise.md)<[`OrderProgressStep`](../enums/utils.OrderProgressStep.md), `string`\> - -The agreement ID. - -#### Defined in - -[src/nevermined/Nfts.ts:291](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L291) - ---- - -### order721 - -▸ **order721**(`did`, `consumer`, `txParams?`): [`SubscribablePromise`](utils.SubscribablePromise.md)<[`OrderProgressStep`](../enums/utils.OrderProgressStep.md), `string`\> - -Buy NFT-721. - -**`Remarks`** - -This will lock the funds of the consumer in escrow pending the transfer of the NFTs -from the publisher. - -**`Example`** - -```ts -// TODO -``` - -#### Parameters - -| Name | Type | Description | -| :---------- | :---------------------- | :--------------------------------------------- | -| `did` | `string` | The Decentralized Identifier of the NFT asset. | -| `consumer` | [`Account`](Account.md) | The account of the NFT buyer. | -| `txParams?` | `TxParameters` | Optional transaction parameters. | - -#### Returns - -[`SubscribablePromise`](utils.SubscribablePromise.md)<[`OrderProgressStep`](../enums/utils.OrderProgressStep.md), `string`\> - -The agreement ID. - -#### Defined in - -[src/nevermined/Nfts.ts:340](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L340) - ---- - -### ownerOf - -▸ **ownerOf**(`did`, `nftTokenAddress`, `agreementId?`): `Promise`<`string`\> - -Get the owner of the NFT - -**`Example`** - -```ts -// TODO -``` - -#### Parameters - -| Name | Type | Description | -| :---------------- | :------- | :--------------------------------------------- | -| `did` | `string` | The Decentralized identifier of the NFT asset. | -| `nftTokenAddress` | `string` | The address of the ERC-721 contract. | -| `agreementId?` | `string` | The NFT sales agreement id. | - -#### Returns - -`Promise`<`string`\> - -The address of the NFT owner. - -#### Defined in - -[src/nevermined/Nfts.ts:663](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L663) - ---- - -### release721Rewards - -▸ **release721Rewards**(`agreementId`, `did`, `publisher`, `txParams?`): `Promise`<`boolean`\> - -Release the funds from escrow. - -**`Remarks`** - -A publisher is able to release the funds put on escrow by the consumer after transferring the NFTs. - -**`Example`** - -```ts -// TODO -``` - -**`Throws`** - -NFTError -Thrown if there is an error releasing the rewards. - -#### Parameters - -| Name | Type | Description | -| :------------ | :---------------------- | :--------------------------------------------- | -| `agreementId` | `string` | The NFT sales agreement id. | -| `did` | `string` | The Decentralized identifier of the NFT asset. | -| `publisher` | [`Account`](Account.md) | The current owner of the NFTs. | -| `txParams?` | `TxParameters` | Optional transaction parameters. | - -#### Returns - -`Promise`<`boolean`\> - -true if the funds release was successful. - -#### Defined in - -[src/nevermined/Nfts.ts:574](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L574) - ---- - -### releaseRewards - -▸ **releaseRewards**(`agreementId`, `did`, `nftAmount`, `publisher`, `txParams?`): `Promise`<`boolean`\> - -Release the funds from escrow. - -**`Remarks`** - -A publisher is able to release the funds put on escrow by the consumer after transferring the NFTs. - -**`Example`** - -```ts -// TODO -``` - -**`Throws`** - -NFTError -Thrown if there is an error releasing the rewards - -#### Parameters - -| Name | Type | Description | -| :------------ | :---------------------- | :--------------------------------------------- | -| `agreementId` | `string` | The NFT sales agreement id. | -| `did` | `string` | The Decentralized identifier of the NFT asset. | -| `nftAmount` | `default` | The amount of NFTs to transfer. | -| `publisher` | [`Account`](Account.md) | The current owner of the NFTs. | -| `txParams?` | `TxParameters` | Optional transaction parameters. | - -#### Returns - -`Promise`<`boolean`\> - -true if the funds release was successful. - -#### Defined in - -[src/nevermined/Nfts.ts:526](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L526) - ---- - -### releaseSecondaryMarketRewards - -▸ **releaseSecondaryMarketRewards**(`owner`, `consumer`, `agreementIdSeed`, `params?`): `Promise`<`boolean`\> - -Used to release the secondary market NFT & the locked rewards. - -**`Example`** - -```ts -// TODO -``` - -**`Throws`** - -NFTError -Thrown if there is an error releasing the rewards. - -#### Parameters - -| Name | Type | Description | -| :---------------- | :---------------------- | :----------------- | -| `owner` | [`Account`](Account.md) | The owner account. | -| `consumer` | [`Account`](Account.md) | - | -| `agreementIdSeed` | `string` | - | -| `params?` | `TxParameters` | - | - -#### Returns - -`Promise`<`boolean`\> - -true if the transaction was successful. - -#### Defined in - -[src/nevermined/Nfts.ts:997](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L997) - ---- - -### setApprovalForAll - -▸ **setApprovalForAll**(`operatorAddress`, `approved`, `from`): `Promise`<`ContractReceipt`\> - -Enable or disable NFT transfer rights for an operator. - -**`See`** - -[transferForDelegate](Nfts.md#transferfordelegate) - -**`Example`** - -```ts -// TODO -``` - -#### Parameters - -| Name | Type | Description | -| :---------------- | :---------------------- | :------------------------------------------------------------------- | -| `operatorAddress` | `string` | The address that of the operator we want to give transfer rights to. | -| `approved` | `boolean` | Give or remove transfer rights from the operator. | -| `from` | [`Account`](Account.md) | The account that wants to give transfer rights to the operator. | - -#### Returns - -`Promise`<`ContractReceipt`\> - -The ethers.ContractReceipt - -#### Defined in - -[src/nevermined/Nfts.ts:822](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L822) - ---- - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -Instantiable.setInstanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - ---- - -### transfer - -▸ **transfer**(`agreementId`, `did`, `nftAmount`, `publisher`, `txParams?`): `Promise`<`boolean`\> - -Transfer NFTs to the consumer. - -**`Remarks`** - -A publisher/provider will check if the consumer put the funds in escrow and -execute the transfer in order to be able to release the rewards. - -**`Example`** - -```ts -// TODO -``` - -**`Throws`** - -NFTError -Thrown if there is an error transferring the NFT - -#### Parameters - -| Name | Type | Description | -| :------------ | :---------------------- | :--------------------------------------------- | -| `agreementId` | `string` | The NFT sales agreement id. | -| `did` | `string` | The Decentralized identifier of the NFT asset. | -| `nftAmount` | `default` | The number of NFTs to transfer. | -| `publisher` | [`Account`](Account.md) | The current owner of the NFTs. | -| `txParams?` | `TxParameters` | Optional transaction parameters. | - -#### Returns - -`Promise`<`boolean`\> - -true if the transfer was successful. - -#### Defined in - -[src/nevermined/Nfts.ts:394](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L394) - ---- - -### transfer721 - -▸ **transfer721**(`agreementId`, `did`, `publisher`, `txParams?`): `Promise`<`boolean`\> - -Transfer NFT-721 to the consumer. - -**`Remarks`** - -A publisher/provider will check if the consumer put the funds in escrow and -execute the transfer in order to be able to release the rewards. - -**`Example`** - -```ts -// TODO -``` - -**`Throws`** - -NFTError -Thrown if there is an error transferring the NFT - -#### Parameters - -| Name | Type | Description | -| :------------ | :---------------------- | :--------------------------------------------- | -| `agreementId` | `string` | The NFT sales agreement id. | -| `did` | `string` | The Decentralized identifier of the NFT asset. | -| `publisher` | [`Account`](Account.md) | The current owner of the NFTs. | -| `txParams?` | `TxParameters` | Optional transaction parameters. | - -#### Returns - -`Promise`<`boolean`\> - -true if the transfer was successful. - -#### Defined in - -[src/nevermined/Nfts.ts:481](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L481) - ---- - -### transferForDelegate - -▸ **transferForDelegate**(`agreementId`, `nftHolder`, `nftReceiver`, `nftAmount`, `ercType?`): `Promise`<`boolean`\> - -Asks the gateway to transfer the NFT on behalf of the publisher. - -**`Remarks`** - -This is useful when the consumer does not want to wait for the publisher -to transfer the NFT once the payment is made. Assuming the publisher delegated -transfer permissions to the gateway. - -One example would be a marketplace where the user wants to get access to the NFT -as soon as the payment is made - -**`Example`** - -```ts -// TODO -``` - -#### Parameters - -| Name | Type | Default value | Description | -| :------------ | :-------- | :------------ | :----------------------------------------------- | -| `agreementId` | `string` | `undefined` | The NFT sales agreement id. | -| `nftHolder` | `string` | `undefined` | The address of the current owner of the NFT. | -| `nftReceiver` | `string` | `undefined` | The address where the NFT should be transferred. | -| `nftAmount` | `default` | `undefined` | The amount of NFTs to transfer. | -| `ercType` | `ERCType` | `1155` | The Type of the NFT ERC (1155 or 721). | - -#### Returns - -`Promise`<`boolean`\> - -true if the transfer was successful. - -#### Defined in - -[src/nevermined/Nfts.ts:443](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L443) - ---- - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -Instantiable.addressesStatic - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - ---- - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -Instantiable.findSignerStatic - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - ---- - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`Nfts`](Nfts.md)\> - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`Nfts`](Nfts.md)\> - -#### Overrides - -Instantiable.getInstance - -#### Defined in - -[src/nevermined/Nfts.ts:36](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Nfts.ts#L36) - ---- - -### 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 - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/api-reference/classes/Permissions.md b/docs/api-reference/classes/Permissions.md new file mode 100644 index 000000000..77500cdfe --- /dev/null +++ b/docs/api-reference/classes/Permissions.md @@ -0,0 +1,486 @@ +[@nevermined-io/sdk](../code-reference.md) / Permissions + +# Class: Permissions + +## Hierarchy + +- [`MarketplaceApi`](MarketplaceApi.md) + + ↳ **`Permissions`** + +## Table of contents + +### Constructors + +- [constructor](Permissions.md#constructor) + +### Accessors + +- [artifactsFolder](Permissions.md#artifactsfolder) +- [circuitsFolder](Permissions.md#circuitsfolder) +- [config](Permissions.md#config) +- [instanceConfig](Permissions.md#instanceconfig) +- [instantiableConfig](Permissions.md#instantiableconfig) +- [logger](Permissions.md#logger) +- [nevermined](Permissions.md#nevermined) +- [url](Permissions.md#url) +- [web3](Permissions.md#web3) + +### Methods + +- [addNewAddress](Permissions.md#addnewaddress) +- [create](Permissions.md#create) +- [deleteOneById](Permissions.md#deleteonebyid) +- [findManyByUserId](Permissions.md#findmanybyuserid) +- [findManyByUserIdAndType](Permissions.md#findmanybyuseridandtype) +- [findOneById](Permissions.md#findonebyid) +- [login](Permissions.md#login) +- [setInstanceConfig](Permissions.md#setinstanceconfig) +- [updateOneById](Permissions.md#updateonebyid) +- [getInstance](Permissions.md#getinstance) +- [setInstanceConfig](Permissions.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new Permissions**(`config`) + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Inherited from + +[MarketplaceApi](MarketplaceApi.md).[constructor](MarketplaceApi.md#constructor) + +#### Defined in + +[src/services/metadata/MarketplaceAPI.ts:7](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MarketplaceAPI.ts#L7) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +MarketplaceApi.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +MarketplaceApi.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +MarketplaceApi.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +MarketplaceApi.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +MarketplaceApi.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +MarketplaceApi.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +MarketplaceApi.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### url + +• `Protected` `get` **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +MarketplaceApi.url + +#### Defined in + +[src/services/metadata/MarketplaceAPI.ts:12](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MarketplaceAPI.ts#L12) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +MarketplaceApi.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### addNewAddress + +▸ **addNewAddress**(`clientAssertion`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :---------------- | :------- | +| `clientAssertion` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[MarketplaceApi](MarketplaceApi.md).[addNewAddress](MarketplaceApi.md#addnewaddress) + +#### Defined in + +[src/services/metadata/MarketplaceAPI.ts:36](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MarketplaceAPI.ts#L36) + +--- + +### create + +▸ **create**(`newPermission`): `Promise`<[`Permission`](../interfaces/Permission.md)\> + +Create Permission + +#### Parameters + +| Name | Type | +| :-------------- | :------------------------------------------------ | +| `newPermission` | [`NewPermission`](../interfaces/NewPermission.md) | + +#### Returns + +`Promise`<[`Permission`](../interfaces/Permission.md)\> + +#### Defined in + +[src/services/metadata/Permissions.ts:14](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/Permissions.ts#L14) + +--- + +### deleteOneById + +▸ **deleteOneById**(`id`): `Promise`<`void`\> + +Delele a bookmark by id + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `id` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[src/services/metadata/Permissions.ts:138](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/Permissions.ts#L138) + +--- + +### findManyByUserId + +▸ **findManyByUserId**(`userId`, `query?`): `Promise`<[`MarketplaceResults`](../interfaces/MarketplaceResults.md)<[`Permission`](../interfaces/Permission.md)\>\> + +Get permissions by userId + +#### Parameters + +| Name | Type | +| :------- | :-------------------------------------------- | +| `userId` | `string` | +| `query?` | [`SearchQuery`](../interfaces/SearchQuery.md) | + +#### Returns + +`Promise`<[`MarketplaceResults`](../interfaces/MarketplaceResults.md)<[`Permission`](../interfaces/Permission.md)\>\> + +#### Defined in + +[src/services/metadata/Permissions.ts:63](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/Permissions.ts#L63) + +--- + +### findManyByUserIdAndType + +▸ **findManyByUserIdAndType**(`userId`, `type`, `query?`): `Promise`<[`MarketplaceResults`](../interfaces/MarketplaceResults.md)<[`Permission`](../interfaces/Permission.md)\>\> + +Get permissions by userId and specific type + +#### Parameters + +| Name | Type | +| :------- | :--------------------------------------------- | +| `userId` | `string` | +| `type` | [`PermissionType`](../enums/PermissionType.md) | +| `query?` | [`SearchQuery`](../interfaces/SearchQuery.md) | + +#### Returns + +`Promise`<[`MarketplaceResults`](../interfaces/MarketplaceResults.md)<[`Permission`](../interfaces/Permission.md)\>\> + +#### Defined in + +[src/services/metadata/Permissions.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/Permissions.ts#L88) + +--- + +### findOneById + +▸ **findOneById**(`id`): `Promise`<[`Permission`](../interfaces/Permission.md)\> + +Get a permission by Id + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `id` | `string` | + +#### Returns + +`Promise`<[`Permission`](../interfaces/Permission.md)\> + +#### Defined in + +[src/services/metadata/Permissions.ts:41](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/Permissions.ts#L41) + +--- + +### login + +▸ **login**(`clientAssertion`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :---------------- | :------- | +| `clientAssertion` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[MarketplaceApi](MarketplaceApi.md).[login](MarketplaceApi.md#login) + +#### Defined in + +[src/services/metadata/MarketplaceAPI.ts:16](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MarketplaceAPI.ts#L16) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[MarketplaceApi](MarketplaceApi.md).[setInstanceConfig](MarketplaceApi.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### updateOneById + +▸ **updateOneById**(`id`, `permission`): `Promise`<[`Permission`](../interfaces/Permission.md)\> + +Update a Permission by id + +#### Parameters + +| Name | Type | +| :----------- | :------------------------------------------------------ | +| `id` | `string` | +| `permission` | `Partial`<[`Permission`](../interfaces/Permission.md)\> | + +#### Returns + +`Promise`<[`Permission`](../interfaces/Permission.md)\> + +#### Defined in + +[src/services/metadata/Permissions.ts:114](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/Permissions.ts#L114) + +--- + +### getInstance + +▸ `Static` **getInstance**(`..._args`): `any` + +#### Parameters + +| Name | Type | +| :--------- | :---- | +| `..._args` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[MarketplaceApi](MarketplaceApi.md).[getInstance](MarketplaceApi.md#getinstance) + +#### Defined in + +[src/Instantiable.abstract.ts:86](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L86) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[MarketplaceApi](MarketplaceApi.md).[setInstanceConfig](MarketplaceApi.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/Profiles.md b/docs/api-reference/classes/Profiles.md new file mode 100644 index 000000000..b18ef0a7c --- /dev/null +++ b/docs/api-reference/classes/Profiles.md @@ -0,0 +1,454 @@ +[@nevermined-io/sdk](../code-reference.md) / Profiles + +# Class: Profiles + +## Hierarchy + +- [`MarketplaceApi`](MarketplaceApi.md) + + ↳ **`Profiles`** + +## Table of contents + +### Constructors + +- [constructor](Profiles.md#constructor) + +### Accessors + +- [artifactsFolder](Profiles.md#artifactsfolder) +- [circuitsFolder](Profiles.md#circuitsfolder) +- [config](Profiles.md#config) +- [instanceConfig](Profiles.md#instanceconfig) +- [instantiableConfig](Profiles.md#instantiableconfig) +- [logger](Profiles.md#logger) +- [nevermined](Profiles.md#nevermined) +- [url](Profiles.md#url) +- [web3](Profiles.md#web3) + +### Methods + +- [addNewAddress](Profiles.md#addnewaddress) +- [create](Profiles.md#create) +- [disableOneByUserId](Profiles.md#disableonebyuserid) +- [findOneByAddress](Profiles.md#findonebyaddress) +- [findOneByUserId](Profiles.md#findonebyuserid) +- [login](Profiles.md#login) +- [setInstanceConfig](Profiles.md#setinstanceconfig) +- [update](Profiles.md#update) +- [getInstance](Profiles.md#getinstance) +- [setInstanceConfig](Profiles.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new Profiles**(`config`) + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Inherited from + +[MarketplaceApi](MarketplaceApi.md).[constructor](MarketplaceApi.md#constructor) + +#### Defined in + +[src/services/metadata/MarketplaceAPI.ts:7](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MarketplaceAPI.ts#L7) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +MarketplaceApi.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +MarketplaceApi.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +MarketplaceApi.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +MarketplaceApi.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +MarketplaceApi.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +MarketplaceApi.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +MarketplaceApi.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### url + +• `Protected` `get` **url**(): `string` + +#### Returns + +`string` + +#### Inherited from + +MarketplaceApi.url + +#### Defined in + +[src/services/metadata/MarketplaceAPI.ts:12](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MarketplaceAPI.ts#L12) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +MarketplaceApi.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### addNewAddress + +▸ **addNewAddress**(`clientAssertion`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :---------------- | :------- | +| `clientAssertion` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[MarketplaceApi](MarketplaceApi.md).[addNewAddress](MarketplaceApi.md#addnewaddress) + +#### Defined in + +[src/services/metadata/MarketplaceAPI.ts:36](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MarketplaceAPI.ts#L36) + +--- + +### create + +▸ **create**(`newProfile`): `Promise`<[`Profile`](../interfaces/Profile.md)\> + +Create user profile + +#### Parameters + +| Name | Type | +| :----------- | :------------------------------------------ | +| `newProfile` | [`NewProfile`](../interfaces/NewProfile.md) | + +#### Returns + +`Promise`<[`Profile`](../interfaces/Profile.md)\> + +#### Defined in + +[src/services/metadata/Profiles.ts:11](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/Profiles.ts#L11) + +--- + +### disableOneByUserId + +▸ **disableOneByUserId**(`userId`): `Promise`<[`Profile`](../interfaces/Profile.md)\> + +#### Parameters + +| Name | Type | +| :------- | :------- | +| `userId` | `string` | + +#### Returns + +`Promise`<[`Profile`](../interfaces/Profile.md)\> + +#### Defined in + +[src/services/metadata/Profiles.ts:93](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/Profiles.ts#L93) + +--- + +### findOneByAddress + +▸ **findOneByAddress**(`address`): `Promise`<[`Profile`](../interfaces/Profile.md)\> + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `address` | `string` | + +#### Returns + +`Promise`<[`Profile`](../interfaces/Profile.md)\> + +#### Defined in + +[src/services/metadata/Profiles.ts:74](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/Profiles.ts#L74) + +--- + +### findOneByUserId + +▸ **findOneByUserId**(`userId`): `Promise`<[`Profile`](../interfaces/Profile.md)\> + +#### Parameters + +| Name | Type | +| :------- | :------- | +| `userId` | `string` | + +#### Returns + +`Promise`<[`Profile`](../interfaces/Profile.md)\> + +#### Defined in + +[src/services/metadata/Profiles.ts:55](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/Profiles.ts#L55) + +--- + +### login + +▸ **login**(`clientAssertion`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :---------------- | :------- | +| `clientAssertion` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[MarketplaceApi](MarketplaceApi.md).[login](MarketplaceApi.md#login) + +#### Defined in + +[src/services/metadata/MarketplaceAPI.ts:16](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MarketplaceAPI.ts#L16) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[MarketplaceApi](MarketplaceApi.md).[setInstanceConfig](MarketplaceApi.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### update + +▸ **update**(`userId`, `profile`): `Promise`<[`Profile`](../interfaces/Profile.md)\> + +Update user profile + +#### Parameters + +| Name | Type | +| :-------- | :------------------------------------------------------ | +| `userId` | `string` | +| `profile` | `Partial`<[`NewProfile`](../interfaces/NewProfile.md)\> | + +#### Returns + +`Promise`<[`Profile`](../interfaces/Profile.md)\> + +#### Defined in + +[src/services/metadata/Profiles.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/Profiles.ts#L34) + +--- + +### getInstance + +▸ `Static` **getInstance**(`..._args`): `any` + +#### Parameters + +| Name | Type | +| :--------- | :---- | +| `..._args` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[MarketplaceApi](MarketplaceApi.md).[getInstance](MarketplaceApi.md#getinstance) + +#### Defined in + +[src/Instantiable.abstract.ts:86](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L86) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[MarketplaceApi](MarketplaceApi.md).[setInstanceConfig](MarketplaceApi.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/ProvenanceApi.md b/docs/api-reference/classes/ProvenanceApi.md new file mode 100644 index 000000000..7d6610995 --- /dev/null +++ b/docs/api-reference/classes/ProvenanceApi.md @@ -0,0 +1,592 @@ +[@nevermined-io/sdk](../code-reference.md) / ProvenanceApi + +# Class: ProvenanceApi + +Nevermined Provenance API. It allows to register and search entries in the Nevermined W3C Provenance registry +You can find more information about Nevermined Provenance here: +[https://docs.nevermined.io/docs/architecture/specs/Spec-PROVENANCE](https://docs.nevermined.io/docs/architecture/specs/Spec-PROVENANCE) + +## Hierarchy + +- [`Instantiable`](Instantiable.md) + + ↳ **`ProvenanceApi`** + +## Table of contents + +### Constructors + +- [constructor](ProvenanceApi.md#constructor) + +### Accessors + +- [artifactsFolder](ProvenanceApi.md#artifactsfolder) +- [circuitsFolder](ProvenanceApi.md#circuitsfolder) +- [config](ProvenanceApi.md#config) +- [instanceConfig](ProvenanceApi.md#instanceconfig) +- [instantiableConfig](ProvenanceApi.md#instantiableconfig) +- [logger](ProvenanceApi.md#logger) +- [nevermined](ProvenanceApi.md#nevermined) +- [web3](ProvenanceApi.md#web3) + +### Methods + +- [actedOnBehalf](ProvenanceApi.md#actedonbehalf) +- [addDidProvenanceDelegate](ProvenanceApi.md#adddidprovenancedelegate) +- [getDIDProvenanceEvents](ProvenanceApi.md#getdidprovenanceevents) +- [getProvenanceEntry](ProvenanceApi.md#getprovenanceentry) +- [getProvenanceMethodEvents](ProvenanceApi.md#getprovenancemethodevents) +- [getProvenanceOwner](ProvenanceApi.md#getprovenanceowner) +- [isProvenanceDelegate](ProvenanceApi.md#isprovenancedelegate) +- [removeDidProvenanceDelegate](ProvenanceApi.md#removedidprovenancedelegate) +- [setInstanceConfig](ProvenanceApi.md#setinstanceconfig) +- [used](ProvenanceApi.md#used) +- [wasAssociatedWith](ProvenanceApi.md#wasassociatedwith) +- [wasDerivedFrom](ProvenanceApi.md#wasderivedfrom) +- [getInstance](ProvenanceApi.md#getinstance) +- [setInstanceConfig](ProvenanceApi.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new ProvenanceApi**(`config`) + +Creates a new ProvenanceApi + +#### Parameters + +| Name | Type | Description | +| :------- | :---------------------------------------------------------- | :--------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | Configuration of the Nevermined instance | + +#### Overrides + +[Instantiable](Instantiable.md).[constructor](Instantiable.md#constructor) + +#### Defined in + +[src/nevermined/api/ProvenanceApi.ts:18](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/ProvenanceApi.ts#L18) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +Instantiable.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +Instantiable.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +Instantiable.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +Instantiable.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### actedOnBehalf + +▸ **actedOnBehalf**(`provenanceId`, `did`, `delegateAgentId`, `responsibleAgentId`, `activityId`, `signature`, `attributes`, `from`, `txParams?`): `Promise`<`boolean`\> + +Implements the W3C PROV Delegation action + +#### Parameters + +| Name | Type | Description | +| :------------------- | :---------------------------------------------- | :------------------------------------------------- | +| `provenanceId` | `string` | Provenance ID | +| `did` | `string` | Identifier of the entity created | +| `delegateAgentId` | `string` | Delegate Agent Identifier | +| `responsibleAgentId` | `string` | Responsible Agent Identifier | +| `activityId` | `string` | Identifier of the activity creating the new entity | +| `signature` | `string` | Signature provided by the delegated agent | +| `attributes` | `string` | Attributes associated with the action | +| `from` | [`Account`](Account.md) | Sender account address. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | + +#### Returns + +`Promise`<`boolean`\> + +true if the call succeeded. + +#### Defined in + +[src/nevermined/api/ProvenanceApi.ts:147](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/ProvenanceApi.ts#L147) + +--- + +### addDidProvenanceDelegate + +▸ **addDidProvenanceDelegate**(`did`, `delegated`, `from`, `txParams?`): `Promise`<`boolean`\> + +Add new DID provenance delegate. + +#### Parameters + +| Name | Type | Description | +| :---------- | :---------------------------------------------- | :------------------------------- | +| `did` | `string` | Identifier of the entity created | +| `delegated` | `string` | Delegate Address | +| `from` | [`Account`](Account.md) | Sender account address. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | + +#### Returns + +`Promise`<`boolean`\> + +true if the call succeeded. + +#### Defined in + +[src/nevermined/api/ProvenanceApi.ts:180](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/ProvenanceApi.ts#L180) + +--- + +### getDIDProvenanceEvents + +▸ **getDIDProvenanceEvents**(`did`): `Promise`<{ `activityId`: `string` ; `agentId`: `string` ; `agentInvolvedId`: `string` ; `attributes?`: `string` ; `blockNumberUpdated`: `number` ; `did`: `string` ; `id`: `string` ; `method`: `number` ; `provId`: `string` ; `relatedDid`: `string` }[]\> + +Search for ProvenanceAttributeRegistered events related with a specific DID + +#### Parameters + +| Name | Type | Description | +| :---- | :------- | :------------------------------- | +| `did` | `string` | identifier of the entity created | + +#### Returns + +`Promise`<{ `activityId`: `string` ; `agentId`: `string` ; `agentInvolvedId`: `string` ; `attributes?`: `string` ; `blockNumberUpdated`: `number` ; `did`: `string` ; `id`: `string` ; `method`: `number` ; `provId`: `string` ; `relatedDid`: `string` }[]\> + +A list of provenance events. + +#### Defined in + +[src/nevermined/api/ProvenanceApi.ts:240](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/ProvenanceApi.ts#L240) + +--- + +### getProvenanceEntry + +▸ **getProvenanceEntry**(`provenanceId`): `Promise`<[`ProvenanceRegistry`](../interfaces/ProvenanceRegistry.md)\> + +Given a provenance id it returns the provenance details + +#### Parameters + +| Name | Type | Description | +| :------------- | :------- | :-------------------------------------- | +| `provenanceId` | `string` | Unique identifier of a provenance entry | + +#### Returns + +`Promise`<[`ProvenanceRegistry`](../interfaces/ProvenanceRegistry.md)\> + +#### Defined in + +[src/nevermined/api/ProvenanceApi.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/ProvenanceApi.ts#L28) + +--- + +### getProvenanceMethodEvents + +▸ **getProvenanceMethodEvents**<`T`\>(`method`, `did`): `Promise`<[`ProvenanceEvent`](../code-reference.md#provenanceevent)<`T`\>[]\> + +Search for ProvenanceAttributeRegistered events related with a specific DID + +#### Type parameters + +| Name | Type | +| :--- | :--------------------------------------------------------- | +| `T` | extends [`ProvenanceMethod`](../enums/ProvenanceMethod.md) | + +#### Parameters + +| Name | Type | Description | +| :------- | :------- | :------------------------------- | +| `method` | `T` | Method | +| `did` | `string` | Identifier of the entity created | + +#### Returns + +`Promise`<[`ProvenanceEvent`](../code-reference.md#provenanceevent)<`T`\>[]\> + +A list of provenance method events. + +#### Defined in + +[src/nevermined/api/ProvenanceApi.ts:250](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/ProvenanceApi.ts#L250) + +--- + +### getProvenanceOwner + +▸ **getProvenanceOwner**(`did`): `Promise`<`unknown`\> + +Retrieve the owner of the provenance record. + +#### Parameters + +| Name | Type | Description | +| :---- | :------- | :------------------------------- | +| `did` | `string` | Identifier of the entity created | + +#### Returns + +`Promise`<`unknown`\> + +#### Defined in + +[src/nevermined/api/ProvenanceApi.ts:231](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/ProvenanceApi.ts#L231) + +--- + +### isProvenanceDelegate + +▸ **isProvenanceDelegate**(`did`, `delegated`): `Promise`<`unknown`\> + +Check whether a given DID delegate exists + +#### Parameters + +| Name | Type | Description | +| :---------- | :------- | :------------------------------- | +| `did` | `string` | Identifier of the entity created | +| `delegated` | `string` | Delegate Address | + +#### Returns + +`Promise`<`unknown`\> + +#### Defined in + +[src/nevermined/api/ProvenanceApi.ts:223](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/ProvenanceApi.ts#L223) + +--- + +### removeDidProvenanceDelegate + +▸ **removeDidProvenanceDelegate**(`did`, `delegated`, `from`, `txParams?`): `Promise`<`boolean`\> + +Remove an existing DID delegate. + +#### Parameters + +| Name | Type | Description | +| :---------- | :---------------------------------------------- | :------------------------------- | +| `did` | `string` | Identifier of the entity created | +| `delegated` | `string` | Delegate Address | +| `from` | [`Account`](Account.md) | Sender account address. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | + +#### Returns + +`Promise`<`boolean`\> + +true if the call succeeded. + +#### Defined in + +[src/nevermined/api/ProvenanceApi.ts:203](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/ProvenanceApi.ts#L203) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### used + +▸ **used**(`provenanceId`, `did`, `agentId`, `activityId`, `signature`, `attributes`, `from`, `txParams?`): `Promise`<`boolean`\> + +Implements the W3C PROV Usage action + +#### Parameters + +| Name | Type | Description | +| :------------- | :---------------------------------------------- | :-------------------------------------------------- | +| `provenanceId` | `string` | Provenance ID | +| `did` | `string` | Identifier of the entity created | +| `agentId` | `string` | Agent Identifier | +| `activityId` | `string` | Identifier of the activity creating the new entity | +| `signature` | `string` | Signature (optional) provided by the agent involved | +| `attributes` | `string` | Attributes associated with the action | +| `from` | [`Account`](Account.md) | Sender account address. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | + +#### Returns + +`Promise`<`boolean`\> + +true if the call succeeded. + +#### Defined in + +[src/nevermined/api/ProvenanceApi.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/ProvenanceApi.ts#L44) + +--- + +### wasAssociatedWith + +▸ **wasAssociatedWith**(`provenanceId`, `did`, `agentId`, `activityId`, `attributes`, `from`, `txParams?`): `Promise`<`boolean`\> + +Implements the W3C PROV Association action + +#### Parameters + +| Name | Type | Description | +| :------------- | :---------------------------------------------- | :------------------------------------------------- | +| `provenanceId` | `string` | Provenance ID | +| `did` | `string` | Identifier of the entity created | +| `agentId` | `string` | Agent Identifier | +| `activityId` | `string` | Identifier of the activity creating the new entity | +| `attributes` | `string` | Attributes associated with the action | +| `from` | [`Account`](Account.md) | Sender account address. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | + +#### Returns + +`Promise`<`boolean`\> + +true if the call succeeded. + +#### Defined in + +[src/nevermined/api/ProvenanceApi.ts:113](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/ProvenanceApi.ts#L113) + +--- + +### wasDerivedFrom + +▸ **wasDerivedFrom**(`provenanceId`, `newEntityDid`, `usedEntityDid`, `agentId`, `activityId`, `attributes`, `from`, `txParams?`): `Promise`<`boolean`\> + +Implements the W3C PROV Derivation action + +#### Parameters + +| Name | Type | Description | +| :-------------- | :---------------------------------------------- | :----------------------------------------------------- | +| `provenanceId` | `string` | Provenance ID | +| `newEntityDid` | `string` | Identifier of the new entity derived | +| `usedEntityDid` | `string` | Identifier of the entity used to derive the new entity | +| `agentId` | `string` | Agent Identifier | +| `activityId` | `string` | Identifier of the activity creating the new entity | +| `attributes` | `string` | Attributes associated with the action | +| `from` | [`Account`](Account.md) | Sender account address. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | + +#### Returns + +`Promise`<`boolean`\> + +true if the call succeeded. + +#### Defined in + +[src/nevermined/api/ProvenanceApi.ts:79](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/ProvenanceApi.ts#L79) + +--- + +### getInstance + +▸ `Static` **getInstance**(`..._args`): `any` + +#### Parameters + +| Name | Type | +| :--------- | :---- | +| `..._args` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[Instantiable](Instantiable.md).[getInstance](Instantiable.md#getinstance) + +#### Defined in + +[src/Instantiable.abstract.ts:86](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L86) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/ProviderCondition.md b/docs/api-reference/classes/ProviderCondition.md new file mode 100644 index 000000000..7fc4bef3a --- /dev/null +++ b/docs/api-reference/classes/ProviderCondition.md @@ -0,0 +1,1005 @@ +[@nevermined-io/sdk](../code-reference.md) / ProviderCondition + +# Class: ProviderCondition + +## Type parameters + +| Name | Type | +| :------ | :-------------------------------------------------------------- | +| `Ctx` | extends [`ConditionContext`](../interfaces/ConditionContext.md) | +| `Extra` | `Record`<`string`, `unknown`\> | + +## Hierarchy + +- [`Condition`](Condition.md)<`Ctx`, `Extra`\> + + ↳ **`ProviderCondition`** + + ↳↳ [`AccessCondition`](AccessCondition.md) + + ↳↳ [`EscrowPaymentCondition`](EscrowPaymentCondition.md) + + ↳↳ [`ComputeExecutionCondition`](ComputeExecutionCondition.md) + + ↳↳ [`NFTAccessCondition`](NFTAccessCondition.md) + + ↳↳ [`TransferNFTCondition`](TransferNFTCondition.md) + + ↳↳ [`TransferNFT721Condition`](TransferNFT721Condition.md) + + ↳↳ [`TransferDIDOwnershipCondition`](TransferDIDOwnershipCondition.md) + + ↳↳ [`AaveBorrowCondition`](AaveBorrowCondition.md) + + ↳↳ [`AaveCollateralDepositCondition`](AaveCollateralDepositCondition.md) + + ↳↳ [`AaveCollateralWithdrawCondition`](AaveCollateralWithdrawCondition.md) + + ↳↳ [`AaveRepayCondition`](AaveRepayCondition.md) + + ↳↳ [`NFT721LockCondition`](NFT721LockCondition.md) + + ↳↳ [`DistributeNFTCollateralCondition`](DistributeNFTCollateralCondition.md) + +## Table of contents + +### Constructors + +- [constructor](ProviderCondition.md#constructor) + +### Properties + +- [address](ProviderCondition.md#address) +- [contract](ProviderCondition.md#contract) +- [contractName](ProviderCondition.md#contractname) +- [events](ProviderCondition.md#events) +- [version](ProviderCondition.md#version) + +### Accessors + +- [artifactsFolder](ProviderCondition.md#artifactsfolder) +- [circuitsFolder](ProviderCondition.md#circuitsfolder) +- [config](ProviderCondition.md#config) +- [instanceConfig](ProviderCondition.md#instanceconfig) +- [instantiableConfig](ProviderCondition.md#instantiableconfig) +- [logger](ProviderCondition.md#logger) +- [nevermined](ProviderCondition.md#nevermined) +- [web3](ProviderCondition.md#web3) + +### Methods + +- [abortByTimeOut](ProviderCondition.md#abortbytimeout) +- [call](ProviderCondition.md#call) +- [fulfill](ProviderCondition.md#fulfill) +- [fulfillInstance](ProviderCondition.md#fulfillinstance) +- [fulfillPlain](ProviderCondition.md#fulfillplain) +- [fulfillWithNode](ProviderCondition.md#fulfillwithnode) +- [generateId](ProviderCondition.md#generateid) +- [generateIdHash](ProviderCondition.md#generateidhash) +- [generateIdWithSeed](ProviderCondition.md#generateidwithseed) +- [getConditionFulfilledEvent](ProviderCondition.md#getconditionfulfilledevent) +- [getFromAddress](ProviderCondition.md#getfromaddress) +- [getInputsOfMethod](ProviderCondition.md#getinputsofmethod) +- [getSignatureOfMethod](ProviderCondition.md#getsignatureofmethod) +- [hashValues](ProviderCondition.md#hashvalues) +- [hashValuesPlain](ProviderCondition.md#hashvaluesplain) +- [init](ProviderCondition.md#init) +- [instance](ProviderCondition.md#instance) +- [instanceFromDDO](ProviderCondition.md#instancefromddo) +- [nodeMethod](ProviderCondition.md#nodemethod) +- [params](ProviderCondition.md#params) +- [paramsFromDDO](ProviderCondition.md#paramsfromddo) +- [send](ProviderCondition.md#send) +- [sendFrom](ProviderCondition.md#sendfrom) +- [setInstanceConfig](ProviderCondition.md#setinstanceconfig) +- [getInstance](ProviderCondition.md#getinstance) +- [setInstanceConfig](ProviderCondition.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new ProviderCondition**<`Ctx`, `Extra`\>(`contractName`) + +#### Type parameters + +| Name | Type | +| :------ | :-------------------------------------------------------------- | +| `Ctx` | extends [`ConditionContext`](../interfaces/ConditionContext.md) | +| `Extra` | `Record`<`string`, `unknown`\> | + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Inherited from + +[Condition](Condition.md).[constructor](Condition.md#constructor) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L34) + +## Properties + +### address + +• **address**: `string` + +#### Inherited from + +[Condition](Condition.md).[address](Condition.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[Condition](Condition.md).[contract](Condition.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[Condition](Condition.md).[contractName](Condition.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[Condition](Condition.md).[events](Condition.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[Condition](Condition.md).[version](Condition.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Condition.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Condition.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +Condition.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Condition.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Condition.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +Condition.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +Condition.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +Condition.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### abortByTimeOut + +▸ **abortByTimeOut**(`conditionId`, `from?`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------------ | :---------------------------------------------- | +| `conditionId` | `string` | +| `from?` | [`Account`](Account.md) | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[Condition](Condition.md).[abortByTimeOut](Condition.md#abortbytimeout) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L88) + +--- + +### 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 + +[Condition](Condition.md).[call](Condition.md#call) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### fulfill + +▸ `Abstract` **fulfill**(`agreementId`, `...args`): `any` + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `...args` | `any`[] | + +#### Returns + +`any` + +#### Inherited from + +[Condition](Condition.md).[fulfill](Condition.md#fulfill) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:61](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L61) + +--- + +### fulfillInstance + +▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `txParams?`, `method?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | Default value | +| :----------------- | :------------------------------------------------------------------ | :------------ | +| `cond` | [`ConditionInstance`](../interfaces/ConditionInstance.md)<`Extra`\> | `undefined` | +| `additionalParams` | `Extra` | `undefined` | +| `from?` | [`Account`](Account.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[Condition](Condition.md).[fulfillInstance](Condition.md#fulfillinstance) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:150](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L150) + +--- + +### fulfillPlain + +▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `txParams?`, `method?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | Default value | +| :------------ | :-------------------------------------------------------- | :------------ | +| `agreementId` | `string` | `undefined` | +| `args` | `any`[] | `undefined` | +| `from?` | [`Account`](Account.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[Condition](Condition.md).[fulfillPlain](Condition.md#fulfillplain) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L63) + +--- + +### fulfillWithNode + +▸ **fulfillWithNode**(`cond`, `additionalParams`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :----------------- | :------------------------------------------------------------------ | +| `cond` | [`ConditionInstance`](../interfaces/ConditionInstance.md)<`Extra`\> | +| `additionalParams` | `Extra` | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Overrides + +[Condition](Condition.md).[fulfillWithNode](Condition.md#fulfillwithnode) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:194](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L194) + +--- + +### generateId + +▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `valueHash` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[Condition](Condition.md).[generateId](Condition.md#generateid) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L77) + +--- + +### generateIdHash + +▸ **generateIdHash**(`agreementId`, `...values`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `...values` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[Condition](Condition.md).[generateIdHash](Condition.md#generateidhash) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L73) + +--- + +### generateIdWithSeed + +▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `valueHash` | `string` | + +#### Returns + +`Promise`<[`string`, `string`]\> + +#### Inherited from + +[Condition](Condition.md).[generateIdWithSeed](Condition.md#generateidwithseed) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L81) + +--- + +### getConditionFulfilledEvent + +▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../code-reference.md#eventresult) + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | + +#### Returns + +[`EventResult`](../code-reference.md#eventresult) + +#### Inherited from + +[Condition](Condition.md).[getConditionFulfilledEvent](Condition.md#getconditionfulfilledevent) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L92) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[Condition](Condition.md).[getFromAddress](Condition.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[Condition](Condition.md).[getInputsOfMethod](Condition.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[Condition](Condition.md).[getSignatureOfMethod](Condition.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### hashValues + +▸ **hashValues**(`...args`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[Condition](Condition.md).[hashValues](Condition.md#hashvalues) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L129) + +--- + +### hashValuesPlain + +▸ **hashValuesPlain**(`...args`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[Condition](Condition.md).[hashValuesPlain](Condition.md#hashvaluesplain) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:133](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L133) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[Condition](Condition.md).[init](Condition.md#init) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### instance + +▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Extra`\>\> + +#### Parameters + +| Name | Type | +| :------------ | :---------------------------------------------------------------------- | +| `agreementId` | `string` | +| `params` | [`ConditionParameters`](../interfaces/ConditionParameters.md)<`Extra`\> | + +#### Returns + +`Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Extra`\>\> + +#### Inherited from + +[Condition](Condition.md).[instance](Condition.md#instance) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:174](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L174) + +--- + +### instanceFromDDO + +▸ **instanceFromDDO**(`agreementId`, `ctx`, `...args`): `Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Extra`\>\> + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------------------------------------------- | +| `agreementId` | `string` | +| `ctx` | `Ctx` | +| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | + +#### Returns + +`Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Extra`\>\> + +#### Inherited from + +[Condition](Condition.md).[instanceFromDDO](Condition.md#instancefromddo) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L142) + +--- + +### nodeMethod + +▸ **nodeMethod**(): [`ConditionMethod`](../code-reference.md#conditionmethod) + +#### Returns + +[`ConditionMethod`](../code-reference.md#conditionmethod) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:208](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L208) + +--- + +### params + +▸ **params**(`...args`): [`ConditionParameters`](../interfaces/ConditionParameters.md)<`Extra`\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Extra`\> + +#### Inherited from + +[Condition](Condition.md).[params](Condition.md#params) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:122](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L122) + +--- + +### paramsFromDDO + +▸ `Abstract` **paramsFromDDO**(`ctx`, `...args`): `Promise`<[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Extra`\>\> + +#### Parameters + +| Name | Type | +| :-------- | :-------------------------------------------------------------------- | +| `ctx` | `Ctx` | +| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | + +#### Returns + +`Promise`<[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Extra`\>\> + +#### Inherited from + +[Condition](Condition.md).[paramsFromDDO](Condition.md#paramsfromddo) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:137](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L137) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[Condition](Condition.md).[send](Condition.md#send) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[Condition](Condition.md).[sendFrom](Condition.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Condition](Condition.md).[setInstanceConfig](Condition.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### getInstance + +▸ `Static` **getInstance**<`Ctx`, `Extra`\>(`config`, `conditionName`, `conditionsClass`, `optional?`): `Promise`<`any`\> + +#### Type parameters + +| Name | Type | +| :------ | :-------------------------------------------------------------- | +| `Ctx` | extends [`ConditionContext`](../interfaces/ConditionContext.md) | +| `Extra` | `Extra` | + +#### Parameters + +| Name | Type | Default value | +| :---------------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `conditionName` | `string` | `undefined` | +| `conditionsClass` | `any` | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`any`\> + +#### Inherited from + +[Condition](Condition.md).[getInstance](Condition.md#getinstance) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:111](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L111) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Condition](Condition.md).[setInstanceConfig](Condition.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/Providers.md b/docs/api-reference/classes/Providers.md new file mode 100644 index 000000000..cfcf32426 --- /dev/null +++ b/docs/api-reference/classes/Providers.md @@ -0,0 +1,356 @@ +[@nevermined-io/sdk](../code-reference.md) / Providers + +# Class: Providers + +Providers API that allows the basic management of the provider accounts associated to an asset. + +## Hierarchy + +- [`Instantiable`](Instantiable.md) + + ↳ **`Providers`** + +## Table of contents + +### Constructors + +- [constructor](Providers.md#constructor) + +### Accessors + +- [artifactsFolder](Providers.md#artifactsfolder) +- [circuitsFolder](Providers.md#circuitsfolder) +- [config](Providers.md#config) +- [instanceConfig](Providers.md#instanceconfig) +- [instantiableConfig](Providers.md#instantiableconfig) +- [logger](Providers.md#logger) +- [nevermined](Providers.md#nevermined) +- [web3](Providers.md#web3) + +### Methods + +- [add](Providers.md#add) +- [list](Providers.md#list) +- [remove](Providers.md#remove) +- [setInstanceConfig](Providers.md#setinstanceconfig) +- [getInstance](Providers.md#getinstance) +- [setInstanceConfig](Providers.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new Providers**(`config`) + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Overrides + +[Instantiable](Instantiable.md).[constructor](Instantiable.md#constructor) + +#### Defined in + +[src/nevermined/Provider.ts:9](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Provider.ts#L9) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +Instantiable.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +Instantiable.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +Instantiable.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +Instantiable.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### add + +▸ **add**(`did`, `address`, `from`, `txParams?`): `Promise`<`boolean`\> + +Add a new provider in the registry for a did. + +#### Parameters + +| Name | Type | Description | +| :---------- | :---------------------------------------------- | :--------------------------------------------- | +| `did` | `string` | Identifier of the entity created | +| `address` | `string` | New provider address in the list of providers. | +| `from` | [`Account`](Account.md) | Sender account address. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | + +#### Returns + +`Promise`<`boolean`\> + +true if the call succeeded. + +#### Defined in + +[src/nevermined/Provider.ts:23](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Provider.ts#L23) + +--- + +### list + +▸ **list**(`did`): `Promise`<`any`\> + +List the provider addresses for a did. + +#### Parameters + +| Name | Type | Description | +| :---- | :------- | :------------------------------- | +| `did` | `string` | Identifier of the entity created | + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +[src/nevermined/Provider.ts:55](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Provider.ts#L55) + +--- + +### remove + +▸ **remove**(`did`, `address`, `from`, `txParams?`): `Promise`<`boolean`\> + +Remove a provider in the registry for a did. + +#### Parameters + +| Name | Type | Description | +| :---------- | :---------------------------------------------- | :--------------------------------------------- | +| `did` | `string` | Identifier of the entity created | +| `address` | `string` | New provider address in the list of providers. | +| `from` | [`Account`](Account.md) | Sender account address. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | + +#### Returns + +`Promise`<`boolean`\> + +true if the call succeeded. + +#### Defined in + +[src/nevermined/Provider.ts:41](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Provider.ts#L41) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### getInstance + +▸ `Static` **getInstance**(`..._args`): `any` + +#### Parameters + +| Name | Type | +| :--------- | :---- | +| `..._args` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[Instantiable](Instantiable.md).[getInstance](Instantiable.md#getinstance) + +#### Defined in + +[src/Instantiable.abstract.ts:86](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L86) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/RegistryBaseApi.md b/docs/api-reference/classes/RegistryBaseApi.md new file mode 100644 index 000000000..565ab2916 --- /dev/null +++ b/docs/api-reference/classes/RegistryBaseApi.md @@ -0,0 +1,523 @@ +[@nevermined-io/sdk](../code-reference.md) / RegistryBaseApi + +# Class: RegistryBaseApi + +Abstract class proving common functionality related with Assets registration. + +## Hierarchy + +- [`Instantiable`](Instantiable.md) + + ↳ **`RegistryBaseApi`** + + ↳↳ [`NFTsBaseApi`](NFTsBaseApi.md) + + ↳↳ [`AssetsApi`](AssetsApi.md) + + ↳↳ [`ComputeApi`](ComputeApi.md) + +## Table of contents + +### Constructors + +- [constructor](RegistryBaseApi.md#constructor) + +### Properties + +- [servicePlugin](RegistryBaseApi.md#serviceplugin) + +### Accessors + +- [artifactsFolder](RegistryBaseApi.md#artifactsfolder) +- [circuitsFolder](RegistryBaseApi.md#circuitsfolder) +- [config](RegistryBaseApi.md#config) +- [instanceConfig](RegistryBaseApi.md#instanceconfig) +- [instantiableConfig](RegistryBaseApi.md#instantiableconfig) +- [logger](RegistryBaseApi.md#logger) +- [nevermined](RegistryBaseApi.md#nevermined) +- [web3](RegistryBaseApi.md#web3) + +### Methods + +- [addRating](RegistryBaseApi.md#addrating) +- [getPriced](RegistryBaseApi.md#getpriced) +- [list](RegistryBaseApi.md#list) +- [orderAsset](RegistryBaseApi.md#orderasset) +- [registerNeverminedAsset](RegistryBaseApi.md#registerneverminedasset) +- [resolveAsset](RegistryBaseApi.md#resolveasset) +- [setInstanceConfig](RegistryBaseApi.md#setinstanceconfig) +- [updateAsset](RegistryBaseApi.md#updateasset) +- [getInstance](RegistryBaseApi.md#getinstance) +- [getServicePlugin](RegistryBaseApi.md#getserviceplugin) +- [setInstanceConfig](RegistryBaseApi.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new RegistryBaseApi**() + +#### Inherited from + +[Instantiable](Instantiable.md).[constructor](Instantiable.md#constructor) + +## Properties + +### servicePlugin + +• **servicePlugin**: `Object` + +#### Index signature + +▪ [key: `string`]: [`ServicePlugin`](../interfaces/ServicePlugin.md)<[`Service`](../code-reference.md#service)\> + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L29) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +Instantiable.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +Instantiable.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +Instantiable.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +Instantiable.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### addRating + +▸ **addRating**(`did`, `newRating`, `numVotesAdded?`, `publisher`, `publishMetadata?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +Given a DID, it adds a vote to the asset curation information. + +#### Parameters + +| Name | Type | Default value | Description | +| :---------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `newRating` | `number` | `undefined` | New average rating of the asset | +| `numVotesAdded` | `number` | `1` | Number of new votes added to the rating, typically just 1 | +| `publisher` | [`Account`](Account.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +[DDO](DDO.md) The DDO updated + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:514](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L514) + +--- + +### getPriced + +▸ `Private` **getPriced**(`assetPrice`): `Promise`<[`PricedMetadataInformation`](../code-reference.md#pricedmetadatainformation)\> + +#### Parameters + +| Name | Type | +| :----------- | :---------------------------- | +| `assetPrice` | [`AssetPrice`](AssetPrice.md) | + +#### Returns + +`Promise`<[`PricedMetadataInformation`](../code-reference.md#pricedmetadatainformation)\> + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:629](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L629) + +--- + +### list + +▸ **list**(`did`, `list`, `publisher`, `publishMetadata?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +Given a DID, updates the metadata associated to the asset allowing to list or unlist it. It also can upload this metadata to a remote decentralized stored depending on the `publishMetadata` parameter. +In a Nevermined environment, when an asset is unlisted, it is not possible to be found and accessed by any user. + +#### Parameters + +| Name | Type | Default value | Description | +| :---------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `list` | `boolean` | `undefined` | Needs the asset to be listed or unlisted | +| `publisher` | [`Account`](Account.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +[DDO](DDO.md) The DDO updated + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:462](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L462) + +--- + +### orderAsset + +▸ **orderAsset**(`did`, `serviceReference`, `consumer`, `params?`): [`SubscribablePromise`](SubscribablePromise.md)<[`OrderProgressStep`](../enums/OrderProgressStep.md), `string`\> + +Start the purchase/order of an asset's service. Starts by signing the service agreement +then sends the request to the publisher via the service endpoint (Node http service). + +#### Parameters + +| Name | Type | Description | +| :----------------- | :------------------------------------------------------------ | :---------------- | +| `did` | `string` | Decentralized ID. | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | Service. | +| `consumer` | [`Account`](Account.md) | Consumer account. | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | - | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`OrderProgressStep`](../enums/OrderProgressStep.md), `string`\> + +The agreement ID. + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:563](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L563) + +--- + +### registerNeverminedAsset + +▸ `Protected` **registerNeverminedAsset**(`assetAttributes`, `publisher`, `publicationOptions`, `nftAttributes?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`CreateProgressStep`](../enums/CreateProgressStep.md), [`DDO`](DDO.md)\> + +It registers a new asset in a Nevermined network. This method is protected and not exposed +via the Nevermined APIs directly. It must accessed via the `assets`, `compute`, and `nfts` APIs. + +#### Parameters + +| Name | Type | Description | +| :------------------- | :------------------------------------------------------ | :-------------------------------------------------------------------------------- | +| `assetAttributes` | [`AssetAttributes`](AssetAttributes.md) | Attributes describing the asset | +| `publisher` | [`Account`](Account.md) | The account publishing the asset | +| `publicationOptions` | [`AssetPublicationOptions`](AssetPublicationOptions.md) | Allows to specify the publication options of the off-chain and the on-chain data. | +| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | Attributes describing the NFT (ERC-721) associated to the asset | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`CreateProgressStep`](../enums/CreateProgressStep.md), [`DDO`](DDO.md)\> + +The metadata of the asset created (DDO) + +**`See`** + +[PublishOnChainOptions](../enums/PublishOnChainOptions.md) and [PublishMetadataOptions](../enums/PublishMetadataOptions.md) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L42) + +--- + +### resolveAsset + +▸ `Protected` **resolveAsset**(`did`, `policy?`): `Promise`<[`DDO`](DDO.md)\> + +Returns a DDO by DID. Depending of the resolution policy it prioritize the Metadata API or Immutable urls. + +#### Parameters + +| Name | Type | Default value | Description | +| :------- | :------------------------------------------------- | :---------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `did` | `string` | `undefined` | Decentralized ID. | +| `policy` | [`DIDResolvePolicy`](../enums/DIDResolvePolicy.md) | `DIDResolvePolicy.MetadataAPIFirst` | It specifies the resolve policy to apply. It allows to select that priorities during the asset resolution via Metadata API or Immutable URLs (IPFS, Filecoin, etc) | + +#### Returns + +`Promise`<[`DDO`](DDO.md)\> + +[DDO](DDO.md) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:310](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L310) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### updateAsset + +▸ `Protected` **updateAsset**(`did`, `metadata`, `publisher`, `publishMetadataOptions?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +Given a DID, updates the metadata associated to the asset. It also can upload this metadata to a remote decentralized stored depending on the `publishMetadata` parameter. + +#### Parameters + +| Name | Type | Default value | Description | +| :----------------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | Metadata describing the asset | +| `publisher` | [`Account`](Account.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadataOptions` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +[DDO](DDO.md) The DDO updated + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:353](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L353) + +--- + +### getInstance + +▸ `Static` **getInstance**(`..._args`): `any` + +#### Parameters + +| Name | Type | +| :--------- | :---- | +| `..._args` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[Instantiable](Instantiable.md).[getInstance](Instantiable.md#getinstance) + +#### Defined in + +[src/Instantiable.abstract.ts:86](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L86) + +--- + +### getServicePlugin + +▸ `Static` `Protected` **getServicePlugin**(`config`): `Object` + +Initializes the default Nevermined service plugins and return that instance + +#### Parameters + +| Name | Type | Description | +| :------- | :---------------------------------------------------------- | :---------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | Nevermined config | + +#### Returns + +`Object` + +The Nevermined Service Plugin instance + +| Name | Type | +| :------------ | :------------------------------------------------------------------------------------------------------------ | +| `aave-credit` | [`ServicePlugin`](../interfaces/ServicePlugin.md)<[`ServiceAaveCredit`](../interfaces/ServiceAaveCredit.md)\> | +| `access` | [`AccessService`](AccessService.md) | +| `compute` | [`EscrowComputeExecutionTemplate`](EscrowComputeExecutionTemplate.md) | +| `nft-access` | [`NFTAccessService`](NFTAccessService.md) | +| `nft-sales` | [`NFTSalesService`](NFTSalesService.md) | + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:618](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L618) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/RewardsDistributor.md b/docs/api-reference/classes/RewardsDistributor.md new file mode 100644 index 000000000..39a823b03 --- /dev/null +++ b/docs/api-reference/classes/RewardsDistributor.md @@ -0,0 +1,599 @@ +[@nevermined-io/sdk](../code-reference.md) / RewardsDistributor + +# Class: RewardsDistributor + +## Hierarchy + +- [`ContractBase`](ContractBase.md) + + ↳ **`RewardsDistributor`** + +## Table of contents + +### Constructors + +- [constructor](RewardsDistributor.md#constructor) + +### Properties + +- [address](RewardsDistributor.md#address) +- [contract](RewardsDistributor.md#contract) +- [contractName](RewardsDistributor.md#contractname) +- [events](RewardsDistributor.md#events) +- [version](RewardsDistributor.md#version) + +### Accessors + +- [artifactsFolder](RewardsDistributor.md#artifactsfolder) +- [circuitsFolder](RewardsDistributor.md#circuitsfolder) +- [config](RewardsDistributor.md#config) +- [instanceConfig](RewardsDistributor.md#instanceconfig) +- [instantiableConfig](RewardsDistributor.md#instantiableconfig) +- [logger](RewardsDistributor.md#logger) +- [nevermined](RewardsDistributor.md#nevermined) +- [web3](RewardsDistributor.md#web3) + +### Methods + +- [call](RewardsDistributor.md#call) +- [claimReward](RewardsDistributor.md#claimreward) +- [getFromAddress](RewardsDistributor.md#getfromaddress) +- [getInputsOfMethod](RewardsDistributor.md#getinputsofmethod) +- [getSignatureOfMethod](RewardsDistributor.md#getsignatureofmethod) +- [init](RewardsDistributor.md#init) +- [send](RewardsDistributor.md#send) +- [sendFrom](RewardsDistributor.md#sendfrom) +- [setInstanceConfig](RewardsDistributor.md#setinstanceconfig) +- [setReceivers](RewardsDistributor.md#setreceivers) +- [getInstance](RewardsDistributor.md#getinstance) +- [setInstanceConfig](RewardsDistributor.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new RewardsDistributor**(`contractName`) + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Inherited from + +[ContractBase](ContractBase.md).[constructor](ContractBase.md#constructor) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L34) + +## Properties + +### address + +• **address**: `string` + +#### Inherited from + +[ContractBase](ContractBase.md).[address](ContractBase.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[ContractBase](ContractBase.md).[contract](ContractBase.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[ContractBase](ContractBase.md).[contractName](ContractBase.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[ContractBase](ContractBase.md).[events](ContractBase.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[ContractBase](ContractBase.md).[version](ContractBase.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ContractBase.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ContractBase.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +ContractBase.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ContractBase.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ContractBase.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +ContractBase.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +ContractBase.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +ContractBase.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### 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](ContractBase.md).[call](ContractBase.md#call) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### claimReward + +▸ **claimReward**(`agreementId`, `did`, `amounts`, `receivers`, `returnAddress`, `lockPaymentAddress`, `tokenAddress`, `lockCondition`, `releaseConditions`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------- | +| `agreementId` | `string` | +| `did` | `string` | +| `amounts` | `bigint`[] | +| `receivers` | `string`[] | +| `returnAddress` | `string` | +| `lockPaymentAddress` | `string` | +| `tokenAddress` | `string` | +| `lockCondition` | `string` | +| `releaseConditions` | `string`[] | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Defined in + +[src/keeper/contracts/royalties/RewardsDistributor.ts:19](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/royalties/RewardsDistributor.ts#L19) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ContractBase](ContractBase.md).[getFromAddress](ContractBase.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[ContractBase](ContractBase.md).[getInputsOfMethod](ContractBase.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[ContractBase](ContractBase.md).[getSignatureOfMethod](ContractBase.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[ContractBase](ContractBase.md).[init](ContractBase.md#init) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ContractBase](ContractBase.md).[send](ContractBase.md#send) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ContractBase](ContractBase.md).[sendFrom](ContractBase.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ContractBase](ContractBase.md).[setInstanceConfig](ContractBase.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### setReceivers + +▸ **setReceivers**(`did`, `addr`, `from?`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :-------- | :---------------------------------------------- | +| `did` | `string` | +| `addr` | `string`[] | +| `from?` | [`Account`](Account.md) | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Defined in + +[src/keeper/contracts/royalties/RewardsDistributor.ts:16](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/royalties/RewardsDistributor.ts#L16) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`): `Promise`<[`RewardsDistributor`](RewardsDistributor.md)\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`Promise`<[`RewardsDistributor`](RewardsDistributor.md)\> + +#### Overrides + +[ContractBase](ContractBase.md).[getInstance](ContractBase.md#getinstance) + +#### Defined in + +[src/keeper/contracts/royalties/RewardsDistributor.ts:7](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/royalties/RewardsDistributor.ts#L7) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ContractBase](ContractBase.md).[setInstanceConfig](ContractBase.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/RoyaltyScheme.md b/docs/api-reference/classes/RoyaltyScheme.md new file mode 100644 index 000000000..19df0d93e --- /dev/null +++ b/docs/api-reference/classes/RoyaltyScheme.md @@ -0,0 +1,596 @@ +[@nevermined-io/sdk](../code-reference.md) / RoyaltyScheme + +# Class: RoyaltyScheme + +## Hierarchy + +- [`ContractBase`](ContractBase.md) + + ↳ **`RoyaltyScheme`** + + ↳↳ [`StandardRoyalties`](StandardRoyalties.md) + + ↳↳ [`CurveRoyalties`](CurveRoyalties.md) + +## Table of contents + +### Constructors + +- [constructor](RoyaltyScheme.md#constructor) + +### Properties + +- [address](RoyaltyScheme.md#address) +- [contract](RoyaltyScheme.md#contract) +- [contractName](RoyaltyScheme.md#contractname) +- [events](RoyaltyScheme.md#events) +- [version](RoyaltyScheme.md#version) + +### Accessors + +- [artifactsFolder](RoyaltyScheme.md#artifactsfolder) +- [circuitsFolder](RoyaltyScheme.md#circuitsfolder) +- [config](RoyaltyScheme.md#config) +- [instanceConfig](RoyaltyScheme.md#instanceconfig) +- [instantiableConfig](RoyaltyScheme.md#instantiableconfig) +- [logger](RoyaltyScheme.md#logger) +- [nevermined](RoyaltyScheme.md#nevermined) +- [web3](RoyaltyScheme.md#web3) + +### Methods + +- [call](RoyaltyScheme.md#call) +- [getFromAddress](RoyaltyScheme.md#getfromaddress) +- [getInputsOfMethod](RoyaltyScheme.md#getinputsofmethod) +- [getRoyalty](RoyaltyScheme.md#getroyalty) +- [getSignatureOfMethod](RoyaltyScheme.md#getsignatureofmethod) +- [init](RoyaltyScheme.md#init) +- [send](RoyaltyScheme.md#send) +- [sendFrom](RoyaltyScheme.md#sendfrom) +- [setInstanceConfig](RoyaltyScheme.md#setinstanceconfig) +- [setRoyalty](RoyaltyScheme.md#setroyalty) +- [getInstance](RoyaltyScheme.md#getinstance) +- [setInstanceConfig](RoyaltyScheme.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new RoyaltyScheme**(`contractName`) + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Inherited from + +[ContractBase](ContractBase.md).[constructor](ContractBase.md#constructor) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L34) + +## Properties + +### address + +• **address**: `string` + +#### Inherited from + +[ContractBase](ContractBase.md).[address](ContractBase.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[ContractBase](ContractBase.md).[contract](ContractBase.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[ContractBase](ContractBase.md).[contractName](ContractBase.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[ContractBase](ContractBase.md).[events](ContractBase.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[ContractBase](ContractBase.md).[version](ContractBase.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ContractBase.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ContractBase.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +ContractBase.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ContractBase.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ContractBase.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +ContractBase.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +ContractBase.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +ContractBase.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### 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](ContractBase.md).[call](ContractBase.md#call) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ContractBase](ContractBase.md).[getFromAddress](ContractBase.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[ContractBase](ContractBase.md).[getInputsOfMethod](ContractBase.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getRoyalty + +▸ **getRoyalty**(`did`): `Promise`<`number`\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `did` | `string` | + +#### Returns + +`Promise`<`number`\> + +#### Defined in + +[src/keeper/contracts/royalties/RoyaltyScheme.abstract.ts:26](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/royalties/RoyaltyScheme.abstract.ts#L26) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[ContractBase](ContractBase.md).[getSignatureOfMethod](ContractBase.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[ContractBase](ContractBase.md).[init](ContractBase.md#init) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ContractBase](ContractBase.md).[send](ContractBase.md#send) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ContractBase](ContractBase.md).[sendFrom](ContractBase.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ContractBase](ContractBase.md).[setInstanceConfig](ContractBase.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### setRoyalty + +▸ **setRoyalty**(`did`, `amount`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :---------- | :---------------------------------------------- | +| `did` | `string` | +| `amount` | `number` | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Defined in + +[src/keeper/contracts/royalties/RoyaltyScheme.abstract.ts:22](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/royalties/RoyaltyScheme.abstract.ts#L22) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`, `schemeName`, `schemeClass`, `optional?`): `Promise`<`any`\> + +#### Parameters + +| Name | Type | Default value | +| :------------ | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `schemeName` | `string` | `undefined` | +| `schemeClass` | `any` | `undefined` | +| `optional` | `boolean` | `true` | + +#### Returns + +`Promise`<`any`\> + +#### Overrides + +[ContractBase](ContractBase.md).[getInstance](ContractBase.md#getinstance) + +#### Defined in + +[src/keeper/contracts/royalties/RoyaltyScheme.abstract.ts:7](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/royalties/RoyaltyScheme.abstract.ts#L7) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ContractBase](ContractBase.md).[setInstanceConfig](ContractBase.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/SearchApi.md b/docs/api-reference/classes/SearchApi.md new file mode 100644 index 000000000..58bb01954 --- /dev/null +++ b/docs/api-reference/classes/SearchApi.md @@ -0,0 +1,621 @@ +[@nevermined-io/sdk](../code-reference.md) / SearchApi + +# Class: SearchApi + +Nevermined Search API. It allows the search of assets registered in Nevermined ecosystems. +You can find more information about Nevermined Metadata here: +[https://docs.nevermined.io/docs/architecture/nevermined-data](https://docs.nevermined.io/docs/architecture/nevermined-data) + +## Hierarchy + +- [`Instantiable`](Instantiable.md) + + ↳ **`SearchApi`** + +## Table of contents + +### Constructors + +- [constructor](SearchApi.md#constructor) + +### Accessors + +- [artifactsFolder](SearchApi.md#artifactsfolder) +- [circuitsFolder](SearchApi.md#circuitsfolder) +- [config](SearchApi.md#config) +- [instanceConfig](SearchApi.md#instanceconfig) +- [instantiableConfig](SearchApi.md#instantiableconfig) +- [logger](SearchApi.md#logger) +- [nevermined](SearchApi.md#nevermined) +- [web3](SearchApi.md#web3) + +### Methods + +- [byDID](SearchApi.md#bydid) +- [byPrice](SearchApi.md#byprice) +- [bySubscriptionContractAddress](SearchApi.md#bysubscriptioncontractaddress) +- [byText](SearchApi.md#bytext) +- [datasetsByNftContract](SearchApi.md#datasetsbynftcontract) +- [datasetsBySubscription](SearchApi.md#datasetsbysubscription) +- [query](SearchApi.md#query) +- [servicesByNftContract](SearchApi.md#servicesbynftcontract) +- [servicesBySubscription](SearchApi.md#servicesbysubscription) +- [setInstanceConfig](SearchApi.md#setinstanceconfig) +- [subscriptionsCreated](SearchApi.md#subscriptionscreated) +- [subscriptionsPurchased](SearchApi.md#subscriptionspurchased) +- [getInstance](SearchApi.md#getinstance) +- [setInstanceConfig](SearchApi.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new SearchApi**(`config`) + +Creates a new SearchApi + +#### Parameters + +| Name | Type | Description | +| :------- | :---------------------------------------------------------- | :--------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | Configuration of the Nevermined instance | + +#### Overrides + +[Instantiable](Instantiable.md).[constructor](Instantiable.md#constructor) + +#### Defined in + +[src/nevermined/api/SearchApi.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/SearchApi.ts#L32) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +Instantiable.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +Instantiable.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +Instantiable.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +Instantiable.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### byDID + +▸ **byDID**(`did?`, `metadataServiceEndpoint?`): `Promise`<[`DDO`](DDO.md)\> + +Search over the assets using a keyword. + +#### Parameters + +| Name | Type | Description | +| :------------------------- | :-------------------------- | :------------------------- | +| `did?` | `string` \| [`DID`](DID.md) | DID of the asset. | +| `metadataServiceEndpoint?` | `string` | Metadata service endpoint. | + +#### Returns + +`Promise`<[`DDO`](DDO.md)\> + +DDO of the asset. + +#### Defined in + +[src/nevermined/api/SearchApi.ts:43](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/SearchApi.ts#L43) + +--- + +### byPrice + +▸ **byPrice**(`minPrice`, `maxPrice`, `serviceType?`, `offset?`, `page?`, `sort?`, `appId?`): `Promise`<[`QueryResult`](../interfaces/QueryResult.md)\> + +Query for assets by price. + +#### Parameters + +| Name | Type | Default value | Description | +| :------------- | :------------------------------------------------ | :------------ | :------------------------------------------------- | +| `minPrice` | `number` | `undefined` | The minimum price to search for. | +| `maxPrice` | `number` | `undefined` | The maximum price to search for. | +| `serviceType?` | [`ServiceType`](../code-reference.md#servicetype) | `undefined` | The name of the service. Defaults to all services. | +| `offset` | `number` | `100` | | +| `page` | `number` | `1` | | +| `sort` | `string` | `'desc'` | | +| `appId?` | `string` | `undefined` | | + +#### Returns + +`Promise`<[`QueryResult`](../interfaces/QueryResult.md)\> + +**`Example`** + +```ts +const results = await nevermined.search.byPrice(1, 20) +``` + +#### Defined in + +[src/nevermined/api/SearchApi.ts:112](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/SearchApi.ts#L112) + +--- + +### bySubscriptionContractAddress + +▸ **bySubscriptionContractAddress**(`contractAddress`, `nftType`, `customNestedQueries?`, `offset?`, `page?`, `sort?`, `appId?`): `Promise`<[`QueryResult`](../interfaces/QueryResult.md)\> + +Search for all subscription DDOs with `contractAddress` + +#### Parameters + +| Name | Type | Default value | Description | +| :--------------------- | :---------- | :------------ | :----------------------------------------- | +| `contractAddress` | `string` | `undefined` | The address of the subscription contract | +| `nftType` | `string` | `undefined` | The nftType | +| `customNestedQueries?` | `unknown`[] | `undefined` | Custom nested queries to add to the search | +| `offset` | `number` | `100` | The number of results to return | +| `page` | `number` | `1` | | +| `sort` | `string` | `'desc'` | The sort order | +| `appId?` | `string` | `undefined` | The appId used to filter the results | + +#### Returns + +`Promise`<[`QueryResult`](../interfaces/QueryResult.md)\> + +Promise + +#### Defined in + +[src/nevermined/api/SearchApi.ts:165](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/SearchApi.ts#L165) + +--- + +### byText + +▸ **byText**(`text`, `offset?`, `page?`, `sort?`, `appId?`): `Promise`<[`QueryResult`](../interfaces/QueryResult.md)\> + +Search over the assets using a keyword. + +#### Parameters + +| Name | Type | Default value | Description | +| :------- | :------- | :------------ | :------------------------- | +| `text` | `string` | `undefined` | Text to filter the assets. | +| `offset` | `number` | `100` | - | +| `page` | `number` | `1` | - | +| `sort` | `string` | `'desc'` | - | +| `appId?` | `string` | `undefined` | - | + +#### Returns + +`Promise`<[`QueryResult`](../interfaces/QueryResult.md)\> + +A list of [DDO](DDO.md)s. + +#### Defined in + +[src/nevermined/api/SearchApi.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/SearchApi.ts#L80) + +--- + +### datasetsByNftContract + +▸ **datasetsByNftContract**(`nftContractAddress`, `nftType?`, `tokenId?`, `customNestedQueries?`, `offset?`, `page?`, `sort?`, `appId?`): `Promise`<[`QueryResult`](../interfaces/QueryResult.md)\> + +Search of all datasets belonging to a subscription NFT contract + +#### Parameters + +| Name | Type | Default value | Description | +| :--------------------- | :------------------------------------------------------------------------------------------------------------------------- | :------------ | :----------------------------------------- | +| `nftContractAddress` | `string` | `undefined` | The DID of the subscription. | +| `nftType?` | [`NeverminedNFT721Type`](../enums/NeverminedNFT721Type.md) \| [`NeverminedNFT1155Type`](../enums/NeverminedNFT1155Type.md) | `undefined` | - | +| `tokenId?` | `string` | `undefined` | - | +| `customNestedQueries?` | `unknown`[] | `undefined` | Custom nested queries to add to the search | +| `offset` | `number` | `100` | The number of results to return | +| `page` | `number` | `1` | | +| `sort` | `string` | `'desc'` | The sort order | +| `appId?` | `string` | `undefined` | The appId used to filter the results | + +#### Returns + +`Promise`<[`QueryResult`](../interfaces/QueryResult.md)\> + +Promise + +#### Defined in + +[src/nevermined/api/SearchApi.ts:634](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/SearchApi.ts#L634) + +--- + +### datasetsBySubscription + +▸ **datasetsBySubscription**(`subscriptionDid`, `nftType?`, `customNestedQueries?`, `offset?`, `page?`, `sort?`, `appId?`): `Promise`<[`QueryResult`](../interfaces/QueryResult.md)\> + +Search of all datasets belonging to a subscription + +#### Parameters + +| Name | Type | Default value | Description | +| :--------------------- | :------------------------------------------------------------------------------------------------------------------------- | :------------ | :----------------------------------------- | +| `subscriptionDid` | `string` | `undefined` | The DID of the subscription. | +| `nftType?` | [`NeverminedNFT721Type`](../enums/NeverminedNFT721Type.md) \| [`NeverminedNFT1155Type`](../enums/NeverminedNFT1155Type.md) | `undefined` | - | +| `customNestedQueries?` | `unknown`[] | `undefined` | Custom nested queries to add to the search | +| `offset` | `number` | `100` | The number of results to return | +| `page` | `number` | `1` | | +| `sort` | `string` | `'desc'` | The sort order | +| `appId?` | `string` | `undefined` | The appId used to filter the results | + +#### Returns + +`Promise`<[`QueryResult`](../interfaces/QueryResult.md)\> + +Promise + +#### Defined in + +[src/nevermined/api/SearchApi.ts:744](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/SearchApi.ts#L744) + +--- + +### query + +▸ **query**(`query`): `Promise`<[`QueryResult`](../interfaces/QueryResult.md)\> + +Search over the assets using a query. + +#### Parameters + +| Name | Type | Description | +| :------ | :-------------------------------------------- | :-------------------------- | +| `query` | [`SearchQuery`](../interfaces/SearchQuery.md) | Query to filter the assets. | + +#### Returns + +`Promise`<[`QueryResult`](../interfaces/QueryResult.md)\> + +A list of [DDO](DDO.md)s matching the query + +**`Remarks`** + +If the `appId` is set in the search query results will be filtered +returning only DDOs for that appId + +#### Defined in + +[src/nevermined/api/SearchApi.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/SearchApi.ts#L57) + +--- + +### servicesByNftContract + +▸ **servicesByNftContract**(`nftContractAddress`, `nftType?`, `tokenId?`, `customNestedQueries?`, `offset?`, `page?`, `sort?`, `appId?`): `Promise`<[`QueryResult`](../interfaces/QueryResult.md)\> + +Search of all services belonging to a subscription nft contract + +#### Parameters + +| Name | Type | Default value | Description | +| :--------------------- | :------------------------------------------------------------------------------------------------------------------------- | :------------ | :-------------------------------------------- | +| `nftContractAddress` | `string` | `undefined` | The NFT contract address of the subscription. | +| `nftType?` | [`NeverminedNFT721Type`](../enums/NeverminedNFT721Type.md) \| [`NeverminedNFT1155Type`](../enums/NeverminedNFT1155Type.md) | `undefined` | - | +| `tokenId?` | `string` | `undefined` | - | +| `customNestedQueries?` | `unknown`[] | `undefined` | Custom nested queries to add to the search | +| `offset` | `number` | `100` | The number of results to return | +| `page` | `number` | `1` | | +| `sort` | `string` | `'desc'` | The sort order | +| `appId?` | `string` | `undefined` | The appId used to filter the results | + +#### Returns + +`Promise`<[`QueryResult`](../interfaces/QueryResult.md)\> + +Promise + +#### Defined in + +[src/nevermined/api/SearchApi.ts:474](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/SearchApi.ts#L474) + +--- + +### servicesBySubscription + +▸ **servicesBySubscription**(`subscriptionDid`, `nftType?`, `customNestedQueries?`, `offset?`, `page?`, `sort?`, `appId?`): `Promise`<[`QueryResult`](../interfaces/QueryResult.md)\> + +Search of all services belonging to a subscription + +#### Parameters + +| Name | Type | Default value | Description | +| :--------------------- | :------------------------------------------------------------------------------------------------------------------------- | :------------ | :----------------------------------------- | +| `subscriptionDid` | `string` | `undefined` | The DID of the subscription. | +| `nftType?` | [`NeverminedNFT721Type`](../enums/NeverminedNFT721Type.md) \| [`NeverminedNFT1155Type`](../enums/NeverminedNFT1155Type.md) | `undefined` | - | +| `customNestedQueries?` | `unknown`[] | `undefined` | Custom nested queries to add to the search | +| `offset` | `number` | `100` | The number of results to return | +| `page` | `number` | `1` | | +| `sort` | `string` | `'desc'` | The sort order | +| `appId?` | `string` | `undefined` | The appId used to filter the results | + +#### Returns + +`Promise`<[`QueryResult`](../interfaces/QueryResult.md)\> + +Promise + +#### Defined in + +[src/nevermined/api/SearchApi.ts:584](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/SearchApi.ts#L584) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### subscriptionsCreated + +▸ **subscriptionsCreated**(`account`, `nftType?`, `customNestedQueries?`, `offset?`, `page?`, `sort?`, `appId?`): `Promise`<[`QueryResult`](../interfaces/QueryResult.md)\> + +Search of all subscriptions created by `account` + +#### Parameters + +| Name | Type | Default value | Description | +| :--------------------- | :------------------------------------------------------------------------------------------------------------------------- | :------------ | :------------------------------------------ | +| `account` | [`Account`](Account.md) | `undefined` | The account that created the subscriptions. | +| `nftType?` | [`NeverminedNFT721Type`](../enums/NeverminedNFT721Type.md) \| [`NeverminedNFT1155Type`](../enums/NeverminedNFT1155Type.md) | `undefined` | The nftType | +| `customNestedQueries?` | `unknown`[] | `undefined` | Custom nested queries to add to the search | +| `offset` | `number` | `100` | The number of results to return | +| `page` | `number` | `1` | | +| `sort` | `string` | `'desc'` | The sort order | +| `appId?` | `string` | `undefined` | The appId used to filter the results | + +#### Returns + +`Promise`<[`QueryResult`](../interfaces/QueryResult.md)\> + +Promise + +#### Defined in + +[src/nevermined/api/SearchApi.ts:264](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/SearchApi.ts#L264) + +--- + +### subscriptionsPurchased + +▸ **subscriptionsPurchased**(`account`, `nftType?`, `ercType?`, `customNestedQueries?`, `offset?`, `page?`, `sort?`, `appId?`): `Promise`<[`QueryResult`](../interfaces/QueryResult.md)\> + +Search of all subscriptions purchased by `account` + +#### Parameters + +| Name | Type | Default value | Description | +| :--------------------- | :------------------------------------------------------------------------------------------------------------------------- | :------------ | :-------------------------------------------- | +| `account` | [`Account`](Account.md) | `undefined` | The account that purchased the subscriptions. | +| `nftType?` | [`NeverminedNFT721Type`](../enums/NeverminedNFT721Type.md) \| [`NeverminedNFT1155Type`](../enums/NeverminedNFT1155Type.md) | `undefined` | The nftType | +| `ercType?` | `721` \| `1155` | `undefined` | - | +| `customNestedQueries?` | `unknown`[] | `undefined` | Custom nested queries to add to the search | +| `offset` | `number` | `100` | The number of results to return | +| `page` | `number` | `1` | | +| `sort` | `string` | `'desc'` | The sort order | +| `appId?` | `string` | `undefined` | The appId used to filter the results | + +#### Returns + +`Promise`<[`QueryResult`](../interfaces/QueryResult.md)\> + +Promise + +#### Defined in + +[src/nevermined/api/SearchApi.ts:356](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/SearchApi.ts#L356) + +--- + +### getInstance + +▸ `Static` **getInstance**(`..._args`): `any` + +#### Parameters + +| Name | Type | +| :--------- | :---- | +| `..._args` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[Instantiable](Instantiable.md).[getInstance](Instantiable.md#getinstance) + +#### Defined in + +[src/Instantiable.abstract.ts:86](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L86) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/ServiceAgreement.md b/docs/api-reference/classes/ServiceAgreement.md new file mode 100644 index 000000000..33ee9cd45 --- /dev/null +++ b/docs/api-reference/classes/ServiceAgreement.md @@ -0,0 +1,373 @@ +[@nevermined-io/sdk](../code-reference.md) / ServiceAgreement + +# Class: ServiceAgreement + +## Hierarchy + +- [`Instantiable`](Instantiable.md) + + ↳ **`ServiceAgreement`** + +## Table of contents + +### Constructors + +- [constructor](ServiceAgreement.md#constructor) + +### Accessors + +- [artifactsFolder](ServiceAgreement.md#artifactsfolder) +- [circuitsFolder](ServiceAgreement.md#circuitsfolder) +- [config](ServiceAgreement.md#config) +- [instanceConfig](ServiceAgreement.md#instanceconfig) +- [instantiableConfig](ServiceAgreement.md#instantiableconfig) +- [logger](ServiceAgreement.md#logger) +- [nevermined](ServiceAgreement.md#nevermined) +- [web3](ServiceAgreement.md#web3) + +### Methods + +- [createHashSignature](ServiceAgreement.md#createhashsignature) +- [getTimeValuesFromService](ServiceAgreement.md#gettimevaluesfromservice) +- [hashServiceAgreement](ServiceAgreement.md#hashserviceagreement) +- [setInstanceConfig](ServiceAgreement.md#setinstanceconfig) +- [signServiceAgreement](ServiceAgreement.md#signserviceagreement) +- [getInstance](ServiceAgreement.md#getinstance) +- [setInstanceConfig](ServiceAgreement.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new ServiceAgreement**(`config`) + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Overrides + +[Instantiable](Instantiable.md).[constructor](Instantiable.md#constructor) + +#### Defined in + +[src/nevermined/utils/ServiceAgreement.ts:8](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/ServiceAgreement.ts#L8) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +Instantiable.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +Instantiable.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +Instantiable.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +Instantiable.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### createHashSignature + +▸ **createHashSignature**(`templateId`, `serviceAgreementId`, `valueHashes`, `timelockValues`, `timeoutValues`, `consumer`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------- | +| `templateId` | `string` | +| `serviceAgreementId` | `string` | +| `valueHashes` | `string`[] | +| `timelockValues` | `number`[] | +| `timeoutValues` | `number`[] | +| `consumer` | [`Account`](Account.md) | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/nevermined/utils/ServiceAgreement.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/ServiceAgreement.ts#L42) + +--- + +### getTimeValuesFromService + +▸ `Private` **getTimeValuesFromService**(`service`, `type`): `number`[] + +#### Parameters + +| Name | Type | +| :-------- | :------------------------------------------------ | +| `service` | [`ServiceAccess`](../interfaces/ServiceAccess.md) | +| `type` | `"timeout"` \| `"timelock"` | + +#### Returns + +`number`[] + +#### Defined in + +[src/nevermined/utils/ServiceAgreement.ts:86](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/ServiceAgreement.ts#L86) + +--- + +### hashServiceAgreement + +▸ **hashServiceAgreement**(`serviceAgreementTemplateId`, `serviceAgreementId`, `valueHashes`, `timelocks`, `timeouts`): `string` + +#### Parameters + +| Name | Type | +| :--------------------------- | :--------- | +| `serviceAgreementTemplateId` | `string` | +| `serviceAgreementId` | `string` | +| `valueHashes` | `string`[] | +| `timelocks` | `number`[] | +| `timeouts` | `number`[] | + +#### Returns + +`string` + +#### Defined in + +[src/nevermined/utils/ServiceAgreement.ts:66](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/ServiceAgreement.ts#L66) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### signServiceAgreement + +▸ **signServiceAgreement**(`ddo`, `serviceType`, `serviceAgreementId`, `agreementConditionsIds`, `consumer`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :----------------------- | :------------------------------------------------ | +| `ddo` | [`DDO`](DDO.md) | +| `serviceType` | [`ServiceType`](../code-reference.md#servicetype) | +| `serviceAgreementId` | `string` | +| `agreementConditionsIds` | `string`[] | +| `consumer` | [`Account`](Account.md) | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/nevermined/utils/ServiceAgreement.ts:13](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/ServiceAgreement.ts#L13) + +--- + +### getInstance + +▸ `Static` **getInstance**(`..._args`): `any` + +#### Parameters + +| Name | Type | +| :--------- | :---- | +| `..._args` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[Instantiable](Instantiable.md).[getInstance](Instantiable.md#getinstance) + +#### Defined in + +[src/Instantiable.abstract.ts:86](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L86) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/ServicesApi.md b/docs/api-reference/classes/ServicesApi.md new file mode 100644 index 000000000..84ad5b9da --- /dev/null +++ b/docs/api-reference/classes/ServicesApi.md @@ -0,0 +1,388 @@ +[@nevermined-io/sdk](../code-reference.md) / ServicesApi + +# Class: ServicesApi + +Utils internal submodule of Nevermined. + +## Hierarchy + +- [`Instantiable`](Instantiable.md) + + ↳ **`ServicesApi`** + +## Table of contents + +### Constructors + +- [constructor](ServicesApi.md#constructor) + +### Properties + +- [aave](ServicesApi.md#aave) +- [bookmarks](ServicesApi.md#bookmarks) +- [marketplace](ServicesApi.md#marketplace) +- [metadata](ServicesApi.md#metadata) +- [node](ServicesApi.md#node) +- [permissions](ServicesApi.md#permissions) +- [profiles](ServicesApi.md#profiles) + +### Accessors + +- [artifactsFolder](ServicesApi.md#artifactsfolder) +- [circuitsFolder](ServicesApi.md#circuitsfolder) +- [config](ServicesApi.md#config) +- [instanceConfig](ServicesApi.md#instanceconfig) +- [instantiableConfig](ServicesApi.md#instantiableconfig) +- [logger](ServicesApi.md#logger) +- [nevermined](ServicesApi.md#nevermined) +- [web3](ServicesApi.md#web3) + +### Methods + +- [initializeAave](ServicesApi.md#initializeaave) +- [setInstanceConfig](ServicesApi.md#setinstanceconfig) +- [getInstance](ServicesApi.md#getinstance) +- [setInstanceConfig](ServicesApi.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new ServicesApi**(`config`) + +Creates a new ServicesApi + +#### Parameters + +| Name | Type | Description | +| :------- | :---------------------------------------------------------- | :--------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | Configuration of the Nevermined instance | + +#### Overrides + +[Instantiable](Instantiable.md).[constructor](Instantiable.md#constructor) + +#### Defined in + +[src/nevermined/api/ServicesApi.ts:56](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/ServicesApi.ts#L56) + +## Properties + +### aave + +• **aave**: [`AaveCredit`](AaveCredit.md) + +Aave instance. + +#### Defined in + +[src/nevermined/api/ServicesApi.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/ServicesApi.ts#L49) + +--- + +### bookmarks + +• **bookmarks**: [`Bookmarks`](Bookmarks.md) + +Bookmarks instance + +#### Defined in + +[src/nevermined/api/ServicesApi.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/ServicesApi.ts#L44) + +--- + +### marketplace + +• **marketplace**: [`MarketplaceApi`](MarketplaceApi.md) + +Nevermined Node Service + +#### Defined in + +[src/nevermined/api/ServicesApi.ts:24](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/ServicesApi.ts#L24) + +--- + +### metadata + +• **metadata**: [`MetadataService`](MetadataService.md) + +Marketplace instance. + +#### Defined in + +[src/nevermined/api/ServicesApi.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/ServicesApi.ts#L29) + +--- + +### node + +• **node**: [`NeverminedNode`](NeverminedNode.md) + +Nevermined Node Service + +#### Defined in + +[src/nevermined/api/ServicesApi.ts:19](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/ServicesApi.ts#L19) + +--- + +### permissions + +• **permissions**: [`Permissions`](Permissions.md) + +Permissions service + +#### Defined in + +[src/nevermined/api/ServicesApi.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/ServicesApi.ts#L34) + +--- + +### profiles + +• **profiles**: [`Profiles`](Profiles.md) + +Profiles instance + +#### Defined in + +[src/nevermined/api/ServicesApi.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/ServicesApi.ts#L39) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +Instantiable.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +Instantiable.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +Instantiable.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +Instantiable.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### initializeAave + +▸ **initializeAave**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[src/nevermined/api/ServicesApi.ts:68](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/ServicesApi.ts#L68) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### getInstance + +▸ `Static` **getInstance**(`..._args`): `any` + +#### Parameters + +| Name | Type | +| :--------- | :---- | +| `..._args` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[Instantiable](Instantiable.md).[getInstance](Instantiable.md#getinstance) + +#### Defined in + +[src/Instantiable.abstract.ts:86](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L86) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/SignatureUtils.md b/docs/api-reference/classes/SignatureUtils.md new file mode 100644 index 000000000..6cf618b09 --- /dev/null +++ b/docs/api-reference/classes/SignatureUtils.md @@ -0,0 +1,340 @@ +[@nevermined-io/sdk](../code-reference.md) / SignatureUtils + +# Class: SignatureUtils + +## Hierarchy + +- [`Instantiable`](Instantiable.md) + + ↳ **`SignatureUtils`** + +## Table of contents + +### Constructors + +- [constructor](SignatureUtils.md#constructor) + +### Accessors + +- [artifactsFolder](SignatureUtils.md#artifactsfolder) +- [circuitsFolder](SignatureUtils.md#circuitsfolder) +- [config](SignatureUtils.md#config) +- [instanceConfig](SignatureUtils.md#instanceconfig) +- [instantiableConfig](SignatureUtils.md#instantiableconfig) +- [logger](SignatureUtils.md#logger) +- [nevermined](SignatureUtils.md#nevermined) +- [web3](SignatureUtils.md#web3) + +### Methods + +- [setInstanceConfig](SignatureUtils.md#setinstanceconfig) +- [signText](SignatureUtils.md#signtext) +- [verifyText](SignatureUtils.md#verifytext) +- [getInstance](SignatureUtils.md#getinstance) +- [hash](SignatureUtils.md#hash) +- [setInstanceConfig](SignatureUtils.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new SignatureUtils**(`config`) + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Overrides + +[Instantiable](Instantiable.md).[constructor](Instantiable.md#constructor) + +#### Defined in + +[src/nevermined/utils/SignatureUtils.ts:5](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/SignatureUtils.ts#L5) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +Instantiable.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +Instantiable.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +Instantiable.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +Instantiable.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### signText + +▸ **signText**(`text`, `address`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :----------------------- | +| `text` | `string` \| `Uint8Array` | +| `address` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/nevermined/utils/SignatureUtils.ts:10](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/SignatureUtils.ts#L10) + +--- + +### verifyText + +▸ **verifyText**(`text`, `signature`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :---------- | :------- | +| `text` | `string` | +| `signature` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/nevermined/utils/SignatureUtils.ts:22](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/SignatureUtils.ts#L22) + +--- + +### getInstance + +▸ `Static` **getInstance**(`..._args`): `any` + +#### Parameters + +| Name | Type | +| :--------- | :---- | +| `..._args` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[Instantiable](Instantiable.md).[getInstance](Instantiable.md#getinstance) + +#### Defined in + +[src/Instantiable.abstract.ts:86](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L86) + +--- + +### hash + +▸ `Static` **hash**(`seed`): `string` + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `seed` | `string` | + +#### Returns + +`string` + +#### Defined in + +[src/nevermined/utils/SignatureUtils.ts:26](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/SignatureUtils.ts#L26) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/StandardRoyalties.md b/docs/api-reference/classes/StandardRoyalties.md new file mode 100644 index 000000000..d9bed58fe --- /dev/null +++ b/docs/api-reference/classes/StandardRoyalties.md @@ -0,0 +1,597 @@ +[@nevermined-io/sdk](../code-reference.md) / StandardRoyalties + +# Class: StandardRoyalties + +## Hierarchy + +- [`RoyaltyScheme`](RoyaltyScheme.md) + + ↳ **`StandardRoyalties`** + +## Table of contents + +### Constructors + +- [constructor](StandardRoyalties.md#constructor) + +### Properties + +- [address](StandardRoyalties.md#address) +- [contract](StandardRoyalties.md#contract) +- [contractName](StandardRoyalties.md#contractname) +- [events](StandardRoyalties.md#events) +- [version](StandardRoyalties.md#version) + +### Accessors + +- [artifactsFolder](StandardRoyalties.md#artifactsfolder) +- [circuitsFolder](StandardRoyalties.md#circuitsfolder) +- [config](StandardRoyalties.md#config) +- [instanceConfig](StandardRoyalties.md#instanceconfig) +- [instantiableConfig](StandardRoyalties.md#instantiableconfig) +- [logger](StandardRoyalties.md#logger) +- [nevermined](StandardRoyalties.md#nevermined) +- [web3](StandardRoyalties.md#web3) + +### Methods + +- [call](StandardRoyalties.md#call) +- [getFromAddress](StandardRoyalties.md#getfromaddress) +- [getInputsOfMethod](StandardRoyalties.md#getinputsofmethod) +- [getRoyalty](StandardRoyalties.md#getroyalty) +- [getSignatureOfMethod](StandardRoyalties.md#getsignatureofmethod) +- [init](StandardRoyalties.md#init) +- [send](StandardRoyalties.md#send) +- [sendFrom](StandardRoyalties.md#sendfrom) +- [setInstanceConfig](StandardRoyalties.md#setinstanceconfig) +- [setRoyalty](StandardRoyalties.md#setroyalty) +- [getInstance](StandardRoyalties.md#getinstance) +- [setInstanceConfig](StandardRoyalties.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new StandardRoyalties**(`contractName`) + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Inherited from + +[RoyaltyScheme](RoyaltyScheme.md).[constructor](RoyaltyScheme.md#constructor) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L34) + +## Properties + +### address + +• **address**: `string` + +#### Inherited from + +[RoyaltyScheme](RoyaltyScheme.md).[address](RoyaltyScheme.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[RoyaltyScheme](RoyaltyScheme.md).[contract](RoyaltyScheme.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[RoyaltyScheme](RoyaltyScheme.md).[contractName](RoyaltyScheme.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[RoyaltyScheme](RoyaltyScheme.md).[events](RoyaltyScheme.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[RoyaltyScheme](RoyaltyScheme.md).[version](RoyaltyScheme.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +RoyaltyScheme.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +RoyaltyScheme.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +RoyaltyScheme.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +RoyaltyScheme.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +RoyaltyScheme.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +RoyaltyScheme.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +RoyaltyScheme.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +RoyaltyScheme.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### 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 + +[RoyaltyScheme](RoyaltyScheme.md).[call](RoyaltyScheme.md#call) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[RoyaltyScheme](RoyaltyScheme.md).[getFromAddress](RoyaltyScheme.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[RoyaltyScheme](RoyaltyScheme.md).[getInputsOfMethod](RoyaltyScheme.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getRoyalty + +▸ **getRoyalty**(`did`): `Promise`<`number`\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `did` | `string` | + +#### Returns + +`Promise`<`number`\> + +#### Inherited from + +[RoyaltyScheme](RoyaltyScheme.md).[getRoyalty](RoyaltyScheme.md#getroyalty) + +#### Defined in + +[src/keeper/contracts/royalties/RoyaltyScheme.abstract.ts:26](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/royalties/RoyaltyScheme.abstract.ts#L26) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[RoyaltyScheme](RoyaltyScheme.md).[getSignatureOfMethod](RoyaltyScheme.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[RoyaltyScheme](RoyaltyScheme.md).[init](RoyaltyScheme.md#init) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[RoyaltyScheme](RoyaltyScheme.md).[send](RoyaltyScheme.md#send) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[RoyaltyScheme](RoyaltyScheme.md).[sendFrom](RoyaltyScheme.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[RoyaltyScheme](RoyaltyScheme.md).[setInstanceConfig](RoyaltyScheme.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### setRoyalty + +▸ **setRoyalty**(`did`, `amount`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :---------- | :---------------------------------------------- | +| `did` | `string` | +| `amount` | `number` | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[RoyaltyScheme](RoyaltyScheme.md).[setRoyalty](RoyaltyScheme.md#setroyalty) + +#### Defined in + +[src/keeper/contracts/royalties/RoyaltyScheme.abstract.ts:22](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/royalties/RoyaltyScheme.abstract.ts#L22) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`): `Promise`<[`StandardRoyalties`](StandardRoyalties.md)\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`Promise`<[`StandardRoyalties`](StandardRoyalties.md)\> + +#### Overrides + +[RoyaltyScheme](RoyaltyScheme.md).[getInstance](RoyaltyScheme.md#getinstance) + +#### Defined in + +[src/keeper/contracts/royalties/StandardRoyalties.ts:5](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/royalties/StandardRoyalties.ts#L5) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[RoyaltyScheme](RoyaltyScheme.md).[setInstanceConfig](RoyaltyScheme.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/SubgraphEvent.md b/docs/api-reference/classes/SubgraphEvent.md new file mode 100644 index 000000000..6a01098b5 --- /dev/null +++ b/docs/api-reference/classes/SubgraphEvent.md @@ -0,0 +1,444 @@ +[@nevermined-io/sdk](../code-reference.md) / SubgraphEvent + +# Class: SubgraphEvent + +## Hierarchy + +- [`NeverminedEvent`](NeverminedEvent.md) + + ↳ **`SubgraphEvent`** + +## Table of contents + +### Constructors + +- [constructor](SubgraphEvent.md#constructor) + +### Properties + +- [contract](SubgraphEvent.md#contract) +- [eventEmitter](SubgraphEvent.md#eventemitter) +- [subgraph](SubgraphEvent.md#subgraph) + +### Accessors + +- [artifactsFolder](SubgraphEvent.md#artifactsfolder) +- [circuitsFolder](SubgraphEvent.md#circuitsfolder) +- [config](SubgraphEvent.md#config) +- [instanceConfig](SubgraphEvent.md#instanceconfig) +- [instantiableConfig](SubgraphEvent.md#instantiableconfig) +- [logger](SubgraphEvent.md#logger) +- [nevermined](SubgraphEvent.md#nevermined) +- [web3](SubgraphEvent.md#web3) + +### Methods + +- [getBlockNumber](SubgraphEvent.md#getblocknumber) +- [getEventData](SubgraphEvent.md#geteventdata) +- [getPastEvents](SubgraphEvent.md#getpastevents) +- [once](SubgraphEvent.md#once) +- [setInstanceConfig](SubgraphEvent.md#setinstanceconfig) +- [subscribe](SubgraphEvent.md#subscribe) +- [getInstance](SubgraphEvent.md#getinstance) +- [setInstanceConfig](SubgraphEvent.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• `Protected` **new SubgraphEvent**(`contract`, `eventEmitter`) + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `contract` | [`ContractBase`](ContractBase.md) | +| `eventEmitter` | [`EventEmitter`](../interfaces/EventEmitter.md) | + +#### Inherited from + +[NeverminedEvent](NeverminedEvent.md).[constructor](NeverminedEvent.md#constructor) + +#### Defined in + +[src/events/NeverminedEvent.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/NeverminedEvent.ts#L34) + +## Properties + +### contract + +• `Protected` **contract**: [`ContractBase`](ContractBase.md) = `null` + +#### Inherited from + +[NeverminedEvent](NeverminedEvent.md).[contract](NeverminedEvent.md#contract) + +#### Defined in + +[src/events/NeverminedEvent.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/NeverminedEvent.ts#L29) + +--- + +### eventEmitter + +• `Protected` **eventEmitter**: [`EventEmitter`](../interfaces/EventEmitter.md) + +#### Inherited from + +[NeverminedEvent](NeverminedEvent.md).[eventEmitter](NeverminedEvent.md#eventemitter) + +#### Defined in + +[src/events/NeverminedEvent.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/NeverminedEvent.ts#L28) + +--- + +### subgraph + +• **subgraph**: `ApolloClient`<`NormalizedCacheObject`\> + +#### Defined in + +[src/events/SubgraphEvent.ts:16](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/SubgraphEvent.ts#L16) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +NeverminedEvent.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +NeverminedEvent.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +NeverminedEvent.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +NeverminedEvent.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +NeverminedEvent.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +NeverminedEvent.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +NeverminedEvent.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +NeverminedEvent.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### getBlockNumber + +▸ **getBlockNumber**(): `Promise`<`number`\> + +#### Returns + +`Promise`<`number`\> + +#### Overrides + +[NeverminedEvent](NeverminedEvent.md).[getBlockNumber](NeverminedEvent.md#getblocknumber) + +#### Defined in + +[src/events/SubgraphEvent.ts:68](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/SubgraphEvent.ts#L68) + +--- + +### getEventData + +▸ **getEventData**(`options`): [`EventResult`](../code-reference.md#eventresult) + +#### Parameters + +| Name | Type | +| :-------- | :---------------------------------------------- | +| `options` | [`EventOptions`](../interfaces/EventOptions.md) | + +#### Returns + +[`EventResult`](../code-reference.md#eventresult) + +#### Overrides + +[NeverminedEvent](NeverminedEvent.md).[getEventData](NeverminedEvent.md#geteventdata) + +#### Defined in + +[src/events/SubgraphEvent.ts:46](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/SubgraphEvent.ts#L46) + +--- + +### getPastEvents + +▸ **getPastEvents**(`options`): [`EventResult`](../code-reference.md#eventresult) + +#### Parameters + +| Name | Type | +| :-------- | :---------------------------------------------- | +| `options` | [`EventOptions`](../interfaces/EventOptions.md) | + +#### Returns + +[`EventResult`](../code-reference.md#eventresult) + +#### Overrides + +[NeverminedEvent](NeverminedEvent.md).[getPastEvents](NeverminedEvent.md#getpastevents) + +#### Defined in + +[src/events/SubgraphEvent.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/SubgraphEvent.ts#L64) + +--- + +### once + +▸ **once**(`callback?`, `options?`): `Promise`<[`EventResult`](../code-reference.md#eventresult)\> + +#### Parameters + +| Name | Type | +| :---------- | :------------------------------------------------------------------------ | +| `callback?` | (`events`: [`EventResult`](../code-reference.md#eventresult)[]) => `void` | +| `options?` | [`EventOptions`](../interfaces/EventOptions.md) | + +#### Returns + +`Promise`<[`EventResult`](../code-reference.md#eventresult)\> + +#### Inherited from + +[NeverminedEvent](NeverminedEvent.md).[once](NeverminedEvent.md#once) + +#### Defined in + +[src/events/NeverminedEvent.ts:54](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/NeverminedEvent.ts#L54) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[NeverminedEvent](NeverminedEvent.md).[setInstanceConfig](NeverminedEvent.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### subscribe + +▸ **subscribe**(`callback`, `options`): [`ContractEventSubscription`](../interfaces/ContractEventSubscription.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------------------------------------------ | +| `callback` | (`events`: [`EventResult`](../code-reference.md#eventresult)[]) => `void` | +| `options` | [`EventOptions`](../interfaces/EventOptions.md) | + +#### Returns + +[`ContractEventSubscription`](../interfaces/ContractEventSubscription.md) + +#### Inherited from + +[NeverminedEvent](NeverminedEvent.md).[subscribe](NeverminedEvent.md#subscribe) + +#### Defined in + +[src/events/NeverminedEvent.ts:40](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/NeverminedEvent.ts#L40) + +--- + +### getInstance + +▸ `Static` **getInstance**(`contract`, `eventEmitter`, `graphHttpUri`, `networkName`): [`SubgraphEvent`](SubgraphEvent.md) + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `contract` | [`ContractBase`](ContractBase.md) | +| `eventEmitter` | [`EventEmitter`](../interfaces/EventEmitter.md) | +| `graphHttpUri` | `string` | +| `networkName` | `string` | + +#### Returns + +[`SubgraphEvent`](SubgraphEvent.md) + +#### Overrides + +[NeverminedEvent](NeverminedEvent.md).[getInstance](NeverminedEvent.md#getinstance) + +#### Defined in + +[src/events/SubgraphEvent.ts:18](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/SubgraphEvent.ts#L18) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[NeverminedEvent](NeverminedEvent.md).[setInstanceConfig](NeverminedEvent.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/utils.SubscribableObserver.md b/docs/api-reference/classes/SubscribableObserver.md similarity index 69% rename from docs/api-reference/classes/utils.SubscribableObserver.md rename to docs/api-reference/classes/SubscribableObserver.md index 78ca38ddf..8e067fd3d 100644 --- a/docs/api-reference/classes/utils.SubscribableObserver.md +++ b/docs/api-reference/classes/SubscribableObserver.md @@ -1,9 +1,7 @@ -[@nevermined-io/sdk](../code-reference.md) / [utils](../modules/utils.md) / SubscribableObserver +[@nevermined-io/sdk](../code-reference.md) / SubscribableObserver # Class: SubscribableObserver -[utils](../modules/utils.md).SubscribableObserver - ## Type parameters | Name | @@ -15,21 +13,21 @@ ### Constructors -- [constructor](utils.SubscribableObserver.md#constructor) +- [constructor](SubscribableObserver.md#constructor) ### Properties -- [completed](utils.SubscribableObserver.md#completed) -- [subscriptions](utils.SubscribableObserver.md#subscriptions) +- [completed](SubscribableObserver.md#completed) +- [subscriptions](SubscribableObserver.md#subscriptions) ### Methods -- [complete](utils.SubscribableObserver.md#complete) -- [emit](utils.SubscribableObserver.md#emit) -- [error](utils.SubscribableObserver.md#error) -- [next](utils.SubscribableObserver.md#next) -- [subscribe](utils.SubscribableObserver.md#subscribe) -- [unsubscribe](utils.SubscribableObserver.md#unsubscribe) +- [complete](SubscribableObserver.md#complete) +- [emit](SubscribableObserver.md#emit) +- [error](SubscribableObserver.md#error) +- [next](SubscribableObserver.md#next) +- [subscribe](SubscribableObserver.md#subscribe) +- [unsubscribe](SubscribableObserver.md#unsubscribe) ## Constructors @@ -52,7 +50,7 @@ #### Defined in -[src/utils/SubscribableObserver.ts:2](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/SubscribableObserver.ts#L2) +[src/utils/SubscribableObserver.ts:2](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/utils/SubscribableObserver.ts#L2) --- @@ -62,7 +60,7 @@ #### Defined in -[src/utils/SubscribableObserver.ts:4](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/SubscribableObserver.ts#L4) +[src/utils/SubscribableObserver.ts:4](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/utils/SubscribableObserver.ts#L4) ## Methods @@ -82,7 +80,7 @@ #### Defined in -[src/utils/SubscribableObserver.ts:30](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/SubscribableObserver.ts#L30) +[src/utils/SubscribableObserver.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/utils/SubscribableObserver.ts#L30) --- @@ -103,7 +101,7 @@ #### Defined in -[src/utils/SubscribableObserver.ts:40](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/SubscribableObserver.ts#L40) +[src/utils/SubscribableObserver.ts:40](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/utils/SubscribableObserver.ts#L40) --- @@ -123,7 +121,7 @@ #### Defined in -[src/utils/SubscribableObserver.ts:35](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/SubscribableObserver.ts#L35) +[src/utils/SubscribableObserver.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/utils/SubscribableObserver.ts#L35) --- @@ -143,7 +141,7 @@ #### Defined in -[src/utils/SubscribableObserver.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/SubscribableObserver.ts#L26) +[src/utils/SubscribableObserver.ts:26](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/utils/SubscribableObserver.ts#L26) --- @@ -169,7 +167,7 @@ #### Defined in -[src/utils/SubscribableObserver.ts:10](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/SubscribableObserver.ts#L10) +[src/utils/SubscribableObserver.ts:10](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/utils/SubscribableObserver.ts#L10) --- @@ -183,4 +181,4 @@ #### Defined in -[src/utils/SubscribableObserver.ts:47](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/SubscribableObserver.ts#L47) +[src/utils/SubscribableObserver.ts:47](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/utils/SubscribableObserver.ts#L47) diff --git a/docs/api-reference/classes/utils.SubscribablePromise.md b/docs/api-reference/classes/SubscribablePromise.md similarity index 54% rename from docs/api-reference/classes/utils.SubscribablePromise.md rename to docs/api-reference/classes/SubscribablePromise.md index cf62d4520..13eda781b 100644 --- a/docs/api-reference/classes/utils.SubscribablePromise.md +++ b/docs/api-reference/classes/SubscribablePromise.md @@ -1,9 +1,7 @@ -[@nevermined-io/sdk](../code-reference.md) / [utils](../modules/utils.md) / SubscribablePromise +[@nevermined-io/sdk](../code-reference.md) / SubscribablePromise # Class: SubscribablePromise -[utils](../modules/utils.md).SubscribablePromise - ## Type parameters | Name | @@ -15,21 +13,21 @@ ### Constructors -- [constructor](utils.SubscribablePromise.md#constructor) +- [constructor](SubscribablePromise.md#constructor) ### Properties -- [observer](utils.SubscribablePromise.md#observer) -- [promise](utils.SubscribablePromise.md#promise) +- [observer](SubscribablePromise.md#observer) +- [promise](SubscribablePromise.md#promise) ### Methods -- [catch](utils.SubscribablePromise.md#catch) -- [finally](utils.SubscribablePromise.md#finally) -- [init](utils.SubscribablePromise.md#init) -- [next](utils.SubscribablePromise.md#next) -- [subscribe](utils.SubscribablePromise.md#subscribe) -- [then](utils.SubscribablePromise.md#then) +- [catch](SubscribablePromise.md#catch) +- [finally](SubscribablePromise.md#finally) +- [init](SubscribablePromise.md#init) +- [next](SubscribablePromise.md#next) +- [subscribe](SubscribablePromise.md#subscribe) +- [then](SubscribablePromise.md#then) ## Constructors @@ -46,39 +44,39 @@ #### Parameters -| Name | Type | -| :--------- | :------------------------------------------------------------------------------------------------------------ | -| `executor` | (`observer`: [`SubscribableObserver`](utils.SubscribableObserver.md)<`T`, `P`\>) => `void` \| `Promise`<`P`\> | +| Name | Type | +| :--------- | :------------------------------------------------------------------------------------------------------ | +| `executor` | (`observer`: [`SubscribableObserver`](SubscribableObserver.md)<`T`, `P`\>) => `void` \| `Promise`<`P`\> | #### Defined in -[src/utils/SubscribablePromise.ts:15](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/SubscribablePromise.ts#L15) +[src/utils/SubscribablePromise.ts:15](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/utils/SubscribablePromise.ts#L15) ## Properties ### observer -• `Private` **observer**: [`SubscribableObserver`](utils.SubscribableObserver.md)<`T`, `P`\> +• `Private` **observer**: [`SubscribableObserver`](SubscribableObserver.md)<`T`, `P`\> #### Defined in -[src/utils/SubscribablePromise.ts:4](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/SubscribablePromise.ts#L4) +[src/utils/SubscribablePromise.ts:4](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/utils/SubscribablePromise.ts#L4) --- ### promise -• `Private` **promise**: `Promise`<`P`\> & [`SubscribablePromise`](utils.SubscribablePromise.md)<`T`, `P`\> +• `Private` **promise**: `Promise`<`P`\> & [`SubscribablePromise`](SubscribablePromise.md)<`T`, `P`\> #### Defined in -[src/utils/SubscribablePromise.ts:6](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/SubscribablePromise.ts#L6) +[src/utils/SubscribablePromise.ts:6](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/utils/SubscribablePromise.ts#L6) ## Methods ### catch -▸ **catch**(`onrejected?`): `Promise`<`any`\> & [`SubscribablePromise`](utils.SubscribablePromise.md)<`T`, `P`\> +▸ **catch**(`onrejected?`): `Promise`<`any`\> & [`SubscribablePromise`](SubscribablePromise.md)<`T`, `P`\> #### Parameters @@ -88,17 +86,17 @@ #### Returns -`Promise`<`any`\> & [`SubscribablePromise`](utils.SubscribablePromise.md)<`T`, `P`\> +`Promise`<`any`\> & [`SubscribablePromise`](SubscribablePromise.md)<`T`, `P`\> #### Defined in -[src/utils/SubscribablePromise.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/SubscribablePromise.ts#L33) +[src/utils/SubscribablePromise.ts:33](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/utils/SubscribablePromise.ts#L33) --- ### finally -▸ **finally**(`onfinally?`): `Promise`<`P`\> & [`SubscribablePromise`](utils.SubscribablePromise.md)<`T`, `P`\> +▸ **finally**(`onfinally?`): `Promise`<`P`\> & [`SubscribablePromise`](SubscribablePromise.md)<`T`, `P`\> #### Parameters @@ -108,11 +106,11 @@ #### Returns -`Promise`<`P`\> & [`SubscribablePromise`](utils.SubscribablePromise.md)<`T`, `P`\> +`Promise`<`P`\> & [`SubscribablePromise`](SubscribablePromise.md)<`T`, `P`\> #### Defined in -[src/utils/SubscribablePromise.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/SubscribablePromise.ts#L37) +[src/utils/SubscribablePromise.ts:37](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/utils/SubscribablePromise.ts#L37) --- @@ -122,9 +120,9 @@ #### Parameters -| Name | Type | -| :--------- | :------------------------------------------------------------------------------------------------------------ | -| `executor` | (`observer`: [`SubscribableObserver`](utils.SubscribableObserver.md)<`T`, `P`\>) => `void` \| `Promise`<`P`\> | +| Name | Type | +| :--------- | :------------------------------------------------------------------------------------------------------ | +| `executor` | (`observer`: [`SubscribableObserver`](SubscribableObserver.md)<`T`, `P`\>) => `void` \| `Promise`<`P`\> | #### Returns @@ -132,13 +130,13 @@ #### Defined in -[src/utils/SubscribablePromise.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/SubscribablePromise.ts#L41) +[src/utils/SubscribablePromise.ts:41](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/utils/SubscribablePromise.ts#L41) --- ### next -▸ **next**(`onNext`): [`SubscribablePromise`](utils.SubscribablePromise.md)<`T`, `P`\> +▸ **next**(`onNext`): [`SubscribablePromise`](SubscribablePromise.md)<`T`, `P`\> #### Parameters @@ -148,11 +146,11 @@ #### Returns -[`SubscribablePromise`](utils.SubscribablePromise.md)<`T`, `P`\> +[`SubscribablePromise`](SubscribablePromise.md)<`T`, `P`\> #### Defined in -[src/utils/SubscribablePromise.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/SubscribablePromise.ts#L24) +[src/utils/SubscribablePromise.ts:24](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/utils/SubscribablePromise.ts#L24) --- @@ -176,13 +174,13 @@ #### Defined in -[src/utils/SubscribablePromise.ts:20](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/SubscribablePromise.ts#L20) +[src/utils/SubscribablePromise.ts:20](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/utils/SubscribablePromise.ts#L20) --- ### then -▸ **then**(`onfulfilled?`, `onrejected?`): `Promise`<`any`\> & [`SubscribablePromise`](utils.SubscribablePromise.md)<`T`, `P`\> +▸ **then**(`onfulfilled?`, `onrejected?`): `Promise`<`any`\> & [`SubscribablePromise`](SubscribablePromise.md)<`T`, `P`\> #### Parameters @@ -193,8 +191,8 @@ #### Returns -`Promise`<`any`\> & [`SubscribablePromise`](utils.SubscribablePromise.md)<`T`, `P`\> +`Promise`<`any`\> & [`SubscribablePromise`](SubscribablePromise.md)<`T`, `P`\> #### Defined in -[src/utils/SubscribablePromise.ts:29](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/SubscribablePromise.ts#L29) +[src/utils/SubscribablePromise.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/utils/SubscribablePromise.ts#L29) diff --git a/docs/api-reference/classes/SubscriptionCreditsNFTApi.md b/docs/api-reference/classes/SubscriptionCreditsNFTApi.md new file mode 100644 index 000000000..c7acd2ede --- /dev/null +++ b/docs/api-reference/classes/SubscriptionCreditsNFTApi.md @@ -0,0 +1,1719 @@ +[@nevermined-io/sdk](../code-reference.md) / SubscriptionCreditsNFTApi + +# Class: SubscriptionCreditsNFTApi + +Allows the interaction with external ERC-1155 NFT contracts built on top of the Nevermined NFT extra features. + +## Hierarchy + +- [`NFT1155Api`](NFT1155Api.md) + + ↳ **`SubscriptionCreditsNFTApi`** + +## Table of contents + +### Constructors + +- [constructor](SubscriptionCreditsNFTApi.md#constructor) + +### Properties + +- [nftContract](SubscriptionCreditsNFTApi.md#nftcontract) +- [servicePlugin](SubscriptionCreditsNFTApi.md#serviceplugin) + +### Accessors + +- [address](SubscriptionCreditsNFTApi.md#address) +- [artifactsFolder](SubscriptionCreditsNFTApi.md#artifactsfolder) +- [circuitsFolder](SubscriptionCreditsNFTApi.md#circuitsfolder) +- [config](SubscriptionCreditsNFTApi.md#config) +- [getContract](SubscriptionCreditsNFTApi.md#getcontract) +- [instanceConfig](SubscriptionCreditsNFTApi.md#instanceconfig) +- [instantiableConfig](SubscriptionCreditsNFTApi.md#instantiableconfig) +- [logger](SubscriptionCreditsNFTApi.md#logger) +- [nevermined](SubscriptionCreditsNFTApi.md#nevermined) +- [web3](SubscriptionCreditsNFTApi.md#web3) + +### Methods + +- [\_details](SubscriptionCreditsNFTApi.md#_details) +- [access](SubscriptionCreditsNFTApi.md#access) +- [addRating](SubscriptionCreditsNFTApi.md#addrating) +- [balance](SubscriptionCreditsNFTApi.md#balance) +- [burn](SubscriptionCreditsNFTApi.md#burn) +- [burnFromHolder](SubscriptionCreditsNFTApi.md#burnfromholder) +- [buySecondaryMarketNft](SubscriptionCreditsNFTApi.md#buysecondarymarketnft) +- [claim](SubscriptionCreditsNFTApi.md#claim) +- [claimNFT](SubscriptionCreditsNFTApi.md#claimnft) +- [create](SubscriptionCreditsNFTApi.md#create) +- [details](SubscriptionCreditsNFTApi.md#details) +- [getSubscriptionToken](SubscriptionCreditsNFTApi.md#getsubscriptiontoken) +- [grantOperatorRole](SubscriptionCreditsNFTApi.md#grantoperatorrole) +- [isApprovedForAll](SubscriptionCreditsNFTApi.md#isapprovedforall) +- [isOperator](SubscriptionCreditsNFTApi.md#isoperator) +- [isOperatorOfDID](SubscriptionCreditsNFTApi.md#isoperatorofdid) +- [list](SubscriptionCreditsNFTApi.md#list) +- [listOnSecondaryMarkets](SubscriptionCreditsNFTApi.md#listonsecondarymarkets) +- [mint](SubscriptionCreditsNFTApi.md#mint) +- [order](SubscriptionCreditsNFTApi.md#order) +- [orderAsset](SubscriptionCreditsNFTApi.md#orderasset) +- [owner](SubscriptionCreditsNFTApi.md#owner) +- [registerNeverminedAsset](SubscriptionCreditsNFTApi.md#registerneverminedasset) +- [releaseRewards](SubscriptionCreditsNFTApi.md#releaserewards) +- [releaseSecondaryMarketRewards](SubscriptionCreditsNFTApi.md#releasesecondarymarketrewards) +- [resolveAsset](SubscriptionCreditsNFTApi.md#resolveasset) +- [revokeOperatorRole](SubscriptionCreditsNFTApi.md#revokeoperatorrole) +- [setApprovalForAll](SubscriptionCreditsNFTApi.md#setapprovalforall) +- [setInstanceConfig](SubscriptionCreditsNFTApi.md#setinstanceconfig) +- [transfer](SubscriptionCreditsNFTApi.md#transfer) +- [updateAsset](SubscriptionCreditsNFTApi.md#updateasset) +- [deployInstance](SubscriptionCreditsNFTApi.md#deployinstance) +- [getInstance](SubscriptionCreditsNFTApi.md#getinstance) +- [getInstanceUsingABI](SubscriptionCreditsNFTApi.md#getinstanceusingabi) +- [getNFTContractAddress](SubscriptionCreditsNFTApi.md#getnftcontractaddress) +- [getServicePlugin](SubscriptionCreditsNFTApi.md#getserviceplugin) +- [setInstanceConfig](SubscriptionCreditsNFTApi.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new SubscriptionCreditsNFTApi**() + +#### Inherited from + +[NFT1155Api](NFT1155Api.md).[constructor](NFT1155Api.md#constructor) + +## Properties + +### nftContract + +• **nftContract**: [`Nft1155Contract`](Nft1155Contract.md) + +#### Inherited from + +[NFT1155Api](NFT1155Api.md).[nftContract](NFT1155Api.md#nftcontract) + +#### Defined in + +[src/nevermined/api/nfts/NFT1155Api.ts:22](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT1155Api.ts#L22) + +--- + +### servicePlugin + +• **servicePlugin**: `Object` + +#### Index signature + +▪ [key: `string`]: [`ServicePlugin`](../interfaces/ServicePlugin.md)<[`Service`](../code-reference.md#service)\> + +#### Inherited from + +[NFT1155Api](NFT1155Api.md).[servicePlugin](NFT1155Api.md#serviceplugin) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L29) + +## Accessors + +### address + +• `get` **address**(): `string` + +Gets the ERC-721 NFT Contract address + +#### Returns + +`string` + +The NFT contract address + +#### Inherited from + +NFT1155Api.address + +#### Defined in + +[src/nevermined/api/nfts/NFT1155Api.ts:60](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT1155Api.ts#L60) + +--- + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +NFT1155Api.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +NFT1155Api.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +NFT1155Api.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### getContract + +• `get` **getContract**(): [`Nft1155Contract`](Nft1155Contract.md) + +Gets the instance of the ERC-1155 NFT Contract where the API is connected + +#### Returns + +[`Nft1155Contract`](Nft1155Contract.md) + +The `Nft1155Contract` instance + +#### Inherited from + +NFT1155Api.getContract + +#### Defined in + +[src/nevermined/api/nfts/NFT1155Api.ts:68](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT1155Api.ts#L68) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +NFT1155Api.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +NFT1155Api.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +NFT1155Api.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +NFT1155Api.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +NFT1155Api.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### \_details + +▸ `Protected` **\_details**(`did`, `ercType`): `Promise`<{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> + +Get the details of an NFT + +#### Parameters + +| Name | Type | Description | +| :-------- | :------------------------------- | :--------------------------------------------- | +| `did` | `string` | The Decentralized Identifier of the NFT asset. | +| `ercType` | [`ERCType`](../enums/ERCType.md) | The type of NFT used | + +#### Returns + +`Promise`<{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> + +The details of the NFT. + +**`Example`** + +```ts +const details = await nevermined.nfts1155.details(ddo.id) + +// The `details` object includes the NFT information + +assert.equal(details.mintCap, 5) +assert.equal(details.nftSupply, 5) +assert.equal(details.royaltyScheme, RoyaltyKind.Standard) +assert.equal(details.royalties, 100000) +assert.equal(details.owner, artist.getId()) +``` + +#### Inherited from + +[NFT1155Api](NFT1155Api.md).[\_details](NFT1155Api.md#_details) + +#### Defined in + +[src/nevermined/api/nfts/NFTsBaseApi.ts:150](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFTsBaseApi.ts#L150) + +--- + +### access + +▸ **access**(`did`, `consumer`, `destination?`, `fileIndex?`, `agreementId?`, `buyer?`, `babysig?`, `serviceReference?`): `Promise`<`boolean`\> + +Access the files associated with an NFT. + +#### Parameters + +| Name | Type | Default value | Description | +| :----------------- | :------------------------------------------------------------ | :------------- | :------------------------------------------------------------------------ | +| `did` | `string` | `undefined` | The Decentralized Identifier of the NFT asset. | +| `consumer` | [`Account`](Account.md) | `undefined` | The NFT holder account. | +| `destination?` | `string` | `undefined` | The download destination for the files. | +| `fileIndex?` | `number` | `undefined` | The index of the file. If unset will download all the files in the asset. | +| `agreementId` | `string` | `'0x'` | The NFT sales agreement id. | +| `buyer?` | `string` | `undefined` | Key which represent the buyer | +| `babysig?` | [`Babysig`](../interfaces/Babysig.md) | `undefined` | - | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-access'` | The service reference to use. By default is nft-access. | + +#### Returns + +`Promise`<`boolean`\> + +true if the access was successful or file if isToDownload is false. + +**`Remarks`** + +This function will call the Node that will check if all the access conditions where fulfilled +before providing the files. + +**`Example`** + +```ts +const result = await nevermined.nfts1155.access(ddo.id, collector, '/tmp/') +``` + +#### Inherited from + +[NFT1155Api](NFT1155Api.md).[access](NFT1155Api.md#access) + +#### Defined in + +[src/nevermined/api/nfts/NFTsBaseApi.ts:419](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFTsBaseApi.ts#L419) + +--- + +### addRating + +▸ **addRating**(`did`, `newRating`, `numVotesAdded?`, `publisher`, `publishMetadata?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +Given a DID, it adds a vote to the asset curation information. + +#### Parameters + +| Name | Type | Default value | Description | +| :---------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `newRating` | `number` | `undefined` | New average rating of the asset | +| `numVotesAdded` | `number` | `1` | Number of new votes added to the rating, typically just 1 | +| `publisher` | [`Account`](Account.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +[DDO](DDO.md) The DDO updated + +#### Inherited from + +[NFT1155Api](NFT1155Api.md).[addRating](NFT1155Api.md#addrating) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:514](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L514) + +--- + +### balance + +▸ **balance**(`did`, `account`): `Promise`<`bigint`\> + +Get the NFT balance for a particular did associated to an account/address + +#### Parameters + +| Name | Type | Description | +| :-------- | :---------------------------------- | :--------------------------------------------- | +| `did` | `string` | The Decentralized Identifier of the NFT asset. | +| `account` | `string` \| [`Account`](Account.md) | The account/address to check the balance of. | + +#### Returns + +`Promise`<`bigint`\> + +The number of editions of a NFT owned by the account/address. + +**`Example`** + +```ts +const balance = await nevermined.nfts1155.balance(ddo.id, artist) +``` + +#### Inherited from + +[NFT1155Api](NFT1155Api.md).[balance](NFT1155Api.md#balance) + +#### Defined in + +[src/nevermined/api/nfts/NFT1155Api.ts:466](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT1155Api.ts#L466) + +--- + +### burn + +▸ **burn**(`tokenId`, `nftAmount`, `account`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +Burn NFTs associated with an asset. + +#### Parameters + +| Name | Type | Description | +| :---------- | :---------------------------------------------- | :--------------------------------------------- | +| `tokenId` | `string` | The Decentralized Identifier of the NFT asset. | +| `nftAmount` | `bigint` | The amount of NFTs to burn. | +| `account` | [`Account`](Account.md) | The account of the publisher of the NFT. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +The ethers.ContractTransactionReceipt + +**`Remarks`** + +The publisher can only burn NFTs that it owns. NFTs that were already transferred cannot be burned by the publisher. + +**`Example`** + +```ts +await nevermined.nfts1155.burn(did, 2n, artist) +``` + +#### Inherited from + +[NFT1155Api](NFT1155Api.md).[burn](NFT1155Api.md#burn) + +#### Defined in + +[src/nevermined/api/nfts/NFT1155Api.ts:185](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT1155Api.ts#L185) + +--- + +### burnFromHolder + +▸ **burnFromHolder**(`holder`, `tokenId`, `nftAmount`, `account`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +Burn NFTs associated with an asset of a specific account. + +#### Parameters + +| Name | Type | Description | +| :---------- | :---------------------------------------------- | :---------------------------------------------- | +| `holder` | `string` | The address of the account that holds the NFTs. | +| `tokenId` | `string` | The TokenId of the NFT | +| `nftAmount` | `bigint` | The amount of NFTs to burn. | +| `account` | `string` \| [`Account`](Account.md) | The account of the publisher of the NFT. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +The ethers.ContractTransactionReceipt + +**`Remarks`** + +The publisher can only burn NFTs of an account if is an operator. NFTs that were already transferred cannot be burned by the publisher. + +**`Example`** + +```ts +await nevermined.nfts1155.burnTo(holder, tokenId, 2n, artist) +``` + +#### Inherited from + +[NFT1155Api](NFT1155Api.md).[burnFromHolder](NFT1155Api.md#burnfromholder) + +#### Defined in + +[src/nevermined/api/nfts/NFT1155Api.ts:213](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT1155Api.ts#L213) + +--- + +### buySecondaryMarketNft + +▸ **buySecondaryMarketNft**(`consumer`, `nftAmount?`, `agreementIdSeed`, `conditionsTimeout?`, `txParams?`): `Promise`<`boolean`\> + +Buys a number of listed NFTs on secondary markets. + +#### Parameters + +| Name | Type | Description | +| :------------------ | :---------------------------------------------- | :----------------------------------------- | +| `consumer` | [`Account`](Account.md) | The account of the buyer/consumer. | +| `nftAmount` | `bigint` | The number of assets to buy. 1 by default. | +| `agreementIdSeed` | `string` | - | +| `conditionsTimeout` | `number`[] | - | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | + +#### Returns + +`Promise`<`boolean`\> + +true if the buy was successful. + +**`Example`** + +```ts +const result = await nevermined.nfts1155.buySecondaryMarketNft(collector, 1n, agreementId) +``` + +**`Throws`** + +[NFTError](NFTError.md) +Thrown if there is an error buying the NFT. + +#### Inherited from + +[NFT1155Api](NFT1155Api.md).[buySecondaryMarketNft](NFT1155Api.md#buysecondarymarketnft) + +#### Defined in + +[src/nevermined/api/nfts/NFTsBaseApi.ts:341](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFTsBaseApi.ts#L341) + +--- + +### claim + +▸ **claim**(`agreementId`, `nftHolder`, `nftReceiver`, `numberEditions?`, `did?`, `serviceIndex?`): `Promise`<`boolean`\> + +Claims the transfer of a NFT to the Nevermined Node on behalf of the publisher. + +#### Parameters + +| Name | Type | Description | +| :--------------- | :------- | :--------------------------------------------------------------------------- | +| `agreementId` | `string` | The NFT sales agreement id. | +| `nftHolder` | `string` | The address of the current owner of the NFT. | +| `nftReceiver` | `string` | The address where the NFT should be transferred. | +| `numberEditions` | `bigint` | The number of NFT editions to transfer. If the NFT is ERC-721 it should be 1 | +| `did?` | `string` | The Decentralized Identifier of the asset. | +| `serviceIndex?` | `number` | The index of the service in the DDO that will be claimed | + +#### Returns + +`Promise`<`boolean`\> + +true if the transfer was successful. + +**`Remarks`** + +This is useful when the consumer does not want to wait for the publisher +to transfer the NFT once the payment is made. Assuming the publisher delegated +transfer permissions to the Node. + +One example would be a marketplace where the user wants to get access to the NFT +as soon as the payment is made + +**`Example`** + +```ts +const receipt = await nevermined.nfts721.claim(agreementId, editor.getId(), subscriber.getId(), 1n) +``` + +#### Inherited from + +[NFT1155Api](NFT1155Api.md).[claim](NFT1155Api.md#claim) + +#### Defined in + +[src/nevermined/api/nfts/NFT1155Api.ts:321](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT1155Api.ts#L321) + +--- + +### claimNFT + +▸ `Protected` **claimNFT**(`agreementId`, `nftHolder`, `nftReceiver`, `numberEditions?`, `ercType?`, `did?`, `serviceIndex?`): `Promise`<`boolean`\> + +Claims the transfer of a NFT to the Nevermined Node on behalf of the publisher. + +#### Parameters + +| Name | Type | Default value | Description | +| :--------------- | :------------------------------- | :------------ | :--------------------------------------------------------------------------- | +| `agreementId` | `string` | `undefined` | The NFT sales agreement id. | +| `nftHolder` | `string` | `undefined` | The address of the current owner of the NFT. | +| `nftReceiver` | `string` | `undefined` | The address where the NFT should be transferred. | +| `numberEditions` | `bigint` | `undefined` | The number of NFT editions to transfer. If the NFT is ERC-721 it should be 1 | +| `ercType` | [`ERCType`](../enums/ERCType.md) | `1155` | The Type of the NFT ERC (1155 or 721). | +| `did?` | `string` | `undefined` | The DID of the asset. | +| `serviceIndex?` | `number` | `undefined` | The index of the service in the DDO that will be claimed | + +#### Returns + +`Promise`<`boolean`\> + +true if the transfer was successful. + +**`Remarks`** + +This is useful when the consumer does not want to wait for the publisher +to transfer the NFT once the payment is made. Assuming the publisher delegated +transfer permissions to the Node. + +One example would be a marketplace where the user wants to get access to the NFT +as soon as the payment is made + +**`Example`** + +```ts +const receipt = await nevermined.nfts721.claim( + agreementId, + editor.getId(), + subscriber.getId(), + nftAmount, + 721, +) +``` + +**`Throws`** + +[NFTError](NFTError.md) if Nevermined is not an operator for this NFT + +#### Inherited from + +[NFT1155Api](NFT1155Api.md).[claimNFT](NFT1155Api.md#claimnft) + +#### Defined in + +[src/nevermined/api/nfts/NFTsBaseApi.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFTsBaseApi.ts#L50) + +--- + +### create + +▸ **create**(`nftAttributes`, `publisher`, `publicationOptions?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`CreateProgressStep`](../enums/CreateProgressStep.md), [`DDO`](DDO.md)\> + +Creates a new Nevermined asset associated to a NFT (ERC-1155). + +#### Parameters + +| Name | Type | Description | +| :------------------- | :------------------------------------------------------ | :-------------------------------------------------------------------------------- | +| `nftAttributes` | [`NFTAttributes`](NFTAttributes.md) | Attributes describing the NFT (ERC-721) associated to the asset | +| `publisher` | [`Account`](Account.md) | The account publishing the asset | +| `publicationOptions` | [`AssetPublicationOptions`](AssetPublicationOptions.md) | Allows to specify the publication options of the off-chain and the on-chain data. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`CreateProgressStep`](../enums/CreateProgressStep.md), [`DDO`](DDO.md)\> + +The newly registered [DDO](DDO.md). + +**`Example`** + +```ts +const assetAttributes = AssetAttributes.getInstance({ + metadata, + price: assetPrice, + serviceTypes: ['nft-sales', 'nft-access'], +}) +const nftAttributes = NFTAttributes.getNFT1155Instance({ + ...assetAttributes, + nftContractAddress: nftUpgradeable.address, + cap: cappedAmount, + amount: numberNFTs, + royaltyAttributes, + preMint, +}) +const ddo = await nevermined.nfts1155.create(nftAttributes, publisher) +``` + +**`See`** + +[PublishOnChainOptions](../enums/PublishOnChainOptions.md) and [PublishMetadataOptions](../enums/PublishMetadataOptions.md) + +#### Inherited from + +[NFT1155Api](NFT1155Api.md).[create](NFT1155Api.md#create) + +#### Defined in + +[src/nevermined/api/nfts/NFT1155Api.ts:103](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT1155Api.ts#L103) + +--- + +### details + +▸ **details**(`did`): `Promise`<{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> + +Get the details of an NFT + +#### Parameters + +| Name | Type | Description | +| :---- | :------- | :--------------------------------------------- | +| `did` | `string` | The Decentralized Identifier of the NFT asset. | + +#### Returns + +`Promise`<{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> + +The details of the NFT. + +**`Example`** + +```ts +const details = await nevermined.nfts1155.details(ddo.id) + +// The `details` object includes the NFT information + +assert.equal(details.mintCap, 5) +assert.equal(details.nftSupply, 5) +assert.equal(details.royaltyScheme, RoyaltyKind.Standard) +assert.equal(details.royalties, 100000) +assert.equal(details.owner, artist.getId()) +``` + +#### Inherited from + +[NFT1155Api](NFT1155Api.md).[details](NFT1155Api.md#details) + +#### Defined in + +[src/nevermined/api/nfts/NFT1155Api.ts:679](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT1155Api.ts#L679) + +--- + +### getSubscriptionToken + +▸ **getSubscriptionToken**(`did`, `account`): `Promise`<[`SubscriptionToken`](../interfaces/SubscriptionToken.md)\> + +Get a JWT token for an asset associated with a webService + +#### Parameters + +| Name | Type | Description | +| :-------- | :---------------------- | :----------------------------------------------------------------------------- | +| `did` | `string` | The did of the asset with a webService resource and an associated subscription | +| `account` | [`Account`](Account.md) | Account of the user requesting the token | + +#### Returns + +`Promise`<[`SubscriptionToken`](../interfaces/SubscriptionToken.md)\> + +[SubscriptionToken](../interfaces/SubscriptionToken.md) + +**`Example`** + +```ts +const response = await nevermined.nfts721.getSubscriptionToken(serviceDDO.id, subscriber) + +assert.isDefined(response.accessToken) +assert.isDefined(response.neverminedProxyUri) +``` + +#### Inherited from + +[NFT1155Api](NFT1155Api.md).[getSubscriptionToken](NFT1155Api.md#getsubscriptiontoken) + +#### Defined in + +[src/nevermined/api/nfts/NFTsBaseApi.ts:478](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFTsBaseApi.ts#L478) + +--- + +### grantOperatorRole + +▸ **grantOperatorRole**(`operatorAddress`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +Adds a minter (`minterAddress`) to the NFT Contract. +Granting and revoking minting permissions only can be done by the NFT Contract owner + +#### Parameters + +| Name | Type | Description | +| :---------------- | :---------------------------------------------- | :--------------------------------------------------------------------- | +| `operatorAddress` | `string` | The address of the account to be added as operator in the NFT Contract | +| `from?` | [`Account`](Account.md) | The account giving operator permissions | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +The ethers.ContractTransactionReceipt + +**`Example`** + +```ts +await nevermined.nfts1155.grantOperatorRole(someoneElse, artist) +``` + +#### Inherited from + +[NFT1155Api](NFT1155Api.md).[grantOperatorRole](NFT1155Api.md#grantoperatorrole) + +#### Defined in + +[src/nevermined/api/nfts/NFT1155Api.ts:625](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT1155Api.ts#L625) + +--- + +### isApprovedForAll + +▸ **isApprovedForAll**(`operatorAddress`, `from`): `Promise`<`unknown`\> + +Returns if the `operatorAddress` is approved + +#### Parameters + +| Name | Type | Description | +| :---------------- | :------- | :--------------------------------------------------------------------------------------- | +| `operatorAddress` | `string` | The address to check the permissions | +| `from` | `string` | The address of the account granting or revoking the permissions via `setApprovalForAll`. | + +#### Returns + +`Promise`<`unknown`\> + +Boolean saying if the `operatorAddress` is approved + +**`See`** + +[claim](NFT1155Api.md#claim) + +**`Example`** + +```ts +await nevermined.nfts1155.isApprovedForAll(someoneElse, artist.getId()) +``` + +#### Inherited from + +[NFT1155Api](NFT1155Api.md).[isApprovedForAll](NFT1155Api.md#isapprovedforall) + +#### Defined in + +[src/nevermined/api/nfts/NFT1155Api.ts:540](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT1155Api.ts#L540) + +--- + +### isOperator + +▸ **isOperator**(`nftContractAddress`, `operatorAddress`, `ercType?`): `Promise`<`boolean`\> + +Check if a particular address is the operator of given a NFT address. + +#### Parameters + +| Name | Type | Default value | Description | +| :------------------- | :------------------------------- | :------------ | :-------------------------------------- | +| `nftContractAddress` | `string` | `undefined` | The DID of the NFT to check | +| `operatorAddress` | `string` | `undefined` | The address to check if operator status | +| `ercType` | [`ERCType`](../enums/ERCType.md) | `1155` | The erc type of the NFT. | + +#### Returns + +`Promise`<`boolean`\> + +operator status of address as a boolean + +#### Inherited from + +[NFT1155Api](NFT1155Api.md).[isOperator](NFT1155Api.md#isoperator) + +#### Defined in + +[src/nevermined/api/nfts/NFTsBaseApi.ts:116](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFTsBaseApi.ts#L116) + +--- + +### isOperatorOfDID + +▸ **isOperatorOfDID**(`did`, `address`, `ercType?`): `Promise`<`boolean`\> + +Check if a particular address is the operator of a DID. + +#### Parameters + +| Name | Type | Default value | Description | +| :-------- | :------------------------------- | :------------ | :-------------------------------------- | +| `did` | `string` | `undefined` | The DID of the NFT to check | +| `address` | `string` | `undefined` | The address to check if operator status | +| `ercType` | [`ERCType`](../enums/ERCType.md) | `1155` | The erc type of the NFT. | + +#### Returns + +`Promise`<`boolean`\> + +operator status of address as a boolean + +#### Inherited from + +[NFT1155Api](NFT1155Api.md).[isOperatorOfDID](NFT1155Api.md#isoperatorofdid) + +#### Defined in + +[src/nevermined/api/nfts/NFTsBaseApi.ts:91](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFTsBaseApi.ts#L91) + +--- + +### list + +▸ **list**(`did`, `list`, `publisher`, `publishMetadata?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +Given a DID, updates the metadata associated to the asset allowing to list or unlist it. It also can upload this metadata to a remote decentralized stored depending on the `publishMetadata` parameter. +In a Nevermined environment, when an asset is unlisted, it is not possible to be found and accessed by any user. + +#### Parameters + +| Name | Type | Default value | Description | +| :---------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `list` | `boolean` | `undefined` | Needs the asset to be listed or unlisted | +| `publisher` | [`Account`](Account.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +[DDO](DDO.md) The DDO updated + +#### Inherited from + +[NFT1155Api](NFT1155Api.md).[list](NFT1155Api.md#list) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:462](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L462) + +--- + +### listOnSecondaryMarkets + +▸ **listOnSecondaryMarkets**(`ddo`, `assetPrice`, `nftAmount`, `nftTransfer`, `provider`, `token`, `owner`): `Promise`<`string`\> + +After purchase re-list an NFT to enable secondary market sales. + +#### Parameters + +| Name | Type | Description | +| :------------ | :---------------------------- | :----------------------------------------------------------- | +| `ddo` | [`DDO`](DDO.md) | The DDO of the asset. | +| `assetPrice` | [`AssetPrice`](AssetPrice.md) | The current setup of asset rewards. | +| `nftAmount` | `bigint` | The number of NFTs put up for secondary sale. | +| `nftTransfer` | `boolean` | - | +| `provider` | `string` | The address that will be the provider of the secondary sale. | +| `token` | [`Token`](Token.md) | - | +| `owner` | [`Account`](Account.md) | The account of the current owner. | + +#### Returns + +`Promise`<`string`\> + +the agreementId of the secondary sale. + +**`Example`** + +```ts +const agreementId = await nevermined.nfts1155.listOnSecondaryMarkets( + ddo, + assetPrice, + numberNFTs, + collector.getId(), + token, + collector.getId(), +) +``` + +**`Throws`** + +[NFTError](NFTError.md) +Thrown if there is an error listing the NFT. + +#### Inherited from + +[NFT1155Api](NFT1155Api.md).[listOnSecondaryMarkets](NFT1155Api.md#listonsecondarymarkets) + +#### Defined in + +[src/nevermined/api/nfts/NFTsBaseApi.ts:260](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFTsBaseApi.ts#L260) + +--- + +### mint + +▸ **mint**(`did`, `nftAmount`, `receiver`, `account`, `data?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +Mint NFTs associated with an asset. + +#### Parameters + +| Name | Type | Description | +| :---------- | :---------------------------------------------- | :-------------------------------------------------------------------------------------------- | +| `did` | `string` | The Decentralized Identifier of the NFT asset. | +| `nftAmount` | `bigint` | The amount of NFTs to mint. | +| `receiver` | `string` | Account address of the NFT receiver, if `undefined` the minter account will receive the NFT/s | +| `account` | [`Account`](Account.md) | The account to mint the NFT. \* | +| `data?` | `string` | Data | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +The ethers.ContractTransactionReceipt + +**`Remarks`** + +This function can be called multiple times as long as the minting does not exceed the maximum cap set during creation. + +**`Example`** + +```ts +await nevermined.nfts1155.mint(did, 10n, artist) +``` + +#### Inherited from + +[NFT1155Api](NFT1155Api.md).[mint](NFT1155Api.md#mint) + +#### Defined in + +[src/nevermined/api/nfts/NFT1155Api.ts:145](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT1155Api.ts#L145) + +--- + +### order + +▸ **order**(`did`, `numberEditions`, `consumer`, `serviceReference?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`OrderProgressStep`](../enums/OrderProgressStep.md), `string`\> + +Buy NFTs. + +#### Parameters + +| Name | Type | Default value | Description | +| :----------------- | :------------------------------------------------------------ | :------------ | :------------------------------------------------------------- | +| `did` | `string` | `undefined` | The Decentralized Identifier of the NFT asset. | +| `numberEditions` | `bigint` | `undefined` | The amount of NFTs to buy. | +| `consumer` | [`Account`](Account.md) | `undefined` | The account of the NFT buyer. | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-sales'` | The reference to identify wich service within the DDO to order | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters. | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`OrderProgressStep`](../enums/OrderProgressStep.md), `string`\> + +The agreement ID. + +**`Remarks`** + +This will lock the funds of the consumer in escrow pending the transfer of the NFTs +from the publisher. + +**`Example`** + +```ts +agreementId = await nevermined.nfts1155.order(ddo.id, numberNFTs, collector) +``` + +#### Inherited from + +[NFT1155Api](NFT1155Api.md).[order](NFT1155Api.md#order) + +#### Defined in + +[src/nevermined/api/nfts/NFT1155Api.ts:252](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT1155Api.ts#L252) + +--- + +### orderAsset + +▸ **orderAsset**(`did`, `serviceReference`, `consumer`, `params?`): [`SubscribablePromise`](SubscribablePromise.md)<[`OrderProgressStep`](../enums/OrderProgressStep.md), `string`\> + +Start the purchase/order of an asset's service. Starts by signing the service agreement +then sends the request to the publisher via the service endpoint (Node http service). + +#### Parameters + +| Name | Type | Description | +| :----------------- | :------------------------------------------------------------ | :---------------- | +| `did` | `string` | Decentralized ID. | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | Service. | +| `consumer` | [`Account`](Account.md) | Consumer account. | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | - | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`OrderProgressStep`](../enums/OrderProgressStep.md), `string`\> + +The agreement ID. + +#### Inherited from + +[NFT1155Api](NFT1155Api.md).[orderAsset](NFT1155Api.md#orderasset) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:563](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L563) + +--- + +### owner + +▸ **owner**(): `Promise`<`string`\> + +Gets the contract owner + +#### Returns + +`Promise`<`string`\> + +Address of the contract owner + +**`Example`** + +```ts +const nftContractOwner = new Account(await nevermined.nfts1155.owner()) +``` + +#### Inherited from + +[NFT1155Api](NFT1155Api.md).[owner](NFT1155Api.md#owner) + +#### Defined in + +[src/nevermined/api/nfts/NFT1155Api.ts:485](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT1155Api.ts#L485) + +--- + +### registerNeverminedAsset + +▸ `Protected` **registerNeverminedAsset**(`assetAttributes`, `publisher`, `publicationOptions`, `nftAttributes?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`CreateProgressStep`](../enums/CreateProgressStep.md), [`DDO`](DDO.md)\> + +It registers a new asset in a Nevermined network. This method is protected and not exposed +via the Nevermined APIs directly. It must accessed via the `assets`, `compute`, and `nfts` APIs. + +#### Parameters + +| Name | Type | Description | +| :------------------- | :------------------------------------------------------ | :-------------------------------------------------------------------------------- | +| `assetAttributes` | [`AssetAttributes`](AssetAttributes.md) | Attributes describing the asset | +| `publisher` | [`Account`](Account.md) | The account publishing the asset | +| `publicationOptions` | [`AssetPublicationOptions`](AssetPublicationOptions.md) | Allows to specify the publication options of the off-chain and the on-chain data. | +| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | Attributes describing the NFT (ERC-721) associated to the asset | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`CreateProgressStep`](../enums/CreateProgressStep.md), [`DDO`](DDO.md)\> + +The metadata of the asset created (DDO) + +**`See`** + +[PublishOnChainOptions](../enums/PublishOnChainOptions.md) and [PublishMetadataOptions](../enums/PublishMetadataOptions.md) + +#### Inherited from + +[NFT1155Api](NFT1155Api.md).[registerNeverminedAsset](NFT1155Api.md#registerneverminedasset) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L42) + +--- + +### releaseRewards + +▸ **releaseRewards**(`agreementId`, `did`, `serviceReference?`, `nftAmount`, `publisher`, `txParams?`): `Promise`<`boolean`\> + +Release the funds from escrow. + +#### Parameters + +| Name | Type | Default value | Description | +| :----------------- | :------------------------------------------------------------ | :------------ | :----------------------------------------------------------------------- | +| `agreementId` | `string` | `undefined` | The NFT sales agreement id. | +| `did` | `string` | `undefined` | The Decentralized identifier of the NFT asset. | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-sales'` | The reference to identify wich service within the DDO to release rewards | +| `nftAmount` | `bigint` | `undefined` | The amount of NFTs to transfer. | +| `publisher` | [`Account`](Account.md) | `undefined` | The current owner of the NFTs. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters. | + +#### Returns + +`Promise`<`boolean`\> + +true if the funds release was successful. + +**`Remarks`** + +A publisher is able to release the funds put on escrow by the consumer after transferring the NFTs. + +**`Example`** + +```ts +const receipt = await nevermined.nfts1155.releaseRewards(agreementId, ddo.id, numberNFTs, artist) +``` + +**`Throws`** + +[NFTError](NFTError.md) +Thrown if there is an error releasing the rewards + +#### Inherited from + +[NFT1155Api](NFT1155Api.md).[releaseRewards](NFT1155Api.md#releaserewards) + +#### Defined in + +[src/nevermined/api/nfts/NFT1155Api.ts:424](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT1155Api.ts#L424) + +--- + +### releaseSecondaryMarketRewards + +▸ **releaseSecondaryMarketRewards**(`owner`, `consumer`, `agreementIdSeed`, `serviceReference?`, `txParams?`): `Promise`<`boolean`\> + +Used to release the secondary market NFT & the locked rewards. + +#### Parameters + +| Name | Type | Default value | Description | +| :----------------- | :------------------------------------------------------------ | :------------ | :----------------------------------------------------------------------- | +| `owner` | [`Account`](Account.md) | `undefined` | The owner account. | +| `consumer` | [`Account`](Account.md) | `undefined` | The consumer account. | +| `agreementIdSeed` | `string` | `undefined` | the Id of the underlying service agreement seed. | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-sales'` | The reference to identify wich service within the DDO to release rewards | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters. | + +#### Returns + +`Promise`<`boolean`\> + +true if the transaction was successful. + +**`Example`** + +```ts +// TODO +``` + +**`Throws`** + +[NFTError](NFTError.md) +Thrown if there is an error releasing the rewards. + +#### Inherited from + +[NFT1155Api](NFT1155Api.md).[releaseSecondaryMarketRewards](NFT1155Api.md#releasesecondarymarketrewards) + +#### Defined in + +[src/nevermined/api/nfts/NFT1155Api.ts:562](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT1155Api.ts#L562) + +--- + +### resolveAsset + +▸ `Protected` **resolveAsset**(`did`, `policy?`): `Promise`<[`DDO`](DDO.md)\> + +Returns a DDO by DID. Depending of the resolution policy it prioritize the Metadata API or Immutable urls. + +#### Parameters + +| Name | Type | Default value | Description | +| :------- | :------------------------------------------------- | :---------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `did` | `string` | `undefined` | Decentralized ID. | +| `policy` | [`DIDResolvePolicy`](../enums/DIDResolvePolicy.md) | `DIDResolvePolicy.MetadataAPIFirst` | It specifies the resolve policy to apply. It allows to select that priorities during the asset resolution via Metadata API or Immutable URLs (IPFS, Filecoin, etc) | + +#### Returns + +`Promise`<[`DDO`](DDO.md)\> + +[DDO](DDO.md) + +#### Inherited from + +[NFT1155Api](NFT1155Api.md).[resolveAsset](NFT1155Api.md#resolveasset) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:310](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L310) + +--- + +### revokeOperatorRole + +▸ **revokeOperatorRole**(`operatorAddress`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +Revokes an address (`operatorAddress`) of the NFT Contract as operator. +Granting and revoking minting permissions only can be done by the NFT Contract owner + +#### Parameters + +| Name | Type | Description | +| :---------------- | :---------------------------------------------- | :----------------------------------------------------------------------- | +| `operatorAddress` | `string` | The address of the account to be revoked as operator in the NFT Contract | +| `from?` | [`Account`](Account.md) | The account revoking operator permissions | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +The ethers.ContractTransactionReceipt + +**`Example`** + +```ts +await nevermined.nfts1155.revokeOperatorRole(someoneElse, artist) +``` + +#### Inherited from + +[NFT1155Api](NFT1155Api.md).[revokeOperatorRole](NFT1155Api.md#revokeoperatorrole) + +#### Defined in + +[src/nevermined/api/nfts/NFT1155Api.ts:651](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT1155Api.ts#L651) + +--- + +### setApprovalForAll + +▸ **setApprovalForAll**(`operatorAddress`, `approved`, `from`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +Enable or disable NFT permissions for an operator. + +#### Parameters + +| Name | Type | Description | +| :---------------- | :---------------------------------------------- | :------------------------------------------------------------------- | +| `operatorAddress` | `string` | The address that of the operator we want to give transfer rights to. | +| `approved` | `boolean` | Give or remove transfer rights from the operator. | +| `from` | [`Account`](Account.md) | The account that wants to give transfer rights to the operator. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction additional parameters | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +The ethers.ContractTransactionReceiptnReceiptnReceipt + +**`See`** + +[claim](NFT1155Api.md#claim) + +**`Example`** + +```ts +await nevermined.nfts1155.setApprovalForAll(someoneElse, true, artist) +``` + +#### Inherited from + +[NFT1155Api](NFT1155Api.md).[setApprovalForAll](NFT1155Api.md#setapprovalforall) + +#### Defined in + +[src/nevermined/api/nfts/NFT1155Api.ts:510](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT1155Api.ts#L510) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[NFT1155Api](NFT1155Api.md).[setInstanceConfig](NFT1155Api.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### transfer + +▸ **transfer**(`agreementId`, `did`, `nftAmount`, `publisher`, `serviceReference?`, `txParams?`): `Promise`<`boolean`\> + +Transfer NFTs to the consumer. + +#### Parameters + +| Name | Type | Default value | Description | +| :----------------- | :------------------------------------------------------------ | :------------ | :---------------------------------------------------------------- | +| `agreementId` | `string` | `undefined` | The NFT sales agreement id. | +| `did` | `string` | `undefined` | The Decentralized identifier of the NFT asset. | +| `nftAmount` | `bigint` | `undefined` | The number of NFTs to transfer. | +| `publisher` | [`Account`](Account.md) | `undefined` | The current owner of the NFTs. | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-sales'` | The reference to identify wich service within the DDO to transfer | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters. | + +#### Returns + +`Promise`<`boolean`\> + +true if the transfer was successful. + +**`Remarks`** + +A publisher/provider will check if the consumer put the funds in escrow and +execute the transfer in order to be able to release the rewards. + +**`Example`** + +```ts +const receipt = await nevermined.nfts1155.transfer(agreementId, ddo.id, numberNFTs, artist) +``` + +**`Throws`** + +[NFTError](NFTError.md) +Thrown if there is an error transferring the NFT + +#### Inherited from + +[NFT1155Api](NFT1155Api.md).[transfer](NFT1155Api.md#transfer) + +#### Defined in + +[src/nevermined/api/nfts/NFT1155Api.ts:368](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT1155Api.ts#L368) + +--- + +### updateAsset + +▸ `Protected` **updateAsset**(`did`, `metadata`, `publisher`, `publishMetadataOptions?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +Given a DID, updates the metadata associated to the asset. It also can upload this metadata to a remote decentralized stored depending on the `publishMetadata` parameter. + +#### Parameters + +| Name | Type | Default value | Description | +| :----------------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | Metadata describing the asset | +| `publisher` | [`Account`](Account.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadataOptions` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +[DDO](DDO.md) The DDO updated + +#### Inherited from + +[NFT1155Api](NFT1155Api.md).[updateAsset](NFT1155Api.md#updateasset) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:353](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L353) + +--- + +### deployInstance + +▸ `Static` **deployInstance**(`config`, `contractABI`, `from`, `args?`): `Promise`<[`SubscriptionCreditsNFTApi`](SubscriptionCreditsNFTApi.md)\> + +#### Parameters + +| Name | Type | Default value | +| :------------ | :------------------------------------------ | :------------ | +| `config` | [`NeverminedOptions`](NeverminedOptions.md) | `undefined` | +| `contractABI` | `any` | `undefined` | +| `from` | [`Account`](Account.md) | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`Promise`<[`SubscriptionCreditsNFTApi`](SubscriptionCreditsNFTApi.md)\> + +#### Defined in + +[src/nevermined/api/nfts/SubscriptionCreditsNFTApi.ts:26](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/SubscriptionCreditsNFTApi.ts#L26) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`, `nftContractInstance?`, `nftContractAddress?`): `Promise`<[`NFT1155Api`](NFT1155Api.md)\> + +Create a new Nevermined NFTs (ERC-1155) instance allowing to interact with that kind of NFTs. + +#### Parameters + +| Name | Type | Description | +| :--------------------- | :---------------------------------------------------------- | :---------------------------------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | - | +| `nftContractInstance?` | [`Nft1155Contract`](Nft1155Contract.md) | If there is already deployed an instance of `Nft1155Contract` | +| `nftContractAddress?` | `string` | If the `Nft1155Contract` is deployed in an address it will connect to that contract | + +#### Returns + +`Promise`<[`NFT1155Api`](NFT1155Api.md)\> + +The NFTs 1155 API instance [NFT1155Api](NFT1155Api.md). + +**`Example`** + +```ts +nfts1155 = await Nft1155Api.getInstance(instanceConfig, nft1155Contract) +``` + +#### Inherited from + +[NFT1155Api](NFT1155Api.md).[getInstance](NFT1155Api.md#getinstance) + +#### Defined in + +[src/nevermined/api/nfts/NFT1155Api.ts:40](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT1155Api.ts#L40) + +--- + +### getInstanceUsingABI + +▸ `Static` **getInstanceUsingABI**(`config`, `nftContractAddress`, `solidityABI`): `Promise`<[`SubscriptionCreditsNFTApi`](SubscriptionCreditsNFTApi.md)\> + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | +| `nftContractAddress` | `string` | +| `solidityABI` | `any` | + +#### Returns + +`Promise`<[`SubscriptionCreditsNFTApi`](SubscriptionCreditsNFTApi.md)\> + +#### Defined in + +[src/nevermined/api/nfts/SubscriptionCreditsNFTApi.ts:9](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/SubscriptionCreditsNFTApi.ts#L9) + +--- + +### getNFTContractAddress + +▸ `Static` **getNFTContractAddress**(`ddo`, `serviceReference?`): `any` + +Gets the NFT contract address associated with a Nevermined asset from the DDO. + +#### Parameters + +| Name | Type | Default value | Description | +| :----------------- | :------------------------------------------------------------ | :------------- | :------------------------------------------------ | +| `ddo` | [`DDO`](DDO.md) | `undefined` | The DDO of the asset. | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-access'` | The service type to look for the contract address | + +#### Returns + +`any` + +The NFT contract address. + +**`Example`** + +```ts +const nftContractAddress = NFT1155Api.getNFTContractAddress(ddo) +``` + +#### Inherited from + +[NFT1155Api](NFT1155Api.md).[getNFTContractAddress](NFT1155Api.md#getnftcontractaddress) + +#### Defined in + +[src/nevermined/api/nfts/NFTsBaseApi.ts:219](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFTsBaseApi.ts#L219) + +--- + +### getServicePlugin + +▸ `Static` `Protected` **getServicePlugin**(`config`): `Object` + +Initializes the default Nevermined service plugins and return that instance + +#### Parameters + +| Name | Type | Description | +| :------- | :---------------------------------------------------------- | :---------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | Nevermined config | + +#### Returns + +`Object` + +The Nevermined Service Plugin instance + +| Name | Type | +| :------------ | :------------------------------------------------------------------------------------------------------------ | +| `aave-credit` | [`ServicePlugin`](../interfaces/ServicePlugin.md)<[`ServiceAaveCredit`](../interfaces/ServiceAaveCredit.md)\> | +| `access` | [`AccessService`](AccessService.md) | +| `compute` | [`EscrowComputeExecutionTemplate`](EscrowComputeExecutionTemplate.md) | +| `nft-access` | [`NFTAccessService`](NFTAccessService.md) | +| `nft-sales` | [`NFTSalesService`](NFTSalesService.md) | + +#### Inherited from + +[NFT1155Api](NFT1155Api.md).[getServicePlugin](NFT1155Api.md#getserviceplugin) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:618](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L618) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[NFT1155Api](NFT1155Api.md).[setInstanceConfig](NFT1155Api.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/SubscriptionNFTApi.md b/docs/api-reference/classes/SubscriptionNFTApi.md new file mode 100644 index 000000000..7b535a31d --- /dev/null +++ b/docs/api-reference/classes/SubscriptionNFTApi.md @@ -0,0 +1,1809 @@ +[@nevermined-io/sdk](../code-reference.md) / SubscriptionNFTApi + +# Class: SubscriptionNFTApi + +Allows the interaction with external ERC-721 NFT contracts built on top of the Nevermined NFT extra features. + +## Hierarchy + +- [`NFT721Api`](NFT721Api.md) + + ↳ **`SubscriptionNFTApi`** + +## Table of contents + +### Constructors + +- [constructor](SubscriptionNFTApi.md#constructor) + +### Properties + +- [nftContract](SubscriptionNFTApi.md#nftcontract) +- [servicePlugin](SubscriptionNFTApi.md#serviceplugin) + +### Accessors + +- [address](SubscriptionNFTApi.md#address) +- [artifactsFolder](SubscriptionNFTApi.md#artifactsfolder) +- [circuitsFolder](SubscriptionNFTApi.md#circuitsfolder) +- [config](SubscriptionNFTApi.md#config) +- [getContract](SubscriptionNFTApi.md#getcontract) +- [instanceConfig](SubscriptionNFTApi.md#instanceconfig) +- [instantiableConfig](SubscriptionNFTApi.md#instantiableconfig) +- [logger](SubscriptionNFTApi.md#logger) +- [nevermined](SubscriptionNFTApi.md#nevermined) +- [web3](SubscriptionNFTApi.md#web3) + +### Methods + +- [\_details](SubscriptionNFTApi.md#_details) +- [access](SubscriptionNFTApi.md#access) +- [addRating](SubscriptionNFTApi.md#addrating) +- [balanceOf](SubscriptionNFTApi.md#balanceof) +- [burn](SubscriptionNFTApi.md#burn) +- [buySecondaryMarketNft](SubscriptionNFTApi.md#buysecondarymarketnft) +- [claim](SubscriptionNFTApi.md#claim) +- [claimNFT](SubscriptionNFTApi.md#claimnft) +- [create](SubscriptionNFTApi.md#create) +- [details](SubscriptionNFTApi.md#details) +- [getSubscriptionToken](SubscriptionNFTApi.md#getsubscriptiontoken) +- [grantOperatorRole](SubscriptionNFTApi.md#grantoperatorrole) +- [isApprovedForAll](SubscriptionNFTApi.md#isapprovedforall) +- [isOperator](SubscriptionNFTApi.md#isoperator) +- [isOperatorOfDID](SubscriptionNFTApi.md#isoperatorofdid) +- [list](SubscriptionNFTApi.md#list) +- [listOnSecondaryMarkets](SubscriptionNFTApi.md#listonsecondarymarkets) +- [mint](SubscriptionNFTApi.md#mint) +- [mintWithURL](SubscriptionNFTApi.md#mintwithurl) +- [order](SubscriptionNFTApi.md#order) +- [orderAsset](SubscriptionNFTApi.md#orderasset) +- [ownerOf](SubscriptionNFTApi.md#ownerof) +- [ownerOfAsset](SubscriptionNFTApi.md#ownerofasset) +- [ownerOfAssetByAgreement](SubscriptionNFTApi.md#ownerofassetbyagreement) +- [ownerOfTokenId](SubscriptionNFTApi.md#owneroftokenid) +- [registerNeverminedAsset](SubscriptionNFTApi.md#registerneverminedasset) +- [releaseRewards](SubscriptionNFTApi.md#releaserewards) +- [releaseSecondaryMarketRewards](SubscriptionNFTApi.md#releasesecondarymarketrewards) +- [resolveAsset](SubscriptionNFTApi.md#resolveasset) +- [revokeOperatorRole](SubscriptionNFTApi.md#revokeoperatorrole) +- [setApprovalForAll](SubscriptionNFTApi.md#setapprovalforall) +- [setInstanceConfig](SubscriptionNFTApi.md#setinstanceconfig) +- [transfer](SubscriptionNFTApi.md#transfer) +- [updateAsset](SubscriptionNFTApi.md#updateasset) +- [deployInstance](SubscriptionNFTApi.md#deployinstance) +- [getInstance](SubscriptionNFTApi.md#getinstance) +- [getInstanceUsingABI](SubscriptionNFTApi.md#getinstanceusingabi) +- [getNFTContractAddress](SubscriptionNFTApi.md#getnftcontractaddress) +- [getServicePlugin](SubscriptionNFTApi.md#getserviceplugin) +- [setInstanceConfig](SubscriptionNFTApi.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new SubscriptionNFTApi**() + +#### Inherited from + +[NFT721Api](NFT721Api.md).[constructor](NFT721Api.md#constructor) + +## Properties + +### nftContract + +• **nftContract**: [`Nft721Contract`](Nft721Contract.md) + +#### Inherited from + +[NFT721Api](NFT721Api.md).[nftContract](NFT721Api.md#nftcontract) + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:22](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L22) + +--- + +### servicePlugin + +• **servicePlugin**: `Object` + +#### Index signature + +▪ [key: `string`]: [`ServicePlugin`](../interfaces/ServicePlugin.md)<[`Service`](../code-reference.md#service)\> + +#### Inherited from + +[NFT721Api](NFT721Api.md).[servicePlugin](NFT721Api.md#serviceplugin) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L29) + +## Accessors + +### address + +• `get` **address**(): `string` + +Gets the ERC-721 NFT Contract address + +#### Returns + +`string` + +The NFT contract address + +#### Inherited from + +NFT721Api.address + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:55](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L55) + +--- + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +NFT721Api.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +NFT721Api.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +NFT721Api.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### getContract + +• `get` **getContract**(): [`Nft721Contract`](Nft721Contract.md) + +Gets the instance of the ERC-721 NFT Contract where the API is connected + +#### Returns + +[`Nft721Contract`](Nft721Contract.md) + +The `Nft721Contract` instance + +#### Inherited from + +NFT721Api.getContract + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:63](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L63) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +NFT721Api.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +NFT721Api.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +NFT721Api.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +NFT721Api.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +NFT721Api.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### \_details + +▸ `Protected` **\_details**(`did`, `ercType`): `Promise`<{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> + +Get the details of an NFT + +#### Parameters + +| Name | Type | Description | +| :-------- | :------------------------------- | :--------------------------------------------- | +| `did` | `string` | The Decentralized Identifier of the NFT asset. | +| `ercType` | [`ERCType`](../enums/ERCType.md) | The type of NFT used | + +#### Returns + +`Promise`<{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> + +The details of the NFT. + +**`Example`** + +```ts +const details = await nevermined.nfts1155.details(ddo.id) + +// The `details` object includes the NFT information + +assert.equal(details.mintCap, 5) +assert.equal(details.nftSupply, 5) +assert.equal(details.royaltyScheme, RoyaltyKind.Standard) +assert.equal(details.royalties, 100000) +assert.equal(details.owner, artist.getId()) +``` + +#### Inherited from + +[NFT721Api](NFT721Api.md).[\_details](NFT721Api.md#_details) + +#### Defined in + +[src/nevermined/api/nfts/NFTsBaseApi.ts:150](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFTsBaseApi.ts#L150) + +--- + +### access + +▸ **access**(`did`, `consumer`, `destination?`, `fileIndex?`, `agreementId?`, `buyer?`, `babysig?`, `serviceReference?`): `Promise`<`boolean`\> + +Access the files associated with an NFT. + +#### Parameters + +| Name | Type | Default value | Description | +| :----------------- | :------------------------------------------------------------ | :------------- | :------------------------------------------------------------------------ | +| `did` | `string` | `undefined` | The Decentralized Identifier of the NFT asset. | +| `consumer` | [`Account`](Account.md) | `undefined` | The NFT holder account. | +| `destination?` | `string` | `undefined` | The download destination for the files. | +| `fileIndex?` | `number` | `undefined` | The index of the file. If unset will download all the files in the asset. | +| `agreementId` | `string` | `'0x'` | The NFT sales agreement id. | +| `buyer?` | `string` | `undefined` | Key which represent the buyer | +| `babysig?` | [`Babysig`](../interfaces/Babysig.md) | `undefined` | - | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-access'` | The service reference to use. By default is nft-access. | + +#### Returns + +`Promise`<`boolean`\> + +true if the access was successful or file if isToDownload is false. + +**`Remarks`** + +This function will call the Node that will check if all the access conditions where fulfilled +before providing the files. + +**`Example`** + +```ts +const result = await nevermined.nfts1155.access(ddo.id, collector, '/tmp/') +``` + +#### Inherited from + +[NFT721Api](NFT721Api.md).[access](NFT721Api.md#access) + +#### Defined in + +[src/nevermined/api/nfts/NFTsBaseApi.ts:419](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFTsBaseApi.ts#L419) + +--- + +### addRating + +▸ **addRating**(`did`, `newRating`, `numVotesAdded?`, `publisher`, `publishMetadata?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +Given a DID, it adds a vote to the asset curation information. + +#### Parameters + +| Name | Type | Default value | Description | +| :---------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `newRating` | `number` | `undefined` | New average rating of the asset | +| `numVotesAdded` | `number` | `1` | Number of new votes added to the rating, typically just 1 | +| `publisher` | [`Account`](Account.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +[DDO](DDO.md) The DDO updated + +#### Inherited from + +[NFT721Api](NFT721Api.md).[addRating](NFT721Api.md#addrating) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:514](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L514) + +--- + +### balanceOf + +▸ **balanceOf**(`account`): `Promise`<`bigint`\> + +Get the NFT balance for a particular account/address + +#### Parameters + +| Name | Type | Description | +| :-------- | :---------------------------------- | :------------------------------------------- | +| `account` | `string` \| [`Account`](Account.md) | The account/address to check the balance of. | + +#### Returns + +`Promise`<`bigint`\> + +The balance of NFTs owned by the account. + +**`Example`** + +```ts +const balance = await nevermined.nfts721.balance(artist) +``` + +#### Inherited from + +[NFT721Api](NFT721Api.md).[balanceOf](NFT721Api.md#balanceof) + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:506](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L506) + +--- + +### burn + +▸ **burn**(`tokenId`, `account`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +Burn NFTs associated with an asset. + +#### Parameters + +| Name | Type | Description | +| :---------- | :---------------------------------------------- | :--------------------------------------- | +| `tokenId` | `string` | The identifier of the token to burn | +| `account` | [`Account`](Account.md) | The account of the publisher of the NFT. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +The ethers.ContractTransactionReceipt + +**`Remarks`** + +The publisher can only burn NFTs that it owns. NFTs that were already transferred cannot be burned by the publisher. + +**`Example`** + +```ts +await nevermined.nfts721.burn(tokenId, artist) +``` + +#### Inherited from + +[NFT721Api](NFT721Api.md).[burn](NFT721Api.md#burn) + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:347](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L347) + +--- + +### buySecondaryMarketNft + +▸ **buySecondaryMarketNft**(`consumer`, `nftAmount?`, `agreementIdSeed`, `conditionsTimeout?`, `txParams?`): `Promise`<`boolean`\> + +Buys a number of listed NFTs on secondary markets. + +#### Parameters + +| Name | Type | Description | +| :------------------ | :---------------------------------------------- | :----------------------------------------- | +| `consumer` | [`Account`](Account.md) | The account of the buyer/consumer. | +| `nftAmount` | `bigint` | The number of assets to buy. 1 by default. | +| `agreementIdSeed` | `string` | - | +| `conditionsTimeout` | `number`[] | - | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | - | + +#### Returns + +`Promise`<`boolean`\> + +true if the buy was successful. + +**`Example`** + +```ts +const result = await nevermined.nfts1155.buySecondaryMarketNft(collector, 1n, agreementId) +``` + +**`Throws`** + +[NFTError](NFTError.md) +Thrown if there is an error buying the NFT. + +#### Inherited from + +[NFT721Api](NFT721Api.md).[buySecondaryMarketNft](NFT721Api.md#buysecondarymarketnft) + +#### Defined in + +[src/nevermined/api/nfts/NFTsBaseApi.ts:341](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFTsBaseApi.ts#L341) + +--- + +### claim + +▸ **claim**(`agreementId`, `nftHolder`, `nftReceiver`, `did?`, `serviceIndex?`): `Promise`<`boolean`\> + +Claims the transfer of a NFT to the Nevermined Node on behalf of the publisher. + +#### Parameters + +| Name | Type | Description | +| :-------------- | :------- | :------------------------------------------------------- | +| `agreementId` | `string` | The NFT sales agreement id. | +| `nftHolder` | `string` | The address of the current owner of the NFT. | +| `nftReceiver` | `string` | The address where the NFT should be transferred. | +| `did?` | `string` | The Decentralized Identifier of the asset. | +| `serviceIndex?` | `any` | The index of the service in the DDO that will be claimed | + +#### Returns + +`Promise`<`boolean`\> + +true if the transfer was successful. + +**`Remarks`** + +This is useful when the consumer does not want to wait for the publisher +to transfer the NFT once the payment is made. Assuming the publisher delegated +transfer permissions to the Node. + +One example would be a marketplace where the user wants to get access to the NFT +as soon as the payment is made + +**`Example`** + +```ts +const receipt = await nevermined.nfts721.claim(agreementId, editor.getId(), subscriber.getId()) +``` + +#### Inherited from + +[NFT721Api](NFT721Api.md).[claim](NFT721Api.md#claim) + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:193](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L193) + +--- + +### claimNFT + +▸ `Protected` **claimNFT**(`agreementId`, `nftHolder`, `nftReceiver`, `numberEditions?`, `ercType?`, `did?`, `serviceIndex?`): `Promise`<`boolean`\> + +Claims the transfer of a NFT to the Nevermined Node on behalf of the publisher. + +#### Parameters + +| Name | Type | Default value | Description | +| :--------------- | :------------------------------- | :------------ | :--------------------------------------------------------------------------- | +| `agreementId` | `string` | `undefined` | The NFT sales agreement id. | +| `nftHolder` | `string` | `undefined` | The address of the current owner of the NFT. | +| `nftReceiver` | `string` | `undefined` | The address where the NFT should be transferred. | +| `numberEditions` | `bigint` | `undefined` | The number of NFT editions to transfer. If the NFT is ERC-721 it should be 1 | +| `ercType` | [`ERCType`](../enums/ERCType.md) | `1155` | The Type of the NFT ERC (1155 or 721). | +| `did?` | `string` | `undefined` | The DID of the asset. | +| `serviceIndex?` | `number` | `undefined` | The index of the service in the DDO that will be claimed | + +#### Returns + +`Promise`<`boolean`\> + +true if the transfer was successful. + +**`Remarks`** + +This is useful when the consumer does not want to wait for the publisher +to transfer the NFT once the payment is made. Assuming the publisher delegated +transfer permissions to the Node. + +One example would be a marketplace where the user wants to get access to the NFT +as soon as the payment is made + +**`Example`** + +```ts +const receipt = await nevermined.nfts721.claim( + agreementId, + editor.getId(), + subscriber.getId(), + nftAmount, + 721, +) +``` + +**`Throws`** + +[NFTError](NFTError.md) if Nevermined is not an operator for this NFT + +#### Inherited from + +[NFT721Api](NFT721Api.md).[claimNFT](NFT721Api.md#claimnft) + +#### Defined in + +[src/nevermined/api/nfts/NFTsBaseApi.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFTsBaseApi.ts#L50) + +--- + +### create + +▸ **create**(`nftAttributes`, `publisher`, `publicationOptions?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`CreateProgressStep`](../enums/CreateProgressStep.md), [`DDO`](DDO.md)\> + +Creates a new Nevermined asset associated to a NFT (ERC-721). + +#### Parameters + +| Name | Type | Description | +| :------------------- | :------------------------------------------------------ | :-------------------------------------------------------------------------------- | +| `nftAttributes` | [`NFTAttributes`](NFTAttributes.md) | Attributes describing the NFT (ERC-721) associated to the asset | +| `publisher` | [`Account`](Account.md) | The account publishing the asset | +| `publicationOptions` | [`AssetPublicationOptions`](AssetPublicationOptions.md) | Allows to specify the publication options of the off-chain and the on-chain data. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`CreateProgressStep`](../enums/CreateProgressStep.md), [`DDO`](DDO.md)\> + +The newly registered [DDO](DDO.md). + +**`Example`** + +```ts + +// We define how the Asset is and the properties +// of the NFT attached to it +const nftAttributes = NFTAttributes.getNFT721Instance({ + metadata, + price: assetPrice1, + serviceTypes: ['nft-sales', 'nft-access'] + nftContractAddress: nftContract.address +}) + +// And register the asset +ddo = await nevermined.nfts721.create( + nftAttributes, + artist, + { metadata: PublishMetadata.IPFS } +) +``` + +**`See`** + +[PublishOnChainOptions](../enums/PublishOnChainOptions.md) and [PublishMetadataOptions](../enums/PublishMetadataOptions.md) + +#### Inherited from + +[NFT721Api](NFT721Api.md).[create](NFT721Api.md#create) + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:97](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L97) + +--- + +### details + +▸ **details**(`did`): `Promise`<{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> + +Get the details of an NFT + +#### Parameters + +| Name | Type | Description | +| :---- | :------- | :--------------------------------------------- | +| `did` | `string` | The Decentralized Identifier of the NFT asset. | + +#### Returns + +`Promise`<{ `blockNumberUpdated`: `number` ; `lastChecksum`: `any` ; `lastUpdatedBy`: `any` ; `mintCap`: `bigint` ; `nftContractAddress`: `any` ; `nftInitialized`: `any` ; `nftSupply`: `bigint` ; `nftURI`: `string` ; `owner`: `any` ; `providers`: `any` ; `royalties`: `number` ; `royaltyScheme`: [`RoyaltyKind`](../enums/RoyaltyKind.md) ; `url`: `any` }\> + +The details of the NFT. + +**`Example`** + +```ts +const details = await nevermined.nfts1155.details(ddo.id) + +// The `details` object includes the NFT information + +assert.equal(details.mintCap, 5) +assert.equal(details.nftSupply, 5) +assert.equal(details.royaltyScheme, RoyaltyKind.Standard) +assert.equal(details.royalties, 100000) +assert.equal(details.owner, artist.getId()) +``` + +#### Inherited from + +[NFT721Api](NFT721Api.md).[details](NFT721Api.md#details) + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:639](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L639) + +--- + +### getSubscriptionToken + +▸ **getSubscriptionToken**(`did`, `account`): `Promise`<[`SubscriptionToken`](../interfaces/SubscriptionToken.md)\> + +Get a JWT token for an asset associated with a webService + +#### Parameters + +| Name | Type | Description | +| :-------- | :---------------------- | :----------------------------------------------------------------------------- | +| `did` | `string` | The did of the asset with a webService resource and an associated subscription | +| `account` | [`Account`](Account.md) | Account of the user requesting the token | + +#### Returns + +`Promise`<[`SubscriptionToken`](../interfaces/SubscriptionToken.md)\> + +[SubscriptionToken](../interfaces/SubscriptionToken.md) + +**`Example`** + +```ts +const response = await nevermined.nfts721.getSubscriptionToken(serviceDDO.id, subscriber) + +assert.isDefined(response.accessToken) +assert.isDefined(response.neverminedProxyUri) +``` + +#### Inherited from + +[NFT721Api](NFT721Api.md).[getSubscriptionToken](NFT721Api.md#getsubscriptiontoken) + +#### Defined in + +[src/nevermined/api/nfts/NFTsBaseApi.ts:478](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFTsBaseApi.ts#L478) + +--- + +### grantOperatorRole + +▸ **grantOperatorRole**(`operatorAddress`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +Adds a operator (`operatorAddress`) to the NFT Contract. +Granting and revoking operator permissions only can be done by the NFT Contract owner + +#### Parameters + +| Name | Type | Description | +| :---------------- | :---------------------------------------------- | :--------------------------------------------------------------------- | +| `operatorAddress` | `string` | The address of the account to be added as operator in the NFT Contract | +| `from?` | [`Account`](Account.md) | The account giving operator permissions | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +The ethers.ContractTransactionReceipt + +**`Example`** + +```ts +await nevermined.nfts721.grantOperatorRole(someoneElse, artist) +``` + +#### Inherited from + +[NFT721Api](NFT721Api.md).[grantOperatorRole](NFT721Api.md#grantoperatorrole) + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:585](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L585) + +--- + +### isApprovedForAll + +▸ **isApprovedForAll**(`operatorAddress`, `from`): `Promise`<`unknown`\> + +Returns if the `operatorAddress` is approved + +#### Parameters + +| Name | Type | Description | +| :---------------- | :------- | :--------------------------------------------------------------------------------------- | +| `operatorAddress` | `string` | The address to check the permissions | +| `from` | `string` | The address of the account granting or revoking the permissions via `setApprovalForAll`. | + +#### Returns + +`Promise`<`unknown`\> + +Boolean saying if the `operatorAddress` is approved + +**`Example`** + +```ts +await nevermined.nfts721.isApprovedForAll(someoneElse, artist.getId()) +``` + +#### Inherited from + +[NFT721Api](NFT721Api.md).[isApprovedForAll](NFT721Api.md#isapprovedforall) + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:490](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L490) + +--- + +### isOperator + +▸ **isOperator**(`nftContractAddress`, `operatorAddress`, `ercType?`): `Promise`<`boolean`\> + +Check if a particular address is the operator of given a NFT address. + +#### Parameters + +| Name | Type | Default value | Description | +| :------------------- | :------------------------------- | :------------ | :-------------------------------------- | +| `nftContractAddress` | `string` | `undefined` | The DID of the NFT to check | +| `operatorAddress` | `string` | `undefined` | The address to check if operator status | +| `ercType` | [`ERCType`](../enums/ERCType.md) | `1155` | The erc type of the NFT. | + +#### Returns + +`Promise`<`boolean`\> + +operator status of address as a boolean + +#### Inherited from + +[NFT721Api](NFT721Api.md).[isOperator](NFT721Api.md#isoperator) + +#### Defined in + +[src/nevermined/api/nfts/NFTsBaseApi.ts:116](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFTsBaseApi.ts#L116) + +--- + +### isOperatorOfDID + +▸ **isOperatorOfDID**(`did`, `address`): `Promise`<`boolean`\> + +Check if a particular address is the operator of a DID. + +#### Parameters + +| Name | Type | Description | +| :-------- | :------- | :-------------------------------------- | +| `did` | `string` | The DID of the NFT to check | +| `address` | `string` | The address to check if operator status | + +#### Returns + +`Promise`<`boolean`\> + +operator status of address as a boolean + +#### Inherited from + +[NFT721Api](NFT721Api.md).[isOperatorOfDID](NFT721Api.md#isoperatorofdid) + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:643](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L643) + +--- + +### list + +▸ **list**(`did`, `list`, `publisher`, `publishMetadata?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +Given a DID, updates the metadata associated to the asset allowing to list or unlist it. It also can upload this metadata to a remote decentralized stored depending on the `publishMetadata` parameter. +In a Nevermined environment, when an asset is unlisted, it is not possible to be found and accessed by any user. + +#### Parameters + +| Name | Type | Default value | Description | +| :---------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `list` | `boolean` | `undefined` | Needs the asset to be listed or unlisted | +| `publisher` | [`Account`](Account.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadata` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +[DDO](DDO.md) The DDO updated + +#### Inherited from + +[NFT721Api](NFT721Api.md).[list](NFT721Api.md#list) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:462](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L462) + +--- + +### listOnSecondaryMarkets + +▸ **listOnSecondaryMarkets**(`ddo`, `assetPrice`, `nftAmount`, `nftTransfer`, `provider`, `token`, `owner`): `Promise`<`string`\> + +After purchase re-list an NFT to enable secondary market sales. + +#### Parameters + +| Name | Type | Description | +| :------------ | :---------------------------- | :----------------------------------------------------------- | +| `ddo` | [`DDO`](DDO.md) | The DDO of the asset. | +| `assetPrice` | [`AssetPrice`](AssetPrice.md) | The current setup of asset rewards. | +| `nftAmount` | `bigint` | The number of NFTs put up for secondary sale. | +| `nftTransfer` | `boolean` | - | +| `provider` | `string` | The address that will be the provider of the secondary sale. | +| `token` | [`Token`](Token.md) | - | +| `owner` | [`Account`](Account.md) | The account of the current owner. | + +#### Returns + +`Promise`<`string`\> + +the agreementId of the secondary sale. + +**`Example`** + +```ts +const agreementId = await nevermined.nfts1155.listOnSecondaryMarkets( + ddo, + assetPrice, + numberNFTs, + collector.getId(), + token, + collector.getId(), +) +``` + +**`Throws`** + +[NFTError](NFTError.md) +Thrown if there is an error listing the NFT. + +#### Inherited from + +[NFT721Api](NFT721Api.md).[listOnSecondaryMarkets](NFT721Api.md#listonsecondarymarkets) + +#### Defined in + +[src/nevermined/api/nfts/NFTsBaseApi.ts:260](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFTsBaseApi.ts#L260) + +--- + +### mint + +▸ **mint**(`did`, `publisher`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +Mint NFTs associated with an asset. + +This function can be called multiple times as long as the minting does not exceed the maximum cap set during creation. + +#### Parameters + +| Name | Type | Description | +| :---------- | :---------------------------------------------- | :--------------------------------------------- | +| `did` | `string` | The Decentralized Identifier of the NFT asset. | +| `publisher` | [`Account`](Account.md) | The account of the minter | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +The ethers.ContractTransactionReceipt + +**`Example`** + +```ts +await nevermined.nfts721.mint(ddo.id, artist) +``` + +#### Inherited from + +[NFT721Api](NFT721Api.md).[mint](NFT721Api.md#mint) + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:319](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L319) + +--- + +### mintWithURL + +▸ **mintWithURL**(`to`, `did`, `url`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +Mint NFTs associated with an asset allowing to specify some metadata + +This function can be called multiple times as long as the minting does not exceed the maximum cap set during creation. + +#### Parameters + +| Name | Type | Description | +| :---------- | :---------------------------------------------- | :--------------------------------------------- | +| `to` | `string` | The address receiving the NFT minted | +| `did` | `string` | The Decentralized Identifier of the NFT asset. | +| `url` | `string` | The URL with NFT metadata | +| `from?` | [`Account`](Account.md) | The account of the minter | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +The ethers.ContractTransactionReceipt + +**`Example`** + +```ts +await nevermined.nfts721.mintWithURL(receiverAddress, ddo.id, nftMetadata, artist) +``` + +#### Inherited from + +[NFT721Api](NFT721Api.md).[mintWithURL](NFT721Api.md#mintwithurl) + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:367](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L367) + +--- + +### order + +▸ **order**(`did`, `consumer`, `serviceReference?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`OrderProgressStep`](../enums/OrderProgressStep.md), `string`\> + +Order a NFT-721. + +#### Parameters + +| Name | Type | Default value | Description | +| :----------------- | :------------------------------------------------------------ | :------------ | :------------------------------------------------------------- | +| `did` | `string` | `undefined` | The Decentralized Identifier of the NFT asset. | +| `consumer` | [`Account`](Account.md) | `undefined` | The account of the NFT buyer. | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-sales'` | The reference to identify wich service within the DDO to order | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters. | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`OrderProgressStep`](../enums/OrderProgressStep.md), `string`\> + +The agreement ID. + +**`Remarks`** + +This will lock the funds of the consumer in escrow pending the transfer of the NFTs +from the publisher. + +**`Example`** + +```ts +const agreementId = await nevermined.nfts721.order(ddo.id, collector) +``` + +#### Inherited from + +[NFT721Api](NFT721Api.md).[order](NFT721Api.md#order) + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:134](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L134) + +--- + +### orderAsset + +▸ **orderAsset**(`did`, `serviceReference`, `consumer`, `params?`): [`SubscribablePromise`](SubscribablePromise.md)<[`OrderProgressStep`](../enums/OrderProgressStep.md), `string`\> + +Start the purchase/order of an asset's service. Starts by signing the service agreement +then sends the request to the publisher via the service endpoint (Node http service). + +#### Parameters + +| Name | Type | Description | +| :----------------- | :------------------------------------------------------------ | :---------------- | +| `did` | `string` | Decentralized ID. | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | Service. | +| `consumer` | [`Account`](Account.md) | Consumer account. | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | - | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`OrderProgressStep`](../enums/OrderProgressStep.md), `string`\> + +The agreement ID. + +#### Inherited from + +[NFT721Api](NFT721Api.md).[orderAsset](NFT721Api.md#orderasset) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:563](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L563) + +--- + +### ownerOf + +▸ **ownerOf**(`did`): `Promise`<`string`\> + +Gets the contract owner + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `did` | `string` | + +#### Returns + +`Promise`<`string`\> + +Address of the contract owner + +**`Example`** + +```ts +const nftContractOwner = new Account(await nevermined.nfts721.ownerOf()) +``` + +#### Inherited from + +[NFT721Api](NFT721Api.md).[ownerOf](NFT721Api.md#ownerof) + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:416](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L416) + +--- + +### ownerOfAsset + +▸ **ownerOfAsset**(`did`): `Promise`<`string`\> + +Given a DID it gets the owner of the NFT if that DID is used as tokenId + +#### Parameters + +| Name | Type | Description | +| :---- | :------- | :--------------------------------------------- | +| `did` | `string` | The Decentralized identifier of the NFT asset. | + +#### Returns + +`Promise`<`string`\> + +The address of the NFT owner. + +**`Example`** + +```ts +const owner = await nevermined.nfts721.ownerOfAsset(ddo.id, nftTokenAddress) +``` + +#### Inherited from + +[NFT721Api](NFT721Api.md).[ownerOfAsset](NFT721Api.md#ownerofasset) + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:450](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L450) + +--- + +### ownerOfAssetByAgreement + +▸ **ownerOfAssetByAgreement**(`did`, `agreementId`): `Promise`<`string`\> + +Given a DID and an agreement id it gets the owner of the NFT + +#### Parameters + +| Name | Type | Description | +| :------------ | :------- | :--------------------------------------------- | +| `did` | `string` | The Decentralized identifier of the NFT asset. | +| `agreementId` | `string` | The NFT sales agreement id. | + +#### Returns + +`Promise`<`string`\> + +The address of the NFT owner. + +**`Example`** + +```ts +const owner = await nevermined.nfts721.ownerOfAssetByAgreement(ddo.id, agreementId) +``` + +#### Inherited from + +[NFT721Api](NFT721Api.md).[ownerOfAssetByAgreement](NFT721Api.md#ownerofassetbyagreement) + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:468](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L468) + +--- + +### ownerOfTokenId + +▸ **ownerOfTokenId**(`tokenId`): `Promise`<`string`\> + +Given some information, it gets the owner of the NFT + +#### Parameters + +| Name | Type | Description | +| :-------- | :------- | :----------- | +| `tokenId` | `string` | The token id | + +#### Returns + +`Promise`<`string`\> + +The address of the NFT owner. + +**`Example`** + +```ts +const owner = await nevermined.nfts721.ownerOfTokenId(tokenId) +``` + +#### Inherited from + +[NFT721Api](NFT721Api.md).[ownerOfTokenId](NFT721Api.md#owneroftokenid) + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:433](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L433) + +--- + +### registerNeverminedAsset + +▸ `Protected` **registerNeverminedAsset**(`assetAttributes`, `publisher`, `publicationOptions`, `nftAttributes?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`CreateProgressStep`](../enums/CreateProgressStep.md), [`DDO`](DDO.md)\> + +It registers a new asset in a Nevermined network. This method is protected and not exposed +via the Nevermined APIs directly. It must accessed via the `assets`, `compute`, and `nfts` APIs. + +#### Parameters + +| Name | Type | Description | +| :------------------- | :------------------------------------------------------ | :-------------------------------------------------------------------------------- | +| `assetAttributes` | [`AssetAttributes`](AssetAttributes.md) | Attributes describing the asset | +| `publisher` | [`Account`](Account.md) | The account publishing the asset | +| `publicationOptions` | [`AssetPublicationOptions`](AssetPublicationOptions.md) | Allows to specify the publication options of the off-chain and the on-chain data. | +| `nftAttributes?` | [`NFTAttributes`](NFTAttributes.md) | Attributes describing the NFT (ERC-721) associated to the asset | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`CreateProgressStep`](../enums/CreateProgressStep.md), [`DDO`](DDO.md)\> + +The metadata of the asset created (DDO) + +**`See`** + +[PublishOnChainOptions](../enums/PublishOnChainOptions.md) and [PublishMetadataOptions](../enums/PublishMetadataOptions.md) + +#### Inherited from + +[NFT721Api](NFT721Api.md).[registerNeverminedAsset](NFT721Api.md#registerneverminedasset) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L42) + +--- + +### releaseRewards + +▸ **releaseRewards**(`agreementId`, `did`, `publisher`, `serviceReference?`, `txParams?`): `Promise`<`boolean`\> + +Release the funds from escrow. + +#### Parameters + +| Name | Type | Default value | Description | +| :----------------- | :------------------------------------------------------------ | :------------ | :----------------------------------------------------------------------- | +| `agreementId` | `string` | `undefined` | The NFT sales agreement id. | +| `did` | `string` | `undefined` | The Decentralized identifier of the NFT asset. | +| `publisher` | [`Account`](Account.md) | `undefined` | The current owner of the NFTs. | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-sales'` | The reference to identify wich service within the DDO to release rewards | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters. | + +#### Returns + +`Promise`<`boolean`\> + +true if the funds release was successful. + +**`Remarks`** + +A publisher is able to release the funds put on escrow by the consumer after transferring the NFTs. + +**`Example`** + +```ts +const receipt = await nevermined.nfts721.releaseRewards(agreementId, ddo.id, artist) +``` + +**`Throws`** + +[NFTError](NFTError.md) +Thrown if there is an error releasing the rewards. + +#### Inherited from + +[NFT721Api](NFT721Api.md).[releaseRewards](NFT721Api.md#releaserewards) + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:277](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L277) + +--- + +### releaseSecondaryMarketRewards + +▸ **releaseSecondaryMarketRewards**(`owner`, `account`, `agreementIdSeed`, `txParams?`): `Promise`<`boolean`\> + +Used to release the secondary market NFT & the locked rewards. + +#### Parameters + +| Name | Type | Description | +| :---------------- | :---------------------------------------------- | :---------------------------------------------------------------- | +| `owner` | [`Account`](Account.md) | The owner account. | +| `account` | [`Account`](Account.md) | Account of the user sending the transaction | +| `agreementIdSeed` | `string` | the seed of the Agreement Id of the underlying service agreement. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | + +#### Returns + +`Promise`<`boolean`\> + +true if the transaction was successful. + +**`Example`** + +```ts +// TODO +``` + +**`Throws`** + +[NFTError](NFTError.md) +Thrown if there is an error releasing the rewards. + +#### Inherited from + +[NFT721Api](NFT721Api.md).[releaseSecondaryMarketRewards](NFT721Api.md#releasesecondarymarketrewards) + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:529](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L529) + +--- + +### resolveAsset + +▸ `Protected` **resolveAsset**(`did`, `policy?`): `Promise`<[`DDO`](DDO.md)\> + +Returns a DDO by DID. Depending of the resolution policy it prioritize the Metadata API or Immutable urls. + +#### Parameters + +| Name | Type | Default value | Description | +| :------- | :------------------------------------------------- | :---------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `did` | `string` | `undefined` | Decentralized ID. | +| `policy` | [`DIDResolvePolicy`](../enums/DIDResolvePolicy.md) | `DIDResolvePolicy.MetadataAPIFirst` | It specifies the resolve policy to apply. It allows to select that priorities during the asset resolution via Metadata API or Immutable URLs (IPFS, Filecoin, etc) | + +#### Returns + +`Promise`<[`DDO`](DDO.md)\> + +[DDO](DDO.md) + +#### Inherited from + +[NFT721Api](NFT721Api.md).[resolveAsset](NFT721Api.md#resolveasset) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:310](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L310) + +--- + +### revokeOperatorRole + +▸ **revokeOperatorRole**(`operatorAddress`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +Revokes a minter (`operatorAddress`) of the NFT Contract. +Granting and revoking minting permissions only can be done by the NFT Contract owner + +#### Parameters + +| Name | Type | Description | +| :---------------- | :---------------------------------------------- | :----------------------------------------------------------------------- | +| `operatorAddress` | `string` | The address of the account to be revoked as operator in the NFT Contract | +| `from?` | [`Account`](Account.md) | The account revoking operator permissions | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +The ethers.ContractTransactionReceipt + +**`Example`** + +```ts +await nevermined.nfts721.revokeOperatorRole(someoneElse, artist) +``` + +#### Inherited from + +[NFT721Api](NFT721Api.md).[revokeOperatorRole](NFT721Api.md#revokeoperatorrole) + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:611](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L611) + +--- + +### setApprovalForAll + +▸ **setApprovalForAll**(`target`, `approved`, `from`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +Enable or disable NFT permissions for an operator. + +#### Parameters + +| Name | Type | Description | +| :---------- | :---------------------------------------------- | :------------------------------------------------------------------- | +| `target` | `string` | The address that of the operator we want to give transfer rights to. | +| `approved` | `boolean` | Give or remove transfer rights from the operator. | +| `from` | [`Account`](Account.md) | The account that wants to give transfer rights to the operator. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Optional transaction parameters. | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +The ethers.ContractTransactionReceipt + +**`Example`** + +```ts +await nevermined.nfts721.setApprovalForAll(someoneElse, true, artist) +``` + +#### Inherited from + +[NFT721Api](NFT721Api.md).[setApprovalForAll](NFT721Api.md#setapprovalforall) + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:395](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L395) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[NFT721Api](NFT721Api.md).[setInstanceConfig](NFT721Api.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### transfer + +▸ **transfer**(`agreementId`, `did`, `publisher`, `serviceReference?`, `txParams?`): `Promise`<`boolean`\> + +Transfer NFT-721 to the consumer. + +#### Parameters + +| Name | Type | Default value | Description | +| :----------------- | :------------------------------------------------------------ | :------------ | :---------------------------------------------------------------- | +| `agreementId` | `string` | `undefined` | The NFT sales agreement id. | +| `did` | `string` | `undefined` | The Decentralized identifier of the NFT asset. | +| `publisher` | [`Account`](Account.md) | `undefined` | The current owner of the NFTs. | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-sales'` | The reference to identify wich service within the DDO to transfer | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters. | + +#### Returns + +`Promise`<`boolean`\> + +true if the transfer was successful. + +**`Remarks`** + +A publisher/provider will check if the consumer put the funds in escrow and +execute the transfer in order to be able to release the rewards. + +**`Example`** + +```ts +const receipt = await nevermined.nfts721.transfer(agreementId, ddo.id, artist) +``` + +**`Throws`** + +[NFTError](NFTError.md) +Thrown if there is an error transferring the NFT + +#### Inherited from + +[NFT721Api](NFT721Api.md).[transfer](NFT721Api.md#transfer) + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:226](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L226) + +--- + +### updateAsset + +▸ `Protected` **updateAsset**(`did`, `metadata`, `publisher`, `publishMetadataOptions?`, `txParams?`): [`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +Given a DID, updates the metadata associated to the asset. It also can upload this metadata to a remote decentralized stored depending on the `publishMetadata` parameter. + +#### Parameters + +| Name | Type | Default value | Description | +| :----------------------- | :------------------------------------------------------------- | :--------------------------------------- | :------------------------------------------------------------------------------- | +| `did` | `string` | `undefined` | Decentralized ID representing the unique id of an asset in a Nevermined network. | +| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | Metadata describing the asset | +| `publisher` | [`Account`](Account.md) | `undefined` | Account of the user updating the metadata | +| `publishMetadataOptions` | [`PublishMetadataOptions`](../enums/PublishMetadataOptions.md) | `PublishMetadataOptions.OnlyMetadataAPI` | It allows to specify where to store the metadata | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Optional transaction parameters | + +#### Returns + +[`SubscribablePromise`](SubscribablePromise.md)<[`UpdateProgressStep`](../enums/UpdateProgressStep.md), [`DDO`](DDO.md)\> + +[DDO](DDO.md) The DDO updated + +#### Inherited from + +[NFT721Api](NFT721Api.md).[updateAsset](NFT721Api.md#updateasset) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:353](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L353) + +--- + +### deployInstance + +▸ `Static` **deployInstance**(`config`, `contractABI`, `from`, `args?`): `Promise`<[`SubscriptionNFTApi`](SubscriptionNFTApi.md)\> + +#### Parameters + +| Name | Type | Default value | +| :------------ | :------------------------------------------ | :------------ | +| `config` | [`NeverminedOptions`](NeverminedOptions.md) | `undefined` | +| `contractABI` | `any` | `undefined` | +| `from` | [`Account`](Account.md) | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`Promise`<[`SubscriptionNFTApi`](SubscriptionNFTApi.md)\> + +#### Defined in + +[src/nevermined/api/nfts/SubscriptionNFTApi.ts:25](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/SubscriptionNFTApi.ts#L25) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`, `nftContractAddress`): `Promise`<[`NFT721Api`](NFT721Api.md)\> + +Create a new Nevermined NFTs (ERC-721) instance allowing to interact with that kind of NFTs. + +#### Parameters + +| Name | Type | Description | +| :------------------- | :---------------------------------------------------------- | :-------------------------------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | The Nevermined config | +| `nftContractAddress` | `string` | If the Nft721 Contract is deployed in an address it will connect to that contract | + +#### Returns + +`Promise`<[`NFT721Api`](NFT721Api.md)\> + +The NFTs 721 API instance [NFT721Api](NFT721Api.md). + +**`Example`** + +```ts +nfts721 = await Nft721Api.getInstance(instanceConfig, nftContractAddress) +``` + +#### Inherited from + +[NFT721Api](NFT721Api.md).[getInstance](NFT721Api.md#getinstance) + +#### Defined in + +[src/nevermined/api/nfts/NFT721Api.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFT721Api.ts#L39) + +--- + +### getInstanceUsingABI + +▸ `Static` **getInstanceUsingABI**(`config`, `nftContractAddress`, `solidityABI`): `Promise`<[`SubscriptionNFTApi`](SubscriptionNFTApi.md)\> + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | +| `nftContractAddress` | `string` | +| `solidityABI` | `any` | + +#### Returns + +`Promise`<[`SubscriptionNFTApi`](SubscriptionNFTApi.md)\> + +#### Defined in + +[src/nevermined/api/nfts/SubscriptionNFTApi.ts:8](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/SubscriptionNFTApi.ts#L8) + +--- + +### getNFTContractAddress + +▸ `Static` **getNFTContractAddress**(`ddo`, `serviceReference?`): `any` + +Gets the NFT contract address associated with a Nevermined asset from the DDO. + +#### Parameters + +| Name | Type | Default value | Description | +| :----------------- | :------------------------------------------------------------ | :------------- | :------------------------------------------------ | +| `ddo` | [`DDO`](DDO.md) | `undefined` | The DDO of the asset. | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | `'nft-access'` | The service type to look for the contract address | + +#### Returns + +`any` + +The NFT contract address. + +**`Example`** + +```ts +const nftContractAddress = NFT1155Api.getNFTContractAddress(ddo) +``` + +#### Inherited from + +[NFT721Api](NFT721Api.md).[getNFTContractAddress](NFT721Api.md#getnftcontractaddress) + +#### Defined in + +[src/nevermined/api/nfts/NFTsBaseApi.ts:219](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/nfts/NFTsBaseApi.ts#L219) + +--- + +### getServicePlugin + +▸ `Static` `Protected` **getServicePlugin**(`config`): `Object` + +Initializes the default Nevermined service plugins and return that instance + +#### Parameters + +| Name | Type | Description | +| :------- | :---------------------------------------------------------- | :---------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | Nevermined config | + +#### Returns + +`Object` + +The Nevermined Service Plugin instance + +| Name | Type | +| :------------ | :------------------------------------------------------------------------------------------------------------ | +| `aave-credit` | [`ServicePlugin`](../interfaces/ServicePlugin.md)<[`ServiceAaveCredit`](../interfaces/ServiceAaveCredit.md)\> | +| `access` | [`AccessService`](AccessService.md) | +| `compute` | [`EscrowComputeExecutionTemplate`](EscrowComputeExecutionTemplate.md) | +| `nft-access` | [`NFTAccessService`](NFTAccessService.md) | +| `nft-sales` | [`NFTSalesService`](NFTSalesService.md) | + +#### Inherited from + +[NFT721Api](NFT721Api.md).[getServicePlugin](NFT721Api.md#getserviceplugin) + +#### Defined in + +[src/nevermined/api/RegistryBaseApi.ts:618](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/RegistryBaseApi.ts#L618) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[NFT721Api](NFT721Api.md).[setInstanceConfig](NFT721Api.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/TemplateStoreManager.md b/docs/api-reference/classes/TemplateStoreManager.md new file mode 100644 index 000000000..ee5b88feb --- /dev/null +++ b/docs/api-reference/classes/TemplateStoreManager.md @@ -0,0 +1,687 @@ +[@nevermined-io/sdk](../code-reference.md) / TemplateStoreManager + +# Class: TemplateStoreManager + +## Hierarchy + +- [`ContractBase`](ContractBase.md) + + ↳ **`TemplateStoreManager`** + +## Table of contents + +### Constructors + +- [constructor](TemplateStoreManager.md#constructor) + +### Properties + +- [address](TemplateStoreManager.md#address) +- [contract](TemplateStoreManager.md#contract) +- [contractName](TemplateStoreManager.md#contractname) +- [events](TemplateStoreManager.md#events) +- [version](TemplateStoreManager.md#version) + +### Accessors + +- [artifactsFolder](TemplateStoreManager.md#artifactsfolder) +- [circuitsFolder](TemplateStoreManager.md#circuitsfolder) +- [config](TemplateStoreManager.md#config) +- [instanceConfig](TemplateStoreManager.md#instanceconfig) +- [instantiableConfig](TemplateStoreManager.md#instantiableconfig) +- [logger](TemplateStoreManager.md#logger) +- [nevermined](TemplateStoreManager.md#nevermined) +- [web3](TemplateStoreManager.md#web3) + +### Methods + +- [approveTemplate](TemplateStoreManager.md#approvetemplate) +- [call](TemplateStoreManager.md#call) +- [getFromAddress](TemplateStoreManager.md#getfromaddress) +- [getInputsOfMethod](TemplateStoreManager.md#getinputsofmethod) +- [getListSize](TemplateStoreManager.md#getlistsize) +- [getOwner](TemplateStoreManager.md#getowner) +- [getSignatureOfMethod](TemplateStoreManager.md#getsignatureofmethod) +- [getTemplate](TemplateStoreManager.md#gettemplate) +- [init](TemplateStoreManager.md#init) +- [isApproved](TemplateStoreManager.md#isapproved) +- [proposeTemplate](TemplateStoreManager.md#proposetemplate) +- [revokeTemplate](TemplateStoreManager.md#revoketemplate) +- [send](TemplateStoreManager.md#send) +- [sendFrom](TemplateStoreManager.md#sendfrom) +- [setInstanceConfig](TemplateStoreManager.md#setinstanceconfig) +- [getInstance](TemplateStoreManager.md#getinstance) +- [setInstanceConfig](TemplateStoreManager.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new TemplateStoreManager**(`contractName`) + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Inherited from + +[ContractBase](ContractBase.md).[constructor](ContractBase.md#constructor) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L34) + +## Properties + +### address + +• **address**: `string` + +#### Inherited from + +[ContractBase](ContractBase.md).[address](ContractBase.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[ContractBase](ContractBase.md).[contract](ContractBase.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[ContractBase](ContractBase.md).[contractName](ContractBase.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[ContractBase](ContractBase.md).[events](ContractBase.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[ContractBase](ContractBase.md).[version](ContractBase.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ContractBase.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ContractBase.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +ContractBase.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ContractBase.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ContractBase.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +ContractBase.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +ContractBase.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +ContractBase.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### approveTemplate + +▸ **approveTemplate**(`address`, `from?`, `ignoreApproved?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :---------------- | :---------------------------------------------- | +| `address` | `string` | +| `from?` | [`Account`](Account.md) | +| `ignoreApproved?` | `boolean` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Defined in + +[src/keeper/contracts/managers/TemplateStoreManager.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/TemplateStoreManager.ts#L50) + +--- + +### 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](ContractBase.md).[call](ContractBase.md#call) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ContractBase](ContractBase.md).[getFromAddress](ContractBase.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[ContractBase](ContractBase.md).[getInputsOfMethod](ContractBase.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getListSize + +▸ **getListSize**(): `Promise`<`unknown`\> + +#### Returns + +`Promise`<`unknown`\> + +#### Defined in + +[src/keeper/contracts/managers/TemplateStoreManager.ts:85](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/TemplateStoreManager.ts#L85) + +--- + +### getOwner + +▸ **getOwner**(): `Promise`<`string`\> + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/keeper/contracts/managers/TemplateStoreManager.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/TemplateStoreManager.ts#L29) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[ContractBase](ContractBase.md).[getSignatureOfMethod](ContractBase.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### getTemplate + +▸ **getTemplate**(`templateId`): `Promise`<[`TemplateMetadata`](../interfaces/TemplateMetadata.md)\> + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `templateId` | `string` | + +#### Returns + +`Promise`<[`TemplateMetadata`](../interfaces/TemplateMetadata.md)\> + +#### Defined in + +[src/keeper/contracts/managers/TemplateStoreManager.ts:71](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/TemplateStoreManager.ts#L71) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[ContractBase](ContractBase.md).[init](ContractBase.md#init) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### isApproved + +▸ **isApproved**(`templateId`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `templateId` | `string` | + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[src/keeper/contracts/managers/TemplateStoreManager.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/TemplateStoreManager.ts#L81) + +--- + +### proposeTemplate + +▸ **proposeTemplate**(`address`, `from?`, `ignoreExists?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :-------------- | :---------------------------------------------- | +| `address` | `string` | +| `from?` | [`Account`](Account.md) | +| `ignoreExists?` | `boolean` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Defined in + +[src/keeper/contracts/managers/TemplateStoreManager.ts:33](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/TemplateStoreManager.ts#L33) + +--- + +### revokeTemplate + +▸ **revokeTemplate**(`address`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :---------- | :---------------------------------------------- | +| `address` | `string` | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Defined in + +[src/keeper/contracts/managers/TemplateStoreManager.ts:67](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/TemplateStoreManager.ts#L67) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ContractBase](ContractBase.md).[send](ContractBase.md#send) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ContractBase](ContractBase.md).[sendFrom](ContractBase.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ContractBase](ContractBase.md).[setInstanceConfig](ContractBase.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`): `Promise`<[`TemplateStoreManager`](TemplateStoreManager.md)\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`Promise`<[`TemplateStoreManager`](TemplateStoreManager.md)\> + +#### Overrides + +[ContractBase](ContractBase.md).[getInstance](ContractBase.md#getinstance) + +#### Defined in + +[src/keeper/contracts/managers/TemplateStoreManager.ts:21](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/TemplateStoreManager.ts#L21) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ContractBase](ContractBase.md).[setInstanceConfig](ContractBase.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/Token.md b/docs/api-reference/classes/Token.md new file mode 100644 index 000000000..c0445f7ca --- /dev/null +++ b/docs/api-reference/classes/Token.md @@ -0,0 +1,728 @@ +[@nevermined-io/sdk](../code-reference.md) / Token + +# Class: Token + +## Hierarchy + +- [`ContractBase`](ContractBase.md) + + ↳ **`Token`** + + ↳↳ [`CustomToken`](CustomToken.md) + +## Table of contents + +### Constructors + +- [constructor](Token.md#constructor) + +### Properties + +- [address](Token.md#address) +- [contract](Token.md#contract) +- [contractName](Token.md#contractname) +- [events](Token.md#events) +- [version](Token.md#version) +- [ERC20_ABI](Token.md#erc20_abi) + +### Accessors + +- [artifactsFolder](Token.md#artifactsfolder) +- [circuitsFolder](Token.md#circuitsfolder) +- [config](Token.md#config) +- [instanceConfig](Token.md#instanceconfig) +- [instantiableConfig](Token.md#instantiableconfig) +- [logger](Token.md#logger) +- [nevermined](Token.md#nevermined) +- [web3](Token.md#web3) + +### Methods + +- [approve](Token.md#approve) +- [balanceOf](Token.md#balanceof) +- [balanceOfConverted](Token.md#balanceofconverted) +- [call](Token.md#call) +- [decimals](Token.md#decimals) +- [getFromAddress](Token.md#getfromaddress) +- [getInputsOfMethod](Token.md#getinputsofmethod) +- [getSignatureOfMethod](Token.md#getsignatureofmethod) +- [init](Token.md#init) +- [name](Token.md#name) +- [send](Token.md#send) +- [sendFrom](Token.md#sendfrom) +- [setInstanceConfig](Token.md#setinstanceconfig) +- [strBalanceOf](Token.md#strbalanceof) +- [symbol](Token.md#symbol) +- [totalSupply](Token.md#totalsupply) +- [transfer](Token.md#transfer) +- [getInstance](Token.md#getinstance) +- [setInstanceConfig](Token.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new Token**(`contractName`) + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Inherited from + +[ContractBase](ContractBase.md).[constructor](ContractBase.md#constructor) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L34) + +## Properties + +### address + +• **address**: `string` + +#### Inherited from + +[ContractBase](ContractBase.md).[address](ContractBase.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[ContractBase](ContractBase.md).[contract](ContractBase.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[ContractBase](ContractBase.md).[contractName](ContractBase.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[ContractBase](ContractBase.md).[events](ContractBase.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[ContractBase](ContractBase.md).[version](ContractBase.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +--- + +### ERC20_ABI + +▪ `Static` **ERC20_ABI**: `string`[] + +#### Defined in + +[src/keeper/contracts/Token.ts:7](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Token.ts#L7) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ContractBase.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ContractBase.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +ContractBase.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ContractBase.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ContractBase.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +ContractBase.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +ContractBase.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +ContractBase.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### approve + +▸ **approve**(`to`, `price`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :---------- | :---------------------------------------------- | +| `to` | `string` | +| `price` | `bigint` | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Defined in + +[src/keeper/contracts/Token.ts:27](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Token.ts#L27) + +--- + +### balanceOf + +▸ **balanceOf**(`address`): `Promise`<`bigint`\> + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `address` | `string` | + +#### Returns + +`Promise`<`bigint`\> + +#### Defined in + +[src/keeper/contracts/Token.ts:43](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Token.ts#L43) + +--- + +### balanceOfConverted + +▸ **balanceOfConverted**(`address`): `Promise`<`bigint`\> + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `address` | `string` | + +#### Returns + +`Promise`<`bigint`\> + +#### Defined in + +[src/keeper/contracts/Token.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Token.ts#L35) + +--- + +### 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](ContractBase.md).[call](ContractBase.md#call) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### decimals + +▸ **decimals**(): `Promise`<`number`\> + +#### Returns + +`Promise`<`number`\> + +#### Defined in + +[src/keeper/contracts/Token.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Token.ts#L31) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ContractBase](ContractBase.md).[getFromAddress](ContractBase.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[ContractBase](ContractBase.md).[getInputsOfMethod](ContractBase.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[ContractBase](ContractBase.md).[getSignatureOfMethod](ContractBase.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[ContractBase](ContractBase.md).[init](ContractBase.md#init) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### name + +▸ **name**(): `Promise`<`string`\> + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/keeper/contracts/Token.ts:51](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Token.ts#L51) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ContractBase](ContractBase.md).[send](ContractBase.md#send) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ContractBase](ContractBase.md).[sendFrom](ContractBase.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ContractBase](ContractBase.md).[setInstanceConfig](ContractBase.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### strBalanceOf + +▸ **strBalanceOf**(`address`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `address` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/keeper/contracts/Token.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Token.ts#L39) + +--- + +### symbol + +▸ **symbol**(): `Promise`<`string`\> + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/keeper/contracts/Token.ts:47](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Token.ts#L47) + +--- + +### totalSupply + +▸ **totalSupply**(): `Promise`<`bigint`\> + +#### Returns + +`Promise`<`bigint`\> + +#### Defined in + +[src/keeper/contracts/Token.ts:55](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Token.ts#L55) + +--- + +### transfer + +▸ **transfer**(`to`, `amount`, `from`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :---------- | :---------------------------------------------- | +| `to` | `string` | +| `amount` | `bigint` | +| `from` | `string` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Defined in + +[src/keeper/contracts/Token.ts:59](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Token.ts#L59) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`): `Promise`<[`Token`](Token.md)\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`Promise`<[`Token`](Token.md)\> + +#### Overrides + +[ContractBase](ContractBase.md).[getInstance](ContractBase.md#getinstance) + +#### Defined in + +[src/keeper/contracts/Token.ts:21](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Token.ts#L21) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ContractBase](ContractBase.md).[setInstanceConfig](ContractBase.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/TokenUtils.md b/docs/api-reference/classes/TokenUtils.md new file mode 100644 index 000000000..d6a4fe2a0 --- /dev/null +++ b/docs/api-reference/classes/TokenUtils.md @@ -0,0 +1,402 @@ +[@nevermined-io/sdk](../code-reference.md) / TokenUtils + +# Class: TokenUtils + +Tokens submodule of Nevermined. + +## Hierarchy + +- [`Instantiable`](Instantiable.md) + + ↳ **`TokenUtils`** + +## Table of contents + +### Constructors + +- [constructor](TokenUtils.md#constructor) + +### Accessors + +- [artifactsFolder](TokenUtils.md#artifactsfolder) +- [circuitsFolder](TokenUtils.md#circuitsfolder) +- [config](TokenUtils.md#config) +- [instanceConfig](TokenUtils.md#instanceconfig) +- [instantiableConfig](TokenUtils.md#instantiableconfig) +- [logger](TokenUtils.md#logger) +- [nevermined](TokenUtils.md#nevermined) +- [web3](TokenUtils.md#web3) + +### Methods + +- [getAddress](TokenUtils.md#getaddress) +- [getName](TokenUtils.md#getname) +- [getSymbol](TokenUtils.md#getsymbol) +- [getTotalSupply](TokenUtils.md#gettotalsupply) +- [request](TokenUtils.md#request) +- [setInstanceConfig](TokenUtils.md#setinstanceconfig) +- [transfer](TokenUtils.md#transfer) +- [getInstance](TokenUtils.md#getinstance) +- [setInstanceConfig](TokenUtils.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new TokenUtils**(`config`) + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Overrides + +[Instantiable](Instantiable.md).[constructor](Instantiable.md#constructor) + +#### Defined in + +[src/nevermined/Token.ts:9](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Token.ts#L9) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +Instantiable.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +Instantiable.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +Instantiable.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +Instantiable.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### getAddress + +▸ **getAddress**(): `string` + +#### Returns + +`string` + +#### Defined in + +[src/nevermined/Token.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Token.ts#L30) + +--- + +### getName + +▸ **getName**(): `Promise`<`string`\> + +Get token name. + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/nevermined/Token.ts:37](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Token.ts#L37) + +--- + +### getSymbol + +▸ **getSymbol**(): `Promise`<`string`\> + +Get token symbol. + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/nevermined/Token.ts:26](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Token.ts#L26) + +--- + +### getTotalSupply + +▸ **getTotalSupply**(): `Promise`<`bigint`\> + +Get token total supply + +#### Returns + +`Promise`<`bigint`\> + +#### Defined in + +[src/nevermined/Token.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Token.ts#L44) + +--- + +### request + +▸ **request**(`account`, `amount`, `params?`): `Promise`<`boolean`\> + +Request tokens for an account. + +#### Parameters + +| Name | Type | Description | +| :-------- | :---------------------------------------------- | :---------------- | +| `account` | [`Account`](Account.md) | Account instance. | +| `amount` | `number` | Token amount. | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | - | + +#### Returns + +`Promise`<`boolean`\> + +true if the call succeeded, false otherwise + +#### Defined in + +[src/nevermined/Token.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Token.ts#L73) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### transfer + +▸ **transfer**(`to`, `amount`, `from`, `txParams?`): `Promise`<`boolean`\> + +Transfer a number of tokens to the mentioned account. + +#### Parameters + +| Name | Type | Description | +| :---------- | :---------------------------------------------- | :-------------------------------- | +| `to` | `string` | Address that receives the tokens. | +| `amount` | `bigint` | Tokens to transfer. | +| `from` | [`Account`](Account.md) | Sender account address. | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | + +#### Returns + +`Promise`<`boolean`\> + +True if the transfer succeeded. + +#### Defined in + +[src/nevermined/Token.ts:56](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Token.ts#L56) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`): `Promise`<[`TokenUtils`](TokenUtils.md)\> + +Returns the instance of Token. + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`Promise`<[`TokenUtils`](TokenUtils.md)\> + +[Token](Token.md) + +#### Overrides + +[Instantiable](Instantiable.md).[getInstance](Instantiable.md#getinstance) + +#### Defined in + +[src/nevermined/Token.ts:18](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Token.ts#L18) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/TransferDIDOwnershipCondition.md b/docs/api-reference/classes/TransferDIDOwnershipCondition.md new file mode 100644 index 000000000..2a9300ab8 --- /dev/null +++ b/docs/api-reference/classes/TransferDIDOwnershipCondition.md @@ -0,0 +1,977 @@ +[@nevermined-io/sdk](../code-reference.md) / TransferDIDOwnershipCondition + +# Class: TransferDIDOwnershipCondition + +Condition allowing to transfer the ownership between the original owner and a receiver. + +## Hierarchy + +- [`ProviderCondition`](ProviderCondition.md)<`AccessConditionContext`\> + + ↳ **`TransferDIDOwnershipCondition`** + +## Table of contents + +### Constructors + +- [constructor](TransferDIDOwnershipCondition.md#constructor) + +### Properties + +- [address](TransferDIDOwnershipCondition.md#address) +- [contract](TransferDIDOwnershipCondition.md#contract) +- [contractName](TransferDIDOwnershipCondition.md#contractname) +- [events](TransferDIDOwnershipCondition.md#events) +- [version](TransferDIDOwnershipCondition.md#version) + +### Accessors + +- [artifactsFolder](TransferDIDOwnershipCondition.md#artifactsfolder) +- [circuitsFolder](TransferDIDOwnershipCondition.md#circuitsfolder) +- [config](TransferDIDOwnershipCondition.md#config) +- [instanceConfig](TransferDIDOwnershipCondition.md#instanceconfig) +- [instantiableConfig](TransferDIDOwnershipCondition.md#instantiableconfig) +- [logger](TransferDIDOwnershipCondition.md#logger) +- [nevermined](TransferDIDOwnershipCondition.md#nevermined) +- [web3](TransferDIDOwnershipCondition.md#web3) + +### Methods + +- [abortByTimeOut](TransferDIDOwnershipCondition.md#abortbytimeout) +- [call](TransferDIDOwnershipCondition.md#call) +- [fulfill](TransferDIDOwnershipCondition.md#fulfill) +- [fulfillInstance](TransferDIDOwnershipCondition.md#fulfillinstance) +- [fulfillPlain](TransferDIDOwnershipCondition.md#fulfillplain) +- [fulfillWithNode](TransferDIDOwnershipCondition.md#fulfillwithnode) +- [generateId](TransferDIDOwnershipCondition.md#generateid) +- [generateIdHash](TransferDIDOwnershipCondition.md#generateidhash) +- [generateIdWithSeed](TransferDIDOwnershipCondition.md#generateidwithseed) +- [getConditionFulfilledEvent](TransferDIDOwnershipCondition.md#getconditionfulfilledevent) +- [getFromAddress](TransferDIDOwnershipCondition.md#getfromaddress) +- [getInputsOfMethod](TransferDIDOwnershipCondition.md#getinputsofmethod) +- [getSignatureOfMethod](TransferDIDOwnershipCondition.md#getsignatureofmethod) +- [hashValues](TransferDIDOwnershipCondition.md#hashvalues) +- [hashValuesPlain](TransferDIDOwnershipCondition.md#hashvaluesplain) +- [init](TransferDIDOwnershipCondition.md#init) +- [instance](TransferDIDOwnershipCondition.md#instance) +- [instanceFromDDO](TransferDIDOwnershipCondition.md#instancefromddo) +- [nodeMethod](TransferDIDOwnershipCondition.md#nodemethod) +- [params](TransferDIDOwnershipCondition.md#params) +- [paramsFromDDO](TransferDIDOwnershipCondition.md#paramsfromddo) +- [send](TransferDIDOwnershipCondition.md#send) +- [sendFrom](TransferDIDOwnershipCondition.md#sendfrom) +- [setInstanceConfig](TransferDIDOwnershipCondition.md#setinstanceconfig) +- [getInstance](TransferDIDOwnershipCondition.md#getinstance) +- [setInstanceConfig](TransferDIDOwnershipCondition.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new TransferDIDOwnershipCondition**(`contractName`) + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[constructor](ProviderCondition.md#constructor) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L34) + +## Properties + +### address + +• **address**: `string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[address](ProviderCondition.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[contract](ProviderCondition.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[contractName](ProviderCondition.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[events](ProviderCondition.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[version](ProviderCondition.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ProviderCondition.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ProviderCondition.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +ProviderCondition.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ProviderCondition.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ProviderCondition.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +ProviderCondition.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +ProviderCondition.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +ProviderCondition.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### abortByTimeOut + +▸ **abortByTimeOut**(`conditionId`, `from?`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------------ | :---------------------------------------------- | +| `conditionId` | `string` | +| `from?` | [`Account`](Account.md) | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[abortByTimeOut](ProviderCondition.md#abortbytimeout) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L88) + +--- + +### 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 + +[ProviderCondition](ProviderCondition.md).[call](ProviderCondition.md#call) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### fulfill + +▸ **fulfill**(`agreementId`, `did`, `receiver`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +Fulfill the transfer DID ownership condition. + +#### Parameters + +| Name | Type | Description | +| :------------ | :---------------------------------------------- | :----------------------------------------- | +| `agreementId` | `string` | Agreement identifier. | +| `did` | `string` | The Decentralized Identifier of the asset. | +| `receiver` | `string` | The address of the granted user. | +| `from?` | [`Account`](Account.md) | Account fullfilling | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | Transaction parameters | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +Condition state. + +**`Remarks`** + +Only DID owner or DID provider can call this method. +Fulfill method transfer full ownership permissions to the receiver address. + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[fulfill](ProviderCondition.md#fulfill) + +#### Defined in + +[src/keeper/contracts/conditions/TransferDIDOwnershipCondition.ts:53](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/TransferDIDOwnershipCondition.ts#L53) + +--- + +### fulfillInstance + +▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `txParams?`, `method?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | Default value | +| :----------------- | :----------------------------------------------------------------------------------------- | :------------ | +| `cond` | [`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | +| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | +| `from?` | [`Account`](Account.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[fulfillInstance](ProviderCondition.md#fulfillinstance) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:150](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L150) + +--- + +### fulfillPlain + +▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `txParams?`, `method?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | Default value | +| :------------ | :-------------------------------------------------------- | :------------ | +| `agreementId` | `string` | `undefined` | +| `args` | `any`[] | `undefined` | +| `from?` | [`Account`](Account.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[fulfillPlain](ProviderCondition.md#fulfillplain) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L63) + +--- + +### fulfillWithNode + +▸ **fulfillWithNode**(`cond`, `additionalParams`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :----------------- | :----------------------------------------------------------------------------------------- | +| `cond` | [`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | +| `additionalParams` | `Record`<`string`, `unknown`\> | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[fulfillWithNode](ProviderCondition.md#fulfillwithnode) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:194](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L194) + +--- + +### generateId + +▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `valueHash` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[generateId](ProviderCondition.md#generateid) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L77) + +--- + +### generateIdHash + +▸ **generateIdHash**(`agreementId`, `...values`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `...values` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[generateIdHash](ProviderCondition.md#generateidhash) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L73) + +--- + +### generateIdWithSeed + +▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `valueHash` | `string` | + +#### Returns + +`Promise`<[`string`, `string`]\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[generateIdWithSeed](ProviderCondition.md#generateidwithseed) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L81) + +--- + +### getConditionFulfilledEvent + +▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../code-reference.md#eventresult) + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | + +#### Returns + +[`EventResult`](../code-reference.md#eventresult) + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getConditionFulfilledEvent](ProviderCondition.md#getconditionfulfilledevent) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L92) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getFromAddress](ProviderCondition.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getInputsOfMethod](ProviderCondition.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getSignatureOfMethod](ProviderCondition.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### hashValues + +▸ **hashValues**(`...args`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[hashValues](ProviderCondition.md#hashvalues) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L129) + +--- + +### hashValuesPlain + +▸ **hashValuesPlain**(`...args`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[hashValuesPlain](ProviderCondition.md#hashvaluesplain) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:133](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L133) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[init](ProviderCondition.md#init) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### instance + +▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :------------ | :--------------------------------------------------------------------------------------------- | +| `agreementId` | `string` | +| `params` | [`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | + +#### Returns + +`Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[instance](ProviderCondition.md#instance) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:174](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L174) + +--- + +### instanceFromDDO + +▸ **instanceFromDDO**(`agreementId`, `ctx`, `...args`): `Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------------------------------------------- | +| `agreementId` | `string` | +| `ctx` | `AccessConditionContext` | +| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | + +#### Returns + +`Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[instanceFromDDO](ProviderCondition.md#instancefromddo) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L142) + +--- + +### nodeMethod + +▸ **nodeMethod**(): [`ConditionMethod`](../code-reference.md#conditionmethod) + +#### Returns + +[`ConditionMethod`](../code-reference.md#conditionmethod) + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[nodeMethod](ProviderCondition.md#nodemethod) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:208](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L208) + +--- + +### params + +▸ **params**(`did`, `receiver`): [`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> + +Generates the hash of the condition inputs. + +#### Parameters + +| Name | Type | Description | +| :--------- | :------- | :----------------------------------------------- | +| `did` | `string` | The Decentralized Identifier of the asset. | +| `receiver` | `string` | Address of the granted user or the DID provider. | + +#### Returns + +[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> + +Hash of all the values. + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[params](ProviderCondition.md#params) + +#### Defined in + +[src/keeper/contracts/conditions/TransferDIDOwnershipCondition.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/TransferDIDOwnershipCondition.ts#L31) + +--- + +### paramsFromDDO + +▸ **paramsFromDDO**(`«destructured»`): `Promise`<[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :--------------- | :----------------------- | +| `«destructured»` | `AccessConditionContext` | + +#### Returns + +`Promise`<[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[paramsFromDDO](ProviderCondition.md#paramsfromddo) + +#### Defined in + +[src/keeper/contracts/conditions/TransferDIDOwnershipCondition.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/TransferDIDOwnershipCondition.ts#L35) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[send](ProviderCondition.md#send) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[sendFrom](ProviderCondition.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[setInstanceConfig](ProviderCondition.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`): `Promise`<[`TransferDIDOwnershipCondition`](TransferDIDOwnershipCondition.md)\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`Promise`<[`TransferDIDOwnershipCondition`](TransferDIDOwnershipCondition.md)\> + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[getInstance](ProviderCondition.md#getinstance) + +#### Defined in + +[src/keeper/contracts/conditions/TransferDIDOwnershipCondition.ts:15](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/TransferDIDOwnershipCondition.ts#L15) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[setInstanceConfig](ProviderCondition.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/TransferNFT721Condition.md b/docs/api-reference/classes/TransferNFT721Condition.md new file mode 100644 index 000000000..6fc9ddc81 --- /dev/null +++ b/docs/api-reference/classes/TransferNFT721Condition.md @@ -0,0 +1,1007 @@ +[@nevermined-io/sdk](../code-reference.md) / TransferNFT721Condition + +# Class: TransferNFT721Condition + +Condition allowing to transfer an NFT between the original owner and a receiver + +## Hierarchy + +- [`ProviderCondition`](ProviderCondition.md)<`TransferNFT721ConditionContext`\> + + ↳ **`TransferNFT721Condition`** + +## Table of contents + +### Constructors + +- [constructor](TransferNFT721Condition.md#constructor) + +### Properties + +- [address](TransferNFT721Condition.md#address) +- [contract](TransferNFT721Condition.md#contract) +- [contractName](TransferNFT721Condition.md#contractname) +- [events](TransferNFT721Condition.md#events) +- [version](TransferNFT721Condition.md#version) + +### Accessors + +- [artifactsFolder](TransferNFT721Condition.md#artifactsfolder) +- [circuitsFolder](TransferNFT721Condition.md#circuitsfolder) +- [config](TransferNFT721Condition.md#config) +- [instanceConfig](TransferNFT721Condition.md#instanceconfig) +- [instantiableConfig](TransferNFT721Condition.md#instantiableconfig) +- [logger](TransferNFT721Condition.md#logger) +- [nevermined](TransferNFT721Condition.md#nevermined) +- [web3](TransferNFT721Condition.md#web3) + +### Methods + +- [abortByTimeOut](TransferNFT721Condition.md#abortbytimeout) +- [call](TransferNFT721Condition.md#call) +- [fulfill](TransferNFT721Condition.md#fulfill) +- [fulfillInstance](TransferNFT721Condition.md#fulfillinstance) +- [fulfillPlain](TransferNFT721Condition.md#fulfillplain) +- [fulfillWithNode](TransferNFT721Condition.md#fulfillwithnode) +- [generateId](TransferNFT721Condition.md#generateid) +- [generateIdHash](TransferNFT721Condition.md#generateidhash) +- [generateIdWithSeed](TransferNFT721Condition.md#generateidwithseed) +- [getConditionFulfilledEvent](TransferNFT721Condition.md#getconditionfulfilledevent) +- [getFromAddress](TransferNFT721Condition.md#getfromaddress) +- [getInputsOfMethod](TransferNFT721Condition.md#getinputsofmethod) +- [getSignatureOfMethod](TransferNFT721Condition.md#getsignatureofmethod) +- [hashValues](TransferNFT721Condition.md#hashvalues) +- [hashValuesPlain](TransferNFT721Condition.md#hashvaluesplain) +- [init](TransferNFT721Condition.md#init) +- [instance](TransferNFT721Condition.md#instance) +- [instanceFromDDO](TransferNFT721Condition.md#instancefromddo) +- [nodeMethod](TransferNFT721Condition.md#nodemethod) +- [params](TransferNFT721Condition.md#params) +- [paramsFromDDO](TransferNFT721Condition.md#paramsfromddo) +- [paramsFromService](TransferNFT721Condition.md#paramsfromservice) +- [send](TransferNFT721Condition.md#send) +- [sendFrom](TransferNFT721Condition.md#sendfrom) +- [setInstanceConfig](TransferNFT721Condition.md#setinstanceconfig) +- [getInstance](TransferNFT721Condition.md#getinstance) +- [setInstanceConfig](TransferNFT721Condition.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new TransferNFT721Condition**(`contractName`) + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[constructor](ProviderCondition.md#constructor) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L34) + +## Properties + +### address + +• **address**: `string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[address](ProviderCondition.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[contract](ProviderCondition.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[contractName](ProviderCondition.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[events](ProviderCondition.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[version](ProviderCondition.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ProviderCondition.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ProviderCondition.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +ProviderCondition.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ProviderCondition.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ProviderCondition.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +ProviderCondition.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +ProviderCondition.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +ProviderCondition.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### abortByTimeOut + +▸ **abortByTimeOut**(`conditionId`, `from?`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------------ | :---------------------------------------------- | +| `conditionId` | `string` | +| `from?` | [`Account`](Account.md) | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[abortByTimeOut](ProviderCondition.md#abortbytimeout) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L88) + +--- + +### 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 + +[ProviderCondition](ProviderCondition.md).[call](ProviderCondition.md#call) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### fulfill + +▸ **fulfill**(`agreementId`, `did`, `nftReceiver`, `lockPaymentCondition`, `nftTokenAddress`, `willBeTransferred?`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +Fulfill the transfer NFT condition. + +#### Parameters + +| Name | Type | Default value | Description | +| :--------------------- | :---------------------------------------------- | :------------ | :--------------------------------------------------- | +| `agreementId` | `string` | `undefined` | The agreement identifier. | +| `did` | `string` | `undefined` | The DID of the asset with NFTs. | +| `nftReceiver` | `string` | `undefined` | The address of the account to receive the NFT. | +| `lockPaymentCondition` | `string` | `undefined` | lock payment condition identifier. | +| `nftTokenAddress` | `string` | `undefined` | address of the nft token to use. | +| `willBeTransferred` | `boolean` | `true` | Indicates if the asset will be transferred or minted | +| `from?` | [`Account`](Account.md) | `undefined` | | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | - | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +Condition state. + +**`Remarks`** + +Only DID owner or DID provider can call this method. + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[fulfill](ProviderCondition.md#fulfill) + +#### Defined in + +[src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts:146](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts#L146) + +--- + +### fulfillInstance + +▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `txParams?`, `method?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | Default value | +| :----------------- | :----------------------------------------------------------------------------------------- | :------------ | +| `cond` | [`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | +| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | +| `from?` | [`Account`](Account.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[fulfillInstance](ProviderCondition.md#fulfillinstance) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:150](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L150) + +--- + +### fulfillPlain + +▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `txParams?`, `method?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | Default value | +| :------------ | :-------------------------------------------------------- | :------------ | +| `agreementId` | `string` | `undefined` | +| `args` | `any`[] | `undefined` | +| `from?` | [`Account`](Account.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[fulfillPlain](ProviderCondition.md#fulfillplain) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L63) + +--- + +### fulfillWithNode + +▸ **fulfillWithNode**(`cond`, `additionalParams`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :----------------- | :----------------------------------------------------------------------------------------- | +| `cond` | [`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | +| `additionalParams` | `Record`<`string`, `unknown`\> | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[fulfillWithNode](ProviderCondition.md#fulfillwithnode) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:194](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L194) + +--- + +### generateId + +▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `valueHash` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[generateId](ProviderCondition.md#generateid) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L77) + +--- + +### generateIdHash + +▸ **generateIdHash**(`agreementId`, `...values`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `...values` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[generateIdHash](ProviderCondition.md#generateidhash) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L73) + +--- + +### generateIdWithSeed + +▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `valueHash` | `string` | + +#### Returns + +`Promise`<[`string`, `string`]\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[generateIdWithSeed](ProviderCondition.md#generateidwithseed) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L81) + +--- + +### getConditionFulfilledEvent + +▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../code-reference.md#eventresult) + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | + +#### Returns + +[`EventResult`](../code-reference.md#eventresult) + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getConditionFulfilledEvent](ProviderCondition.md#getconditionfulfilledevent) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L92) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getFromAddress](ProviderCondition.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getInputsOfMethod](ProviderCondition.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getSignatureOfMethod](ProviderCondition.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### hashValues + +▸ **hashValues**(`...args`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[hashValues](ProviderCondition.md#hashvalues) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L129) + +--- + +### hashValuesPlain + +▸ **hashValuesPlain**(`...args`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[hashValuesPlain](ProviderCondition.md#hashvaluesplain) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:133](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L133) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[init](ProviderCondition.md#init) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### instance + +▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :------------ | :--------------------------------------------------------------------------------------------- | +| `agreementId` | `string` | +| `params` | [`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | + +#### Returns + +`Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[instance](ProviderCondition.md#instance) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:174](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L174) + +--- + +### instanceFromDDO + +▸ **instanceFromDDO**(`agreementId`, `ctx`, `...args`): `Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------------------------------------------- | +| `agreementId` | `string` | +| `ctx` | `TransferNFT721ConditionContext` | +| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | + +#### Returns + +`Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[instanceFromDDO](ProviderCondition.md#instancefromddo) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L142) + +--- + +### nodeMethod + +▸ **nodeMethod**(): [`ConditionMethod`](../code-reference.md#conditionmethod) + +#### Returns + +[`ConditionMethod`](../code-reference.md#conditionmethod) + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[nodeMethod](ProviderCondition.md#nodemethod) + +#### Defined in + +[src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts:171](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts#L171) + +--- + +### params + +▸ **params**(`did`, `nftHolder`, `nftReceiver`, `lockCondition`, `nftTokenAddress`, `willBeTransferred?`, `expiration?`): [`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> + +Generates the hash of condition inputs. + +#### Parameters + +| Name | Type | Default value | Description | +| :------------------ | :-------- | :------------ | :--------------------------------------------------- | +| `did` | `string` | `undefined` | The DID of the asset with NFTs. | +| `nftHolder` | `string` | `undefined` | The address of the Holder of the NFT. | +| `nftReceiver` | `string` | `undefined` | The address of the granted user or the DID provider. | +| `lockCondition` | `string` | `undefined` | Lock condition identifier. | +| `nftTokenAddress` | `string` | `undefined` | The address of the NFT token to use. | +| `willBeTransferred` | `boolean` | `true` | Indicates if the asset will be transferred or minted | +| `expiration` | `number` | `0` | The expiration time of the condition | + +#### Returns + +[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> + +Hash of all the values + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[params](ProviderCondition.md#params) + +#### Defined in + +[src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts:38](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts#L38) + +--- + +### paramsFromDDO + +▸ **paramsFromDDO**(`«destructured»`, `lockCondition`): `Promise`<[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :--------------- | :------------------------------- | +| `«destructured»` | `TransferNFT721ConditionContext` | +| `lockCondition` | `any` | + +#### Returns + +`Promise`<[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[paramsFromDDO](ProviderCondition.md#paramsfromddo) + +#### Defined in + +[src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts:83](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts#L83) + +--- + +### paramsFromService + +▸ **paramsFromService**(`«destructured»`, `lockCondition`): `Promise`<[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :--------------- | :------------------------------- | +| `«destructured»` | `TransferNFT721ConditionContext` | +| `lockCondition` | `any` | + +#### Returns + +`Promise`<[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> + +#### Defined in + +[src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts:107](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts#L107) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[send](ProviderCondition.md#send) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[sendFrom](ProviderCondition.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[setInstanceConfig](ProviderCondition.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`): `Promise`<[`TransferNFT721Condition`](TransferNFT721Condition.md)\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`Promise`<[`TransferNFT721Condition`](TransferNFT721Condition.md)\> + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[getInstance](ProviderCondition.md#getinstance) + +#### Defined in + +[src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts:23](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts#L23) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[setInstanceConfig](ProviderCondition.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/TransferNFTCondition.md b/docs/api-reference/classes/TransferNFTCondition.md new file mode 100644 index 000000000..91a3d377e --- /dev/null +++ b/docs/api-reference/classes/TransferNFTCondition.md @@ -0,0 +1,1059 @@ +[@nevermined-io/sdk](../code-reference.md) / TransferNFTCondition + +# Class: TransferNFTCondition + +Condition allowing to transfer an NFT between the original owner and a receiver + +## Hierarchy + +- [`ProviderCondition`](ProviderCondition.md)<`TransferNFTConditionContext`\> + + ↳ **`TransferNFTCondition`** + +## Table of contents + +### Constructors + +- [constructor](TransferNFTCondition.md#constructor) + +### Properties + +- [address](TransferNFTCondition.md#address) +- [contract](TransferNFTCondition.md#contract) +- [contractName](TransferNFTCondition.md#contractname) +- [events](TransferNFTCondition.md#events) +- [version](TransferNFTCondition.md#version) +- [NO_EXPIRY](TransferNFTCondition.md#no_expiry) + +### Accessors + +- [artifactsFolder](TransferNFTCondition.md#artifactsfolder) +- [circuitsFolder](TransferNFTCondition.md#circuitsfolder) +- [config](TransferNFTCondition.md#config) +- [instanceConfig](TransferNFTCondition.md#instanceconfig) +- [instantiableConfig](TransferNFTCondition.md#instantiableconfig) +- [logger](TransferNFTCondition.md#logger) +- [nevermined](TransferNFTCondition.md#nevermined) +- [web3](TransferNFTCondition.md#web3) + +### Methods + +- [abortByTimeOut](TransferNFTCondition.md#abortbytimeout) +- [call](TransferNFTCondition.md#call) +- [fulfill](TransferNFTCondition.md#fulfill) +- [fulfillForDelegate](TransferNFTCondition.md#fulfillfordelegate) +- [fulfillInstance](TransferNFTCondition.md#fulfillinstance) +- [fulfillPlain](TransferNFTCondition.md#fulfillplain) +- [fulfillWithNode](TransferNFTCondition.md#fulfillwithnode) +- [generateId](TransferNFTCondition.md#generateid) +- [generateIdHash](TransferNFTCondition.md#generateidhash) +- [generateIdWithSeed](TransferNFTCondition.md#generateidwithseed) +- [getConditionFulfilledEvent](TransferNFTCondition.md#getconditionfulfilledevent) +- [getFromAddress](TransferNFTCondition.md#getfromaddress) +- [getInputsOfMethod](TransferNFTCondition.md#getinputsofmethod) +- [getSignatureOfMethod](TransferNFTCondition.md#getsignatureofmethod) +- [hashValues](TransferNFTCondition.md#hashvalues) +- [hashValuesPlain](TransferNFTCondition.md#hashvaluesplain) +- [init](TransferNFTCondition.md#init) +- [instance](TransferNFTCondition.md#instance) +- [instanceFromDDO](TransferNFTCondition.md#instancefromddo) +- [nftContractFromService](TransferNFTCondition.md#nftcontractfromservice) +- [nodeMethod](TransferNFTCondition.md#nodemethod) +- [params](TransferNFTCondition.md#params) +- [paramsFromDDO](TransferNFTCondition.md#paramsfromddo) +- [send](TransferNFTCondition.md#send) +- [sendFrom](TransferNFTCondition.md#sendfrom) +- [setInstanceConfig](TransferNFTCondition.md#setinstanceconfig) +- [getInstance](TransferNFTCondition.md#getinstance) +- [setInstanceConfig](TransferNFTCondition.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new TransferNFTCondition**(`contractName`) + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `contractName` | `string` | + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[constructor](ProviderCondition.md#constructor) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L34) + +## Properties + +### address + +• **address**: `string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[address](ProviderCondition.md#address) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L32) + +--- + +### contract + +• **contract**: `BaseContract` = `null` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[contract](ProviderCondition.md#contract) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L29) + +--- + +### contractName + +• `Readonly` **contractName**: `string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[contractName](ProviderCondition.md#contractname) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L28) + +--- + +### events + +• **events**: [`ContractEvent`](ContractEvent.md) \| [`SubgraphEvent`](SubgraphEvent.md) = `null` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[events](ProviderCondition.md#events) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L30) + +--- + +### version + +• **version**: `string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[version](ProviderCondition.md#version) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L31) + +--- + +### NO_EXPIRY + +▪ `Static` `Readonly` **NO_EXPIRY**: `0` + +#### Defined in + +[src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:26](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts#L26) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ProviderCondition.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +ProviderCondition.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +ProviderCondition.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ProviderCondition.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +ProviderCondition.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +ProviderCondition.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +ProviderCondition.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +ProviderCondition.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### abortByTimeOut + +▸ **abortByTimeOut**(`conditionId`, `from?`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------------ | :---------------------------------------------- | +| `conditionId` | `string` | +| `from?` | [`Account`](Account.md) | +| `params?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[abortByTimeOut](ProviderCondition.md#abortbytimeout) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L88) + +--- + +### 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 + +[ProviderCondition](ProviderCondition.md).[call](ProviderCondition.md#call) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L328) + +--- + +### fulfill + +▸ **fulfill**(`agreementId`, `did`, `nftReceiver`, `nftAmount`, `nftContractAddress`, `lockPaymentCondition`, `willBeTransferred?`, `expiration?`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +Fulfill the transfer NFT condition. + +#### Parameters + +| Name | Type | Default value | Description | +| :--------------------- | :---------------------------------------------- | :------------ | :--------------------------------------------------- | +| `agreementId` | `string` | `undefined` | The agreement identifier. | +| `did` | `string` | `undefined` | The DID of the asset with NFTs. | +| `nftReceiver` | `string` | `undefined` | The address of the account to receive the NFT. | +| `nftAmount` | `bigint` | `undefined` | amount of NFTs to transfer. | +| `nftContractAddress` | `string` | `undefined` | Address of the nft contract | +| `lockPaymentCondition` | `string` | `undefined` | lock payment condition identifier. | +| `willBeTransferred` | `boolean` | `true` | Indicates if the asset will be transferred or minted | +| `expiration` | `number` | `0` | - | +| `from?` | [`Account`](Account.md) | `undefined` | | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | - | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +Condition state. + +**`Remarks`** + +Only DID owner or DID provider can call this method. + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[fulfill](ProviderCondition.md#fulfill) + +#### Defined in + +[src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:141](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts#L141) + +--- + +### fulfillForDelegate + +▸ **fulfillForDelegate**(`agreementId`, `did`, `nftHolder`, `nftReceiver`, `nftAmount`, `lockPaymentCondition`, `nftAddress`, `willBeTransferred?`, `expiration?`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +Fulfill the transfer NFT condition. + +#### Parameters + +| Name | Type | Default value | Description | +| :--------------------- | :---------------------------------------------- | :------------ | :------------------------------------------------------------ | +| `agreementId` | `string` | `undefined` | The agreement identifier. | +| `did` | `string` | `undefined` | The DID of the asset with NFTs. | +| `nftHolder` | `string` | `undefined` | The address of the account currently holding the NFT. | +| `nftReceiver` | `string` | `undefined` | The address of the account to receive the NFT. | +| `nftAmount` | `bigint` | `undefined` | The amount of NFTs to transfer. | +| `lockPaymentCondition` | `string` | `undefined` | The lock payment condition identifier. | +| `nftAddress` | `string` | `undefined` | - | +| `willBeTransferred` | `boolean` | `true` | Indicates if the asset will be transferred or minted | +| `expiration` | `bigint` | `undefined` | Block in which the token expires. If zero means no expiration | +| `from?` | [`Account`](Account.md) | `undefined` | Account sending the transaction | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | Transaction parameters | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +Condition state. + +**`Remarks`** + +Only DID owner or DID provider can call this method. + +#### Defined in + +[src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:187](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts#L187) + +--- + +### fulfillInstance + +▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `txParams?`, `method?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | Default value | +| :----------------- | :----------------------------------------------------------------------------------------- | :------------ | +| `cond` | [`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | +| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | +| `from?` | [`Account`](Account.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[fulfillInstance](ProviderCondition.md#fulfillinstance) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:150](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L150) + +--- + +### fulfillPlain + +▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `txParams?`, `method?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | Default value | +| :------------ | :-------------------------------------------------------- | :------------ | +| `agreementId` | `string` | `undefined` | +| `args` | `any`[] | `undefined` | +| `from?` | [`Account`](Account.md) | `undefined` | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | `undefined` | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | `'fulfill'` | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[fulfillPlain](ProviderCondition.md#fulfillplain) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L63) + +--- + +### fulfillWithNode + +▸ **fulfillWithNode**(`cond`, `additionalParams`, `from?`, `txParams?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :----------------- | :----------------------------------------------------------------------------------------- | +| `cond` | [`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | +| `additionalParams` | `Record`<`string`, `unknown`\> | +| `from?` | [`Account`](Account.md) | +| `txParams?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[fulfillWithNode](ProviderCondition.md#fulfillwithnode) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:194](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L194) + +--- + +### generateId + +▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `valueHash` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[generateId](ProviderCondition.md#generateid) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L77) + +--- + +### generateIdHash + +▸ **generateIdHash**(`agreementId`, `...values`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `...values` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[generateIdHash](ProviderCondition.md#generateidhash) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L73) + +--- + +### generateIdWithSeed + +▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | +| `valueHash` | `string` | + +#### Returns + +`Promise`<[`string`, `string`]\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[generateIdWithSeed](ProviderCondition.md#generateidwithseed) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L81) + +--- + +### getConditionFulfilledEvent + +▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../code-reference.md#eventresult) + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | + +#### Returns + +[`EventResult`](../code-reference.md#eventresult) + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getConditionFulfilledEvent](ProviderCondition.md#getconditionfulfilledevent) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:92](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L92) + +--- + +### getFromAddress + +▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `from?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getFromAddress](ProviderCondition.md#getfromaddress) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L80) + +--- + +### getInputsOfMethod + +▸ **getInputsOfMethod**(`methodName`): readonly `ParamType`[] + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `methodName` | `string` | + +#### Returns + +readonly `ParamType`[] + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getInputsOfMethod](ProviderCondition.md#getinputsofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L44) + +--- + +### getSignatureOfMethod + +▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------ | +| `methodName` | `string` | `undefined` | +| `args` | `any`[] | `[]` | + +#### Returns + +`string` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[getSignatureOfMethod](ProviderCondition.md#getsignatureofmethod) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L39) + +--- + +### hashValues + +▸ **hashValues**(`...args`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[hashValues](ProviderCondition.md#hashvalues) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L129) + +--- + +### hashValuesPlain + +▸ **hashValuesPlain**(`...args`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[hashValuesPlain](ProviderCondition.md#hashvaluesplain) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:133](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L133) + +--- + +### init + +▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :--------- | :---------------------------------------------------------- | :------------ | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | `undefined` | +| `optional` | `boolean` | `false` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[init](ProviderCondition.md#init) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L49) + +--- + +### instance + +▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :------------ | :--------------------------------------------------------------------------------------------- | +| `agreementId` | `string` | +| `params` | [`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | + +#### Returns + +`Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[instance](ProviderCondition.md#instance) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:174](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L174) + +--- + +### instanceFromDDO + +▸ **instanceFromDDO**(`agreementId`, `ctx`, `...args`): `Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------------------------------------------- | +| `agreementId` | `string` | +| `ctx` | `TransferNFTConditionContext` | +| `...args` | [`ConditionInstanceSmall`](../interfaces/ConditionInstanceSmall.md)[] | + +#### Returns + +`Promise`<[`ConditionInstance`](../interfaces/ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[instanceFromDDO](ProviderCondition.md#instancefromddo) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L142) + +--- + +### nftContractFromService + +▸ **nftContractFromService**(`service`): `string` + +#### Parameters + +| Name | Type | +| :-------- | :------------------------------------------------ | +| `service` | [`ServiceCommon`](../interfaces/ServiceCommon.md) | + +#### Returns + +`string` + +#### Defined in + +[src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:92](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts#L92) + +--- + +### nodeMethod + +▸ **nodeMethod**(): [`ConditionMethod`](../code-reference.md#conditionmethod) + +#### Returns + +[`ConditionMethod`](../code-reference.md#conditionmethod) + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[nodeMethod](ProviderCondition.md#nodemethod) + +#### Defined in + +[src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:213](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts#L213) + +--- + +### params + +▸ **params**(`did`, `nftHolder`, `nftReceiver`, `nftAmount`, `lockCondition`, `nftContractAddress?`, `willBeTransferred?`, `expiration?`): [`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> + +Generates the hash of condition inputs. + +#### Parameters + +| Name | Type | Default value | Description | +| :-------------------- | :-------- | :------------ | :--------------------------------------------------- | +| `did` | `string` | `undefined` | The DID of the asset with NFTs. | +| `nftHolder` | `string` | `undefined` | The address of the holder of the NFT. | +| `nftReceiver` | `string` | `undefined` | The address of the granted user or the DID provider. | +| `nftAmount` | `bigint` | `undefined` | Amount of NFTs to transfer. | +| `lockCondition` | `string` | `undefined` | Lock condition identifier. | +| `nftContractAddress?` | `string` | `undefined` | The address of the NFT token to use. | +| `willBeTransferred` | `boolean` | `true` | Indicates if the asset will be transferred or minted | +| `expiration` | `number` | `0` | - | + +#### Returns + +[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\> + +Hash of all the values + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[params](ProviderCondition.md#params) + +#### Defined in + +[src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts#L44) + +--- + +### paramsFromDDO + +▸ **paramsFromDDO**(`«destructured»`, `lockCondition`): `Promise`<[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> + +#### Parameters + +| Name | Type | +| :--------------- | :---------------------------- | +| `«destructured»` | `TransferNFTConditionContext` | +| `lockCondition` | `any` | + +#### Returns + +`Promise`<[`ConditionParameters`](../interfaces/ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[paramsFromDDO](ProviderCondition.md#paramsfromddo) + +#### Defined in + +[src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts#L99) + +--- + +### send + +▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `from` | `string` | +| `args` | `any`[] | +| `params` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[send](ProviderCondition.md#send) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:235](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L235) + +--- + +### sendFrom + +▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractTransactionReceipt`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------- | +| `name` | `string` | +| `args` | `any`[] | +| `from?` | [`Account`](Account.md) | +| `value?` | [`TxParameters`](../interfaces/TxParameters.md) | + +#### Returns + +`Promise`<`ContractTransactionReceipt`\> + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[sendFrom](ProviderCondition.md#sendfrom) + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:88](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L88) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[setInstanceConfig](ProviderCondition.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### getInstance + +▸ `Static` **getInstance**(`config`): `Promise`<[`TransferNFTCondition`](TransferNFTCondition.md)\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`Promise`<[`TransferNFTCondition`](TransferNFTCondition.md)\> + +#### Overrides + +[ProviderCondition](ProviderCondition.md).[getInstance](ProviderCondition.md#getinstance) + +#### Defined in + +[src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts#L28) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[ProviderCondition](ProviderCondition.md).[setInstanceConfig](ProviderCondition.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/UtilsApi.md b/docs/api-reference/classes/UtilsApi.md new file mode 100644 index 000000000..0df6db865 --- /dev/null +++ b/docs/api-reference/classes/UtilsApi.md @@ -0,0 +1,386 @@ +[@nevermined-io/sdk](../code-reference.md) / UtilsApi + +# Class: UtilsApi + +Nevermined Utils API + +## Hierarchy + +- [`Instantiable`](Instantiable.md) + + ↳ **`UtilsApi`** + +## Table of contents + +### Constructors + +- [constructor](UtilsApi.md#constructor) + +### Properties + +- [agreements](UtilsApi.md#agreements) +- [contractHandler](UtilsApi.md#contracthandler) +- [fetch](UtilsApi.md#fetch) +- [files](UtilsApi.md#files) +- [jwt](UtilsApi.md#jwt) +- [signature](UtilsApi.md#signature) +- [token](UtilsApi.md#token) +- [versions](UtilsApi.md#versions) + +### Accessors + +- [artifactsFolder](UtilsApi.md#artifactsfolder) +- [circuitsFolder](UtilsApi.md#circuitsfolder) +- [config](UtilsApi.md#config) +- [instanceConfig](UtilsApi.md#instanceconfig) +- [instantiableConfig](UtilsApi.md#instantiableconfig) +- [logger](UtilsApi.md#logger) +- [nevermined](UtilsApi.md#nevermined) +- [web3](UtilsApi.md#web3) + +### Methods + +- [setInstanceConfig](UtilsApi.md#setinstanceconfig) +- [getInstance](UtilsApi.md#getinstance) +- [setInstanceConfig](UtilsApi.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new UtilsApi**(`config`) + +Creates a new AssetsApi + +#### Parameters + +| Name | Type | Description | +| :------- | :---------------------------------------------------------- | :--------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | Configuration of the Nevermined instance | + +#### Overrides + +[Instantiable](Instantiable.md).[constructor](Instantiable.md#constructor) + +#### Defined in + +[src/nevermined/api/UtilsApi.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/UtilsApi.ts#L57) + +## Properties + +### agreements + +• **agreements**: [`ServiceAgreement`](ServiceAgreement.md) + +Agreement utils. + +#### Defined in + +[src/nevermined/api/UtilsApi.ts:15](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/UtilsApi.ts#L15) + +--- + +### contractHandler + +• **contractHandler**: [`ContractHandler`](ContractHandler.md) + +Contract utils + +#### Defined in + +[src/nevermined/api/UtilsApi.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/UtilsApi.ts#L50) + +--- + +### fetch + +• **fetch**: [`WebServiceConnector`](WebServiceConnector.md) + +Fetch utils. + +#### Defined in + +[src/nevermined/api/UtilsApi.ts:20](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/UtilsApi.ts#L20) + +--- + +### files + +• **files**: [`Files`](Files.md) + +Files utils. + +#### Defined in + +[src/nevermined/api/UtilsApi.ts:25](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/UtilsApi.ts#L25) + +--- + +### jwt + +• **jwt**: [`JwtUtils`](JwtUtils.md) + +Jwt utils. + +#### Defined in + +[src/nevermined/api/UtilsApi.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/UtilsApi.ts#L30) + +--- + +### signature + +• **signature**: [`SignatureUtils`](SignatureUtils.md) + +Signature utils. + +#### Defined in + +[src/nevermined/api/UtilsApi.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/UtilsApi.ts#L35) + +--- + +### token + +• **token**: [`TokenUtils`](TokenUtils.md) + +Token utils. + +#### Defined in + +[src/nevermined/api/UtilsApi.ts:40](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/UtilsApi.ts#L40) + +--- + +### versions + +• **versions**: [`Versions`](Versions.md) + +Token utils. + +#### Defined in + +[src/nevermined/api/UtilsApi.ts:45](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/UtilsApi.ts#L45) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +Instantiable.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +Instantiable.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +Instantiable.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +Instantiable.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### getInstance + +▸ `Static` **getInstance**(`..._args`): `any` + +#### Parameters + +| Name | Type | +| :--------- | :---- | +| `..._args` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[Instantiable](Instantiable.md).[getInstance](Instantiable.md#getinstance) + +#### Defined in + +[src/Instantiable.abstract.ts:86](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L86) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/Versions.md b/docs/api-reference/classes/Versions.md new file mode 100644 index 000000000..a2146c6a5 --- /dev/null +++ b/docs/api-reference/classes/Versions.md @@ -0,0 +1,294 @@ +[@nevermined-io/sdk](../code-reference.md) / Versions + +# Class: Versions + +Versions submodule . + +## Hierarchy + +- [`Instantiable`](Instantiable.md) + + ↳ **`Versions`** + +## Table of contents + +### Constructors + +- [constructor](Versions.md#constructor) + +### Accessors + +- [artifactsFolder](Versions.md#artifactsfolder) +- [circuitsFolder](Versions.md#circuitsfolder) +- [config](Versions.md#config) +- [instanceConfig](Versions.md#instanceconfig) +- [instantiableConfig](Versions.md#instantiableconfig) +- [logger](Versions.md#logger) +- [nevermined](Versions.md#nevermined) +- [web3](Versions.md#web3) + +### Methods + +- [get](Versions.md#get) +- [setInstanceConfig](Versions.md#setinstanceconfig) +- [getInstance](Versions.md#getinstance) +- [setInstanceConfig](Versions.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new Versions**(`config`) + +Creates a new Versions + +#### Parameters + +| Name | Type | Description | +| :------- | :---------------------------------------------------------- | :--------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | Configuration of the Nevermined instance | + +#### Overrides + +[Instantiable](Instantiable.md).[constructor](Instantiable.md#constructor) + +#### Defined in + +[src/nevermined/Versions.ts:46](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Versions.ts#L46) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +Instantiable.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +Instantiable.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +Instantiable.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +Instantiable.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### get + +▸ **get**(): `Promise`<[`PlatformVersions`](../interfaces/PlatformVersions.md)\> + +#### Returns + +`Promise`<[`PlatformVersions`](../interfaces/PlatformVersions.md)\> + +#### Defined in + +[src/nevermined/Versions.ts:51](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Versions.ts#L51) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### getInstance + +▸ `Static` **getInstance**(`..._args`): `any` + +#### Parameters + +| Name | Type | +| :--------- | :---- | +| `..._args` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[Instantiable](Instantiable.md).[getInstance](Instantiable.md#getinstance) + +#### Defined in + +[src/Instantiable.abstract.ts:86](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L86) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/Web3Error.md b/docs/api-reference/classes/Web3Error.md new file mode 100644 index 000000000..6cf23df5a --- /dev/null +++ b/docs/api-reference/classes/Web3Error.md @@ -0,0 +1,165 @@ +[@nevermined-io/sdk](../code-reference.md) / Web3Error + +# Class: Web3Error + +## Hierarchy + +- `Error` + + ↳ **`Web3Error`** + +## Table of contents + +### Constructors + +- [constructor](Web3Error.md#constructor) + +### Properties + +- [message](Web3Error.md#message) +- [name](Web3Error.md#name) +- [stack](Web3Error.md#stack) +- [prepareStackTrace](Web3Error.md#preparestacktrace) +- [stackTraceLimit](Web3Error.md#stacktracelimit) + +### Methods + +- [captureStackTrace](Web3Error.md#capturestacktrace) + +## Constructors + +### constructor + +• **new Web3Error**(`message`) + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `message` | `string` | + +#### Overrides + +Error.constructor + +#### Defined in + +[src/errors/Web3Error.ts:2](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/errors/Web3Error.ts#L2) + +## Properties + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1068 + +--- + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1067 + +--- + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1069 + +--- + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +Optional override for formatting stack traces + +##### Parameters + +| Name | Type | +| :------------ | :----------- | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:11 + +--- + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:13 + +## Methods + +### captureStackTrace + +▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :---------------- | :--------- | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:4 diff --git a/docs/api-reference/classes/Web3Provider.md b/docs/api-reference/classes/Web3Provider.md new file mode 100644 index 000000000..d95b92272 --- /dev/null +++ b/docs/api-reference/classes/Web3Provider.md @@ -0,0 +1,43 @@ +[@nevermined-io/sdk](../code-reference.md) / Web3Provider + +# Class: Web3Provider + +## Table of contents + +### Constructors + +- [constructor](Web3Provider.md#constructor) + +### Methods + +- [getWeb3](Web3Provider.md#getweb3) + +## Constructors + +### constructor + +• **new Web3Provider**() + +## Methods + +### getWeb3 + +▸ `Static` **getWeb3**(`config?`): `Promise`<`JsonRpcProvider` \| `BrowserProvider`\> + +Returns ethers.Provider instance. + +#### Parameters + +| Name | Type | +| :------- | :------------------------------------------------------ | +| `config` | `Partial`<[`NeverminedOptions`](NeverminedOptions.md)\> | + +#### Returns + +`Promise`<`JsonRpcProvider` \| `BrowserProvider`\> + +web3 instance + +#### Defined in + +[src/keeper/Web3Provider.ts:10](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/Web3Provider.ts#L10) diff --git a/docs/api-reference/classes/Web3ProviderWrapper.md b/docs/api-reference/classes/Web3ProviderWrapper.md new file mode 100644 index 000000000..720111dc8 --- /dev/null +++ b/docs/api-reference/classes/Web3ProviderWrapper.md @@ -0,0 +1,64 @@ +[@nevermined-io/sdk](../code-reference.md) / Web3ProviderWrapper + +# Class: Web3ProviderWrapper + +## Table of contents + +### Constructors + +- [constructor](Web3ProviderWrapper.md#constructor) + +### Properties + +- [provider](Web3ProviderWrapper.md#provider) + +### Methods + +- [send](Web3ProviderWrapper.md#send) + +## Constructors + +### constructor + +• **new Web3ProviderWrapper**(`provider`) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------- | +| `provider` | `JsonRpcProvider` \| `BrowserProvider` | + +#### Defined in + +[src/keeper/utils.ts:82](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/utils.ts#L82) + +## Properties + +### provider + +• **provider**: `JsonRpcProvider` \| `BrowserProvider` + +#### Defined in + +[src/keeper/utils.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/utils.ts#L80) + +## Methods + +### send + +▸ **send**(`payload`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :--------- | :--------------------------------------------------------------------------------------------- | +| `payload` | [`JsonRpcPayload`](../interfaces/JsonRpcPayload.md) | +| `callback` | (`error`: `Error`, `result?`: [`JsonRpcResponse`](../interfaces/JsonRpcResponse.md)) => `void` | + +#### Returns + +`void` + +#### Defined in + +[src/keeper/utils.ts:85](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/utils.ts#L85) diff --git a/docs/api-reference/classes/WebServiceConnector.md b/docs/api-reference/classes/WebServiceConnector.md new file mode 100644 index 000000000..e8b190950 --- /dev/null +++ b/docs/api-reference/classes/WebServiceConnector.md @@ -0,0 +1,586 @@ +[@nevermined-io/sdk](../code-reference.md) / WebServiceConnector + +# Class: WebServiceConnector + +Provides a common interface to web services. + +## Hierarchy + +- [`Instantiable`](Instantiable.md) + + ↳ **`WebServiceConnector`** + +## Table of contents + +### Constructors + +- [constructor](WebServiceConnector.md#constructor) + +### Accessors + +- [artifactsFolder](WebServiceConnector.md#artifactsfolder) +- [circuitsFolder](WebServiceConnector.md#circuitsfolder) +- [config](WebServiceConnector.md#config) +- [instanceConfig](WebServiceConnector.md#instanceconfig) +- [instantiableConfig](WebServiceConnector.md#instantiableconfig) +- [logger](WebServiceConnector.md#logger) +- [nevermined](WebServiceConnector.md#nevermined) +- [web3](WebServiceConnector.md#web3) + +### Methods + +- [\_sleep](WebServiceConnector.md#_sleep) +- [delete](WebServiceConnector.md#delete) +- [downloadFile](WebServiceConnector.md#downloadfile) +- [downloadUrl](WebServiceConnector.md#downloadurl) +- [fetch](WebServiceConnector.md#fetch) +- [fetchCID](WebServiceConnector.md#fetchcid) +- [fetchToken](WebServiceConnector.md#fetchtoken) +- [get](WebServiceConnector.md#get) +- [getFileResponse](WebServiceConnector.md#getfileresponse) +- [post](WebServiceConnector.md#post) +- [put](WebServiceConnector.md#put) +- [setInstanceConfig](WebServiceConnector.md#setinstanceconfig) +- [uploadFile](WebServiceConnector.md#uploadfile) +- [uploadMessage](WebServiceConnector.md#uploadmessage) +- [getIPFSAuthToken](WebServiceConnector.md#getipfsauthtoken) +- [getInstance](WebServiceConnector.md#getinstance) +- [setInstanceConfig](WebServiceConnector.md#setinstanceconfig-1) + +## Constructors + +### constructor + +• **new WebServiceConnector**(`config`) + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Overrides + +[Instantiable](Instantiable.md).[constructor](Instantiable.md#constructor) + +#### Defined in + +[src/nevermined/utils/WebServiceConnector.ts:21](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/WebServiceConnector.ts#L21) + +## Accessors + +### artifactsFolder + +• `Protected` `get` **artifactsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.artifactsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L73) + +--- + +### circuitsFolder + +• `Protected` `get` **circuitsFolder**(): `string` + +#### Returns + +`string` + +#### Inherited from + +Instantiable.circuitsFolder + +#### Defined in + +[src/Instantiable.abstract.ts:77](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L77) + +--- + +### config + +• `Protected` `get` **config**(): [`NeverminedOptions`](NeverminedOptions.md) + +#### Returns + +[`NeverminedOptions`](NeverminedOptions.md) + +#### Inherited from + +Instantiable.config + +#### Defined in + +[src/Instantiable.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L57) + +--- + +### instanceConfig + +• `Protected` `get` **instanceConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instanceConfig + +#### Defined in + +[src/Instantiable.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L81) + +--- + +### instantiableConfig + +• `Protected` `get` **instantiableConfig**(): [`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Returns + +[`InstantiableConfig`](../interfaces/InstantiableConfig.md) + +#### Inherited from + +Instantiable.instantiableConfig + +#### Defined in + +[src/Instantiable.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L50) + +--- + +### logger + +• `Protected` `get` **logger**(): `Logger` + +#### Returns + +`Logger` + +#### Inherited from + +Instantiable.logger + +#### Defined in + +[src/Instantiable.abstract.ts:64](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L64) + +--- + +### nevermined + +• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) + +#### Returns + +[`Nevermined`](Nevermined.md) + +#### Inherited from + +Instantiable.nevermined + +#### Defined in + +[src/Instantiable.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L35) + +--- + +### web3 + +• `get` **web3**(): `JsonRpcProvider` \| `BrowserProvider` + +#### Returns + +`JsonRpcProvider` \| `BrowserProvider` + +#### Inherited from + +Instantiable.web3 + +#### Defined in + +[src/Instantiable.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L42) + +## Methods + +### \_sleep + +▸ `Private` **\_sleep**(`ms`): `Promise`<`unknown`\> + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `ms` | `number` | + +#### Returns + +`Promise`<`unknown`\> + +#### Defined in + +[src/nevermined/utils/WebServiceConnector.ts:221](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/WebServiceConnector.ts#L221) + +--- + +### delete + +▸ **delete**(`url`, `payload?`, `headers?`): `Promise`<`Response`\> + +#### Parameters + +| Name | Type | +| :--------- | :--------- | +| `url` | `string` | +| `payload?` | `BodyInit` | +| `headers` | `Object` | + +#### Returns + +`Promise`<`Response`\> + +#### Defined in + +[src/nevermined/utils/WebServiceConnector.ts:65](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/WebServiceConnector.ts#L65) + +--- + +### downloadFile + +▸ **downloadFile**(`url`, `destination?`, `index?`, `headers?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------- | :------- | +| `url` | `string` | +| `destination?` | `string` | +| `index?` | `number` | +| `headers?` | `Object` | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/nevermined/utils/WebServiceConnector.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/WebServiceConnector.ts#L80) + +--- + +### downloadUrl + +▸ **downloadUrl**(`url`, `headers?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :--------- | :------- | +| `url` | `string` | +| `headers?` | `any` | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/nevermined/utils/WebServiceConnector.ts:132](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/WebServiceConnector.ts#L132) + +--- + +### fetch + +▸ `Private` **fetch**(`url`, `opts`, `numberTries?`): `Promise`<`Response`\> + +#### Parameters + +| Name | Type | Default value | +| :------------ | :------------ | :------------ | +| `url` | `any` | `undefined` | +| `opts` | `RequestInit` | `undefined` | +| `numberTries` | `number` | `1` | + +#### Returns + +`Promise`<`Response`\> + +#### Defined in + +[src/nevermined/utils/WebServiceConnector.ts:203](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/WebServiceConnector.ts#L203) + +--- + +### fetchCID + +▸ **fetchCID**(`cid`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `cid` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/nevermined/utils/WebServiceConnector.ts:175](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/WebServiceConnector.ts#L175) + +--- + +### fetchToken + +▸ **fetchToken**(`url`, `grantToken`, `numberTries?`): `Promise`<`Response`\> + +#### Parameters + +| Name | Type | Default value | +| :------------ | :------- | :------------ | +| `url` | `string` | `undefined` | +| `grantToken` | `string` | `undefined` | +| `numberTries` | `number` | `1` | + +#### Returns + +`Promise`<`Response`\> + +#### Defined in + +[src/nevermined/utils/WebServiceConnector.ts:159](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/WebServiceConnector.ts#L159) + +--- + +### get + +▸ **get**(`url`, `headers?`): `Promise`<`Response`\> + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `url` | `any` | +| `headers` | `Object` | + +#### Returns + +`Promise`<`Response`\> + +#### Defined in + +[src/nevermined/utils/WebServiceConnector.ts:41](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/WebServiceConnector.ts#L41) + +--- + +### getFileResponse + +▸ `Private` **getFileResponse**(`url`, `index?`, `headers?`): `Promise`<{ `name`: `string` ; `response`: `Response` }\> + +#### Parameters + +| Name | Type | +| :--------- | :------- | +| `url` | `string` | +| `index?` | `number` | +| `headers?` | `Object` | + +#### Returns + +`Promise`<{ `name`: `string` ; `response`: `Response` }\> + +#### Defined in + +[src/nevermined/utils/WebServiceConnector.ts:107](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/WebServiceConnector.ts#L107) + +--- + +### post + +▸ **post**(`url`, `payload`, `headers?`): `Promise`<`Response`\> + +#### Parameters + +| Name | Type | +| :-------- | :--------- | +| `url` | `string` | +| `payload` | `BodyInit` | +| `headers` | `Object` | + +#### Returns + +`Promise`<`Response`\> + +#### Defined in + +[src/nevermined/utils/WebServiceConnector.ts:26](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/WebServiceConnector.ts#L26) + +--- + +### put + +▸ **put**(`url`, `payload`, `headers?`): `Promise`<`Response`\> + +#### Parameters + +| Name | Type | +| :-------- | :--------- | +| `url` | `string` | +| `payload` | `BodyInit` | +| `headers` | `Object` | + +#### Returns + +`Promise`<`Response`\> + +#### Defined in + +[src/nevermined/utils/WebServiceConnector.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/WebServiceConnector.ts#L50) + +--- + +### setInstanceConfig + +▸ `Protected` **setInstanceConfig**(`config`): `void` + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------------------------- | +| `config` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig) + +#### Defined in + +[src/Instantiable.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L99) + +--- + +### uploadFile + +▸ **uploadFile**(`url`, `data`, `encrypt?`): `Promise`<`any`\> + +#### Parameters + +| Name | Type | +| :--------- | :----------- | +| `url` | `string` | +| `data` | `ReadStream` | +| `encrypt?` | `boolean` | + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +[src/nevermined/utils/WebServiceConnector.ts:149](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/WebServiceConnector.ts#L149) + +--- + +### uploadMessage + +▸ **uploadMessage**(`url`, `data`, `encrypt?`): `Promise`<`any`\> + +#### Parameters + +| Name | Type | +| :--------- | :-------- | +| `url` | `string` | +| `data` | `string` | +| `encrypt?` | `boolean` | + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +[src/nevermined/utils/WebServiceConnector.ts:140](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/WebServiceConnector.ts#L140) + +--- + +### getIPFSAuthToken + +▸ `Static` `Private` **getIPFSAuthToken**(): `string` + +#### Returns + +`string` + +#### Defined in + +[src/nevermined/utils/WebServiceConnector.ts:193](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/WebServiceConnector.ts#L193) + +--- + +### getInstance + +▸ `Static` **getInstance**(`..._args`): `any` + +#### Parameters + +| Name | Type | +| :--------- | :---- | +| `..._args` | `any` | + +#### Returns + +`any` + +#### Inherited from + +[Instantiable](Instantiable.md).[getInstance](Instantiable.md#getinstance) + +#### Defined in + +[src/Instantiable.abstract.ts:86](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L86) + +--- + +### setInstanceConfig + +▸ `Static` `Protected` **setInstanceConfig**<`T`\>(`instance`, `instantiableConfig`): `void` + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------- | +| `T` | extends [`Instantiable`](Instantiable.md) | + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------------------- | +| `instance` | `T` | +| `instantiableConfig` | [`InstantiableConfig`](../interfaces/InstantiableConfig.md) | + +#### Returns + +`void` + +#### Inherited from + +[Instantiable](Instantiable.md).[setInstanceConfig](Instantiable.md#setinstanceconfig-1) + +#### Defined in + +[src/Instantiable.abstract.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L90) diff --git a/docs/api-reference/classes/conditions.AaveBorrowCondition.md b/docs/api-reference/classes/conditions.AaveBorrowCondition.md deleted file mode 100644 index 040c0e315..000000000 --- a/docs/api-reference/classes/conditions.AaveBorrowCondition.md +++ /dev/null @@ -1,1119 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [conditions](../modules/conditions.md) / AaveBorrowCondition - -# Class: AaveBorrowCondition - -[conditions](../modules/conditions.md).AaveBorrowCondition - -## Hierarchy - -- [`ProviderCondition`](conditions.ProviderCondition.md)<`AaveBorrowConditionContext`\> - - ↳ **`AaveBorrowCondition`** - -## Table of contents - -### Constructors - -- [constructor](conditions.AaveBorrowCondition.md#constructor) - -### Properties - -- [contract](conditions.AaveBorrowCondition.md#contract) -- [contractName](conditions.AaveBorrowCondition.md#contractname) -- [events](conditions.AaveBorrowCondition.md#events) -- [version](conditions.AaveBorrowCondition.md#version) - -### Accessors - -- [address](conditions.AaveBorrowCondition.md#address) -- [artifactsFolder](conditions.AaveBorrowCondition.md#artifactsfolder) -- [config](conditions.AaveBorrowCondition.md#config) -- [instanceConfig](conditions.AaveBorrowCondition.md#instanceconfig) -- [instantiableConfig](conditions.AaveBorrowCondition.md#instantiableconfig) -- [logger](conditions.AaveBorrowCondition.md#logger) -- [nevermined](conditions.AaveBorrowCondition.md#nevermined) -- [web3](conditions.AaveBorrowCondition.md#web3) - -### Methods - -- [abortByTimeOut](conditions.AaveBorrowCondition.md#abortbytimeout) -- [addresses](conditions.AaveBorrowCondition.md#addresses) -- [call](conditions.AaveBorrowCondition.md#call) -- [checkExists](conditions.AaveBorrowCondition.md#checkexists) -- [findSigner](conditions.AaveBorrowCondition.md#findsigner) -- [fulfill](conditions.AaveBorrowCondition.md#fulfill) -- [fulfillGateway](conditions.AaveBorrowCondition.md#fulfillgateway) -- [fulfillInstance](conditions.AaveBorrowCondition.md#fulfillinstance) -- [fulfillPlain](conditions.AaveBorrowCondition.md#fulfillplain) -- [gatewayMethod](conditions.AaveBorrowCondition.md#gatewaymethod) -- [generateId](conditions.AaveBorrowCondition.md#generateid) -- [generateIdHash](conditions.AaveBorrowCondition.md#generateidhash) -- [generateIdWithSeed](conditions.AaveBorrowCondition.md#generateidwithseed) -- [getAddress](conditions.AaveBorrowCondition.md#getaddress) -- [getConditionFulfilledEvent](conditions.AaveBorrowCondition.md#getconditionfulfilledevent) -- [getContract](conditions.AaveBorrowCondition.md#getcontract) -- [getFromAddress](conditions.AaveBorrowCondition.md#getfromaddress) -- [getInputsOfMethod](conditions.AaveBorrowCondition.md#getinputsofmethod) -- [getSignatureOfMethod](conditions.AaveBorrowCondition.md#getsignatureofmethod) -- [hashValues](conditions.AaveBorrowCondition.md#hashvalues) -- [hashValuesPlain](conditions.AaveBorrowCondition.md#hashvaluesplain) -- [init](conditions.AaveBorrowCondition.md#init) -- [instance](conditions.AaveBorrowCondition.md#instance) -- [instanceFromDDO](conditions.AaveBorrowCondition.md#instancefromddo) -- [params](conditions.AaveBorrowCondition.md#params) -- [paramsFromDDO](conditions.AaveBorrowCondition.md#paramsfromddo) -- [send](conditions.AaveBorrowCondition.md#send) -- [sendFrom](conditions.AaveBorrowCondition.md#sendfrom) -- [setInstanceConfig](conditions.AaveBorrowCondition.md#setinstanceconfig) -- [addressesStatic](conditions.AaveBorrowCondition.md#addressesstatic) -- [findSignerStatic](conditions.AaveBorrowCondition.md#findsignerstatic) -- [getInstance](conditions.AaveBorrowCondition.md#getinstance) -- [setInstanceConfig](conditions.AaveBorrowCondition.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new AaveBorrowCondition**(`contractName`) - -#### Parameters - -| Name | Type | -| :------------- | :------- | -| `contractName` | `string` | - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[constructor](conditions.ProviderCondition.md#constructor) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L32) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contract](conditions.ProviderCondition.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - ---- - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contractName](conditions.ProviderCondition.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - ---- - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[events](conditions.ProviderCondition.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - ---- - -### version - -• **version**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[version](conditions.ProviderCondition.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - ---- - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - ---- - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -ProviderCondition.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - ---- - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - ---- - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - ---- - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -ProviderCondition.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - ---- - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -ProviderCondition.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - ---- - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -ProviderCondition.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### abortByTimeOut - -▸ **abortByTimeOut**(`agreementId`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------------ | :---------------------- | -| `agreementId` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[abortByTimeOut](conditions.ProviderCondition.md#abortbytimeout) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L97) - ---- - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addresses](conditions.ProviderCondition.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - ---- - -### 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 - -[ProviderCondition](conditions.ProviderCondition.md).[call](conditions.ProviderCondition.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - ---- - -### 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 - -[ProviderCondition](conditions.ProviderCondition.md).[checkExists](conditions.ProviderCondition.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - ---- - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSigner](conditions.ProviderCondition.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - ---- - -### fulfill - -▸ **fulfill**(`agreementId`, `did`, `vaultAddress`, `assetToBorrow`, `amount`, `interestRateMode`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :----------------- | :---------------------- | -| `agreementId` | `string` | -| `did` | `string` | -| `vaultAddress` | `string` | -| `assetToBorrow` | `string` | -| `amount` | `string` | -| `interestRateMode` | `number` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[fulfill](conditions.ProviderCondition.md#fulfill) - -#### Defined in - -[src/keeper/contracts/defi/AaveBorrowCondition.ts:62](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveBorrowCondition.ts#L62) - ---- - -### fulfillGateway - -▸ **fulfillGateway**(`cond`, `additionalParams`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :----------------- | :---------------------------------------------------------------------------------------------------- | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | -| `additionalParams` | `Record`<`string`, `unknown`\> | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillGateway](conditions.ProviderCondition.md#fulfillgateway) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:204](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L204) - ---- - -### fulfillInstance - -▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------------------------------------------------- | :------------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillInstance](conditions.ProviderCondition.md#fulfillinstance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L162) - ---- - -### fulfillPlain - -▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------------ | :------------------------------------------------------------ | :------------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillPlain](conditions.ProviderCondition.md#fulfillplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L69) - ---- - -### gatewayMethod - -▸ **gatewayMethod**(): [`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Returns - -[`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[gatewayMethod](conditions.ProviderCondition.md#gatewaymethod) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:221](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L221) - ---- - -### generateId - -▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateId](conditions.ProviderCondition.md#generateid) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:83](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L83) - ---- - -### generateIdHash - -▸ **generateIdHash**(`agreementId`, ...`values`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `...values` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdHash](conditions.ProviderCondition.md#generateidhash) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L79) - ---- - -### generateIdWithSeed - -▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<[`string`, `string`]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdWithSeed](conditions.ProviderCondition.md#generateidwithseed) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L87) - ---- - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getAddress](conditions.ProviderCondition.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - ---- - -### getConditionFulfilledEvent - -▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getConditionFulfilledEvent](conditions.ProviderCondition.md#getconditionfulfilledevent) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:101](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L101) - ---- - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getContract](conditions.ProviderCondition.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - ---- - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getFromAddress](conditions.ProviderCondition.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - ---- - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :----------- | :------- | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getInputsOfMethod](conditions.ProviderCondition.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - ---- - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :----------- | :------- | :------------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getSignatureOfMethod](conditions.ProviderCondition.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - ---- - -### hashValues - -▸ **hashValues**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValues](conditions.ProviderCondition.md#hashvalues) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L141) - ---- - -### hashValuesPlain - -▸ **hashValuesPlain**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValuesPlain](conditions.ProviderCondition.md#hashvaluesplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L145) - ---- - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :--------- | :------------------- | :------------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[init](conditions.ProviderCondition.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - ---- - -### instance - -▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------ | :-------------------------------------------------------------------------------------------------------- | -| `agreementId` | `string` | -| `params` | [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instance](conditions.ProviderCondition.md#instance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:184](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L184) - ---- - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementId`, `ctx`, ...`args`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------ | :------------------------------------------------------------------------------- | -| `agreementId` | `string` | -| `ctx` | `AaveBorrowConditionContext` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instanceFromDDO](conditions.ProviderCondition.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L154) - ---- - -### params - -▸ **params**(`did`, `vaultAddress`, `assetToBorrow`, `amount`, `interestRateMode`): [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -#### Parameters - -| Name | Type | -| :----------------- | :------- | -| `did` | `string` | -| `vaultAddress` | `string` | -| `assetToBorrow` | `string` | -| `amount` | `string` | -| `interestRateMode` | `number` | - -#### Returns - -[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[params](conditions.ProviderCondition.md#params) - -#### Defined in - -[src/keeper/contracts/defi/AaveBorrowCondition.ts:30](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveBorrowCondition.ts#L30) - ---- - -### paramsFromDDO - -▸ **paramsFromDDO**(`__namedParameters`): `Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------------ | :--------------------------- | -| `__namedParameters` | `AaveBorrowConditionContext` | - -#### Returns - -`Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[paramsFromDDO](conditions.ProviderCondition.md#paramsfromddo) - -#### Defined in - -[src/keeper/contracts/defi/AaveBorrowCondition.ts:46](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveBorrowCondition.ts#L46) - ---- - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :------------- | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[send](conditions.ProviderCondition.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - ---- - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :---------------------- | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[sendFrom](conditions.ProviderCondition.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - ---- - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - ---- - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addressesStatic](conditions.ProviderCondition.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - ---- - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSignerStatic](conditions.ProviderCondition.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - ---- - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`AaveBorrowCondition`](conditions.AaveBorrowCondition.md)\> - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`AaveBorrowCondition`](conditions.AaveBorrowCondition.md)\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[getInstance](conditions.ProviderCondition.md#getinstance) - -#### Defined in - -[src/keeper/contracts/defi/AaveBorrowCondition.ts:19](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveBorrowCondition.ts#L19) - ---- - -### 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 - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/api-reference/classes/conditions.AaveCollateralDepositCondition.md b/docs/api-reference/classes/conditions.AaveCollateralDepositCondition.md deleted file mode 100644 index 48487992e..000000000 --- a/docs/api-reference/classes/conditions.AaveCollateralDepositCondition.md +++ /dev/null @@ -1,1123 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [conditions](../modules/conditions.md) / AaveCollateralDepositCondition - -# Class: AaveCollateralDepositCondition - -[conditions](../modules/conditions.md).AaveCollateralDepositCondition - -## Hierarchy - -- [`ProviderCondition`](conditions.ProviderCondition.md)<`AaveCollateralDepositConditionContext`\> - - ↳ **`AaveCollateralDepositCondition`** - -## Table of contents - -### Constructors - -- [constructor](conditions.AaveCollateralDepositCondition.md#constructor) - -### Properties - -- [contract](conditions.AaveCollateralDepositCondition.md#contract) -- [contractName](conditions.AaveCollateralDepositCondition.md#contractname) -- [events](conditions.AaveCollateralDepositCondition.md#events) -- [version](conditions.AaveCollateralDepositCondition.md#version) - -### Accessors - -- [address](conditions.AaveCollateralDepositCondition.md#address) -- [artifactsFolder](conditions.AaveCollateralDepositCondition.md#artifactsfolder) -- [config](conditions.AaveCollateralDepositCondition.md#config) -- [instanceConfig](conditions.AaveCollateralDepositCondition.md#instanceconfig) -- [instantiableConfig](conditions.AaveCollateralDepositCondition.md#instantiableconfig) -- [logger](conditions.AaveCollateralDepositCondition.md#logger) -- [nevermined](conditions.AaveCollateralDepositCondition.md#nevermined) -- [web3](conditions.AaveCollateralDepositCondition.md#web3) - -### Methods - -- [abortByTimeOut](conditions.AaveCollateralDepositCondition.md#abortbytimeout) -- [addresses](conditions.AaveCollateralDepositCondition.md#addresses) -- [call](conditions.AaveCollateralDepositCondition.md#call) -- [checkExists](conditions.AaveCollateralDepositCondition.md#checkexists) -- [findSigner](conditions.AaveCollateralDepositCondition.md#findsigner) -- [fulfill](conditions.AaveCollateralDepositCondition.md#fulfill) -- [fulfillGateway](conditions.AaveCollateralDepositCondition.md#fulfillgateway) -- [fulfillInstance](conditions.AaveCollateralDepositCondition.md#fulfillinstance) -- [fulfillPlain](conditions.AaveCollateralDepositCondition.md#fulfillplain) -- [gatewayMethod](conditions.AaveCollateralDepositCondition.md#gatewaymethod) -- [generateId](conditions.AaveCollateralDepositCondition.md#generateid) -- [generateIdHash](conditions.AaveCollateralDepositCondition.md#generateidhash) -- [generateIdWithSeed](conditions.AaveCollateralDepositCondition.md#generateidwithseed) -- [getAddress](conditions.AaveCollateralDepositCondition.md#getaddress) -- [getConditionFulfilledEvent](conditions.AaveCollateralDepositCondition.md#getconditionfulfilledevent) -- [getContract](conditions.AaveCollateralDepositCondition.md#getcontract) -- [getFromAddress](conditions.AaveCollateralDepositCondition.md#getfromaddress) -- [getInputsOfMethod](conditions.AaveCollateralDepositCondition.md#getinputsofmethod) -- [getSignatureOfMethod](conditions.AaveCollateralDepositCondition.md#getsignatureofmethod) -- [hashValues](conditions.AaveCollateralDepositCondition.md#hashvalues) -- [hashValuesPlain](conditions.AaveCollateralDepositCondition.md#hashvaluesplain) -- [init](conditions.AaveCollateralDepositCondition.md#init) -- [instance](conditions.AaveCollateralDepositCondition.md#instance) -- [instanceFromDDO](conditions.AaveCollateralDepositCondition.md#instancefromddo) -- [params](conditions.AaveCollateralDepositCondition.md#params) -- [paramsFromDDO](conditions.AaveCollateralDepositCondition.md#paramsfromddo) -- [send](conditions.AaveCollateralDepositCondition.md#send) -- [sendFrom](conditions.AaveCollateralDepositCondition.md#sendfrom) -- [setInstanceConfig](conditions.AaveCollateralDepositCondition.md#setinstanceconfig) -- [addressesStatic](conditions.AaveCollateralDepositCondition.md#addressesstatic) -- [findSignerStatic](conditions.AaveCollateralDepositCondition.md#findsignerstatic) -- [getInstance](conditions.AaveCollateralDepositCondition.md#getinstance) -- [setInstanceConfig](conditions.AaveCollateralDepositCondition.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new AaveCollateralDepositCondition**(`contractName`) - -#### Parameters - -| Name | Type | -| :------------- | :------- | -| `contractName` | `string` | - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[constructor](conditions.ProviderCondition.md#constructor) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L32) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contract](conditions.ProviderCondition.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - ---- - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contractName](conditions.ProviderCondition.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - ---- - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[events](conditions.ProviderCondition.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - ---- - -### version - -• **version**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[version](conditions.ProviderCondition.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - ---- - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - ---- - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -ProviderCondition.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - ---- - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - ---- - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - ---- - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -ProviderCondition.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - ---- - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -ProviderCondition.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - ---- - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -ProviderCondition.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### abortByTimeOut - -▸ **abortByTimeOut**(`agreementId`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------------ | :---------------------- | -| `agreementId` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[abortByTimeOut](conditions.ProviderCondition.md#abortbytimeout) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L97) - ---- - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addresses](conditions.ProviderCondition.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - ---- - -### 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 - -[ProviderCondition](conditions.ProviderCondition.md).[call](conditions.ProviderCondition.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - ---- - -### 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 - -[ProviderCondition](conditions.ProviderCondition.md).[checkExists](conditions.ProviderCondition.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - ---- - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSigner](conditions.ProviderCondition.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - ---- - -### fulfill - -▸ **fulfill**(`agreementId`, `did`, `vaultAddress`, `collateralAsset`, `collateralAmount`, `delegatedAsset`, `delegatedAmount`, `interestRateMode`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :----------------- | :---------------------- | -| `agreementId` | `string` | -| `did` | `string` | -| `vaultAddress` | `string` | -| `collateralAsset` | `string` | -| `collateralAmount` | `string` | -| `delegatedAsset` | `string` | -| `delegatedAmount` | `string` | -| `interestRateMode` | `number` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[fulfill](conditions.ProviderCondition.md#fulfill) - -#### Defined in - -[src/keeper/contracts/defi/AaveCollateralDepositCondition.ts:71](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCollateralDepositCondition.ts#L71) - ---- - -### fulfillGateway - -▸ **fulfillGateway**(`cond`, `additionalParams`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :----------------- | :---------------------------------------------------------------------------------------------------- | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | -| `additionalParams` | `Record`<`string`, `unknown`\> | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillGateway](conditions.ProviderCondition.md#fulfillgateway) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:204](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L204) - ---- - -### fulfillInstance - -▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------------------------------------------------- | :------------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillInstance](conditions.ProviderCondition.md#fulfillinstance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L162) - ---- - -### fulfillPlain - -▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------------ | :------------------------------------------------------------ | :------------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillPlain](conditions.ProviderCondition.md#fulfillplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L69) - ---- - -### gatewayMethod - -▸ **gatewayMethod**(): [`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Returns - -[`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[gatewayMethod](conditions.ProviderCondition.md#gatewaymethod) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:221](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L221) - ---- - -### generateId - -▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateId](conditions.ProviderCondition.md#generateid) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:83](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L83) - ---- - -### generateIdHash - -▸ **generateIdHash**(`agreementId`, ...`values`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `...values` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdHash](conditions.ProviderCondition.md#generateidhash) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L79) - ---- - -### generateIdWithSeed - -▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<[`string`, `string`]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdWithSeed](conditions.ProviderCondition.md#generateidwithseed) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L87) - ---- - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getAddress](conditions.ProviderCondition.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - ---- - -### getConditionFulfilledEvent - -▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getConditionFulfilledEvent](conditions.ProviderCondition.md#getconditionfulfilledevent) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:101](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L101) - ---- - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getContract](conditions.ProviderCondition.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - ---- - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getFromAddress](conditions.ProviderCondition.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - ---- - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :----------- | :------- | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getInputsOfMethod](conditions.ProviderCondition.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - ---- - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :----------- | :------- | :------------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getSignatureOfMethod](conditions.ProviderCondition.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - ---- - -### hashValues - -▸ **hashValues**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValues](conditions.ProviderCondition.md#hashvalues) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L141) - ---- - -### hashValuesPlain - -▸ **hashValuesPlain**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValuesPlain](conditions.ProviderCondition.md#hashvaluesplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L145) - ---- - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :--------- | :------------------- | :------------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[init](conditions.ProviderCondition.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - ---- - -### instance - -▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------ | :-------------------------------------------------------------------------------------------------------- | -| `agreementId` | `string` | -| `params` | [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instance](conditions.ProviderCondition.md#instance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:184](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L184) - ---- - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementId`, `ctx`, ...`args`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------ | :------------------------------------------------------------------------------- | -| `agreementId` | `string` | -| `ctx` | `AaveCollateralDepositConditionContext` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instanceFromDDO](conditions.ProviderCondition.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L154) - ---- - -### params - -▸ **params**(`did`, `vaultAddress`, `collateralAsset`, `collateralAmount`, `delegatedAsset`, `delegatedAmount`, `interestRateMode`): [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -#### Parameters - -| Name | Type | -| :----------------- | :------- | -| `did` | `string` | -| `vaultAddress` | `string` | -| `collateralAsset` | `string` | -| `collateralAmount` | `string` | -| `delegatedAsset` | `string` | -| `delegatedAmount` | `string` | -| `interestRateMode` | `number` | - -#### Returns - -[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[params](conditions.ProviderCondition.md#params) - -#### Defined in - -[src/keeper/contracts/defi/AaveCollateralDepositCondition.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCollateralDepositCondition.ts#L32) - ---- - -### paramsFromDDO - -▸ **paramsFromDDO**(`__namedParameters`): `Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------------ | :-------------------------------------- | -| `__namedParameters` | `AaveCollateralDepositConditionContext` | - -#### Returns - -`Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[paramsFromDDO](conditions.ProviderCondition.md#paramsfromddo) - -#### Defined in - -[src/keeper/contracts/defi/AaveCollateralDepositCondition.ts:51](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCollateralDepositCondition.ts#L51) - ---- - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :------------- | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[send](conditions.ProviderCondition.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - ---- - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :---------------------- | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[sendFrom](conditions.ProviderCondition.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - ---- - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - ---- - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addressesStatic](conditions.ProviderCondition.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - ---- - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSignerStatic](conditions.ProviderCondition.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - ---- - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`AaveCollateralDepositCondition`](conditions.AaveCollateralDepositCondition.md)\> - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`AaveCollateralDepositCondition`](conditions.AaveCollateralDepositCondition.md)\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[getInstance](conditions.ProviderCondition.md#getinstance) - -#### Defined in - -[src/keeper/contracts/defi/AaveCollateralDepositCondition.ts:21](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCollateralDepositCondition.ts#L21) - ---- - -### 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 - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/api-reference/classes/conditions.AaveCollateralWithdrawCondition.md b/docs/api-reference/classes/conditions.AaveCollateralWithdrawCondition.md deleted file mode 100644 index 496fc5f95..000000000 --- a/docs/api-reference/classes/conditions.AaveCollateralWithdrawCondition.md +++ /dev/null @@ -1,1115 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [conditions](../modules/conditions.md) / AaveCollateralWithdrawCondition - -# Class: AaveCollateralWithdrawCondition - -[conditions](../modules/conditions.md).AaveCollateralWithdrawCondition - -## Hierarchy - -- [`ProviderCondition`](conditions.ProviderCondition.md)<`AaveCollateralWithdrawConditionContext`\> - - ↳ **`AaveCollateralWithdrawCondition`** - -## Table of contents - -### Constructors - -- [constructor](conditions.AaveCollateralWithdrawCondition.md#constructor) - -### Properties - -- [contract](conditions.AaveCollateralWithdrawCondition.md#contract) -- [contractName](conditions.AaveCollateralWithdrawCondition.md#contractname) -- [events](conditions.AaveCollateralWithdrawCondition.md#events) -- [version](conditions.AaveCollateralWithdrawCondition.md#version) - -### Accessors - -- [address](conditions.AaveCollateralWithdrawCondition.md#address) -- [artifactsFolder](conditions.AaveCollateralWithdrawCondition.md#artifactsfolder) -- [config](conditions.AaveCollateralWithdrawCondition.md#config) -- [instanceConfig](conditions.AaveCollateralWithdrawCondition.md#instanceconfig) -- [instantiableConfig](conditions.AaveCollateralWithdrawCondition.md#instantiableconfig) -- [logger](conditions.AaveCollateralWithdrawCondition.md#logger) -- [nevermined](conditions.AaveCollateralWithdrawCondition.md#nevermined) -- [web3](conditions.AaveCollateralWithdrawCondition.md#web3) - -### Methods - -- [abortByTimeOut](conditions.AaveCollateralWithdrawCondition.md#abortbytimeout) -- [addresses](conditions.AaveCollateralWithdrawCondition.md#addresses) -- [call](conditions.AaveCollateralWithdrawCondition.md#call) -- [checkExists](conditions.AaveCollateralWithdrawCondition.md#checkexists) -- [findSigner](conditions.AaveCollateralWithdrawCondition.md#findsigner) -- [fulfill](conditions.AaveCollateralWithdrawCondition.md#fulfill) -- [fulfillGateway](conditions.AaveCollateralWithdrawCondition.md#fulfillgateway) -- [fulfillInstance](conditions.AaveCollateralWithdrawCondition.md#fulfillinstance) -- [fulfillPlain](conditions.AaveCollateralWithdrawCondition.md#fulfillplain) -- [gatewayMethod](conditions.AaveCollateralWithdrawCondition.md#gatewaymethod) -- [generateId](conditions.AaveCollateralWithdrawCondition.md#generateid) -- [generateIdHash](conditions.AaveCollateralWithdrawCondition.md#generateidhash) -- [generateIdWithSeed](conditions.AaveCollateralWithdrawCondition.md#generateidwithseed) -- [getAddress](conditions.AaveCollateralWithdrawCondition.md#getaddress) -- [getConditionFulfilledEvent](conditions.AaveCollateralWithdrawCondition.md#getconditionfulfilledevent) -- [getContract](conditions.AaveCollateralWithdrawCondition.md#getcontract) -- [getFromAddress](conditions.AaveCollateralWithdrawCondition.md#getfromaddress) -- [getInputsOfMethod](conditions.AaveCollateralWithdrawCondition.md#getinputsofmethod) -- [getSignatureOfMethod](conditions.AaveCollateralWithdrawCondition.md#getsignatureofmethod) -- [hashValues](conditions.AaveCollateralWithdrawCondition.md#hashvalues) -- [hashValuesPlain](conditions.AaveCollateralWithdrawCondition.md#hashvaluesplain) -- [init](conditions.AaveCollateralWithdrawCondition.md#init) -- [instance](conditions.AaveCollateralWithdrawCondition.md#instance) -- [instanceFromDDO](conditions.AaveCollateralWithdrawCondition.md#instancefromddo) -- [params](conditions.AaveCollateralWithdrawCondition.md#params) -- [paramsFromDDO](conditions.AaveCollateralWithdrawCondition.md#paramsfromddo) -- [send](conditions.AaveCollateralWithdrawCondition.md#send) -- [sendFrom](conditions.AaveCollateralWithdrawCondition.md#sendfrom) -- [setInstanceConfig](conditions.AaveCollateralWithdrawCondition.md#setinstanceconfig) -- [addressesStatic](conditions.AaveCollateralWithdrawCondition.md#addressesstatic) -- [findSignerStatic](conditions.AaveCollateralWithdrawCondition.md#findsignerstatic) -- [getInstance](conditions.AaveCollateralWithdrawCondition.md#getinstance) -- [setInstanceConfig](conditions.AaveCollateralWithdrawCondition.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new AaveCollateralWithdrawCondition**(`contractName`) - -#### Parameters - -| Name | Type | -| :------------- | :------- | -| `contractName` | `string` | - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[constructor](conditions.ProviderCondition.md#constructor) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L32) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contract](conditions.ProviderCondition.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - ---- - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contractName](conditions.ProviderCondition.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - ---- - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[events](conditions.ProviderCondition.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - ---- - -### version - -• **version**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[version](conditions.ProviderCondition.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - ---- - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - ---- - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -ProviderCondition.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - ---- - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - ---- - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - ---- - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -ProviderCondition.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - ---- - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -ProviderCondition.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - ---- - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -ProviderCondition.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### abortByTimeOut - -▸ **abortByTimeOut**(`agreementId`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------------ | :---------------------- | -| `agreementId` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[abortByTimeOut](conditions.ProviderCondition.md#abortbytimeout) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L97) - ---- - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addresses](conditions.ProviderCondition.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - ---- - -### 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 - -[ProviderCondition](conditions.ProviderCondition.md).[call](conditions.ProviderCondition.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - ---- - -### 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 - -[ProviderCondition](conditions.ProviderCondition.md).[checkExists](conditions.ProviderCondition.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - ---- - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSigner](conditions.ProviderCondition.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - ---- - -### fulfill - -▸ **fulfill**(`agreementId`, `did`, `vaultAddress`, `collateralAsset`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :---------------- | :---------------------- | -| `agreementId` | `string` | -| `did` | `string` | -| `vaultAddress` | `string` | -| `collateralAsset` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[fulfill](conditions.ProviderCondition.md#fulfill) - -#### Defined in - -[src/keeper/contracts/defi/AaveCollateralWithdrawCondition.ts:40](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCollateralWithdrawCondition.ts#L40) - ---- - -### fulfillGateway - -▸ **fulfillGateway**(`cond`, `additionalParams`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :----------------- | :---------------------------------------------------------------------------------------------------- | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | -| `additionalParams` | `Record`<`string`, `unknown`\> | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillGateway](conditions.ProviderCondition.md#fulfillgateway) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:204](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L204) - ---- - -### fulfillInstance - -▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------------------------------------------------- | :------------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillInstance](conditions.ProviderCondition.md#fulfillinstance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L162) - ---- - -### fulfillPlain - -▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------------ | :------------------------------------------------------------ | :------------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillPlain](conditions.ProviderCondition.md#fulfillplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L69) - ---- - -### gatewayMethod - -▸ **gatewayMethod**(): [`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Returns - -[`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[gatewayMethod](conditions.ProviderCondition.md#gatewaymethod) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:221](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L221) - ---- - -### generateId - -▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateId](conditions.ProviderCondition.md#generateid) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:83](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L83) - ---- - -### generateIdHash - -▸ **generateIdHash**(`agreementId`, ...`values`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `...values` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdHash](conditions.ProviderCondition.md#generateidhash) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L79) - ---- - -### generateIdWithSeed - -▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<[`string`, `string`]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdWithSeed](conditions.ProviderCondition.md#generateidwithseed) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L87) - ---- - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getAddress](conditions.ProviderCondition.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - ---- - -### getConditionFulfilledEvent - -▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getConditionFulfilledEvent](conditions.ProviderCondition.md#getconditionfulfilledevent) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:101](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L101) - ---- - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getContract](conditions.ProviderCondition.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - ---- - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getFromAddress](conditions.ProviderCondition.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - ---- - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :----------- | :------- | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getInputsOfMethod](conditions.ProviderCondition.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - ---- - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :----------- | :------- | :------------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getSignatureOfMethod](conditions.ProviderCondition.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - ---- - -### hashValues - -▸ **hashValues**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValues](conditions.ProviderCondition.md#hashvalues) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L141) - ---- - -### hashValuesPlain - -▸ **hashValuesPlain**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValuesPlain](conditions.ProviderCondition.md#hashvaluesplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L145) - ---- - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :--------- | :------------------- | :------------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[init](conditions.ProviderCondition.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - ---- - -### instance - -▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------ | :-------------------------------------------------------------------------------------------------------- | -| `agreementId` | `string` | -| `params` | [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instance](conditions.ProviderCondition.md#instance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:184](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L184) - ---- - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementId`, `ctx`, ...`args`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------ | :------------------------------------------------------------------------------- | -| `agreementId` | `string` | -| `ctx` | `AaveCollateralWithdrawConditionContext` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instanceFromDDO](conditions.ProviderCondition.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L154) - ---- - -### params - -▸ **params**(`did`, `vaultAddress`, `collateralAsset`): [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -#### Parameters - -| Name | Type | -| :---------------- | :------- | -| `did` | `string` | -| `vaultAddress` | `string` | -| `collateralAsset` | `string` | - -#### Returns - -[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[params](conditions.ProviderCondition.md#params) - -#### Defined in - -[src/keeper/contracts/defi/AaveCollateralWithdrawCondition.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCollateralWithdrawCondition.ts#L28) - ---- - -### paramsFromDDO - -▸ **paramsFromDDO**(`__namedParameters`): `Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------------ | :--------------------------------------- | -| `__namedParameters` | `AaveCollateralWithdrawConditionContext` | - -#### Returns - -`Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[paramsFromDDO](conditions.ProviderCondition.md#paramsfromddo) - -#### Defined in - -[src/keeper/contracts/defi/AaveCollateralWithdrawCondition.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCollateralWithdrawCondition.ts#L32) - ---- - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :------------- | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[send](conditions.ProviderCondition.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - ---- - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :---------------------- | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[sendFrom](conditions.ProviderCondition.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - ---- - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - ---- - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addressesStatic](conditions.ProviderCondition.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - ---- - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSignerStatic](conditions.ProviderCondition.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - ---- - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`AaveCollateralWithdrawCondition`](conditions.AaveCollateralWithdrawCondition.md)\> - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`AaveCollateralWithdrawCondition`](conditions.AaveCollateralWithdrawCondition.md)\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[getInstance](conditions.ProviderCondition.md#getinstance) - -#### Defined in - -[src/keeper/contracts/defi/AaveCollateralWithdrawCondition.ts:17](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCollateralWithdrawCondition.ts#L17) - ---- - -### 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 - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/api-reference/classes/conditions.AaveRepayCondition.md b/docs/api-reference/classes/conditions.AaveRepayCondition.md deleted file mode 100644 index 2ca3e379e..000000000 --- a/docs/api-reference/classes/conditions.AaveRepayCondition.md +++ /dev/null @@ -1,1119 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [conditions](../modules/conditions.md) / AaveRepayCondition - -# Class: AaveRepayCondition - -[conditions](../modules/conditions.md).AaveRepayCondition - -## Hierarchy - -- [`ProviderCondition`](conditions.ProviderCondition.md)<`AaveRepayConditionContext`\> - - ↳ **`AaveRepayCondition`** - -## Table of contents - -### Constructors - -- [constructor](conditions.AaveRepayCondition.md#constructor) - -### Properties - -- [contract](conditions.AaveRepayCondition.md#contract) -- [contractName](conditions.AaveRepayCondition.md#contractname) -- [events](conditions.AaveRepayCondition.md#events) -- [version](conditions.AaveRepayCondition.md#version) - -### Accessors - -- [address](conditions.AaveRepayCondition.md#address) -- [artifactsFolder](conditions.AaveRepayCondition.md#artifactsfolder) -- [config](conditions.AaveRepayCondition.md#config) -- [instanceConfig](conditions.AaveRepayCondition.md#instanceconfig) -- [instantiableConfig](conditions.AaveRepayCondition.md#instantiableconfig) -- [logger](conditions.AaveRepayCondition.md#logger) -- [nevermined](conditions.AaveRepayCondition.md#nevermined) -- [web3](conditions.AaveRepayCondition.md#web3) - -### Methods - -- [abortByTimeOut](conditions.AaveRepayCondition.md#abortbytimeout) -- [addresses](conditions.AaveRepayCondition.md#addresses) -- [call](conditions.AaveRepayCondition.md#call) -- [checkExists](conditions.AaveRepayCondition.md#checkexists) -- [findSigner](conditions.AaveRepayCondition.md#findsigner) -- [fulfill](conditions.AaveRepayCondition.md#fulfill) -- [fulfillGateway](conditions.AaveRepayCondition.md#fulfillgateway) -- [fulfillInstance](conditions.AaveRepayCondition.md#fulfillinstance) -- [fulfillPlain](conditions.AaveRepayCondition.md#fulfillplain) -- [gatewayMethod](conditions.AaveRepayCondition.md#gatewaymethod) -- [generateId](conditions.AaveRepayCondition.md#generateid) -- [generateIdHash](conditions.AaveRepayCondition.md#generateidhash) -- [generateIdWithSeed](conditions.AaveRepayCondition.md#generateidwithseed) -- [getAddress](conditions.AaveRepayCondition.md#getaddress) -- [getConditionFulfilledEvent](conditions.AaveRepayCondition.md#getconditionfulfilledevent) -- [getContract](conditions.AaveRepayCondition.md#getcontract) -- [getFromAddress](conditions.AaveRepayCondition.md#getfromaddress) -- [getInputsOfMethod](conditions.AaveRepayCondition.md#getinputsofmethod) -- [getSignatureOfMethod](conditions.AaveRepayCondition.md#getsignatureofmethod) -- [hashValues](conditions.AaveRepayCondition.md#hashvalues) -- [hashValuesPlain](conditions.AaveRepayCondition.md#hashvaluesplain) -- [init](conditions.AaveRepayCondition.md#init) -- [instance](conditions.AaveRepayCondition.md#instance) -- [instanceFromDDO](conditions.AaveRepayCondition.md#instancefromddo) -- [params](conditions.AaveRepayCondition.md#params) -- [paramsFromDDO](conditions.AaveRepayCondition.md#paramsfromddo) -- [send](conditions.AaveRepayCondition.md#send) -- [sendFrom](conditions.AaveRepayCondition.md#sendfrom) -- [setInstanceConfig](conditions.AaveRepayCondition.md#setinstanceconfig) -- [addressesStatic](conditions.AaveRepayCondition.md#addressesstatic) -- [findSignerStatic](conditions.AaveRepayCondition.md#findsignerstatic) -- [getInstance](conditions.AaveRepayCondition.md#getinstance) -- [setInstanceConfig](conditions.AaveRepayCondition.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new AaveRepayCondition**(`contractName`) - -#### Parameters - -| Name | Type | -| :------------- | :------- | -| `contractName` | `string` | - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[constructor](conditions.ProviderCondition.md#constructor) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L32) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contract](conditions.ProviderCondition.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - ---- - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contractName](conditions.ProviderCondition.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - ---- - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[events](conditions.ProviderCondition.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - ---- - -### version - -• **version**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[version](conditions.ProviderCondition.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - ---- - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - ---- - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -ProviderCondition.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - ---- - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - ---- - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - ---- - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -ProviderCondition.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - ---- - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -ProviderCondition.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - ---- - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -ProviderCondition.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### abortByTimeOut - -▸ **abortByTimeOut**(`agreementId`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------------ | :---------------------- | -| `agreementId` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[abortByTimeOut](conditions.ProviderCondition.md#abortbytimeout) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L97) - ---- - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addresses](conditions.ProviderCondition.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - ---- - -### 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 - -[ProviderCondition](conditions.ProviderCondition.md).[call](conditions.ProviderCondition.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - ---- - -### 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 - -[ProviderCondition](conditions.ProviderCondition.md).[checkExists](conditions.ProviderCondition.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - ---- - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSigner](conditions.ProviderCondition.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - ---- - -### fulfill - -▸ **fulfill**(`agreementId`, `did`, `vaultAddress`, `assetToRepay`, `amountToRepay`, `interestRateMode`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :----------------- | :---------------------- | -| `agreementId` | `string` | -| `did` | `string` | -| `vaultAddress` | `string` | -| `assetToRepay` | `string` | -| `amountToRepay` | `string` | -| `interestRateMode` | `number` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[fulfill](conditions.ProviderCondition.md#fulfill) - -#### Defined in - -[src/keeper/contracts/defi/AaveRepayCondition.ts:61](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveRepayCondition.ts#L61) - ---- - -### fulfillGateway - -▸ **fulfillGateway**(`cond`, `additionalParams`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :----------------- | :---------------------------------------------------------------------------------------------------- | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | -| `additionalParams` | `Record`<`string`, `unknown`\> | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillGateway](conditions.ProviderCondition.md#fulfillgateway) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:204](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L204) - ---- - -### fulfillInstance - -▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------------------------------------------------- | :------------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillInstance](conditions.ProviderCondition.md#fulfillinstance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L162) - ---- - -### fulfillPlain - -▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------------ | :------------------------------------------------------------ | :------------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillPlain](conditions.ProviderCondition.md#fulfillplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L69) - ---- - -### gatewayMethod - -▸ **gatewayMethod**(): [`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Returns - -[`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[gatewayMethod](conditions.ProviderCondition.md#gatewaymethod) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:221](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L221) - ---- - -### generateId - -▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateId](conditions.ProviderCondition.md#generateid) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:83](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L83) - ---- - -### generateIdHash - -▸ **generateIdHash**(`agreementId`, ...`values`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `...values` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdHash](conditions.ProviderCondition.md#generateidhash) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L79) - ---- - -### generateIdWithSeed - -▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<[`string`, `string`]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdWithSeed](conditions.ProviderCondition.md#generateidwithseed) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L87) - ---- - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getAddress](conditions.ProviderCondition.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - ---- - -### getConditionFulfilledEvent - -▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getConditionFulfilledEvent](conditions.ProviderCondition.md#getconditionfulfilledevent) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:101](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L101) - ---- - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getContract](conditions.ProviderCondition.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - ---- - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getFromAddress](conditions.ProviderCondition.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - ---- - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :----------- | :------- | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getInputsOfMethod](conditions.ProviderCondition.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - ---- - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :----------- | :------- | :------------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getSignatureOfMethod](conditions.ProviderCondition.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - ---- - -### hashValues - -▸ **hashValues**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValues](conditions.ProviderCondition.md#hashvalues) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L141) - ---- - -### hashValuesPlain - -▸ **hashValuesPlain**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValuesPlain](conditions.ProviderCondition.md#hashvaluesplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L145) - ---- - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :--------- | :------------------- | :------------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[init](conditions.ProviderCondition.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - ---- - -### instance - -▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------ | :-------------------------------------------------------------------------------------------------------- | -| `agreementId` | `string` | -| `params` | [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instance](conditions.ProviderCondition.md#instance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:184](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L184) - ---- - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementId`, `ctx`, ...`args`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------ | :------------------------------------------------------------------------------- | -| `agreementId` | `string` | -| `ctx` | `AaveRepayConditionContext` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instanceFromDDO](conditions.ProviderCondition.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L154) - ---- - -### params - -▸ **params**(`did`, `vaultAddress`, `assetToRepay`, `amountToRepay`, `interestRateMode`): [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -#### Parameters - -| Name | Type | -| :----------------- | :------- | -| `did` | `string` | -| `vaultAddress` | `string` | -| `assetToRepay` | `string` | -| `amountToRepay` | `string` | -| `interestRateMode` | `number` | - -#### Returns - -[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[params](conditions.ProviderCondition.md#params) - -#### Defined in - -[src/keeper/contracts/defi/AaveRepayCondition.ts:30](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveRepayCondition.ts#L30) - ---- - -### paramsFromDDO - -▸ **paramsFromDDO**(`__namedParameters`): `Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------------ | :-------------------------- | -| `__namedParameters` | `AaveRepayConditionContext` | - -#### Returns - -`Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[paramsFromDDO](conditions.ProviderCondition.md#paramsfromddo) - -#### Defined in - -[src/keeper/contracts/defi/AaveRepayCondition.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveRepayCondition.ts#L45) - ---- - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :------------- | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[send](conditions.ProviderCondition.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - ---- - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :---------------------- | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[sendFrom](conditions.ProviderCondition.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - ---- - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - ---- - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addressesStatic](conditions.ProviderCondition.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - ---- - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSignerStatic](conditions.ProviderCondition.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - ---- - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`AaveRepayCondition`](conditions.AaveRepayCondition.md)\> - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`AaveRepayCondition`](conditions.AaveRepayCondition.md)\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[getInstance](conditions.ProviderCondition.md#getinstance) - -#### Defined in - -[src/keeper/contracts/defi/AaveRepayCondition.ts:19](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveRepayCondition.ts#L19) - ---- - -### 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 - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/api-reference/classes/conditions.AccessCondition.md b/docs/api-reference/classes/conditions.AccessCondition.md deleted file mode 100644 index 197ce8709..000000000 --- a/docs/api-reference/classes/conditions.AccessCondition.md +++ /dev/null @@ -1,1157 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [conditions](../modules/conditions.md) / AccessCondition - -# Class: AccessCondition - -[conditions](../modules/conditions.md).AccessCondition - -## Hierarchy - -- [`ProviderCondition`](conditions.ProviderCondition.md)<`AccessConditionContext`\> - - ↳ **`AccessCondition`** - -## Table of contents - -### Constructors - -- [constructor](conditions.AccessCondition.md#constructor) - -### Properties - -- [contract](conditions.AccessCondition.md#contract) -- [contractName](conditions.AccessCondition.md#contractname) -- [events](conditions.AccessCondition.md#events) -- [version](conditions.AccessCondition.md#version) - -### Accessors - -- [address](conditions.AccessCondition.md#address) -- [artifactsFolder](conditions.AccessCondition.md#artifactsfolder) -- [config](conditions.AccessCondition.md#config) -- [instanceConfig](conditions.AccessCondition.md#instanceconfig) -- [instantiableConfig](conditions.AccessCondition.md#instantiableconfig) -- [logger](conditions.AccessCondition.md#logger) -- [nevermined](conditions.AccessCondition.md#nevermined) -- [web3](conditions.AccessCondition.md#web3) - -### Methods - -- [abortByTimeOut](conditions.AccessCondition.md#abortbytimeout) -- [addresses](conditions.AccessCondition.md#addresses) -- [call](conditions.AccessCondition.md#call) -- [checkExists](conditions.AccessCondition.md#checkexists) -- [checkPermissions](conditions.AccessCondition.md#checkpermissions) -- [findSigner](conditions.AccessCondition.md#findsigner) -- [fulfill](conditions.AccessCondition.md#fulfill) -- [fulfillGateway](conditions.AccessCondition.md#fulfillgateway) -- [fulfillInstance](conditions.AccessCondition.md#fulfillinstance) -- [fulfillPlain](conditions.AccessCondition.md#fulfillplain) -- [gatewayMethod](conditions.AccessCondition.md#gatewaymethod) -- [generateId](conditions.AccessCondition.md#generateid) -- [generateIdHash](conditions.AccessCondition.md#generateidhash) -- [generateIdWithSeed](conditions.AccessCondition.md#generateidwithseed) -- [getAddress](conditions.AccessCondition.md#getaddress) -- [getConditionFulfilledEvent](conditions.AccessCondition.md#getconditionfulfilledevent) -- [getContract](conditions.AccessCondition.md#getcontract) -- [getFromAddress](conditions.AccessCondition.md#getfromaddress) -- [getGrantedDidByConsumer](conditions.AccessCondition.md#getgranteddidbyconsumer) -- [getInputsOfMethod](conditions.AccessCondition.md#getinputsofmethod) -- [getSignatureOfMethod](conditions.AccessCondition.md#getsignatureofmethod) -- [hashValues](conditions.AccessCondition.md#hashvalues) -- [hashValuesPlain](conditions.AccessCondition.md#hashvaluesplain) -- [init](conditions.AccessCondition.md#init) -- [instance](conditions.AccessCondition.md#instance) -- [instanceFromDDO](conditions.AccessCondition.md#instancefromddo) -- [params](conditions.AccessCondition.md#params) -- [paramsFromDDO](conditions.AccessCondition.md#paramsfromddo) -- [send](conditions.AccessCondition.md#send) -- [sendFrom](conditions.AccessCondition.md#sendfrom) -- [setInstanceConfig](conditions.AccessCondition.md#setinstanceconfig) -- [addressesStatic](conditions.AccessCondition.md#addressesstatic) -- [findSignerStatic](conditions.AccessCondition.md#findsignerstatic) -- [getInstance](conditions.AccessCondition.md#getinstance) -- [setInstanceConfig](conditions.AccessCondition.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new AccessCondition**(`contractName`) - -#### Parameters - -| Name | Type | -| :------------- | :------- | -| `contractName` | `string` | - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[constructor](conditions.ProviderCondition.md#constructor) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L32) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contract](conditions.ProviderCondition.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - ---- - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contractName](conditions.ProviderCondition.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - ---- - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[events](conditions.ProviderCondition.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - ---- - -### version - -• **version**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[version](conditions.ProviderCondition.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - ---- - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - ---- - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -ProviderCondition.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - ---- - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - ---- - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - ---- - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -ProviderCondition.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - ---- - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -ProviderCondition.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - ---- - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -ProviderCondition.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### abortByTimeOut - -▸ **abortByTimeOut**(`agreementId`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------------ | :---------------------- | -| `agreementId` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[abortByTimeOut](conditions.ProviderCondition.md#abortbytimeout) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L97) - ---- - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addresses](conditions.ProviderCondition.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - ---- - -### 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 - -[ProviderCondition](conditions.ProviderCondition.md).[call](conditions.ProviderCondition.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - ---- - -### 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 - -[ProviderCondition](conditions.ProviderCondition.md).[checkExists](conditions.ProviderCondition.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - ---- - -### checkPermissions - -▸ **checkPermissions**(`grantee`, `did`, `from?`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :-------- | :---------------------- | -| `grantee` | `string` | -| `did` | `string` | -| `from?` | [`Account`](Account.md) | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -[src/keeper/contracts/conditions/AccessCondition.ts:42](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/AccessCondition.ts#L42) - ---- - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSigner](conditions.ProviderCondition.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - ---- - -### fulfill - -▸ **fulfill**(`agreementId`, `did`, `grantee`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------------ | :---------------------- | -| `agreementId` | `string` | -| `did` | `string` | -| `grantee` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[fulfill](conditions.ProviderCondition.md#fulfill) - -#### Defined in - -[src/keeper/contracts/conditions/AccessCondition.ts:27](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/AccessCondition.ts#L27) - ---- - -### fulfillGateway - -▸ **fulfillGateway**(`cond`, `additionalParams`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :----------------- | :---------------------------------------------------------------------------------------------------- | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | -| `additionalParams` | `Record`<`string`, `unknown`\> | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillGateway](conditions.ProviderCondition.md#fulfillgateway) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:204](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L204) - ---- - -### fulfillInstance - -▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------------------------------------------------- | :------------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillInstance](conditions.ProviderCondition.md#fulfillinstance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L162) - ---- - -### fulfillPlain - -▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------------ | :------------------------------------------------------------ | :------------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillPlain](conditions.ProviderCondition.md#fulfillplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L69) - ---- - -### gatewayMethod - -▸ **gatewayMethod**(): [`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Returns - -[`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[gatewayMethod](conditions.ProviderCondition.md#gatewaymethod) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:221](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L221) - ---- - -### generateId - -▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateId](conditions.ProviderCondition.md#generateid) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:83](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L83) - ---- - -### generateIdHash - -▸ **generateIdHash**(`agreementId`, ...`values`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `...values` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdHash](conditions.ProviderCondition.md#generateidhash) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L79) - ---- - -### generateIdWithSeed - -▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<[`string`, `string`]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdWithSeed](conditions.ProviderCondition.md#generateidwithseed) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L87) - ---- - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getAddress](conditions.ProviderCondition.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - ---- - -### getConditionFulfilledEvent - -▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getConditionFulfilledEvent](conditions.ProviderCondition.md#getconditionfulfilledevent) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:101](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L101) - ---- - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getContract](conditions.ProviderCondition.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - ---- - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getFromAddress](conditions.ProviderCondition.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - ---- - -### getGrantedDidByConsumer - -▸ **getGrantedDidByConsumer**(`consumer`): `Promise`<{ `agreementId`: `string` ; `did`: `string` }[]\> - -#### Parameters - -| Name | Type | -| :--------- | :------- | -| `consumer` | `string` | - -#### Returns - -`Promise`<{ `agreementId`: `string` ; `did`: `string` }[]\> - -#### Defined in - -[src/keeper/contracts/conditions/AccessCondition.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/AccessCondition.ts#L50) - ---- - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :----------- | :------- | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getInputsOfMethod](conditions.ProviderCondition.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - ---- - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :----------- | :------- | :------------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getSignatureOfMethod](conditions.ProviderCondition.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - ---- - -### hashValues - -▸ **hashValues**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValues](conditions.ProviderCondition.md#hashvalues) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L141) - ---- - -### hashValuesPlain - -▸ **hashValuesPlain**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValuesPlain](conditions.ProviderCondition.md#hashvaluesplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L145) - ---- - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :--------- | :------------------- | :------------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[init](conditions.ProviderCondition.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - ---- - -### instance - -▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------ | :-------------------------------------------------------------------------------------------------------- | -| `agreementId` | `string` | -| `params` | [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instance](conditions.ProviderCondition.md#instance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:184](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L184) - ---- - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementId`, `ctx`, ...`args`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------ | :------------------------------------------------------------------------------- | -| `agreementId` | `string` | -| `ctx` | `AccessConditionContext` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instanceFromDDO](conditions.ProviderCondition.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L154) - ---- - -### params - -▸ **params**(`did`, `grantee`): [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -#### Parameters - -| Name | Type | -| :-------- | :------- | -| `did` | `string` | -| `grantee` | `string` | - -#### Returns - -[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[params](conditions.ProviderCondition.md#params) - -#### Defined in - -[src/keeper/contracts/conditions/AccessCondition.ts:19](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/AccessCondition.ts#L19) - ---- - -### paramsFromDDO - -▸ **paramsFromDDO**(`__namedParameters`): `Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------------ | :----------------------- | -| `__namedParameters` | `AccessConditionContext` | - -#### Returns - -`Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[paramsFromDDO](conditions.ProviderCondition.md#paramsfromddo) - -#### Defined in - -[src/keeper/contracts/conditions/AccessCondition.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/AccessCondition.ts#L23) - ---- - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :------------- | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[send](conditions.ProviderCondition.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - ---- - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :---------------------- | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[sendFrom](conditions.ProviderCondition.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - ---- - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - ---- - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addressesStatic](conditions.ProviderCondition.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - ---- - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSignerStatic](conditions.ProviderCondition.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - ---- - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`AccessCondition`](conditions.AccessCondition.md)\> - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`AccessCondition`](conditions.AccessCondition.md)\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[getInstance](conditions.ProviderCondition.md#getinstance) - -#### Defined in - -[src/keeper/contracts/conditions/AccessCondition.ts:13](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/AccessCondition.ts#L13) - ---- - -### 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 - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/api-reference/classes/conditions.ComputeExecutionCondition.md b/docs/api-reference/classes/conditions.ComputeExecutionCondition.md deleted file mode 100644 index 21438cefa..000000000 --- a/docs/api-reference/classes/conditions.ComputeExecutionCondition.md +++ /dev/null @@ -1,1136 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [conditions](../modules/conditions.md) / ComputeExecutionCondition - -# Class: ComputeExecutionCondition - -[conditions](../modules/conditions.md).ComputeExecutionCondition - -## Hierarchy - -- [`ProviderCondition`](conditions.ProviderCondition.md)<`ComputeExecutionConditionContext`\> - - ↳ **`ComputeExecutionCondition`** - -## Table of contents - -### Constructors - -- [constructor](conditions.ComputeExecutionCondition.md#constructor) - -### Properties - -- [contract](conditions.ComputeExecutionCondition.md#contract) -- [contractName](conditions.ComputeExecutionCondition.md#contractname) -- [events](conditions.ComputeExecutionCondition.md#events) -- [version](conditions.ComputeExecutionCondition.md#version) - -### Accessors - -- [address](conditions.ComputeExecutionCondition.md#address) -- [artifactsFolder](conditions.ComputeExecutionCondition.md#artifactsfolder) -- [config](conditions.ComputeExecutionCondition.md#config) -- [instanceConfig](conditions.ComputeExecutionCondition.md#instanceconfig) -- [instantiableConfig](conditions.ComputeExecutionCondition.md#instantiableconfig) -- [logger](conditions.ComputeExecutionCondition.md#logger) -- [nevermined](conditions.ComputeExecutionCondition.md#nevermined) -- [web3](conditions.ComputeExecutionCondition.md#web3) - -### Methods - -- [abortByTimeOut](conditions.ComputeExecutionCondition.md#abortbytimeout) -- [addresses](conditions.ComputeExecutionCondition.md#addresses) -- [call](conditions.ComputeExecutionCondition.md#call) -- [checkExists](conditions.ComputeExecutionCondition.md#checkexists) -- [findSigner](conditions.ComputeExecutionCondition.md#findsigner) -- [fulfill](conditions.ComputeExecutionCondition.md#fulfill) -- [fulfillGateway](conditions.ComputeExecutionCondition.md#fulfillgateway) -- [fulfillInstance](conditions.ComputeExecutionCondition.md#fulfillinstance) -- [fulfillPlain](conditions.ComputeExecutionCondition.md#fulfillplain) -- [gatewayMethod](conditions.ComputeExecutionCondition.md#gatewaymethod) -- [generateId](conditions.ComputeExecutionCondition.md#generateid) -- [generateIdHash](conditions.ComputeExecutionCondition.md#generateidhash) -- [generateIdWithSeed](conditions.ComputeExecutionCondition.md#generateidwithseed) -- [getAddress](conditions.ComputeExecutionCondition.md#getaddress) -- [getConditionFulfilledEvent](conditions.ComputeExecutionCondition.md#getconditionfulfilledevent) -- [getContract](conditions.ComputeExecutionCondition.md#getcontract) -- [getFromAddress](conditions.ComputeExecutionCondition.md#getfromaddress) -- [getInputsOfMethod](conditions.ComputeExecutionCondition.md#getinputsofmethod) -- [getSignatureOfMethod](conditions.ComputeExecutionCondition.md#getsignatureofmethod) -- [hashValues](conditions.ComputeExecutionCondition.md#hashvalues) -- [hashValuesPlain](conditions.ComputeExecutionCondition.md#hashvaluesplain) -- [init](conditions.ComputeExecutionCondition.md#init) -- [instance](conditions.ComputeExecutionCondition.md#instance) -- [instanceFromDDO](conditions.ComputeExecutionCondition.md#instancefromddo) -- [params](conditions.ComputeExecutionCondition.md#params) -- [paramsFromDDO](conditions.ComputeExecutionCondition.md#paramsfromddo) -- [send](conditions.ComputeExecutionCondition.md#send) -- [sendFrom](conditions.ComputeExecutionCondition.md#sendfrom) -- [setInstanceConfig](conditions.ComputeExecutionCondition.md#setinstanceconfig) -- [wasComputeTriggered](conditions.ComputeExecutionCondition.md#wascomputetriggered) -- [addressesStatic](conditions.ComputeExecutionCondition.md#addressesstatic) -- [findSignerStatic](conditions.ComputeExecutionCondition.md#findsignerstatic) -- [getInstance](conditions.ComputeExecutionCondition.md#getinstance) -- [setInstanceConfig](conditions.ComputeExecutionCondition.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new ComputeExecutionCondition**(`contractName`) - -#### Parameters - -| Name | Type | -| :------------- | :------- | -| `contractName` | `string` | - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[constructor](conditions.ProviderCondition.md#constructor) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L32) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contract](conditions.ProviderCondition.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - ---- - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contractName](conditions.ProviderCondition.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - ---- - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[events](conditions.ProviderCondition.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - ---- - -### version - -• **version**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[version](conditions.ProviderCondition.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - ---- - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - ---- - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -ProviderCondition.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - ---- - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - ---- - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - ---- - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -ProviderCondition.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - ---- - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -ProviderCondition.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - ---- - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -ProviderCondition.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### abortByTimeOut - -▸ **abortByTimeOut**(`agreementId`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------------ | :---------------------- | -| `agreementId` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[abortByTimeOut](conditions.ProviderCondition.md#abortbytimeout) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L97) - ---- - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addresses](conditions.ProviderCondition.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - ---- - -### 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 - -[ProviderCondition](conditions.ProviderCondition.md).[call](conditions.ProviderCondition.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - ---- - -### 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 - -[ProviderCondition](conditions.ProviderCondition.md).[checkExists](conditions.ProviderCondition.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - ---- - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSigner](conditions.ProviderCondition.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - ---- - -### fulfill - -▸ **fulfill**(`agreementId`, `did`, `computeConsumer`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :---------------- | :---------------------- | -| `agreementId` | `string` | -| `did` | `string` | -| `computeConsumer` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[fulfill](conditions.ProviderCondition.md#fulfill) - -#### Defined in - -[src/keeper/contracts/conditions/ComputeExecutionCondition.ts:30](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/ComputeExecutionCondition.ts#L30) - ---- - -### fulfillGateway - -▸ **fulfillGateway**(`cond`, `additionalParams`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :----------------- | :---------------------------------------------------------------------------------------------------- | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | -| `additionalParams` | `Record`<`string`, `unknown`\> | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillGateway](conditions.ProviderCondition.md#fulfillgateway) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:204](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L204) - ---- - -### fulfillInstance - -▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------------------------------------------------- | :------------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillInstance](conditions.ProviderCondition.md#fulfillinstance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L162) - ---- - -### fulfillPlain - -▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------------ | :------------------------------------------------------------ | :------------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillPlain](conditions.ProviderCondition.md#fulfillplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L69) - ---- - -### gatewayMethod - -▸ **gatewayMethod**(): [`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Returns - -[`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[gatewayMethod](conditions.ProviderCondition.md#gatewaymethod) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:221](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L221) - ---- - -### generateId - -▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateId](conditions.ProviderCondition.md#generateid) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:83](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L83) - ---- - -### generateIdHash - -▸ **generateIdHash**(`agreementId`, ...`values`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `...values` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdHash](conditions.ProviderCondition.md#generateidhash) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L79) - ---- - -### generateIdWithSeed - -▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<[`string`, `string`]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdWithSeed](conditions.ProviderCondition.md#generateidwithseed) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L87) - ---- - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getAddress](conditions.ProviderCondition.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - ---- - -### getConditionFulfilledEvent - -▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getConditionFulfilledEvent](conditions.ProviderCondition.md#getconditionfulfilledevent) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:101](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L101) - ---- - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getContract](conditions.ProviderCondition.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - ---- - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getFromAddress](conditions.ProviderCondition.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - ---- - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :----------- | :------- | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getInputsOfMethod](conditions.ProviderCondition.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - ---- - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :----------- | :------- | :------------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getSignatureOfMethod](conditions.ProviderCondition.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - ---- - -### hashValues - -▸ **hashValues**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValues](conditions.ProviderCondition.md#hashvalues) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L141) - ---- - -### hashValuesPlain - -▸ **hashValuesPlain**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValuesPlain](conditions.ProviderCondition.md#hashvaluesplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L145) - ---- - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :--------- | :------------------- | :------------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[init](conditions.ProviderCondition.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - ---- - -### instance - -▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------ | :-------------------------------------------------------------------------------------------------------- | -| `agreementId` | `string` | -| `params` | [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instance](conditions.ProviderCondition.md#instance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:184](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L184) - ---- - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementId`, `ctx`, ...`args`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------ | :------------------------------------------------------------------------------- | -| `agreementId` | `string` | -| `ctx` | `ComputeExecutionConditionContext` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instanceFromDDO](conditions.ProviderCondition.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L154) - ---- - -### params - -▸ **params**(`did`, `computeConsumer`): [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -#### Parameters - -| Name | Type | -| :---------------- | :------- | -| `did` | `string` | -| `computeConsumer` | `string` | - -#### Returns - -[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[params](conditions.ProviderCondition.md#params) - -#### Defined in - -[src/keeper/contracts/conditions/ComputeExecutionCondition.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/ComputeExecutionCondition.ts#L26) - ---- - -### paramsFromDDO - -▸ **paramsFromDDO**(`__namedParameters`): `Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------------ | :--------------------------------- | -| `__namedParameters` | `ComputeExecutionConditionContext` | - -#### Returns - -`Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[paramsFromDDO](conditions.ProviderCondition.md#paramsfromddo) - -#### Defined in - -[src/keeper/contracts/conditions/ComputeExecutionCondition.ts:12](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/ComputeExecutionCondition.ts#L12) - ---- - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :------------- | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[send](conditions.ProviderCondition.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - ---- - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :---------------------- | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[sendFrom](conditions.ProviderCondition.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - ---- - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - ---- - -### wasComputeTriggered - -▸ **wasComputeTriggered**(`did`, `computeConsumer`, `from?`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :---------------- | :---------------------- | -| `did` | `string` | -| `computeConsumer` | `string` | -| `from?` | [`Account`](Account.md) | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -[src/keeper/contracts/conditions/ComputeExecutionCondition.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/ComputeExecutionCondition.ts#L45) - ---- - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addressesStatic](conditions.ProviderCondition.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - ---- - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSignerStatic](conditions.ProviderCondition.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - ---- - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`ComputeExecutionCondition`](conditions.ComputeExecutionCondition.md)\> - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`ComputeExecutionCondition`](conditions.ComputeExecutionCondition.md)\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[getInstance](conditions.ProviderCondition.md#getinstance) - -#### Defined in - -[src/keeper/contracts/conditions/ComputeExecutionCondition.ts:16](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/ComputeExecutionCondition.ts#L16) - ---- - -### 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 - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/api-reference/classes/conditions.ConditionSmall.md b/docs/api-reference/classes/conditions.ConditionSmall.md deleted file mode 100644 index 4e25c476f..000000000 --- a/docs/api-reference/classes/conditions.ConditionSmall.md +++ /dev/null @@ -1,885 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [conditions](../modules/conditions.md) / ConditionSmall - -# Class: ConditionSmall - -[conditions](../modules/conditions.md).ConditionSmall - -## Hierarchy - -- `ContractBase` - - ↳ **`ConditionSmall`** - - ↳↳ [`Condition`](Condition.md) - -## Table of contents - -### Constructors - -- [constructor](conditions.ConditionSmall.md#constructor) - -### Properties - -- [contract](conditions.ConditionSmall.md#contract) -- [contractName](conditions.ConditionSmall.md#contractname) -- [events](conditions.ConditionSmall.md#events) -- [version](conditions.ConditionSmall.md#version) - -### Accessors - -- [address](conditions.ConditionSmall.md#address) -- [artifactsFolder](conditions.ConditionSmall.md#artifactsfolder) -- [config](conditions.ConditionSmall.md#config) -- [instanceConfig](conditions.ConditionSmall.md#instanceconfig) -- [instantiableConfig](conditions.ConditionSmall.md#instantiableconfig) -- [logger](conditions.ConditionSmall.md#logger) -- [nevermined](conditions.ConditionSmall.md#nevermined) -- [web3](conditions.ConditionSmall.md#web3) - -### Methods - -- [abortByTimeOut](conditions.ConditionSmall.md#abortbytimeout) -- [addresses](conditions.ConditionSmall.md#addresses) -- [call](conditions.ConditionSmall.md#call) -- [checkExists](conditions.ConditionSmall.md#checkexists) -- [findSigner](conditions.ConditionSmall.md#findsigner) -- [fulfill](conditions.ConditionSmall.md#fulfill) -- [fulfillPlain](conditions.ConditionSmall.md#fulfillplain) -- [generateId](conditions.ConditionSmall.md#generateid) -- [generateIdHash](conditions.ConditionSmall.md#generateidhash) -- [generateIdWithSeed](conditions.ConditionSmall.md#generateidwithseed) -- [getAddress](conditions.ConditionSmall.md#getaddress) -- [getConditionFulfilledEvent](conditions.ConditionSmall.md#getconditionfulfilledevent) -- [getContract](conditions.ConditionSmall.md#getcontract) -- [getFromAddress](conditions.ConditionSmall.md#getfromaddress) -- [getInputsOfMethod](conditions.ConditionSmall.md#getinputsofmethod) -- [getSignatureOfMethod](conditions.ConditionSmall.md#getsignatureofmethod) -- [hashValues](conditions.ConditionSmall.md#hashvalues) -- [init](conditions.ConditionSmall.md#init) -- [send](conditions.ConditionSmall.md#send) -- [sendFrom](conditions.ConditionSmall.md#sendfrom) -- [setInstanceConfig](conditions.ConditionSmall.md#setinstanceconfig) -- [addressesStatic](conditions.ConditionSmall.md#addressesstatic) -- [findSignerStatic](conditions.ConditionSmall.md#findsignerstatic) -- [getInstance](conditions.ConditionSmall.md#getinstance) -- [setInstanceConfig](conditions.ConditionSmall.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new ConditionSmall**(`contractName`) - -#### Parameters - -| Name | Type | -| :------------- | :------- | -| `contractName` | `string` | - -#### Inherited from - -ContractBase.constructor - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L32) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -ContractBase.contract - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - ---- - -### contractName - -• **contractName**: `string` - -#### Inherited from - -ContractBase.contractName - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - ---- - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -ContractBase.events - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - ---- - -### version - -• **version**: `string` - -#### Inherited from - -ContractBase.version - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ContractBase.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - ---- - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ContractBase.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - ---- - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -ContractBase.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - ---- - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ContractBase.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - ---- - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ContractBase.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - ---- - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -ContractBase.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - ---- - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -ContractBase.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - ---- - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -ContractBase.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### abortByTimeOut - -▸ **abortByTimeOut**(`agreementId`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------------ | :---------------------- | -| `agreementId` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L97) - ---- - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -ContractBase.addresses - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - ---- - -### 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](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - ---- - -### 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](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - ---- - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -ContractBase.findSigner - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - ---- - -### fulfill - -▸ `Abstract` **fulfill**(`agreementId`, ...`args`): `any` - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `...args` | `any`[] | - -#### Returns - -`any` - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:67](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L67) - ---- - -### fulfillPlain - -▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------------ | :------------------------------------------------------------ | :------------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L69) - ---- - -### generateId - -▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:83](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L83) - ---- - -### generateIdHash - -▸ **generateIdHash**(`agreementId`, ...`values`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `...values` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L79) - ---- - -### generateIdWithSeed - -▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<[`string`, `string`]\> - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L87) - ---- - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ContractBase.getAddress - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - ---- - -### getConditionFulfilledEvent - -▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:101](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L101) - ---- - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -ContractBase.getContract - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - ---- - -### 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](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - ---- - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :----------- | :------- | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -ContractBase.getInputsOfMethod - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - ---- - -### 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](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - ---- - -### hashValues - -▸ **hashValues**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L63) - ---- - -### 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](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - ---- - -### 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](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - ---- - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :---------------------- | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -ContractBase.sendFrom - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - ---- - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -ContractBase.setInstanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - ---- - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -ContractBase.addressesStatic - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - ---- - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -ContractBase.findSignerStatic - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - ---- - -### getInstance - -▸ `Static` **getInstance**<`Ctx`, `Extra`\>(`config`, `conditionName`, `conditionsClass`, `optional?`): `Promise`<`any`\> - -#### Type parameters - -| Name | Type | -| :------ | :------------------------------------------------------------------------- | -| `Ctx` | extends [`ConditionContext`](../interfaces/conditions.ConditionContext.md) | -| `Extra` | `Extra` | - -#### Parameters - -| Name | Type | Default value | -| :---------------- | :------------------- | :------------ | -| `config` | `InstantiableConfig` | `undefined` | -| `conditionName` | `string` | `undefined` | -| `conditionsClass` | `any` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`any`\> - -#### Overrides - -ContractBase.getInstance - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:52](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L52) - ---- - -### 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](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/api-reference/classes/conditions.ConsumerCondition.md b/docs/api-reference/classes/conditions.ConsumerCondition.md deleted file mode 100644 index 9834c659c..000000000 --- a/docs/api-reference/classes/conditions.ConsumerCondition.md +++ /dev/null @@ -1,1123 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [conditions](../modules/conditions.md) / ConsumerCondition - -# Class: ConsumerCondition - -[conditions](../modules/conditions.md).ConsumerCondition - -## Type parameters - -| Name | Type | -| :------ | :------------------------------------------------------------------------- | -| `Ctx` | extends [`ConditionContext`](../interfaces/conditions.ConditionContext.md) | -| `Extra` | `Record`<`string`, `unknown`\> | - -## Hierarchy - -- [`Condition`](Condition.md)<`Ctx`, `Extra`\> - - ↳ **`ConsumerCondition`** - - ↳↳ [`LockPaymentCondition`](conditions.LockPaymentCondition.md) - - ↳↳ [`NFTHolderCondition`](conditions.NFTHolderCondition.md) - - ↳↳ [`NFT721HolderCondition`](conditions.NFT721HolderCondition.md) - - ↳↳ [`NFTLockCondition`](conditions.NFTLockCondition.md) - -## Table of contents - -### Constructors - -- [constructor](conditions.ConsumerCondition.md#constructor) - -### Properties - -- [contract](conditions.ConsumerCondition.md#contract) -- [contractName](conditions.ConsumerCondition.md#contractname) -- [events](conditions.ConsumerCondition.md#events) -- [version](conditions.ConsumerCondition.md#version) - -### Accessors - -- [address](conditions.ConsumerCondition.md#address) -- [artifactsFolder](conditions.ConsumerCondition.md#artifactsfolder) -- [config](conditions.ConsumerCondition.md#config) -- [instanceConfig](conditions.ConsumerCondition.md#instanceconfig) -- [instantiableConfig](conditions.ConsumerCondition.md#instantiableconfig) -- [logger](conditions.ConsumerCondition.md#logger) -- [nevermined](conditions.ConsumerCondition.md#nevermined) -- [web3](conditions.ConsumerCondition.md#web3) - -### Methods - -- [abortByTimeOut](conditions.ConsumerCondition.md#abortbytimeout) -- [addresses](conditions.ConsumerCondition.md#addresses) -- [call](conditions.ConsumerCondition.md#call) -- [checkExists](conditions.ConsumerCondition.md#checkexists) -- [findSigner](conditions.ConsumerCondition.md#findsigner) -- [fulfill](conditions.ConsumerCondition.md#fulfill) -- [fulfillGateway](conditions.ConsumerCondition.md#fulfillgateway) -- [fulfillInstance](conditions.ConsumerCondition.md#fulfillinstance) -- [fulfillPlain](conditions.ConsumerCondition.md#fulfillplain) -- [generateId](conditions.ConsumerCondition.md#generateid) -- [generateIdHash](conditions.ConsumerCondition.md#generateidhash) -- [generateIdWithSeed](conditions.ConsumerCondition.md#generateidwithseed) -- [getAddress](conditions.ConsumerCondition.md#getaddress) -- [getConditionFulfilledEvent](conditions.ConsumerCondition.md#getconditionfulfilledevent) -- [getContract](conditions.ConsumerCondition.md#getcontract) -- [getFromAddress](conditions.ConsumerCondition.md#getfromaddress) -- [getInputsOfMethod](conditions.ConsumerCondition.md#getinputsofmethod) -- [getSignatureOfMethod](conditions.ConsumerCondition.md#getsignatureofmethod) -- [hashValues](conditions.ConsumerCondition.md#hashvalues) -- [hashValuesPlain](conditions.ConsumerCondition.md#hashvaluesplain) -- [init](conditions.ConsumerCondition.md#init) -- [instance](conditions.ConsumerCondition.md#instance) -- [instanceFromDDO](conditions.ConsumerCondition.md#instancefromddo) -- [params](conditions.ConsumerCondition.md#params) -- [paramsFromDDO](conditions.ConsumerCondition.md#paramsfromddo) -- [send](conditions.ConsumerCondition.md#send) -- [sendFrom](conditions.ConsumerCondition.md#sendfrom) -- [setInstanceConfig](conditions.ConsumerCondition.md#setinstanceconfig) -- [addressesStatic](conditions.ConsumerCondition.md#addressesstatic) -- [findSignerStatic](conditions.ConsumerCondition.md#findsignerstatic) -- [getInstance](conditions.ConsumerCondition.md#getinstance) -- [setInstanceConfig](conditions.ConsumerCondition.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new ConsumerCondition**<`Ctx`, `Extra`\>(`contractName`) - -#### Type parameters - -| Name | Type | -| :------ | :------------------------------------------------------------------------- | -| `Ctx` | extends [`ConditionContext`](../interfaces/conditions.ConditionContext.md) | -| `Extra` | `Record`<`string`, `unknown`\> | - -#### Parameters - -| Name | Type | -| :------------- | :------- | -| `contractName` | `string` | - -#### Inherited from - -[Condition](Condition.md).[constructor](Condition.md#constructor) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L32) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[Condition](Condition.md).[contract](Condition.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - ---- - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[Condition](Condition.md).[contractName](Condition.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - ---- - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[Condition](Condition.md).[events](Condition.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - ---- - -### version - -• **version**: `string` - -#### Inherited from - -[Condition](Condition.md).[version](Condition.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -Condition.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - ---- - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -Condition.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - ---- - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -Condition.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - ---- - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -Condition.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - ---- - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -Condition.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - ---- - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -Condition.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - ---- - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -Condition.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - ---- - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -Condition.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### abortByTimeOut - -▸ **abortByTimeOut**(`agreementId`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------------ | :---------------------- | -| `agreementId` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[Condition](Condition.md).[abortByTimeOut](Condition.md#abortbytimeout) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L97) - ---- - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[Condition](Condition.md).[addresses](Condition.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - ---- - -### 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 - -[Condition](Condition.md).[call](Condition.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - ---- - -### 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 - -[Condition](Condition.md).[checkExists](Condition.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - ---- - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[Condition](Condition.md).[findSigner](Condition.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - ---- - -### fulfill - -▸ `Abstract` **fulfill**(`agreementId`, ...`args`): `any` - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `...args` | `any`[] | - -#### Returns - -`any` - -#### Inherited from - -[Condition](Condition.md).[fulfill](Condition.md#fulfill) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:67](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L67) - ---- - -### fulfillGateway - -▸ **fulfillGateway**(`_cond`, `_additionalParams`, `_from?`, `_params?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------------------ | :----------------------------------------------------------------------------- | -| `_cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Extra`\> | -| `_additionalParams` | `Extra` | -| `_from?` | [`Account`](Account.md) | -| `_params?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Overrides - -[Condition](Condition.md).[fulfillGateway](Condition.md#fulfillgateway) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:230](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L230) - ---- - -### fulfillInstance - -▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :----------------- | :----------------------------------------------------------------------------- | :------------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Extra`\> | `undefined` | -| `additionalParams` | `Extra` | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[Condition](Condition.md).[fulfillInstance](Condition.md#fulfillinstance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L162) - ---- - -### fulfillPlain - -▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------------ | :------------------------------------------------------------ | :------------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[Condition](Condition.md).[fulfillPlain](Condition.md#fulfillplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L69) - ---- - -### generateId - -▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[Condition](Condition.md).[generateId](Condition.md#generateid) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:83](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L83) - ---- - -### generateIdHash - -▸ **generateIdHash**(`agreementId`, ...`values`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `...values` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[Condition](Condition.md).[generateIdHash](Condition.md#generateidhash) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L79) - ---- - -### generateIdWithSeed - -▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<[`string`, `string`]\> - -#### Inherited from - -[Condition](Condition.md).[generateIdWithSeed](Condition.md#generateidwithseed) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L87) - ---- - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[Condition](Condition.md).[getAddress](Condition.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - ---- - -### getConditionFulfilledEvent - -▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Inherited from - -[Condition](Condition.md).[getConditionFulfilledEvent](Condition.md#getconditionfulfilledevent) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:101](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L101) - ---- - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[Condition](Condition.md).[getContract](Condition.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - ---- - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[Condition](Condition.md).[getFromAddress](Condition.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - ---- - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :----------- | :------- | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[Condition](Condition.md).[getInputsOfMethod](Condition.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - ---- - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :----------- | :------- | :------------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[Condition](Condition.md).[getSignatureOfMethod](Condition.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - ---- - -### hashValues - -▸ **hashValues**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[Condition](Condition.md).[hashValues](Condition.md#hashvalues) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L141) - ---- - -### hashValuesPlain - -▸ **hashValuesPlain**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[Condition](Condition.md).[hashValuesPlain](Condition.md#hashvaluesplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L145) - ---- - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :--------- | :------------------- | :------------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[Condition](Condition.md).[init](Condition.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - ---- - -### instance - -▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Extra`\>\> - -#### Parameters - -| Name | Type | -| :------------ | :--------------------------------------------------------------------------------- | -| `agreementId` | `string` | -| `params` | [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Extra`\> | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Extra`\>\> - -#### Inherited from - -[Condition](Condition.md).[instance](Condition.md#instance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:184](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L184) - ---- - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementId`, `ctx`, ...`args`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Extra`\>\> - -#### Parameters - -| Name | Type | -| :------------ | :------------------------------------------------------------------------------- | -| `agreementId` | `string` | -| `ctx` | `Ctx` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Extra`\>\> - -#### Inherited from - -[Condition](Condition.md).[instanceFromDDO](Condition.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L154) - ---- - -### params - -▸ **params**(...`args`): [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Extra`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Extra`\> - -#### Inherited from - -[Condition](Condition.md).[params](Condition.md#params) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:134](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L134) - ---- - -### paramsFromDDO - -▸ `Abstract` **paramsFromDDO**(`ctx`, ...`args`): `Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Extra`\>\> - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------- | -| `ctx` | `Ctx` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Extra`\>\> - -#### Inherited from - -[Condition](Condition.md).[paramsFromDDO](Condition.md#paramsfromddo) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L149) - ---- - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :------------- | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[Condition](Condition.md).[send](Condition.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - ---- - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :---------------------- | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[Condition](Condition.md).[sendFrom](Condition.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - ---- - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[Condition](Condition.md).[setInstanceConfig](Condition.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - ---- - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[Condition](Condition.md).[addressesStatic](Condition.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - ---- - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[Condition](Condition.md).[findSignerStatic](Condition.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - ---- - -### getInstance - -▸ `Static` **getInstance**<`Ctx`, `Extra`\>(`config`, `conditionName`, `conditionsClass`, `optional?`): `Promise`<`any`\> - -#### Type parameters - -| Name | Type | -| :------ | :------------------------------------------------------------------------- | -| `Ctx` | extends [`ConditionContext`](../interfaces/conditions.ConditionContext.md) | -| `Extra` | `Extra` | - -#### Parameters - -| Name | Type | Default value | -| :---------------- | :------------------- | :------------ | -| `config` | `InstantiableConfig` | `undefined` | -| `conditionName` | `string` | `undefined` | -| `conditionsClass` | `any` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`any`\> - -#### Inherited from - -[Condition](Condition.md).[getInstance](Condition.md#getinstance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:121](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L121) - ---- - -### 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 - -[Condition](Condition.md).[setInstanceConfig](Condition.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/api-reference/classes/conditions.DistributeNFTCollateralCondition.md b/docs/api-reference/classes/conditions.DistributeNFTCollateralCondition.md deleted file mode 100644 index fe36d8300..000000000 --- a/docs/api-reference/classes/conditions.DistributeNFTCollateralCondition.md +++ /dev/null @@ -1,1127 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [conditions](../modules/conditions.md) / DistributeNFTCollateralCondition - -# Class: DistributeNFTCollateralCondition - -[conditions](../modules/conditions.md).DistributeNFTCollateralCondition - -Condition allowing to transfer an NFT either to the original owner or a lender -depending on the loan status. - -## Hierarchy - -- [`ProviderCondition`](conditions.ProviderCondition.md)<`DistributeNFTCollateralConditionContext`\> - - ↳ **`DistributeNFTCollateralCondition`** - -## Table of contents - -### Constructors - -- [constructor](conditions.DistributeNFTCollateralCondition.md#constructor) - -### Properties - -- [contract](conditions.DistributeNFTCollateralCondition.md#contract) -- [contractName](conditions.DistributeNFTCollateralCondition.md#contractname) -- [events](conditions.DistributeNFTCollateralCondition.md#events) -- [version](conditions.DistributeNFTCollateralCondition.md#version) - -### Accessors - -- [address](conditions.DistributeNFTCollateralCondition.md#address) -- [artifactsFolder](conditions.DistributeNFTCollateralCondition.md#artifactsfolder) -- [config](conditions.DistributeNFTCollateralCondition.md#config) -- [instanceConfig](conditions.DistributeNFTCollateralCondition.md#instanceconfig) -- [instantiableConfig](conditions.DistributeNFTCollateralCondition.md#instantiableconfig) -- [logger](conditions.DistributeNFTCollateralCondition.md#logger) -- [nevermined](conditions.DistributeNFTCollateralCondition.md#nevermined) -- [web3](conditions.DistributeNFTCollateralCondition.md#web3) - -### Methods - -- [abortByTimeOut](conditions.DistributeNFTCollateralCondition.md#abortbytimeout) -- [addresses](conditions.DistributeNFTCollateralCondition.md#addresses) -- [call](conditions.DistributeNFTCollateralCondition.md#call) -- [checkExists](conditions.DistributeNFTCollateralCondition.md#checkexists) -- [findSigner](conditions.DistributeNFTCollateralCondition.md#findsigner) -- [fulfill](conditions.DistributeNFTCollateralCondition.md#fulfill) -- [fulfillGateway](conditions.DistributeNFTCollateralCondition.md#fulfillgateway) -- [fulfillInstance](conditions.DistributeNFTCollateralCondition.md#fulfillinstance) -- [fulfillPlain](conditions.DistributeNFTCollateralCondition.md#fulfillplain) -- [gatewayMethod](conditions.DistributeNFTCollateralCondition.md#gatewaymethod) -- [generateId](conditions.DistributeNFTCollateralCondition.md#generateid) -- [generateIdHash](conditions.DistributeNFTCollateralCondition.md#generateidhash) -- [generateIdWithSeed](conditions.DistributeNFTCollateralCondition.md#generateidwithseed) -- [getAddress](conditions.DistributeNFTCollateralCondition.md#getaddress) -- [getConditionFulfilledEvent](conditions.DistributeNFTCollateralCondition.md#getconditionfulfilledevent) -- [getContract](conditions.DistributeNFTCollateralCondition.md#getcontract) -- [getFromAddress](conditions.DistributeNFTCollateralCondition.md#getfromaddress) -- [getInputsOfMethod](conditions.DistributeNFTCollateralCondition.md#getinputsofmethod) -- [getSignatureOfMethod](conditions.DistributeNFTCollateralCondition.md#getsignatureofmethod) -- [hashValues](conditions.DistributeNFTCollateralCondition.md#hashvalues) -- [hashValuesPlain](conditions.DistributeNFTCollateralCondition.md#hashvaluesplain) -- [init](conditions.DistributeNFTCollateralCondition.md#init) -- [instance](conditions.DistributeNFTCollateralCondition.md#instance) -- [instanceFromDDO](conditions.DistributeNFTCollateralCondition.md#instancefromddo) -- [params](conditions.DistributeNFTCollateralCondition.md#params) -- [paramsFromDDO](conditions.DistributeNFTCollateralCondition.md#paramsfromddo) -- [send](conditions.DistributeNFTCollateralCondition.md#send) -- [sendFrom](conditions.DistributeNFTCollateralCondition.md#sendfrom) -- [setInstanceConfig](conditions.DistributeNFTCollateralCondition.md#setinstanceconfig) -- [addressesStatic](conditions.DistributeNFTCollateralCondition.md#addressesstatic) -- [findSignerStatic](conditions.DistributeNFTCollateralCondition.md#findsignerstatic) -- [getInstance](conditions.DistributeNFTCollateralCondition.md#getinstance) -- [setInstanceConfig](conditions.DistributeNFTCollateralCondition.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new DistributeNFTCollateralCondition**(`contractName`) - -#### Parameters - -| Name | Type | -| :------------- | :------- | -| `contractName` | `string` | - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[constructor](conditions.ProviderCondition.md#constructor) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L32) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contract](conditions.ProviderCondition.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - ---- - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contractName](conditions.ProviderCondition.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - ---- - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[events](conditions.ProviderCondition.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - ---- - -### version - -• **version**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[version](conditions.ProviderCondition.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - ---- - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - ---- - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -ProviderCondition.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - ---- - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - ---- - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - ---- - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -ProviderCondition.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - ---- - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -ProviderCondition.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - ---- - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -ProviderCondition.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### abortByTimeOut - -▸ **abortByTimeOut**(`agreementId`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------------ | :---------------------- | -| `agreementId` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[abortByTimeOut](conditions.ProviderCondition.md#abortbytimeout) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L97) - ---- - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addresses](conditions.ProviderCondition.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - ---- - -### 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 - -[ProviderCondition](conditions.ProviderCondition.md).[call](conditions.ProviderCondition.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - ---- - -### 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 - -[ProviderCondition](conditions.ProviderCondition.md).[checkExists](conditions.ProviderCondition.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - ---- - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSigner](conditions.ProviderCondition.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - ---- - -### fulfill - -▸ **fulfill**(`agreementId`, `did`, `vaultAddress`, `nftContractAddress`, `from?`, `txParams?`): `Promise`<`ContractReceipt`\> - -Fulfill the distribute NFT collateral condition. -Only the borrower or the lender can call this method. - -#### Parameters - -| Name | Type | Description | -| :------------------- | :---------------------- | :--------------------------------------------------------- | -| `agreementId` | `string` | The agreement identifier. | -| `did` | `string` | The DID of the asset with NFTs. | -| `vaultAddress` | `string` | The address of the vault contract where the NFT is locked. | -| `nftContractAddress` | `string` | The address of the NFT721 contract | -| `from?` | [`Account`](Account.md) | | -| `txParams?` | `TxParameters` | - | - -#### Returns - -`Promise`<`ContractReceipt`\> - -Condition state. - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[fulfill](conditions.ProviderCondition.md#fulfill) - -#### Defined in - -[src/keeper/contracts/defi/DistributeNFT721CollateralCondition.ts:62](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/DistributeNFT721CollateralCondition.ts#L62) - ---- - -### fulfillGateway - -▸ **fulfillGateway**(`cond`, `additionalParams`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :----------------- | :---------------------------------------------------------------------------------------------------- | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | -| `additionalParams` | `Record`<`string`, `unknown`\> | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillGateway](conditions.ProviderCondition.md#fulfillgateway) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:204](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L204) - ---- - -### fulfillInstance - -▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------------------------------------------------- | :------------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillInstance](conditions.ProviderCondition.md#fulfillinstance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L162) - ---- - -### fulfillPlain - -▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------------ | :------------------------------------------------------------ | :------------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillPlain](conditions.ProviderCondition.md#fulfillplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L69) - ---- - -### gatewayMethod - -▸ **gatewayMethod**(): [`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Returns - -[`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[gatewayMethod](conditions.ProviderCondition.md#gatewaymethod) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:221](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L221) - ---- - -### generateId - -▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateId](conditions.ProviderCondition.md#generateid) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:83](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L83) - ---- - -### generateIdHash - -▸ **generateIdHash**(`agreementId`, ...`values`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `...values` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdHash](conditions.ProviderCondition.md#generateidhash) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L79) - ---- - -### generateIdWithSeed - -▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<[`string`, `string`]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdWithSeed](conditions.ProviderCondition.md#generateidwithseed) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L87) - ---- - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getAddress](conditions.ProviderCondition.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - ---- - -### getConditionFulfilledEvent - -▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getConditionFulfilledEvent](conditions.ProviderCondition.md#getconditionfulfilledevent) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:101](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L101) - ---- - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getContract](conditions.ProviderCondition.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - ---- - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getFromAddress](conditions.ProviderCondition.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - ---- - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :----------- | :------- | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getInputsOfMethod](conditions.ProviderCondition.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - ---- - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :----------- | :------- | :------------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getSignatureOfMethod](conditions.ProviderCondition.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - ---- - -### hashValues - -▸ **hashValues**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValues](conditions.ProviderCondition.md#hashvalues) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L141) - ---- - -### hashValuesPlain - -▸ **hashValuesPlain**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValuesPlain](conditions.ProviderCondition.md#hashvaluesplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L145) - ---- - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :--------- | :------------------- | :------------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[init](conditions.ProviderCondition.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - ---- - -### instance - -▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------ | :-------------------------------------------------------------------------------------------------------- | -| `agreementId` | `string` | -| `params` | [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instance](conditions.ProviderCondition.md#instance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:184](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L184) - ---- - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementId`, `ctx`, ...`args`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------ | :------------------------------------------------------------------------------- | -| `agreementId` | `string` | -| `ctx` | `DistributeNFTCollateralConditionContext` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instanceFromDDO](conditions.ProviderCondition.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L154) - ---- - -### params - -▸ **params**(`did`, `vaultAddress`, `nftContractAddress`): [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -Generates the ash of condition inputs. - -#### Parameters - -| Name | Type | Description | -| :------------------- | :------- | :--------------------------------------------------------- | -| `did` | `string` | The DID of the asset with NFTs. | -| `vaultAddress` | `string` | The address of the vault contract where the NFT is locked. | -| `nftContractAddress` | `string` | The address of the NFT721 contract | - -#### Returns - -[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -Hash of all the values - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[params](conditions.ProviderCondition.md#params) - -#### Defined in - -[src/keeper/contracts/defi/DistributeNFT721CollateralCondition.ts:39](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/DistributeNFT721CollateralCondition.ts#L39) - ---- - -### paramsFromDDO - -▸ **paramsFromDDO**(`__namedParameters`): `Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------------ | :---------------------------------------- | -| `__namedParameters` | `DistributeNFTCollateralConditionContext` | - -#### Returns - -`Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[paramsFromDDO](conditions.ProviderCondition.md#paramsfromddo) - -#### Defined in - -[src/keeper/contracts/defi/DistributeNFT721CollateralCondition.ts:43](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/DistributeNFT721CollateralCondition.ts#L43) - ---- - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :------------- | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[send](conditions.ProviderCondition.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - ---- - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :---------------------- | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[sendFrom](conditions.ProviderCondition.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - ---- - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - ---- - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addressesStatic](conditions.ProviderCondition.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - ---- - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSignerStatic](conditions.ProviderCondition.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - ---- - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`DistributeNFTCollateralCondition`](conditions.DistributeNFTCollateralCondition.md)\> - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`DistributeNFTCollateralCondition`](conditions.DistributeNFTCollateralCondition.md)\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[getInstance](conditions.ProviderCondition.md#getinstance) - -#### Defined in - -[src/keeper/contracts/defi/DistributeNFT721CollateralCondition.ts:21](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/DistributeNFT721CollateralCondition.ts#L21) - ---- - -### 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 - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/api-reference/classes/conditions.EscrowPaymentCondition.md b/docs/api-reference/classes/conditions.EscrowPaymentCondition.md deleted file mode 100644 index 49d6763fc..000000000 --- a/docs/api-reference/classes/conditions.EscrowPaymentCondition.md +++ /dev/null @@ -1,1127 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [conditions](../modules/conditions.md) / EscrowPaymentCondition - -# Class: EscrowPaymentCondition - -[conditions](../modules/conditions.md).EscrowPaymentCondition - -## Hierarchy - -- [`ProviderCondition`](conditions.ProviderCondition.md)<`EscrowPaymentConditionContext`\> - - ↳ **`EscrowPaymentCondition`** - -## Table of contents - -### Constructors - -- [constructor](conditions.EscrowPaymentCondition.md#constructor) - -### Properties - -- [contract](conditions.EscrowPaymentCondition.md#contract) -- [contractName](conditions.EscrowPaymentCondition.md#contractname) -- [events](conditions.EscrowPaymentCondition.md#events) -- [version](conditions.EscrowPaymentCondition.md#version) - -### Accessors - -- [address](conditions.EscrowPaymentCondition.md#address) -- [artifactsFolder](conditions.EscrowPaymentCondition.md#artifactsfolder) -- [config](conditions.EscrowPaymentCondition.md#config) -- [instanceConfig](conditions.EscrowPaymentCondition.md#instanceconfig) -- [instantiableConfig](conditions.EscrowPaymentCondition.md#instantiableconfig) -- [logger](conditions.EscrowPaymentCondition.md#logger) -- [nevermined](conditions.EscrowPaymentCondition.md#nevermined) -- [web3](conditions.EscrowPaymentCondition.md#web3) - -### Methods - -- [abortByTimeOut](conditions.EscrowPaymentCondition.md#abortbytimeout) -- [addresses](conditions.EscrowPaymentCondition.md#addresses) -- [call](conditions.EscrowPaymentCondition.md#call) -- [checkExists](conditions.EscrowPaymentCondition.md#checkexists) -- [findSigner](conditions.EscrowPaymentCondition.md#findsigner) -- [fulfill](conditions.EscrowPaymentCondition.md#fulfill) -- [fulfillGateway](conditions.EscrowPaymentCondition.md#fulfillgateway) -- [fulfillInstance](conditions.EscrowPaymentCondition.md#fulfillinstance) -- [fulfillPlain](conditions.EscrowPaymentCondition.md#fulfillplain) -- [gatewayMethod](conditions.EscrowPaymentCondition.md#gatewaymethod) -- [generateId](conditions.EscrowPaymentCondition.md#generateid) -- [generateIdHash](conditions.EscrowPaymentCondition.md#generateidhash) -- [generateIdWithSeed](conditions.EscrowPaymentCondition.md#generateidwithseed) -- [getAddress](conditions.EscrowPaymentCondition.md#getaddress) -- [getConditionFulfilledEvent](conditions.EscrowPaymentCondition.md#getconditionfulfilledevent) -- [getContract](conditions.EscrowPaymentCondition.md#getcontract) -- [getFromAddress](conditions.EscrowPaymentCondition.md#getfromaddress) -- [getInputsOfMethod](conditions.EscrowPaymentCondition.md#getinputsofmethod) -- [getSignatureOfMethod](conditions.EscrowPaymentCondition.md#getsignatureofmethod) -- [hashValues](conditions.EscrowPaymentCondition.md#hashvalues) -- [hashValuesPlain](conditions.EscrowPaymentCondition.md#hashvaluesplain) -- [init](conditions.EscrowPaymentCondition.md#init) -- [instance](conditions.EscrowPaymentCondition.md#instance) -- [instanceFromDDO](conditions.EscrowPaymentCondition.md#instancefromddo) -- [params](conditions.EscrowPaymentCondition.md#params) -- [paramsFromDDO](conditions.EscrowPaymentCondition.md#paramsfromddo) -- [send](conditions.EscrowPaymentCondition.md#send) -- [sendFrom](conditions.EscrowPaymentCondition.md#sendfrom) -- [setInstanceConfig](conditions.EscrowPaymentCondition.md#setinstanceconfig) -- [addressesStatic](conditions.EscrowPaymentCondition.md#addressesstatic) -- [findSignerStatic](conditions.EscrowPaymentCondition.md#findsignerstatic) -- [getInstance](conditions.EscrowPaymentCondition.md#getinstance) -- [setInstanceConfig](conditions.EscrowPaymentCondition.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new EscrowPaymentCondition**(`contractName`) - -#### Parameters - -| Name | Type | -| :------------- | :------- | -| `contractName` | `string` | - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[constructor](conditions.ProviderCondition.md#constructor) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L32) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contract](conditions.ProviderCondition.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - ---- - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contractName](conditions.ProviderCondition.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - ---- - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[events](conditions.ProviderCondition.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - ---- - -### version - -• **version**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[version](conditions.ProviderCondition.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - ---- - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - ---- - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -ProviderCondition.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - ---- - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - ---- - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - ---- - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -ProviderCondition.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - ---- - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -ProviderCondition.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - ---- - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -ProviderCondition.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### abortByTimeOut - -▸ **abortByTimeOut**(`agreementId`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------------ | :---------------------- | -| `agreementId` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[abortByTimeOut](conditions.ProviderCondition.md#abortbytimeout) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L97) - ---- - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addresses](conditions.ProviderCondition.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - ---- - -### 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 - -[ProviderCondition](conditions.ProviderCondition.md).[call](conditions.ProviderCondition.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - ---- - -### 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 - -[ProviderCondition](conditions.ProviderCondition.md).[checkExists](conditions.ProviderCondition.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - ---- - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSigner](conditions.ProviderCondition.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - ---- - -### fulfill - -▸ **fulfill**(`agreementId`, `did`, `amounts`, `receivers`, `returnAddress`, `lockPaymentAddress`, `tokenAddress`, `lockCondition`, `releaseCondition`, `from?`, `txParams?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------------------- | :---------------------- | -| `agreementId` | `string` | -| `did` | `string` | -| `amounts` | `default`[] | -| `receivers` | `string`[] | -| `returnAddress` | `string` | -| `lockPaymentAddress` | `string` | -| `tokenAddress` | `string` | -| `lockCondition` | `string` | -| `releaseCondition` | `string` | -| `from?` | [`Account`](Account.md) | -| `txParams?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[fulfill](conditions.ProviderCondition.md#fulfill) - -#### Defined in - -[src/keeper/contracts/conditions/EscrowPaymentCondition.ts:68](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/EscrowPaymentCondition.ts#L68) - ---- - -### fulfillGateway - -▸ **fulfillGateway**(`cond`, `additionalParams`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :----------------- | :---------------------------------------------------------------------------------------------------- | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | -| `additionalParams` | `Record`<`string`, `unknown`\> | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillGateway](conditions.ProviderCondition.md#fulfillgateway) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:204](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L204) - ---- - -### fulfillInstance - -▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------------------------------------------------- | :------------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillInstance](conditions.ProviderCondition.md#fulfillinstance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L162) - ---- - -### fulfillPlain - -▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------------ | :------------------------------------------------------------ | :------------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillPlain](conditions.ProviderCondition.md#fulfillplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L69) - ---- - -### gatewayMethod - -▸ **gatewayMethod**(): [`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Returns - -[`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[gatewayMethod](conditions.ProviderCondition.md#gatewaymethod) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:221](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L221) - ---- - -### generateId - -▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateId](conditions.ProviderCondition.md#generateid) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:83](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L83) - ---- - -### generateIdHash - -▸ **generateIdHash**(`agreementId`, ...`values`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `...values` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdHash](conditions.ProviderCondition.md#generateidhash) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L79) - ---- - -### generateIdWithSeed - -▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<[`string`, `string`]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdWithSeed](conditions.ProviderCondition.md#generateidwithseed) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L87) - ---- - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getAddress](conditions.ProviderCondition.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - ---- - -### getConditionFulfilledEvent - -▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getConditionFulfilledEvent](conditions.ProviderCondition.md#getconditionfulfilledevent) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:101](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L101) - ---- - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getContract](conditions.ProviderCondition.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - ---- - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getFromAddress](conditions.ProviderCondition.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - ---- - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :----------- | :------- | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getInputsOfMethod](conditions.ProviderCondition.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - ---- - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :----------- | :------- | :------------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getSignatureOfMethod](conditions.ProviderCondition.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - ---- - -### hashValues - -▸ **hashValues**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValues](conditions.ProviderCondition.md#hashvalues) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L141) - ---- - -### hashValuesPlain - -▸ **hashValuesPlain**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValuesPlain](conditions.ProviderCondition.md#hashvaluesplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L145) - ---- - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :--------- | :------------------- | :------------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[init](conditions.ProviderCondition.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - ---- - -### instance - -▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------ | :-------------------------------------------------------------------------------------------------------- | -| `agreementId` | `string` | -| `params` | [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instance](conditions.ProviderCondition.md#instance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:184](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L184) - ---- - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementId`, `ctx`, ...`args`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------ | :------------------------------------------------------------------------------- | -| `agreementId` | `string` | -| `ctx` | `EscrowPaymentConditionContext` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instanceFromDDO](conditions.ProviderCondition.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L154) - ---- - -### params - -▸ **params**(`did`, `amounts`, `receivers`, `returnAddress`, `sender`, `tokenAddress`, `lockCondition`, `releaseCondition`): [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -#### Parameters - -| Name | Type | -| :----------------- | :---------- | -| `did` | `string` | -| `amounts` | `default`[] | -| `receivers` | `string`[] | -| `returnAddress` | `string` | -| `sender` | `string` | -| `tokenAddress` | `string` | -| `lockCondition` | `string` | -| `releaseCondition` | `string` | - -#### Returns - -[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[params](conditions.ProviderCondition.md#params) - -#### Defined in - -[src/keeper/contracts/conditions/EscrowPaymentCondition.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/EscrowPaymentCondition.ts#L28) - ---- - -### paramsFromDDO - -▸ **paramsFromDDO**(`__namedParameters`, `access`, `lock`): `Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------------ | :----------------------------------------------------------------------------- | -| `__namedParameters` | `EscrowPaymentConditionContext` | -| `access` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md) | -| `lock` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md) | - -#### Returns - -`Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[paramsFromDDO](conditions.ProviderCondition.md#paramsfromddo) - -#### Defined in - -[src/keeper/contracts/conditions/EscrowPaymentCondition.ts:49](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/EscrowPaymentCondition.ts#L49) - ---- - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :------------- | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[send](conditions.ProviderCondition.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - ---- - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :---------------------- | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[sendFrom](conditions.ProviderCondition.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - ---- - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - ---- - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addressesStatic](conditions.ProviderCondition.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - ---- - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSignerStatic](conditions.ProviderCondition.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - ---- - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`EscrowPaymentCondition`](conditions.EscrowPaymentCondition.md)\> - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`EscrowPaymentCondition`](conditions.EscrowPaymentCondition.md)\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[getInstance](conditions.ProviderCondition.md#getinstance) - -#### Defined in - -[src/keeper/contracts/conditions/EscrowPaymentCondition.ts:18](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/EscrowPaymentCondition.ts#L18) - ---- - -### 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 - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/api-reference/classes/conditions.LockPaymentCondition.md b/docs/api-reference/classes/conditions.LockPaymentCondition.md deleted file mode 100644 index bbd870c5d..000000000 --- a/docs/api-reference/classes/conditions.LockPaymentCondition.md +++ /dev/null @@ -1,1100 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [conditions](../modules/conditions.md) / LockPaymentCondition - -# Class: LockPaymentCondition - -[conditions](../modules/conditions.md).LockPaymentCondition - -## Hierarchy - -- [`ConsumerCondition`](conditions.ConsumerCondition.md)<[`ConditionContext`](../interfaces/conditions.ConditionContext.md)\> - - ↳ **`LockPaymentCondition`** - -## Table of contents - -### Constructors - -- [constructor](conditions.LockPaymentCondition.md#constructor) - -### Properties - -- [contract](conditions.LockPaymentCondition.md#contract) -- [contractName](conditions.LockPaymentCondition.md#contractname) -- [events](conditions.LockPaymentCondition.md#events) -- [version](conditions.LockPaymentCondition.md#version) - -### Accessors - -- [address](conditions.LockPaymentCondition.md#address) -- [artifactsFolder](conditions.LockPaymentCondition.md#artifactsfolder) -- [config](conditions.LockPaymentCondition.md#config) -- [instanceConfig](conditions.LockPaymentCondition.md#instanceconfig) -- [instantiableConfig](conditions.LockPaymentCondition.md#instantiableconfig) -- [logger](conditions.LockPaymentCondition.md#logger) -- [nevermined](conditions.LockPaymentCondition.md#nevermined) -- [web3](conditions.LockPaymentCondition.md#web3) - -### Methods - -- [abortByTimeOut](conditions.LockPaymentCondition.md#abortbytimeout) -- [addresses](conditions.LockPaymentCondition.md#addresses) -- [call](conditions.LockPaymentCondition.md#call) -- [checkExists](conditions.LockPaymentCondition.md#checkexists) -- [findSigner](conditions.LockPaymentCondition.md#findsigner) -- [fulfill](conditions.LockPaymentCondition.md#fulfill) -- [fulfillGateway](conditions.LockPaymentCondition.md#fulfillgateway) -- [fulfillInstance](conditions.LockPaymentCondition.md#fulfillinstance) -- [fulfillPlain](conditions.LockPaymentCondition.md#fulfillplain) -- [generateId](conditions.LockPaymentCondition.md#generateid) -- [generateIdHash](conditions.LockPaymentCondition.md#generateidhash) -- [generateIdWithSeed](conditions.LockPaymentCondition.md#generateidwithseed) -- [getAddress](conditions.LockPaymentCondition.md#getaddress) -- [getConditionFulfilledEvent](conditions.LockPaymentCondition.md#getconditionfulfilledevent) -- [getContract](conditions.LockPaymentCondition.md#getcontract) -- [getFromAddress](conditions.LockPaymentCondition.md#getfromaddress) -- [getInputsOfMethod](conditions.LockPaymentCondition.md#getinputsofmethod) -- [getSignatureOfMethod](conditions.LockPaymentCondition.md#getsignatureofmethod) -- [hashValues](conditions.LockPaymentCondition.md#hashvalues) -- [hashValuesPlain](conditions.LockPaymentCondition.md#hashvaluesplain) -- [init](conditions.LockPaymentCondition.md#init) -- [instance](conditions.LockPaymentCondition.md#instance) -- [instanceFromDDO](conditions.LockPaymentCondition.md#instancefromddo) -- [params](conditions.LockPaymentCondition.md#params) -- [paramsFromDDO](conditions.LockPaymentCondition.md#paramsfromddo) -- [send](conditions.LockPaymentCondition.md#send) -- [sendFrom](conditions.LockPaymentCondition.md#sendfrom) -- [setInstanceConfig](conditions.LockPaymentCondition.md#setinstanceconfig) -- [addressesStatic](conditions.LockPaymentCondition.md#addressesstatic) -- [findSignerStatic](conditions.LockPaymentCondition.md#findsignerstatic) -- [getInstance](conditions.LockPaymentCondition.md#getinstance) -- [setInstanceConfig](conditions.LockPaymentCondition.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new LockPaymentCondition**(`contractName`) - -#### Parameters - -| Name | Type | -| :------------- | :------- | -| `contractName` | `string` | - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[constructor](conditions.ConsumerCondition.md#constructor) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L32) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[contract](conditions.ConsumerCondition.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - ---- - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[contractName](conditions.ConsumerCondition.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - ---- - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[events](conditions.ConsumerCondition.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - ---- - -### version - -• **version**: `string` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[version](conditions.ConsumerCondition.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ConsumerCondition.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - ---- - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ConsumerCondition.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - ---- - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -ConsumerCondition.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - ---- - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ConsumerCondition.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - ---- - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ConsumerCondition.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - ---- - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -ConsumerCondition.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - ---- - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -ConsumerCondition.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - ---- - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -ConsumerCondition.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### abortByTimeOut - -▸ **abortByTimeOut**(`agreementId`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------------ | :---------------------- | -| `agreementId` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[abortByTimeOut](conditions.ConsumerCondition.md#abortbytimeout) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L97) - ---- - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[addresses](conditions.ConsumerCondition.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - ---- - -### 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 - -[ConsumerCondition](conditions.ConsumerCondition.md).[call](conditions.ConsumerCondition.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - ---- - -### 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 - -[ConsumerCondition](conditions.ConsumerCondition.md).[checkExists](conditions.ConsumerCondition.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - ---- - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[findSigner](conditions.ConsumerCondition.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - ---- - -### fulfill - -▸ **fulfill**(`agreementId`, `did`, `rewardAddress`, `tokenAddress`, `amounts`, `receivers`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :-------------- | :---------------------- | -| `agreementId` | `string` | -| `did` | `string` | -| `rewardAddress` | `string` | -| `tokenAddress` | `string` | -| `amounts` | `default`[] | -| `receivers` | `string`[] | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Overrides - -[ConsumerCondition](conditions.ConsumerCondition.md).[fulfill](conditions.ConsumerCondition.md#fulfill) - -#### Defined in - -[src/keeper/contracts/conditions/LockPaymentCondition.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/LockPaymentCondition.ts#L44) - ---- - -### fulfillGateway - -▸ **fulfillGateway**(`_cond`, `_additionalParams`, `_from?`, `_params?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------------------ | :---------------------------------------------------------------------------------------------------- | -| `_cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | -| `_additionalParams` | `Record`<`string`, `unknown`\> | -| `_from?` | [`Account`](Account.md) | -| `_params?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[fulfillGateway](conditions.ConsumerCondition.md#fulfillgateway) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:230](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L230) - ---- - -### fulfillInstance - -▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------------------------------------------------- | :------------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[fulfillInstance](conditions.ConsumerCondition.md#fulfillinstance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L162) - ---- - -### fulfillPlain - -▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------------ | :------------------------------------------------------------ | :------------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[fulfillPlain](conditions.ConsumerCondition.md#fulfillplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L69) - ---- - -### generateId - -▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[generateId](conditions.ConsumerCondition.md#generateid) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:83](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L83) - ---- - -### generateIdHash - -▸ **generateIdHash**(`agreementId`, ...`values`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `...values` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[generateIdHash](conditions.ConsumerCondition.md#generateidhash) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L79) - ---- - -### generateIdWithSeed - -▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<[`string`, `string`]\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[generateIdWithSeed](conditions.ConsumerCondition.md#generateidwithseed) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L87) - ---- - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getAddress](conditions.ConsumerCondition.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - ---- - -### getConditionFulfilledEvent - -▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getConditionFulfilledEvent](conditions.ConsumerCondition.md#getconditionfulfilledevent) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:101](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L101) - ---- - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getContract](conditions.ConsumerCondition.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - ---- - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getFromAddress](conditions.ConsumerCondition.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - ---- - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :----------- | :------- | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getInputsOfMethod](conditions.ConsumerCondition.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - ---- - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :----------- | :------- | :------------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getSignatureOfMethod](conditions.ConsumerCondition.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - ---- - -### hashValues - -▸ **hashValues**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[hashValues](conditions.ConsumerCondition.md#hashvalues) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L141) - ---- - -### hashValuesPlain - -▸ **hashValuesPlain**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[hashValuesPlain](conditions.ConsumerCondition.md#hashvaluesplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L145) - ---- - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :--------- | :------------------- | :------------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[init](conditions.ConsumerCondition.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - ---- - -### instance - -▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------ | :-------------------------------------------------------------------------------------------------------- | -| `agreementId` | `string` | -| `params` | [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[instance](conditions.ConsumerCondition.md#instance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:184](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L184) - ---- - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementId`, `ctx`, ...`args`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------ | :------------------------------------------------------------------------------- | -| `agreementId` | `string` | -| `ctx` | [`ConditionContext`](../interfaces/conditions.ConditionContext.md) | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[instanceFromDDO](conditions.ConsumerCondition.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L154) - ---- - -### params - -▸ **params**(`did`, `rewardAddress`, `tokenAddress`, `amounts`, `receivers`): [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -#### Parameters - -| Name | Type | -| :-------------- | :---------- | -| `did` | `string` | -| `rewardAddress` | `string` | -| `tokenAddress` | `string` | -| `amounts` | `default`[] | -| `receivers` | `string`[] | - -#### Returns - -[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -#### Overrides - -[ConsumerCondition](conditions.ConsumerCondition.md).[params](conditions.ConsumerCondition.md#params) - -#### Defined in - -[src/keeper/contracts/conditions/LockPaymentCondition.ts:15](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/LockPaymentCondition.ts#L15) - ---- - -### paramsFromDDO - -▸ **paramsFromDDO**(`__namedParameters`): `Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------------ | :----------------------------------------------------------------- | -| `__namedParameters` | [`ConditionContext`](../interfaces/conditions.ConditionContext.md) | - -#### Returns - -`Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Overrides - -[ConsumerCondition](conditions.ConsumerCondition.md).[paramsFromDDO](conditions.ConsumerCondition.md#paramsfromddo) - -#### Defined in - -[src/keeper/contracts/conditions/LockPaymentCondition.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/LockPaymentCondition.ts#L33) - ---- - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :------------- | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[send](conditions.ConsumerCondition.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - ---- - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :---------------------- | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[sendFrom](conditions.ConsumerCondition.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - ---- - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[setInstanceConfig](conditions.ConsumerCondition.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - ---- - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[addressesStatic](conditions.ConsumerCondition.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - ---- - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[findSignerStatic](conditions.ConsumerCondition.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - ---- - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`LockPaymentCondition`](conditions.LockPaymentCondition.md)\> - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`LockPaymentCondition`](conditions.LockPaymentCondition.md)\> - -#### Overrides - -[ConsumerCondition](conditions.ConsumerCondition.md).[getInstance](conditions.ConsumerCondition.md#getinstance) - -#### Defined in - -[src/keeper/contracts/conditions/LockPaymentCondition.ts:9](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/LockPaymentCondition.ts#L9) - ---- - -### 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 - -[ConsumerCondition](conditions.ConsumerCondition.md).[setInstanceConfig](conditions.ConsumerCondition.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/api-reference/classes/conditions.NFT721HolderCondition.md b/docs/api-reference/classes/conditions.NFT721HolderCondition.md deleted file mode 100644 index e609a9ff2..000000000 --- a/docs/api-reference/classes/conditions.NFT721HolderCondition.md +++ /dev/null @@ -1,1127 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [conditions](../modules/conditions.md) / NFT721HolderCondition - -# Class: NFT721HolderCondition - -[conditions](../modules/conditions.md).NFT721HolderCondition - -Allows to fulfill a condition to users holding some amount of NFTs for a specific DID. - -## Hierarchy - -- [`ConsumerCondition`](conditions.ConsumerCondition.md)<`NFT721HolderConditionContext`\> - - ↳ **`NFT721HolderCondition`** - -## Table of contents - -### Constructors - -- [constructor](conditions.NFT721HolderCondition.md#constructor) - -### Properties - -- [contract](conditions.NFT721HolderCondition.md#contract) -- [contractName](conditions.NFT721HolderCondition.md#contractname) -- [events](conditions.NFT721HolderCondition.md#events) -- [version](conditions.NFT721HolderCondition.md#version) - -### Accessors - -- [address](conditions.NFT721HolderCondition.md#address) -- [artifactsFolder](conditions.NFT721HolderCondition.md#artifactsfolder) -- [config](conditions.NFT721HolderCondition.md#config) -- [instanceConfig](conditions.NFT721HolderCondition.md#instanceconfig) -- [instantiableConfig](conditions.NFT721HolderCondition.md#instantiableconfig) -- [logger](conditions.NFT721HolderCondition.md#logger) -- [nevermined](conditions.NFT721HolderCondition.md#nevermined) -- [web3](conditions.NFT721HolderCondition.md#web3) - -### Methods - -- [abortByTimeOut](conditions.NFT721HolderCondition.md#abortbytimeout) -- [addresses](conditions.NFT721HolderCondition.md#addresses) -- [call](conditions.NFT721HolderCondition.md#call) -- [checkExists](conditions.NFT721HolderCondition.md#checkexists) -- [findSigner](conditions.NFT721HolderCondition.md#findsigner) -- [fulfill](conditions.NFT721HolderCondition.md#fulfill) -- [fulfillGateway](conditions.NFT721HolderCondition.md#fulfillgateway) -- [fulfillInstance](conditions.NFT721HolderCondition.md#fulfillinstance) -- [fulfillPlain](conditions.NFT721HolderCondition.md#fulfillplain) -- [generateId](conditions.NFT721HolderCondition.md#generateid) -- [generateIdHash](conditions.NFT721HolderCondition.md#generateidhash) -- [generateIdWithSeed](conditions.NFT721HolderCondition.md#generateidwithseed) -- [getAddress](conditions.NFT721HolderCondition.md#getaddress) -- [getConditionFulfilledEvent](conditions.NFT721HolderCondition.md#getconditionfulfilledevent) -- [getContract](conditions.NFT721HolderCondition.md#getcontract) -- [getFromAddress](conditions.NFT721HolderCondition.md#getfromaddress) -- [getInputsOfMethod](conditions.NFT721HolderCondition.md#getinputsofmethod) -- [getSignatureOfMethod](conditions.NFT721HolderCondition.md#getsignatureofmethod) -- [hashValues](conditions.NFT721HolderCondition.md#hashvalues) -- [hashValuesPlain](conditions.NFT721HolderCondition.md#hashvaluesplain) -- [init](conditions.NFT721HolderCondition.md#init) -- [instance](conditions.NFT721HolderCondition.md#instance) -- [instanceFromDDO](conditions.NFT721HolderCondition.md#instancefromddo) -- [nftContractFromService](conditions.NFT721HolderCondition.md#nftcontractfromservice) -- [params](conditions.NFT721HolderCondition.md#params) -- [paramsFromDDO](conditions.NFT721HolderCondition.md#paramsfromddo) -- [send](conditions.NFT721HolderCondition.md#send) -- [sendFrom](conditions.NFT721HolderCondition.md#sendfrom) -- [setInstanceConfig](conditions.NFT721HolderCondition.md#setinstanceconfig) -- [addressesStatic](conditions.NFT721HolderCondition.md#addressesstatic) -- [findSignerStatic](conditions.NFT721HolderCondition.md#findsignerstatic) -- [getInstance](conditions.NFT721HolderCondition.md#getinstance) -- [setInstanceConfig](conditions.NFT721HolderCondition.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new NFT721HolderCondition**(`contractName`) - -#### Parameters - -| Name | Type | -| :------------- | :------- | -| `contractName` | `string` | - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[constructor](conditions.ConsumerCondition.md#constructor) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L32) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[contract](conditions.ConsumerCondition.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - ---- - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[contractName](conditions.ConsumerCondition.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - ---- - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[events](conditions.ConsumerCondition.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - ---- - -### version - -• **version**: `string` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[version](conditions.ConsumerCondition.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ConsumerCondition.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - ---- - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ConsumerCondition.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - ---- - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -ConsumerCondition.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - ---- - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ConsumerCondition.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - ---- - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ConsumerCondition.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - ---- - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -ConsumerCondition.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - ---- - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -ConsumerCondition.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - ---- - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -ConsumerCondition.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### abortByTimeOut - -▸ **abortByTimeOut**(`agreementId`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------------ | :---------------------- | -| `agreementId` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[abortByTimeOut](conditions.ConsumerCondition.md#abortbytimeout) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L97) - ---- - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[addresses](conditions.ConsumerCondition.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - ---- - -### 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 - -[ConsumerCondition](conditions.ConsumerCondition.md).[call](conditions.ConsumerCondition.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - ---- - -### 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 - -[ConsumerCondition](conditions.ConsumerCondition.md).[checkExists](conditions.ConsumerCondition.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - ---- - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[findSigner](conditions.ConsumerCondition.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - ---- - -### fulfill - -▸ **fulfill**(`agreementId`, `did`, `holderAddress`, `nftTokenAddress`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -Fulfill requires a validation that holder as enough NFTs for a specific DID. - -#### Parameters - -| Name | Type | Description | -| :---------------- | :---------------------- | :----------------------------------------------- | -| `agreementId` | `string` | SEA agreement identifier. | -| `did` | `string` | The Decentralized Identifier of the asset. | -| `holderAddress` | `string` | The contract address where the reward is locked. | -| `nftTokenAddress` | `string` | The contract address of the nft to use. | -| `from?` | [`Account`](Account.md) | | -| `params?` | `TxParameters` | - | - -#### Returns - -`Promise`<`ContractReceipt`\> - -condition state - -#### Overrides - -[ConsumerCondition](conditions.ConsumerCondition.md).[fulfill](conditions.ConsumerCondition.md#fulfill) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts:71](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts#L71) - ---- - -### fulfillGateway - -▸ **fulfillGateway**(`_cond`, `_additionalParams`, `_from?`, `_params?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------------------ | :---------------------------------------------------------------------------------------------------- | -| `_cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | -| `_additionalParams` | `Record`<`string`, `unknown`\> | -| `_from?` | [`Account`](Account.md) | -| `_params?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[fulfillGateway](conditions.ConsumerCondition.md#fulfillgateway) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:230](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L230) - ---- - -### fulfillInstance - -▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------------------------------------------------- | :------------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[fulfillInstance](conditions.ConsumerCondition.md#fulfillinstance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L162) - ---- - -### fulfillPlain - -▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------------ | :------------------------------------------------------------ | :------------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[fulfillPlain](conditions.ConsumerCondition.md#fulfillplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L69) - ---- - -### generateId - -▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[generateId](conditions.ConsumerCondition.md#generateid) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:83](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L83) - ---- - -### generateIdHash - -▸ **generateIdHash**(`agreementId`, ...`values`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `...values` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[generateIdHash](conditions.ConsumerCondition.md#generateidhash) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L79) - ---- - -### generateIdWithSeed - -▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<[`string`, `string`]\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[generateIdWithSeed](conditions.ConsumerCondition.md#generateidwithseed) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L87) - ---- - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getAddress](conditions.ConsumerCondition.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - ---- - -### getConditionFulfilledEvent - -▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getConditionFulfilledEvent](conditions.ConsumerCondition.md#getconditionfulfilledevent) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:101](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L101) - ---- - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getContract](conditions.ConsumerCondition.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - ---- - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getFromAddress](conditions.ConsumerCondition.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - ---- - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :----------- | :------- | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getInputsOfMethod](conditions.ConsumerCondition.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - ---- - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :----------- | :------- | :------------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getSignatureOfMethod](conditions.ConsumerCondition.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - ---- - -### hashValues - -▸ **hashValues**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[hashValues](conditions.ConsumerCondition.md#hashvalues) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L141) - ---- - -### hashValuesPlain - -▸ **hashValuesPlain**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[hashValuesPlain](conditions.ConsumerCondition.md#hashvaluesplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L145) - ---- - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :--------- | :------------------- | :------------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[init](conditions.ConsumerCondition.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - ---- - -### instance - -▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------ | :-------------------------------------------------------------------------------------------------------- | -| `agreementId` | `string` | -| `params` | [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[instance](conditions.ConsumerCondition.md#instance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:184](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L184) - ---- - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementId`, `ctx`, ...`args`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------ | :------------------------------------------------------------------------------- | -| `agreementId` | `string` | -| `ctx` | `NFT721HolderConditionContext` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[instanceFromDDO](conditions.ConsumerCondition.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L154) - ---- - -### nftContractFromService - -▸ **nftContractFromService**(`service`): `string` - -#### Parameters - -| Name | Type | -| :-------- | :-------------- | -| `service` | `ServiceCommon` | - -#### Returns - -`string` - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts#L44) - ---- - -### params - -▸ **params**(`did`, `holderAddress`, `nftTokenAddress`): [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -Generate the hash of condition inputs with the following parameters. - -#### Parameters - -| Name | Type | Description | -| :---------------- | :------- | :----------------------------------------- | -| `did` | `string` | The Decentralized Identifier of the asset. | -| `holderAddress` | `string` | The address of the NFT holder . | -| `nftTokenAddress` | `string` | The address of the nft 721 token to use | - -#### Returns - -[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -hash of all the values - -#### Overrides - -[ConsumerCondition](conditions.ConsumerCondition.md).[params](conditions.ConsumerCondition.md#params) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts:35](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts#L35) - ---- - -### paramsFromDDO - -▸ **paramsFromDDO**(`__namedParameters`): `Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------------ | :----------------------------- | -| `__namedParameters` | `NFT721HolderConditionContext` | - -#### Returns - -`Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Overrides - -[ConsumerCondition](conditions.ConsumerCondition.md).[paramsFromDDO](conditions.ConsumerCondition.md#paramsfromddo) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts#L50) - ---- - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :------------- | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[send](conditions.ConsumerCondition.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - ---- - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :---------------------- | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[sendFrom](conditions.ConsumerCondition.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - ---- - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[setInstanceConfig](conditions.ConsumerCondition.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - ---- - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[addressesStatic](conditions.ConsumerCondition.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - ---- - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[findSignerStatic](conditions.ConsumerCondition.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - ---- - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`NFT721HolderCondition`](conditions.NFT721HolderCondition.md)\> - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`NFT721HolderCondition`](conditions.NFT721HolderCondition.md)\> - -#### Overrides - -[ConsumerCondition](conditions.ConsumerCondition.md).[getInstance](conditions.ConsumerCondition.md#getinstance) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts:16](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/NFT721HolderCondition.ts#L16) - ---- - -### 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 - -[ConsumerCondition](conditions.ConsumerCondition.md).[setInstanceConfig](conditions.ConsumerCondition.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/api-reference/classes/conditions.NFT721LockCondition.md b/docs/api-reference/classes/conditions.NFT721LockCondition.md deleted file mode 100644 index 26d989813..000000000 --- a/docs/api-reference/classes/conditions.NFT721LockCondition.md +++ /dev/null @@ -1,1126 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [conditions](../modules/conditions.md) / NFT721LockCondition - -# Class: NFT721LockCondition - -[conditions](../modules/conditions.md).NFT721LockCondition - -Implementation of the NFT Lock Condition - -## Hierarchy - -- [`ProviderCondition`](conditions.ProviderCondition.md)<`NFT721LockConditionContext`\> - - ↳ **`NFT721LockCondition`** - -## Table of contents - -### Constructors - -- [constructor](conditions.NFT721LockCondition.md#constructor) - -### Properties - -- [contract](conditions.NFT721LockCondition.md#contract) -- [contractName](conditions.NFT721LockCondition.md#contractname) -- [events](conditions.NFT721LockCondition.md#events) -- [version](conditions.NFT721LockCondition.md#version) - -### Accessors - -- [address](conditions.NFT721LockCondition.md#address) -- [artifactsFolder](conditions.NFT721LockCondition.md#artifactsfolder) -- [config](conditions.NFT721LockCondition.md#config) -- [instanceConfig](conditions.NFT721LockCondition.md#instanceconfig) -- [instantiableConfig](conditions.NFT721LockCondition.md#instantiableconfig) -- [logger](conditions.NFT721LockCondition.md#logger) -- [nevermined](conditions.NFT721LockCondition.md#nevermined) -- [web3](conditions.NFT721LockCondition.md#web3) - -### Methods - -- [abortByTimeOut](conditions.NFT721LockCondition.md#abortbytimeout) -- [addresses](conditions.NFT721LockCondition.md#addresses) -- [call](conditions.NFT721LockCondition.md#call) -- [checkExists](conditions.NFT721LockCondition.md#checkexists) -- [findSigner](conditions.NFT721LockCondition.md#findsigner) -- [fulfill](conditions.NFT721LockCondition.md#fulfill) -- [fulfillGateway](conditions.NFT721LockCondition.md#fulfillgateway) -- [fulfillInstance](conditions.NFT721LockCondition.md#fulfillinstance) -- [fulfillPlain](conditions.NFT721LockCondition.md#fulfillplain) -- [gatewayMethod](conditions.NFT721LockCondition.md#gatewaymethod) -- [generateId](conditions.NFT721LockCondition.md#generateid) -- [generateIdHash](conditions.NFT721LockCondition.md#generateidhash) -- [generateIdWithSeed](conditions.NFT721LockCondition.md#generateidwithseed) -- [getAddress](conditions.NFT721LockCondition.md#getaddress) -- [getConditionFulfilledEvent](conditions.NFT721LockCondition.md#getconditionfulfilledevent) -- [getContract](conditions.NFT721LockCondition.md#getcontract) -- [getFromAddress](conditions.NFT721LockCondition.md#getfromaddress) -- [getInputsOfMethod](conditions.NFT721LockCondition.md#getinputsofmethod) -- [getSignatureOfMethod](conditions.NFT721LockCondition.md#getsignatureofmethod) -- [hashValues](conditions.NFT721LockCondition.md#hashvalues) -- [hashValuesPlain](conditions.NFT721LockCondition.md#hashvaluesplain) -- [init](conditions.NFT721LockCondition.md#init) -- [instance](conditions.NFT721LockCondition.md#instance) -- [instanceFromDDO](conditions.NFT721LockCondition.md#instancefromddo) -- [params](conditions.NFT721LockCondition.md#params) -- [paramsFromDDO](conditions.NFT721LockCondition.md#paramsfromddo) -- [send](conditions.NFT721LockCondition.md#send) -- [sendFrom](conditions.NFT721LockCondition.md#sendfrom) -- [setInstanceConfig](conditions.NFT721LockCondition.md#setinstanceconfig) -- [addressesStatic](conditions.NFT721LockCondition.md#addressesstatic) -- [findSignerStatic](conditions.NFT721LockCondition.md#findsignerstatic) -- [getInstance](conditions.NFT721LockCondition.md#getinstance) -- [setInstanceConfig](conditions.NFT721LockCondition.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new NFT721LockCondition**(`contractName`) - -#### Parameters - -| Name | Type | -| :------------- | :------- | -| `contractName` | `string` | - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[constructor](conditions.ProviderCondition.md#constructor) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L32) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contract](conditions.ProviderCondition.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - ---- - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contractName](conditions.ProviderCondition.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - ---- - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[events](conditions.ProviderCondition.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - ---- - -### version - -• **version**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[version](conditions.ProviderCondition.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - ---- - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - ---- - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -ProviderCondition.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - ---- - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - ---- - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - ---- - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -ProviderCondition.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - ---- - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -ProviderCondition.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - ---- - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -ProviderCondition.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### abortByTimeOut - -▸ **abortByTimeOut**(`agreementId`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------------ | :---------------------- | -| `agreementId` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[abortByTimeOut](conditions.ProviderCondition.md#abortbytimeout) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L97) - ---- - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addresses](conditions.ProviderCondition.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - ---- - -### 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 - -[ProviderCondition](conditions.ProviderCondition.md).[call](conditions.ProviderCondition.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - ---- - -### 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 - -[ProviderCondition](conditions.ProviderCondition.md).[checkExists](conditions.ProviderCondition.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - ---- - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSigner](conditions.ProviderCondition.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - ---- - -### 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 - -| Name | Type | Description | -| :------------------- | :---------------------- | :-------------------------------------------- | -| `agreementId` | `string` | SEA agreement identifier. | -| `did` | `string` | Asset Decentralized identifier. | -| `lockAddress` | `string` | The contract address where the NFT is locked. | -| `amount` | `number` | The amount of tokens to be locked. | -| `nftContractAddress` | `string` | The NFT721 contract address | -| `from?` | [`Account`](Account.md) | | - -#### Returns - -`Promise`<`ContractReceipt`\> - -Condition state. - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[fulfill](conditions.ProviderCondition.md#fulfill) - -#### Defined in - -[src/keeper/contracts/defi/NFT721LockCondition.ts:72](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/NFT721LockCondition.ts#L72) - ---- - -### fulfillGateway - -▸ **fulfillGateway**(`cond`, `additionalParams`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :----------------- | :---------------------------------------------------------------------------------------------------- | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | -| `additionalParams` | `Record`<`string`, `unknown`\> | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillGateway](conditions.ProviderCondition.md#fulfillgateway) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:204](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L204) - ---- - -### fulfillInstance - -▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------------------------------------------------- | :------------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillInstance](conditions.ProviderCondition.md#fulfillinstance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L162) - ---- - -### fulfillPlain - -▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------------ | :------------------------------------------------------------ | :------------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillPlain](conditions.ProviderCondition.md#fulfillplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L69) - ---- - -### gatewayMethod - -▸ **gatewayMethod**(): [`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Returns - -[`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[gatewayMethod](conditions.ProviderCondition.md#gatewaymethod) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:221](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L221) - ---- - -### generateId - -▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateId](conditions.ProviderCondition.md#generateid) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:83](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L83) - ---- - -### generateIdHash - -▸ **generateIdHash**(`agreementId`, ...`values`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `...values` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdHash](conditions.ProviderCondition.md#generateidhash) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L79) - ---- - -### generateIdWithSeed - -▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<[`string`, `string`]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdWithSeed](conditions.ProviderCondition.md#generateidwithseed) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L87) - ---- - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getAddress](conditions.ProviderCondition.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - ---- - -### getConditionFulfilledEvent - -▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getConditionFulfilledEvent](conditions.ProviderCondition.md#getconditionfulfilledevent) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:101](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L101) - ---- - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getContract](conditions.ProviderCondition.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - ---- - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getFromAddress](conditions.ProviderCondition.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - ---- - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :----------- | :------- | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getInputsOfMethod](conditions.ProviderCondition.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - ---- - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :----------- | :------- | :------------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getSignatureOfMethod](conditions.ProviderCondition.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - ---- - -### hashValues - -▸ **hashValues**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValues](conditions.ProviderCondition.md#hashvalues) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L141) - ---- - -### hashValuesPlain - -▸ **hashValuesPlain**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValuesPlain](conditions.ProviderCondition.md#hashvaluesplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L145) - ---- - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :--------- | :------------------- | :------------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[init](conditions.ProviderCondition.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - ---- - -### instance - -▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------ | :-------------------------------------------------------------------------------------------------------- | -| `agreementId` | `string` | -| `params` | [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instance](conditions.ProviderCondition.md#instance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:184](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L184) - ---- - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementId`, `ctx`, ...`args`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------ | :------------------------------------------------------------------------------- | -| `agreementId` | `string` | -| `ctx` | `NFT721LockConditionContext` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instanceFromDDO](conditions.ProviderCondition.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L154) - ---- - -### params - -▸ **params**(`did`, `lockAddress`, `amount`, `nftContractAddress`): [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -Generates the hash of condition inputs. - -#### Parameters - -| Name | Type | Description | -| :------------------- | :------- | :----------------------------------------------- | -| `did` | `string` | The DID of the asset with NFTs attached to lock. | -| `lockAddress` | `string` | the address to lock the NFT to (vault address) | -| `amount` | `number` | The amount of locked tokens. | -| `nftContractAddress` | `string` | The NFT721 contract address | - -#### Returns - -[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -Hash of all the values. - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[params](conditions.ProviderCondition.md#params) - -#### Defined in - -[src/keeper/contracts/defi/NFT721LockCondition.ts:39](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/NFT721LockCondition.ts#L39) - ---- - -### paramsFromDDO - -▸ **paramsFromDDO**(`__namedParameters`): `Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------------ | :--------------------------- | -| `__namedParameters` | `NFT721LockConditionContext` | - -#### Returns - -`Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[paramsFromDDO](conditions.ProviderCondition.md#paramsfromddo) - -#### Defined in - -[src/keeper/contracts/defi/NFT721LockCondition.ts:53](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/NFT721LockCondition.ts#L53) - ---- - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :------------- | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[send](conditions.ProviderCondition.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - ---- - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :---------------------- | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[sendFrom](conditions.ProviderCondition.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - ---- - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - ---- - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addressesStatic](conditions.ProviderCondition.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - ---- - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSignerStatic](conditions.ProviderCondition.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - ---- - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`NFT721LockCondition`](conditions.NFT721LockCondition.md)\> - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`NFT721LockCondition`](conditions.NFT721LockCondition.md)\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[getInstance](conditions.ProviderCondition.md#getinstance) - -#### Defined in - -[src/keeper/contracts/defi/NFT721LockCondition.ts:20](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/NFT721LockCondition.ts#L20) - ---- - -### 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 - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/api-reference/classes/conditions.NFTAccessCondition.md b/docs/api-reference/classes/conditions.NFTAccessCondition.md deleted file mode 100644 index 40e477120..000000000 --- a/docs/api-reference/classes/conditions.NFTAccessCondition.md +++ /dev/null @@ -1,1136 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [conditions](../modules/conditions.md) / NFTAccessCondition - -# Class: NFTAccessCondition - -[conditions](../modules/conditions.md).NFTAccessCondition - -## Hierarchy - -- [`ProviderCondition`](conditions.ProviderCondition.md)<`NFTAccessConditionContext`\> - - ↳ **`NFTAccessCondition`** - -## Table of contents - -### Constructors - -- [constructor](conditions.NFTAccessCondition.md#constructor) - -### Properties - -- [contract](conditions.NFTAccessCondition.md#contract) -- [contractName](conditions.NFTAccessCondition.md#contractname) -- [events](conditions.NFTAccessCondition.md#events) -- [version](conditions.NFTAccessCondition.md#version) - -### Accessors - -- [address](conditions.NFTAccessCondition.md#address) -- [artifactsFolder](conditions.NFTAccessCondition.md#artifactsfolder) -- [config](conditions.NFTAccessCondition.md#config) -- [instanceConfig](conditions.NFTAccessCondition.md#instanceconfig) -- [instantiableConfig](conditions.NFTAccessCondition.md#instantiableconfig) -- [logger](conditions.NFTAccessCondition.md#logger) -- [nevermined](conditions.NFTAccessCondition.md#nevermined) -- [web3](conditions.NFTAccessCondition.md#web3) - -### Methods - -- [abortByTimeOut](conditions.NFTAccessCondition.md#abortbytimeout) -- [addresses](conditions.NFTAccessCondition.md#addresses) -- [call](conditions.NFTAccessCondition.md#call) -- [checkExists](conditions.NFTAccessCondition.md#checkexists) -- [checkPermissions](conditions.NFTAccessCondition.md#checkpermissions) -- [findSigner](conditions.NFTAccessCondition.md#findsigner) -- [fulfill](conditions.NFTAccessCondition.md#fulfill) -- [fulfillGateway](conditions.NFTAccessCondition.md#fulfillgateway) -- [fulfillInstance](conditions.NFTAccessCondition.md#fulfillinstance) -- [fulfillPlain](conditions.NFTAccessCondition.md#fulfillplain) -- [gatewayMethod](conditions.NFTAccessCondition.md#gatewaymethod) -- [generateId](conditions.NFTAccessCondition.md#generateid) -- [generateIdHash](conditions.NFTAccessCondition.md#generateidhash) -- [generateIdWithSeed](conditions.NFTAccessCondition.md#generateidwithseed) -- [getAddress](conditions.NFTAccessCondition.md#getaddress) -- [getConditionFulfilledEvent](conditions.NFTAccessCondition.md#getconditionfulfilledevent) -- [getContract](conditions.NFTAccessCondition.md#getcontract) -- [getFromAddress](conditions.NFTAccessCondition.md#getfromaddress) -- [getInputsOfMethod](conditions.NFTAccessCondition.md#getinputsofmethod) -- [getSignatureOfMethod](conditions.NFTAccessCondition.md#getsignatureofmethod) -- [hashValues](conditions.NFTAccessCondition.md#hashvalues) -- [hashValuesPlain](conditions.NFTAccessCondition.md#hashvaluesplain) -- [init](conditions.NFTAccessCondition.md#init) -- [instance](conditions.NFTAccessCondition.md#instance) -- [instanceFromDDO](conditions.NFTAccessCondition.md#instancefromddo) -- [params](conditions.NFTAccessCondition.md#params) -- [paramsFromDDO](conditions.NFTAccessCondition.md#paramsfromddo) -- [send](conditions.NFTAccessCondition.md#send) -- [sendFrom](conditions.NFTAccessCondition.md#sendfrom) -- [setInstanceConfig](conditions.NFTAccessCondition.md#setinstanceconfig) -- [addressesStatic](conditions.NFTAccessCondition.md#addressesstatic) -- [findSignerStatic](conditions.NFTAccessCondition.md#findsignerstatic) -- [getInstance](conditions.NFTAccessCondition.md#getinstance) -- [setInstanceConfig](conditions.NFTAccessCondition.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new NFTAccessCondition**(`contractName`) - -#### Parameters - -| Name | Type | -| :------------- | :------- | -| `contractName` | `string` | - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[constructor](conditions.ProviderCondition.md#constructor) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L32) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contract](conditions.ProviderCondition.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - ---- - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contractName](conditions.ProviderCondition.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - ---- - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[events](conditions.ProviderCondition.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - ---- - -### version - -• **version**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[version](conditions.ProviderCondition.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - ---- - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - ---- - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -ProviderCondition.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - ---- - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - ---- - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - ---- - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -ProviderCondition.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - ---- - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -ProviderCondition.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - ---- - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -ProviderCondition.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### abortByTimeOut - -▸ **abortByTimeOut**(`agreementId`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------------ | :---------------------- | -| `agreementId` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[abortByTimeOut](conditions.ProviderCondition.md#abortbytimeout) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L97) - ---- - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addresses](conditions.ProviderCondition.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - ---- - -### 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 - -[ProviderCondition](conditions.ProviderCondition.md).[call](conditions.ProviderCondition.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - ---- - -### 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 - -[ProviderCondition](conditions.ProviderCondition.md).[checkExists](conditions.ProviderCondition.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - ---- - -### checkPermissions - -▸ **checkPermissions**(`grantee`, `did`, `from?`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :-------- | :---------------------- | -| `grantee` | `string` | -| `did` | `string` | -| `from?` | [`Account`](Account.md) | - -#### Returns - -`Promise`<`boolean`\> - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts#L41) - ---- - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSigner](conditions.ProviderCondition.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - ---- - -### fulfill - -▸ **fulfill**(`agreementId`, `did`, `grantee`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------------ | :---------------------- | -| `agreementId` | `string` | -| `did` | `string` | -| `grantee` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[fulfill](conditions.ProviderCondition.md#fulfill) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts#L26) - ---- - -### fulfillGateway - -▸ **fulfillGateway**(`cond`, `additionalParams`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :----------------- | :---------------------------------------------------------------------------------------------------- | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | -| `additionalParams` | `Record`<`string`, `unknown`\> | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillGateway](conditions.ProviderCondition.md#fulfillgateway) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:204](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L204) - ---- - -### fulfillInstance - -▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------------------------------------------------- | :------------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillInstance](conditions.ProviderCondition.md#fulfillinstance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L162) - ---- - -### fulfillPlain - -▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------------ | :------------------------------------------------------------ | :------------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillPlain](conditions.ProviderCondition.md#fulfillplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L69) - ---- - -### gatewayMethod - -▸ **gatewayMethod**(): [`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Returns - -[`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[gatewayMethod](conditions.ProviderCondition.md#gatewaymethod) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:221](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L221) - ---- - -### generateId - -▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateId](conditions.ProviderCondition.md#generateid) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:83](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L83) - ---- - -### generateIdHash - -▸ **generateIdHash**(`agreementId`, ...`values`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `...values` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdHash](conditions.ProviderCondition.md#generateidhash) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L79) - ---- - -### generateIdWithSeed - -▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<[`string`, `string`]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdWithSeed](conditions.ProviderCondition.md#generateidwithseed) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L87) - ---- - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getAddress](conditions.ProviderCondition.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - ---- - -### getConditionFulfilledEvent - -▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getConditionFulfilledEvent](conditions.ProviderCondition.md#getconditionfulfilledevent) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:101](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L101) - ---- - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getContract](conditions.ProviderCondition.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - ---- - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getFromAddress](conditions.ProviderCondition.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - ---- - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :----------- | :------- | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getInputsOfMethod](conditions.ProviderCondition.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - ---- - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :----------- | :------- | :------------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getSignatureOfMethod](conditions.ProviderCondition.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - ---- - -### hashValues - -▸ **hashValues**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValues](conditions.ProviderCondition.md#hashvalues) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L141) - ---- - -### hashValuesPlain - -▸ **hashValuesPlain**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValuesPlain](conditions.ProviderCondition.md#hashvaluesplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L145) - ---- - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :--------- | :------------------- | :------------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[init](conditions.ProviderCondition.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - ---- - -### instance - -▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------ | :-------------------------------------------------------------------------------------------------------- | -| `agreementId` | `string` | -| `params` | [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instance](conditions.ProviderCondition.md#instance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:184](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L184) - ---- - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementId`, `ctx`, ...`args`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------ | :------------------------------------------------------------------------------- | -| `agreementId` | `string` | -| `ctx` | `NFTAccessConditionContext` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instanceFromDDO](conditions.ProviderCondition.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L154) - ---- - -### params - -▸ **params**(`did`, `grantee`): [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -#### Parameters - -| Name | Type | -| :-------- | :------- | -| `did` | `string` | -| `grantee` | `string` | - -#### Returns - -[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[params](conditions.ProviderCondition.md#params) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts:18](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts#L18) - ---- - -### paramsFromDDO - -▸ **paramsFromDDO**(`__namedParameters`): `Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------------ | :-------------------------- | -| `__namedParameters` | `NFTAccessConditionContext` | - -#### Returns - -`Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[paramsFromDDO](conditions.ProviderCondition.md#paramsfromddo) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts:22](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts#L22) - ---- - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :------------- | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[send](conditions.ProviderCondition.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - ---- - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :---------------------- | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[sendFrom](conditions.ProviderCondition.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - ---- - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - ---- - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addressesStatic](conditions.ProviderCondition.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - ---- - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSignerStatic](conditions.ProviderCondition.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - ---- - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`NFTAccessCondition`](conditions.NFTAccessCondition.md)\> - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`NFTAccessCondition`](conditions.NFTAccessCondition.md)\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[getInstance](conditions.ProviderCondition.md#getinstance) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts:12](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/NFTAccessCondition.ts#L12) - ---- - -### 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 - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/api-reference/classes/conditions.NFTHolderCondition.md b/docs/api-reference/classes/conditions.NFTHolderCondition.md deleted file mode 100644 index da6c85997..000000000 --- a/docs/api-reference/classes/conditions.NFTHolderCondition.md +++ /dev/null @@ -1,1127 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [conditions](../modules/conditions.md) / NFTHolderCondition - -# Class: NFTHolderCondition - -[conditions](../modules/conditions.md).NFTHolderCondition - -Allows to fulfill a condition to users holding some amount of NFTs for a specific DID. - -## Hierarchy - -- [`ConsumerCondition`](conditions.ConsumerCondition.md)<`NFTHolderConditionContext`\> - - ↳ **`NFTHolderCondition`** - -## Table of contents - -### Constructors - -- [constructor](conditions.NFTHolderCondition.md#constructor) - -### Properties - -- [contract](conditions.NFTHolderCondition.md#contract) -- [contractName](conditions.NFTHolderCondition.md#contractname) -- [events](conditions.NFTHolderCondition.md#events) -- [version](conditions.NFTHolderCondition.md#version) - -### Accessors - -- [address](conditions.NFTHolderCondition.md#address) -- [artifactsFolder](conditions.NFTHolderCondition.md#artifactsfolder) -- [config](conditions.NFTHolderCondition.md#config) -- [instanceConfig](conditions.NFTHolderCondition.md#instanceconfig) -- [instantiableConfig](conditions.NFTHolderCondition.md#instantiableconfig) -- [logger](conditions.NFTHolderCondition.md#logger) -- [nevermined](conditions.NFTHolderCondition.md#nevermined) -- [web3](conditions.NFTHolderCondition.md#web3) - -### Methods - -- [abortByTimeOut](conditions.NFTHolderCondition.md#abortbytimeout) -- [addresses](conditions.NFTHolderCondition.md#addresses) -- [amountFromService](conditions.NFTHolderCondition.md#amountfromservice) -- [call](conditions.NFTHolderCondition.md#call) -- [checkExists](conditions.NFTHolderCondition.md#checkexists) -- [findSigner](conditions.NFTHolderCondition.md#findsigner) -- [fulfill](conditions.NFTHolderCondition.md#fulfill) -- [fulfillGateway](conditions.NFTHolderCondition.md#fulfillgateway) -- [fulfillInstance](conditions.NFTHolderCondition.md#fulfillinstance) -- [fulfillPlain](conditions.NFTHolderCondition.md#fulfillplain) -- [generateId](conditions.NFTHolderCondition.md#generateid) -- [generateIdHash](conditions.NFTHolderCondition.md#generateidhash) -- [generateIdWithSeed](conditions.NFTHolderCondition.md#generateidwithseed) -- [getAddress](conditions.NFTHolderCondition.md#getaddress) -- [getConditionFulfilledEvent](conditions.NFTHolderCondition.md#getconditionfulfilledevent) -- [getContract](conditions.NFTHolderCondition.md#getcontract) -- [getFromAddress](conditions.NFTHolderCondition.md#getfromaddress) -- [getInputsOfMethod](conditions.NFTHolderCondition.md#getinputsofmethod) -- [getSignatureOfMethod](conditions.NFTHolderCondition.md#getsignatureofmethod) -- [hashValues](conditions.NFTHolderCondition.md#hashvalues) -- [hashValuesPlain](conditions.NFTHolderCondition.md#hashvaluesplain) -- [init](conditions.NFTHolderCondition.md#init) -- [instance](conditions.NFTHolderCondition.md#instance) -- [instanceFromDDO](conditions.NFTHolderCondition.md#instancefromddo) -- [params](conditions.NFTHolderCondition.md#params) -- [paramsFromDDO](conditions.NFTHolderCondition.md#paramsfromddo) -- [send](conditions.NFTHolderCondition.md#send) -- [sendFrom](conditions.NFTHolderCondition.md#sendfrom) -- [setInstanceConfig](conditions.NFTHolderCondition.md#setinstanceconfig) -- [addressesStatic](conditions.NFTHolderCondition.md#addressesstatic) -- [findSignerStatic](conditions.NFTHolderCondition.md#findsignerstatic) -- [getInstance](conditions.NFTHolderCondition.md#getinstance) -- [setInstanceConfig](conditions.NFTHolderCondition.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new NFTHolderCondition**(`contractName`) - -#### Parameters - -| Name | Type | -| :------------- | :------- | -| `contractName` | `string` | - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[constructor](conditions.ConsumerCondition.md#constructor) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L32) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[contract](conditions.ConsumerCondition.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - ---- - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[contractName](conditions.ConsumerCondition.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - ---- - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[events](conditions.ConsumerCondition.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - ---- - -### version - -• **version**: `string` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[version](conditions.ConsumerCondition.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ConsumerCondition.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - ---- - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ConsumerCondition.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - ---- - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -ConsumerCondition.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - ---- - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ConsumerCondition.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - ---- - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ConsumerCondition.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - ---- - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -ConsumerCondition.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - ---- - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -ConsumerCondition.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - ---- - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -ConsumerCondition.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### abortByTimeOut - -▸ **abortByTimeOut**(`agreementId`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------------ | :---------------------- | -| `agreementId` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[abortByTimeOut](conditions.ConsumerCondition.md#abortbytimeout) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L97) - ---- - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[addresses](conditions.ConsumerCondition.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - ---- - -### amountFromService - -▸ **amountFromService**(`service`): `default` - -#### Parameters - -| Name | Type | -| :-------- | :-------------- | -| `service` | `ServiceCommon` | - -#### Returns - -`default` - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts:36](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts#L36) - ---- - -### 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 - -[ConsumerCondition](conditions.ConsumerCondition.md).[call](conditions.ConsumerCondition.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - ---- - -### 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 - -[ConsumerCondition](conditions.ConsumerCondition.md).[checkExists](conditions.ConsumerCondition.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - ---- - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[findSigner](conditions.ConsumerCondition.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - ---- - -### fulfill - -▸ **fulfill**(`agreementId`, `did`, `holderAddress`, `amount`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -Fulfill requires a validation that holder as enough NFTs for a specific DID. - -#### Parameters - -| Name | Type | Description | -| :-------------- | :---------------------- | :----------------------------------------------- | -| `agreementId` | `string` | SEA agreement identifier. | -| `did` | `string` | The Decentralized Identifier of the asset. | -| `holderAddress` | `string` | The contract address where the reward is locked. | -| `amount` | `default` | The amount of NFT to be hold | -| `from?` | [`Account`](Account.md) | | -| `params?` | `TxParameters` | - | - -#### Returns - -`Promise`<`ContractReceipt`\> - -condition state - -#### Overrides - -[ConsumerCondition](conditions.ConsumerCondition.md).[fulfill](conditions.ConsumerCondition.md#fulfill) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts:62](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts#L62) - ---- - -### fulfillGateway - -▸ **fulfillGateway**(`_cond`, `_additionalParams`, `_from?`, `_params?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------------------ | :---------------------------------------------------------------------------------------------------- | -| `_cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | -| `_additionalParams` | `Record`<`string`, `unknown`\> | -| `_from?` | [`Account`](Account.md) | -| `_params?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[fulfillGateway](conditions.ConsumerCondition.md#fulfillgateway) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:230](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L230) - ---- - -### fulfillInstance - -▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------------------------------------------------- | :------------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[fulfillInstance](conditions.ConsumerCondition.md#fulfillinstance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L162) - ---- - -### fulfillPlain - -▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------------ | :------------------------------------------------------------ | :------------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[fulfillPlain](conditions.ConsumerCondition.md#fulfillplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L69) - ---- - -### generateId - -▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[generateId](conditions.ConsumerCondition.md#generateid) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:83](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L83) - ---- - -### generateIdHash - -▸ **generateIdHash**(`agreementId`, ...`values`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `...values` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[generateIdHash](conditions.ConsumerCondition.md#generateidhash) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L79) - ---- - -### generateIdWithSeed - -▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<[`string`, `string`]\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[generateIdWithSeed](conditions.ConsumerCondition.md#generateidwithseed) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L87) - ---- - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getAddress](conditions.ConsumerCondition.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - ---- - -### getConditionFulfilledEvent - -▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getConditionFulfilledEvent](conditions.ConsumerCondition.md#getconditionfulfilledevent) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:101](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L101) - ---- - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getContract](conditions.ConsumerCondition.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - ---- - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getFromAddress](conditions.ConsumerCondition.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - ---- - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :----------- | :------- | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getInputsOfMethod](conditions.ConsumerCondition.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - ---- - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :----------- | :------- | :------------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getSignatureOfMethod](conditions.ConsumerCondition.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - ---- - -### hashValues - -▸ **hashValues**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[hashValues](conditions.ConsumerCondition.md#hashvalues) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L141) - ---- - -### hashValuesPlain - -▸ **hashValuesPlain**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[hashValuesPlain](conditions.ConsumerCondition.md#hashvaluesplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L145) - ---- - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :--------- | :------------------- | :------------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[init](conditions.ConsumerCondition.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - ---- - -### instance - -▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------ | :-------------------------------------------------------------------------------------------------------- | -| `agreementId` | `string` | -| `params` | [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[instance](conditions.ConsumerCondition.md#instance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:184](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L184) - ---- - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementId`, `ctx`, ...`args`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------ | :------------------------------------------------------------------------------- | -| `agreementId` | `string` | -| `ctx` | `NFTHolderConditionContext` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[instanceFromDDO](conditions.ConsumerCondition.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L154) - ---- - -### params - -▸ **params**(`did`, `holderAddress`, `amount?`): [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -Generate the hash of condition inputs with the following parameters. - -#### Parameters - -| Name | Type | Description | -| :-------------- | :-------- | :---------------------------------------------------- | -| `did` | `string` | The Decentralized Identifier of the asset. | -| `holderAddress` | `string` | The address of the NFT holder . | -| `amount?` | `default` | The amount of NFTs that need to be hold by the holder | - -#### Returns - -[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -hash of all the values - -#### Overrides - -[ConsumerCondition](conditions.ConsumerCondition.md).[params](conditions.ConsumerCondition.md#params) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts#L32) - ---- - -### paramsFromDDO - -▸ **paramsFromDDO**(`__namedParameters`): `Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------------ | :-------------------------- | -| `__namedParameters` | `NFTHolderConditionContext` | - -#### Returns - -`Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Overrides - -[ConsumerCondition](conditions.ConsumerCondition.md).[paramsFromDDO](conditions.ConsumerCondition.md#paramsfromddo) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts:42](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts#L42) - ---- - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :------------- | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[send](conditions.ConsumerCondition.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - ---- - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :---------------------- | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[sendFrom](conditions.ConsumerCondition.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - ---- - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[setInstanceConfig](conditions.ConsumerCondition.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - ---- - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[addressesStatic](conditions.ConsumerCondition.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - ---- - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[findSignerStatic](conditions.ConsumerCondition.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - ---- - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`NFTHolderCondition`](conditions.NFTHolderCondition.md)\> - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`NFTHolderCondition`](conditions.NFTHolderCondition.md)\> - -#### Overrides - -[ConsumerCondition](conditions.ConsumerCondition.md).[getInstance](conditions.ConsumerCondition.md#getinstance) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts:18](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/NFTHolderCondition.ts#L18) - ---- - -### 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 - -[ConsumerCondition](conditions.ConsumerCondition.md).[setInstanceConfig](conditions.ConsumerCondition.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/api-reference/classes/conditions.NFTLockCondition.md b/docs/api-reference/classes/conditions.NFTLockCondition.md deleted file mode 100644 index 9d02c1f6c..000000000 --- a/docs/api-reference/classes/conditions.NFTLockCondition.md +++ /dev/null @@ -1,1106 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [conditions](../modules/conditions.md) / NFTLockCondition - -# Class: NFTLockCondition - -[conditions](../modules/conditions.md).NFTLockCondition - -Implementation of the NFT Lock Condition - -## Hierarchy - -- [`ConsumerCondition`](conditions.ConsumerCondition.md)<`NFTLockConditionContext`\> - - ↳ **`NFTLockCondition`** - -## Table of contents - -### Constructors - -- [constructor](conditions.NFTLockCondition.md#constructor) - -### Properties - -- [contract](conditions.NFTLockCondition.md#contract) -- [contractName](conditions.NFTLockCondition.md#contractname) -- [events](conditions.NFTLockCondition.md#events) -- [version](conditions.NFTLockCondition.md#version) - -### Accessors - -- [address](conditions.NFTLockCondition.md#address) -- [artifactsFolder](conditions.NFTLockCondition.md#artifactsfolder) -- [config](conditions.NFTLockCondition.md#config) -- [instanceConfig](conditions.NFTLockCondition.md#instanceconfig) -- [instantiableConfig](conditions.NFTLockCondition.md#instantiableconfig) -- [logger](conditions.NFTLockCondition.md#logger) -- [nevermined](conditions.NFTLockCondition.md#nevermined) -- [web3](conditions.NFTLockCondition.md#web3) - -### Methods - -- [abortByTimeOut](conditions.NFTLockCondition.md#abortbytimeout) -- [addresses](conditions.NFTLockCondition.md#addresses) -- [call](conditions.NFTLockCondition.md#call) -- [checkExists](conditions.NFTLockCondition.md#checkexists) -- [findSigner](conditions.NFTLockCondition.md#findsigner) -- [fulfill](conditions.NFTLockCondition.md#fulfill) -- [fulfillGateway](conditions.NFTLockCondition.md#fulfillgateway) -- [fulfillInstance](conditions.NFTLockCondition.md#fulfillinstance) -- [fulfillPlain](conditions.NFTLockCondition.md#fulfillplain) -- [generateId](conditions.NFTLockCondition.md#generateid) -- [generateIdHash](conditions.NFTLockCondition.md#generateidhash) -- [generateIdWithSeed](conditions.NFTLockCondition.md#generateidwithseed) -- [getAddress](conditions.NFTLockCondition.md#getaddress) -- [getConditionFulfilledEvent](conditions.NFTLockCondition.md#getconditionfulfilledevent) -- [getContract](conditions.NFTLockCondition.md#getcontract) -- [getFromAddress](conditions.NFTLockCondition.md#getfromaddress) -- [getInputsOfMethod](conditions.NFTLockCondition.md#getinputsofmethod) -- [getSignatureOfMethod](conditions.NFTLockCondition.md#getsignatureofmethod) -- [hashValues](conditions.NFTLockCondition.md#hashvalues) -- [hashValuesPlain](conditions.NFTLockCondition.md#hashvaluesplain) -- [init](conditions.NFTLockCondition.md#init) -- [instance](conditions.NFTLockCondition.md#instance) -- [instanceFromDDO](conditions.NFTLockCondition.md#instancefromddo) -- [params](conditions.NFTLockCondition.md#params) -- [paramsFromDDO](conditions.NFTLockCondition.md#paramsfromddo) -- [send](conditions.NFTLockCondition.md#send) -- [sendFrom](conditions.NFTLockCondition.md#sendfrom) -- [setInstanceConfig](conditions.NFTLockCondition.md#setinstanceconfig) -- [addressesStatic](conditions.NFTLockCondition.md#addressesstatic) -- [findSignerStatic](conditions.NFTLockCondition.md#findsignerstatic) -- [getInstance](conditions.NFTLockCondition.md#getinstance) -- [setInstanceConfig](conditions.NFTLockCondition.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new NFTLockCondition**(`contractName`) - -#### Parameters - -| Name | Type | -| :------------- | :------- | -| `contractName` | `string` | - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[constructor](conditions.ConsumerCondition.md#constructor) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L32) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[contract](conditions.ConsumerCondition.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - ---- - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[contractName](conditions.ConsumerCondition.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - ---- - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[events](conditions.ConsumerCondition.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - ---- - -### version - -• **version**: `string` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[version](conditions.ConsumerCondition.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ConsumerCondition.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - ---- - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ConsumerCondition.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - ---- - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -ConsumerCondition.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - ---- - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ConsumerCondition.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - ---- - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ConsumerCondition.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - ---- - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -ConsumerCondition.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - ---- - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -ConsumerCondition.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - ---- - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -ConsumerCondition.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### abortByTimeOut - -▸ **abortByTimeOut**(`agreementId`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------------ | :---------------------- | -| `agreementId` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[abortByTimeOut](conditions.ConsumerCondition.md#abortbytimeout) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L97) - ---- - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[addresses](conditions.ConsumerCondition.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - ---- - -### 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 - -[ConsumerCondition](conditions.ConsumerCondition.md).[call](conditions.ConsumerCondition.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - ---- - -### 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 - -[ConsumerCondition](conditions.ConsumerCondition.md).[checkExists](conditions.ConsumerCondition.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - ---- - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[findSigner](conditions.ConsumerCondition.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - ---- - -### fulfill - -▸ **fulfill**(`agreementId`, `did`, `rewardAddress`, `amount`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -Fulfill requires valid NFT transfer in order to lock the amount of DID NFTs based on SEA. - -#### Parameters - -| Name | Type | Description | -| :-------------- | :---------------------- | :----------------------------------------------- | -| `agreementId` | `string` | SEA agreement identifier. | -| `did` | `string` | Asset Decentralized identifier. | -| `rewardAddress` | `string` | The contract address where the reward is locked. | -| `amount` | `default` | The amount of tokens to be transferred. | -| `from?` | [`Account`](Account.md) | | -| `params?` | `TxParameters` | - | - -#### Returns - -`Promise`<`ContractReceipt`\> - -Condition state. - -#### Overrides - -[ConsumerCondition](conditions.ConsumerCondition.md).[fulfill](conditions.ConsumerCondition.md#fulfill) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/NFTLockCondition.ts:47](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/NFTLockCondition.ts#L47) - ---- - -### fulfillGateway - -▸ **fulfillGateway**(`_cond`, `_additionalParams`, `_from?`, `_params?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------------------ | :---------------------------------------------------------------------------------------------------- | -| `_cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | -| `_additionalParams` | `Record`<`string`, `unknown`\> | -| `_from?` | [`Account`](Account.md) | -| `_params?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[fulfillGateway](conditions.ConsumerCondition.md#fulfillgateway) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:230](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L230) - ---- - -### fulfillInstance - -▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------------------------------------------------- | :------------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[fulfillInstance](conditions.ConsumerCondition.md#fulfillinstance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L162) - ---- - -### fulfillPlain - -▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------------ | :------------------------------------------------------------ | :------------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[fulfillPlain](conditions.ConsumerCondition.md#fulfillplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L69) - ---- - -### generateId - -▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[generateId](conditions.ConsumerCondition.md#generateid) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:83](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L83) - ---- - -### generateIdHash - -▸ **generateIdHash**(`agreementId`, ...`values`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `...values` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[generateIdHash](conditions.ConsumerCondition.md#generateidhash) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L79) - ---- - -### generateIdWithSeed - -▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<[`string`, `string`]\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[generateIdWithSeed](conditions.ConsumerCondition.md#generateidwithseed) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L87) - ---- - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getAddress](conditions.ConsumerCondition.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - ---- - -### getConditionFulfilledEvent - -▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getConditionFulfilledEvent](conditions.ConsumerCondition.md#getconditionfulfilledevent) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:101](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L101) - ---- - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getContract](conditions.ConsumerCondition.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - ---- - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getFromAddress](conditions.ConsumerCondition.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - ---- - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :----------- | :------- | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getInputsOfMethod](conditions.ConsumerCondition.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - ---- - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :----------- | :------- | :------------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[getSignatureOfMethod](conditions.ConsumerCondition.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - ---- - -### hashValues - -▸ **hashValues**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[hashValues](conditions.ConsumerCondition.md#hashvalues) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L141) - ---- - -### hashValuesPlain - -▸ **hashValuesPlain**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[hashValuesPlain](conditions.ConsumerCondition.md#hashvaluesplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L145) - ---- - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :--------- | :------------------- | :------------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[init](conditions.ConsumerCondition.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - ---- - -### instance - -▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------ | :-------------------------------------------------------------------------------------------------------- | -| `agreementId` | `string` | -| `params` | [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[instance](conditions.ConsumerCondition.md#instance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:184](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L184) - ---- - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementId`, `ctx`, ...`args`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------ | :------------------------------------------------------------------------------- | -| `agreementId` | `string` | -| `ctx` | `NFTLockConditionContext` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[instanceFromDDO](conditions.ConsumerCondition.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L154) - ---- - -### params - -▸ **params**(`did`, `rewardAddress`, `amount`): [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -Generates the hash of condition inputs. - -#### Parameters - -| Name | Type | Description | -| :-------------- | :------- | :----------------------------------------------- | -| `did` | `string` | The DID of the asset with NFTs attached to lock. | -| `rewardAddress` | `string` | The final address to receive the NFTs. | -| `amount` | `number` | The amount of locked tokens. | - -#### Returns - -[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -Hash of all the values. - -#### Overrides - -[ConsumerCondition](conditions.ConsumerCondition.md).[params](conditions.ConsumerCondition.md#params) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/NFTLockCondition.ts:30](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/NFTLockCondition.ts#L30) - ---- - -### paramsFromDDO - -▸ **paramsFromDDO**(`__namedParameters`): `Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------------ | :------------------------ | -| `__namedParameters` | `NFTLockConditionContext` | - -#### Returns - -`Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Overrides - -[ConsumerCondition](conditions.ConsumerCondition.md).[paramsFromDDO](conditions.ConsumerCondition.md#paramsfromddo) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/NFTLockCondition.ts:34](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/NFTLockCondition.ts#L34) - ---- - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :------------- | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[send](conditions.ConsumerCondition.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - ---- - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :---------------------- | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[sendFrom](conditions.ConsumerCondition.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - ---- - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[setInstanceConfig](conditions.ConsumerCondition.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - ---- - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[addressesStatic](conditions.ConsumerCondition.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - ---- - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ConsumerCondition](conditions.ConsumerCondition.md).[findSignerStatic](conditions.ConsumerCondition.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - ---- - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`NFTLockCondition`](conditions.NFTLockCondition.md)\> - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`NFTLockCondition`](conditions.NFTLockCondition.md)\> - -#### Overrides - -[ConsumerCondition](conditions.ConsumerCondition.md).[getInstance](conditions.ConsumerCondition.md#getinstance) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/NFTLockCondition.ts:17](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/NFTLockCondition.ts#L17) - ---- - -### 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 - -[ConsumerCondition](conditions.ConsumerCondition.md).[setInstanceConfig](conditions.ConsumerCondition.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/api-reference/classes/conditions.ProviderCondition.md b/docs/api-reference/classes/conditions.ProviderCondition.md deleted file mode 100644 index 693354a98..000000000 --- a/docs/api-reference/classes/conditions.ProviderCondition.md +++ /dev/null @@ -1,1156 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [conditions](../modules/conditions.md) / ProviderCondition - -# Class: ProviderCondition - -[conditions](../modules/conditions.md).ProviderCondition - -## Type parameters - -| Name | Type | -| :------ | :------------------------------------------------------------------------- | -| `Ctx` | extends [`ConditionContext`](../interfaces/conditions.ConditionContext.md) | -| `Extra` | `Record`<`string`, `unknown`\> | - -## Hierarchy - -- [`Condition`](Condition.md)<`Ctx`, `Extra`\> - - ↳ **`ProviderCondition`** - - ↳↳ [`AccessCondition`](conditions.AccessCondition.md) - - ↳↳ [`EscrowPaymentCondition`](conditions.EscrowPaymentCondition.md) - - ↳↳ [`ComputeExecutionCondition`](conditions.ComputeExecutionCondition.md) - - ↳↳ [`NFTAccessCondition`](conditions.NFTAccessCondition.md) - - ↳↳ [`TransferNFTCondition`](conditions.TransferNFTCondition.md) - - ↳↳ [`TransferNFT721Condition`](conditions.TransferNFT721Condition.md) - - ↳↳ [`TransferDIDOwnershipCondition`](conditions.TransferDIDOwnershipCondition.md) - - ↳↳ [`AaveBorrowCondition`](conditions.AaveBorrowCondition.md) - - ↳↳ [`AaveCollateralDepositCondition`](conditions.AaveCollateralDepositCondition.md) - - ↳↳ [`AaveCollateralWithdrawCondition`](conditions.AaveCollateralWithdrawCondition.md) - - ↳↳ [`AaveRepayCondition`](conditions.AaveRepayCondition.md) - - ↳↳ [`NFT721LockCondition`](conditions.NFT721LockCondition.md) - - ↳↳ [`DistributeNFTCollateralCondition`](conditions.DistributeNFTCollateralCondition.md) - -## Table of contents - -### Constructors - -- [constructor](conditions.ProviderCondition.md#constructor) - -### Properties - -- [contract](conditions.ProviderCondition.md#contract) -- [contractName](conditions.ProviderCondition.md#contractname) -- [events](conditions.ProviderCondition.md#events) -- [version](conditions.ProviderCondition.md#version) - -### Accessors - -- [address](conditions.ProviderCondition.md#address) -- [artifactsFolder](conditions.ProviderCondition.md#artifactsfolder) -- [config](conditions.ProviderCondition.md#config) -- [instanceConfig](conditions.ProviderCondition.md#instanceconfig) -- [instantiableConfig](conditions.ProviderCondition.md#instantiableconfig) -- [logger](conditions.ProviderCondition.md#logger) -- [nevermined](conditions.ProviderCondition.md#nevermined) -- [web3](conditions.ProviderCondition.md#web3) - -### Methods - -- [abortByTimeOut](conditions.ProviderCondition.md#abortbytimeout) -- [addresses](conditions.ProviderCondition.md#addresses) -- [call](conditions.ProviderCondition.md#call) -- [checkExists](conditions.ProviderCondition.md#checkexists) -- [findSigner](conditions.ProviderCondition.md#findsigner) -- [fulfill](conditions.ProviderCondition.md#fulfill) -- [fulfillGateway](conditions.ProviderCondition.md#fulfillgateway) -- [fulfillInstance](conditions.ProviderCondition.md#fulfillinstance) -- [fulfillPlain](conditions.ProviderCondition.md#fulfillplain) -- [gatewayMethod](conditions.ProviderCondition.md#gatewaymethod) -- [generateId](conditions.ProviderCondition.md#generateid) -- [generateIdHash](conditions.ProviderCondition.md#generateidhash) -- [generateIdWithSeed](conditions.ProviderCondition.md#generateidwithseed) -- [getAddress](conditions.ProviderCondition.md#getaddress) -- [getConditionFulfilledEvent](conditions.ProviderCondition.md#getconditionfulfilledevent) -- [getContract](conditions.ProviderCondition.md#getcontract) -- [getFromAddress](conditions.ProviderCondition.md#getfromaddress) -- [getInputsOfMethod](conditions.ProviderCondition.md#getinputsofmethod) -- [getSignatureOfMethod](conditions.ProviderCondition.md#getsignatureofmethod) -- [hashValues](conditions.ProviderCondition.md#hashvalues) -- [hashValuesPlain](conditions.ProviderCondition.md#hashvaluesplain) -- [init](conditions.ProviderCondition.md#init) -- [instance](conditions.ProviderCondition.md#instance) -- [instanceFromDDO](conditions.ProviderCondition.md#instancefromddo) -- [params](conditions.ProviderCondition.md#params) -- [paramsFromDDO](conditions.ProviderCondition.md#paramsfromddo) -- [send](conditions.ProviderCondition.md#send) -- [sendFrom](conditions.ProviderCondition.md#sendfrom) -- [setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig) -- [addressesStatic](conditions.ProviderCondition.md#addressesstatic) -- [findSignerStatic](conditions.ProviderCondition.md#findsignerstatic) -- [getInstance](conditions.ProviderCondition.md#getinstance) -- [setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new ProviderCondition**<`Ctx`, `Extra`\>(`contractName`) - -#### Type parameters - -| Name | Type | -| :------ | :------------------------------------------------------------------------- | -| `Ctx` | extends [`ConditionContext`](../interfaces/conditions.ConditionContext.md) | -| `Extra` | `Record`<`string`, `unknown`\> | - -#### Parameters - -| Name | Type | -| :------------- | :------- | -| `contractName` | `string` | - -#### Inherited from - -[Condition](Condition.md).[constructor](Condition.md#constructor) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L32) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[Condition](Condition.md).[contract](Condition.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - ---- - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[Condition](Condition.md).[contractName](Condition.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - ---- - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[Condition](Condition.md).[events](Condition.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - ---- - -### version - -• **version**: `string` - -#### Inherited from - -[Condition](Condition.md).[version](Condition.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -Condition.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - ---- - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -Condition.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - ---- - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -Condition.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - ---- - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -Condition.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - ---- - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -Condition.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - ---- - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -Condition.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - ---- - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -Condition.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - ---- - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -Condition.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### abortByTimeOut - -▸ **abortByTimeOut**(`agreementId`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------------ | :---------------------- | -| `agreementId` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[Condition](Condition.md).[abortByTimeOut](Condition.md#abortbytimeout) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L97) - ---- - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[Condition](Condition.md).[addresses](Condition.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - ---- - -### 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 - -[Condition](Condition.md).[call](Condition.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - ---- - -### 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 - -[Condition](Condition.md).[checkExists](Condition.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - ---- - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[Condition](Condition.md).[findSigner](Condition.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - ---- - -### fulfill - -▸ `Abstract` **fulfill**(`agreementId`, ...`args`): `any` - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `...args` | `any`[] | - -#### Returns - -`any` - -#### Inherited from - -[Condition](Condition.md).[fulfill](Condition.md#fulfill) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:67](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L67) - ---- - -### fulfillGateway - -▸ **fulfillGateway**(`cond`, `additionalParams`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :----------------- | :----------------------------------------------------------------------------- | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Extra`\> | -| `additionalParams` | `Extra` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Overrides - -[Condition](Condition.md).[fulfillGateway](Condition.md#fulfillgateway) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:204](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L204) - ---- - -### fulfillInstance - -▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :----------------- | :----------------------------------------------------------------------------- | :------------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Extra`\> | `undefined` | -| `additionalParams` | `Extra` | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[Condition](Condition.md).[fulfillInstance](Condition.md#fulfillinstance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L162) - ---- - -### fulfillPlain - -▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------------ | :------------------------------------------------------------ | :------------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[Condition](Condition.md).[fulfillPlain](Condition.md#fulfillplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L69) - ---- - -### gatewayMethod - -▸ **gatewayMethod**(): [`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Returns - -[`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:221](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L221) - ---- - -### generateId - -▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[Condition](Condition.md).[generateId](Condition.md#generateid) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:83](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L83) - ---- - -### generateIdHash - -▸ **generateIdHash**(`agreementId`, ...`values`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `...values` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[Condition](Condition.md).[generateIdHash](Condition.md#generateidhash) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L79) - ---- - -### generateIdWithSeed - -▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<[`string`, `string`]\> - -#### Inherited from - -[Condition](Condition.md).[generateIdWithSeed](Condition.md#generateidwithseed) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L87) - ---- - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[Condition](Condition.md).[getAddress](Condition.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - ---- - -### getConditionFulfilledEvent - -▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Inherited from - -[Condition](Condition.md).[getConditionFulfilledEvent](Condition.md#getconditionfulfilledevent) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:101](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L101) - ---- - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[Condition](Condition.md).[getContract](Condition.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - ---- - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[Condition](Condition.md).[getFromAddress](Condition.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - ---- - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :----------- | :------- | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[Condition](Condition.md).[getInputsOfMethod](Condition.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - ---- - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :----------- | :------- | :------------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[Condition](Condition.md).[getSignatureOfMethod](Condition.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - ---- - -### hashValues - -▸ **hashValues**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[Condition](Condition.md).[hashValues](Condition.md#hashvalues) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L141) - ---- - -### hashValuesPlain - -▸ **hashValuesPlain**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[Condition](Condition.md).[hashValuesPlain](Condition.md#hashvaluesplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L145) - ---- - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :--------- | :------------------- | :------------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[Condition](Condition.md).[init](Condition.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - ---- - -### instance - -▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Extra`\>\> - -#### Parameters - -| Name | Type | -| :------------ | :--------------------------------------------------------------------------------- | -| `agreementId` | `string` | -| `params` | [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Extra`\> | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Extra`\>\> - -#### Inherited from - -[Condition](Condition.md).[instance](Condition.md#instance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:184](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L184) - ---- - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementId`, `ctx`, ...`args`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Extra`\>\> - -#### Parameters - -| Name | Type | -| :------------ | :------------------------------------------------------------------------------- | -| `agreementId` | `string` | -| `ctx` | `Ctx` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Extra`\>\> - -#### Inherited from - -[Condition](Condition.md).[instanceFromDDO](Condition.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L154) - ---- - -### params - -▸ **params**(...`args`): [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Extra`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Extra`\> - -#### Inherited from - -[Condition](Condition.md).[params](Condition.md#params) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:134](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L134) - ---- - -### paramsFromDDO - -▸ `Abstract` **paramsFromDDO**(`ctx`, ...`args`): `Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Extra`\>\> - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------- | -| `ctx` | `Ctx` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Extra`\>\> - -#### Inherited from - -[Condition](Condition.md).[paramsFromDDO](Condition.md#paramsfromddo) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:149](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L149) - ---- - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :------------- | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[Condition](Condition.md).[send](Condition.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - ---- - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :---------------------- | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[Condition](Condition.md).[sendFrom](Condition.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - ---- - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[Condition](Condition.md).[setInstanceConfig](Condition.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - ---- - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[Condition](Condition.md).[addressesStatic](Condition.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - ---- - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[Condition](Condition.md).[findSignerStatic](Condition.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - ---- - -### getInstance - -▸ `Static` **getInstance**<`Ctx`, `Extra`\>(`config`, `conditionName`, `conditionsClass`, `optional?`): `Promise`<`any`\> - -#### Type parameters - -| Name | Type | -| :------ | :------------------------------------------------------------------------- | -| `Ctx` | extends [`ConditionContext`](../interfaces/conditions.ConditionContext.md) | -| `Extra` | `Extra` | - -#### Parameters - -| Name | Type | Default value | -| :---------------- | :------------------- | :------------ | -| `config` | `InstantiableConfig` | `undefined` | -| `conditionName` | `string` | `undefined` | -| `conditionsClass` | `any` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`any`\> - -#### Inherited from - -[Condition](Condition.md).[getInstance](Condition.md#getinstance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:121](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L121) - ---- - -### 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 - -[Condition](Condition.md).[setInstanceConfig](Condition.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/api-reference/classes/conditions.TransferDIDOwnershipCondition.md b/docs/api-reference/classes/conditions.TransferDIDOwnershipCondition.md deleted file mode 100644 index d65572616..000000000 --- a/docs/api-reference/classes/conditions.TransferDIDOwnershipCondition.md +++ /dev/null @@ -1,1128 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [conditions](../modules/conditions.md) / TransferDIDOwnershipCondition - -# Class: TransferDIDOwnershipCondition - -[conditions](../modules/conditions.md).TransferDIDOwnershipCondition - -Condition allowing to transfer the ownership between the original owner and a receiver. - -## Hierarchy - -- [`ProviderCondition`](conditions.ProviderCondition.md)<`AccessConditionContext`\> - - ↳ **`TransferDIDOwnershipCondition`** - -## Table of contents - -### Constructors - -- [constructor](conditions.TransferDIDOwnershipCondition.md#constructor) - -### Properties - -- [contract](conditions.TransferDIDOwnershipCondition.md#contract) -- [contractName](conditions.TransferDIDOwnershipCondition.md#contractname) -- [events](conditions.TransferDIDOwnershipCondition.md#events) -- [version](conditions.TransferDIDOwnershipCondition.md#version) - -### Accessors - -- [address](conditions.TransferDIDOwnershipCondition.md#address) -- [artifactsFolder](conditions.TransferDIDOwnershipCondition.md#artifactsfolder) -- [config](conditions.TransferDIDOwnershipCondition.md#config) -- [instanceConfig](conditions.TransferDIDOwnershipCondition.md#instanceconfig) -- [instantiableConfig](conditions.TransferDIDOwnershipCondition.md#instantiableconfig) -- [logger](conditions.TransferDIDOwnershipCondition.md#logger) -- [nevermined](conditions.TransferDIDOwnershipCondition.md#nevermined) -- [web3](conditions.TransferDIDOwnershipCondition.md#web3) - -### Methods - -- [abortByTimeOut](conditions.TransferDIDOwnershipCondition.md#abortbytimeout) -- [addresses](conditions.TransferDIDOwnershipCondition.md#addresses) -- [call](conditions.TransferDIDOwnershipCondition.md#call) -- [checkExists](conditions.TransferDIDOwnershipCondition.md#checkexists) -- [findSigner](conditions.TransferDIDOwnershipCondition.md#findsigner) -- [fulfill](conditions.TransferDIDOwnershipCondition.md#fulfill) -- [fulfillGateway](conditions.TransferDIDOwnershipCondition.md#fulfillgateway) -- [fulfillInstance](conditions.TransferDIDOwnershipCondition.md#fulfillinstance) -- [fulfillPlain](conditions.TransferDIDOwnershipCondition.md#fulfillplain) -- [gatewayMethod](conditions.TransferDIDOwnershipCondition.md#gatewaymethod) -- [generateId](conditions.TransferDIDOwnershipCondition.md#generateid) -- [generateIdHash](conditions.TransferDIDOwnershipCondition.md#generateidhash) -- [generateIdWithSeed](conditions.TransferDIDOwnershipCondition.md#generateidwithseed) -- [getAddress](conditions.TransferDIDOwnershipCondition.md#getaddress) -- [getConditionFulfilledEvent](conditions.TransferDIDOwnershipCondition.md#getconditionfulfilledevent) -- [getContract](conditions.TransferDIDOwnershipCondition.md#getcontract) -- [getFromAddress](conditions.TransferDIDOwnershipCondition.md#getfromaddress) -- [getInputsOfMethod](conditions.TransferDIDOwnershipCondition.md#getinputsofmethod) -- [getSignatureOfMethod](conditions.TransferDIDOwnershipCondition.md#getsignatureofmethod) -- [hashValues](conditions.TransferDIDOwnershipCondition.md#hashvalues) -- [hashValuesPlain](conditions.TransferDIDOwnershipCondition.md#hashvaluesplain) -- [init](conditions.TransferDIDOwnershipCondition.md#init) -- [instance](conditions.TransferDIDOwnershipCondition.md#instance) -- [instanceFromDDO](conditions.TransferDIDOwnershipCondition.md#instancefromddo) -- [params](conditions.TransferDIDOwnershipCondition.md#params) -- [paramsFromDDO](conditions.TransferDIDOwnershipCondition.md#paramsfromddo) -- [send](conditions.TransferDIDOwnershipCondition.md#send) -- [sendFrom](conditions.TransferDIDOwnershipCondition.md#sendfrom) -- [setInstanceConfig](conditions.TransferDIDOwnershipCondition.md#setinstanceconfig) -- [addressesStatic](conditions.TransferDIDOwnershipCondition.md#addressesstatic) -- [findSignerStatic](conditions.TransferDIDOwnershipCondition.md#findsignerstatic) -- [getInstance](conditions.TransferDIDOwnershipCondition.md#getinstance) -- [setInstanceConfig](conditions.TransferDIDOwnershipCondition.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new TransferDIDOwnershipCondition**(`contractName`) - -#### Parameters - -| Name | Type | -| :------------- | :------- | -| `contractName` | `string` | - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[constructor](conditions.ProviderCondition.md#constructor) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L32) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contract](conditions.ProviderCondition.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - ---- - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contractName](conditions.ProviderCondition.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - ---- - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[events](conditions.ProviderCondition.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - ---- - -### version - -• **version**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[version](conditions.ProviderCondition.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - ---- - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - ---- - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -ProviderCondition.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - ---- - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - ---- - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - ---- - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -ProviderCondition.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - ---- - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -ProviderCondition.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - ---- - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -ProviderCondition.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### abortByTimeOut - -▸ **abortByTimeOut**(`agreementId`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------------ | :---------------------- | -| `agreementId` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[abortByTimeOut](conditions.ProviderCondition.md#abortbytimeout) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L97) - ---- - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addresses](conditions.ProviderCondition.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - ---- - -### 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 - -[ProviderCondition](conditions.ProviderCondition.md).[call](conditions.ProviderCondition.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - ---- - -### 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 - -[ProviderCondition](conditions.ProviderCondition.md).[checkExists](conditions.ProviderCondition.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - ---- - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSigner](conditions.ProviderCondition.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - ---- - -### fulfill - -▸ **fulfill**(`agreementId`, `did`, `receiver`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -Fulfill the transfer DID ownership condition. - -**`Remarks`** - -Only DID owner or DID provider can call this method. -Fulfill method transfer full ownership permissions to the receiver address. - -#### Parameters - -| Name | Type | Description | -| :------------ | :---------------------- | :----------------------------------------- | -| `agreementId` | `string` | Agreement identifier. | -| `did` | `string` | The Decentralized Identifier of the asset. | -| `receiver` | `string` | The address of the granted user. | -| `from?` | [`Account`](Account.md) | | -| `params?` | `TxParameters` | - | - -#### Returns - -`Promise`<`ContractReceipt`\> - -Condition state. - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[fulfill](conditions.ProviderCondition.md#fulfill) - -#### Defined in - -[src/keeper/contracts/conditions/TransferDIDOwnershipCondition.ts:52](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/TransferDIDOwnershipCondition.ts#L52) - ---- - -### fulfillGateway - -▸ **fulfillGateway**(`cond`, `additionalParams`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :----------------- | :---------------------------------------------------------------------------------------------------- | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | -| `additionalParams` | `Record`<`string`, `unknown`\> | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillGateway](conditions.ProviderCondition.md#fulfillgateway) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:204](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L204) - ---- - -### fulfillInstance - -▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------------------------------------------------- | :------------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillInstance](conditions.ProviderCondition.md#fulfillinstance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L162) - ---- - -### fulfillPlain - -▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------------ | :------------------------------------------------------------ | :------------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillPlain](conditions.ProviderCondition.md#fulfillplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L69) - ---- - -### gatewayMethod - -▸ **gatewayMethod**(): [`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Returns - -[`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[gatewayMethod](conditions.ProviderCondition.md#gatewaymethod) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:221](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L221) - ---- - -### generateId - -▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateId](conditions.ProviderCondition.md#generateid) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:83](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L83) - ---- - -### generateIdHash - -▸ **generateIdHash**(`agreementId`, ...`values`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `...values` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdHash](conditions.ProviderCondition.md#generateidhash) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L79) - ---- - -### generateIdWithSeed - -▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<[`string`, `string`]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdWithSeed](conditions.ProviderCondition.md#generateidwithseed) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L87) - ---- - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getAddress](conditions.ProviderCondition.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - ---- - -### getConditionFulfilledEvent - -▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getConditionFulfilledEvent](conditions.ProviderCondition.md#getconditionfulfilledevent) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:101](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L101) - ---- - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getContract](conditions.ProviderCondition.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - ---- - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getFromAddress](conditions.ProviderCondition.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - ---- - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :----------- | :------- | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getInputsOfMethod](conditions.ProviderCondition.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - ---- - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :----------- | :------- | :------------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getSignatureOfMethod](conditions.ProviderCondition.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - ---- - -### hashValues - -▸ **hashValues**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValues](conditions.ProviderCondition.md#hashvalues) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L141) - ---- - -### hashValuesPlain - -▸ **hashValuesPlain**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValuesPlain](conditions.ProviderCondition.md#hashvaluesplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L145) - ---- - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :--------- | :------------------- | :------------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[init](conditions.ProviderCondition.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - ---- - -### instance - -▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------ | :-------------------------------------------------------------------------------------------------------- | -| `agreementId` | `string` | -| `params` | [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instance](conditions.ProviderCondition.md#instance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:184](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L184) - ---- - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementId`, `ctx`, ...`args`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------ | :------------------------------------------------------------------------------- | -| `agreementId` | `string` | -| `ctx` | `AccessConditionContext` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instanceFromDDO](conditions.ProviderCondition.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L154) - ---- - -### params - -▸ **params**(`did`, `receiver`): [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -Generates the hash of the condition inputs. - -#### Parameters - -| Name | Type | Description | -| :--------- | :------- | :----------------------------------------------- | -| `did` | `string` | The Decentralized Identifier of the asset. | -| `receiver` | `string` | Address of the granted user or the DID provider. | - -#### Returns - -[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -Hash of all the values. - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[params](conditions.ProviderCondition.md#params) - -#### Defined in - -[src/keeper/contracts/conditions/TransferDIDOwnershipCondition.ts:31](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/TransferDIDOwnershipCondition.ts#L31) - ---- - -### paramsFromDDO - -▸ **paramsFromDDO**(`__namedParameters`): `Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------------ | :----------------------- | -| `__namedParameters` | `AccessConditionContext` | - -#### Returns - -`Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[paramsFromDDO](conditions.ProviderCondition.md#paramsfromddo) - -#### Defined in - -[src/keeper/contracts/conditions/TransferDIDOwnershipCondition.ts:35](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/TransferDIDOwnershipCondition.ts#L35) - ---- - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :------------- | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[send](conditions.ProviderCondition.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - ---- - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :---------------------- | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[sendFrom](conditions.ProviderCondition.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - ---- - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - ---- - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addressesStatic](conditions.ProviderCondition.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - ---- - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSignerStatic](conditions.ProviderCondition.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - ---- - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`TransferDIDOwnershipCondition`](conditions.TransferDIDOwnershipCondition.md)\> - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`TransferDIDOwnershipCondition`](conditions.TransferDIDOwnershipCondition.md)\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[getInstance](conditions.ProviderCondition.md#getinstance) - -#### Defined in - -[src/keeper/contracts/conditions/TransferDIDOwnershipCondition.ts:15](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/TransferDIDOwnershipCondition.ts#L15) - ---- - -### 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 - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/api-reference/classes/conditions.TransferNFT721Condition.md b/docs/api-reference/classes/conditions.TransferNFT721Condition.md deleted file mode 100644 index 82238d072..000000000 --- a/docs/api-reference/classes/conditions.TransferNFT721Condition.md +++ /dev/null @@ -1,1136 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [conditions](../modules/conditions.md) / TransferNFT721Condition - -# Class: TransferNFT721Condition - -[conditions](../modules/conditions.md).TransferNFT721Condition - -Condition allowing to transfer an NFT between the original owner and a receiver - -## Hierarchy - -- [`ProviderCondition`](conditions.ProviderCondition.md)<`TransferNFT721ConditionContext`\> - - ↳ **`TransferNFT721Condition`** - -## Table of contents - -### Constructors - -- [constructor](conditions.TransferNFT721Condition.md#constructor) - -### Properties - -- [contract](conditions.TransferNFT721Condition.md#contract) -- [contractName](conditions.TransferNFT721Condition.md#contractname) -- [events](conditions.TransferNFT721Condition.md#events) -- [version](conditions.TransferNFT721Condition.md#version) - -### Accessors - -- [address](conditions.TransferNFT721Condition.md#address) -- [artifactsFolder](conditions.TransferNFT721Condition.md#artifactsfolder) -- [config](conditions.TransferNFT721Condition.md#config) -- [instanceConfig](conditions.TransferNFT721Condition.md#instanceconfig) -- [instantiableConfig](conditions.TransferNFT721Condition.md#instantiableconfig) -- [logger](conditions.TransferNFT721Condition.md#logger) -- [nevermined](conditions.TransferNFT721Condition.md#nevermined) -- [web3](conditions.TransferNFT721Condition.md#web3) - -### Methods - -- [abortByTimeOut](conditions.TransferNFT721Condition.md#abortbytimeout) -- [addresses](conditions.TransferNFT721Condition.md#addresses) -- [call](conditions.TransferNFT721Condition.md#call) -- [checkExists](conditions.TransferNFT721Condition.md#checkexists) -- [findSigner](conditions.TransferNFT721Condition.md#findsigner) -- [fulfill](conditions.TransferNFT721Condition.md#fulfill) -- [fulfillGateway](conditions.TransferNFT721Condition.md#fulfillgateway) -- [fulfillInstance](conditions.TransferNFT721Condition.md#fulfillinstance) -- [fulfillPlain](conditions.TransferNFT721Condition.md#fulfillplain) -- [gatewayMethod](conditions.TransferNFT721Condition.md#gatewaymethod) -- [generateId](conditions.TransferNFT721Condition.md#generateid) -- [generateIdHash](conditions.TransferNFT721Condition.md#generateidhash) -- [generateIdWithSeed](conditions.TransferNFT721Condition.md#generateidwithseed) -- [getAddress](conditions.TransferNFT721Condition.md#getaddress) -- [getConditionFulfilledEvent](conditions.TransferNFT721Condition.md#getconditionfulfilledevent) -- [getContract](conditions.TransferNFT721Condition.md#getcontract) -- [getFromAddress](conditions.TransferNFT721Condition.md#getfromaddress) -- [getInputsOfMethod](conditions.TransferNFT721Condition.md#getinputsofmethod) -- [getSignatureOfMethod](conditions.TransferNFT721Condition.md#getsignatureofmethod) -- [hashValues](conditions.TransferNFT721Condition.md#hashvalues) -- [hashValuesPlain](conditions.TransferNFT721Condition.md#hashvaluesplain) -- [init](conditions.TransferNFT721Condition.md#init) -- [instance](conditions.TransferNFT721Condition.md#instance) -- [instanceFromDDO](conditions.TransferNFT721Condition.md#instancefromddo) -- [params](conditions.TransferNFT721Condition.md#params) -- [paramsFromDDO](conditions.TransferNFT721Condition.md#paramsfromddo) -- [send](conditions.TransferNFT721Condition.md#send) -- [sendFrom](conditions.TransferNFT721Condition.md#sendfrom) -- [setInstanceConfig](conditions.TransferNFT721Condition.md#setinstanceconfig) -- [addressesStatic](conditions.TransferNFT721Condition.md#addressesstatic) -- [findSignerStatic](conditions.TransferNFT721Condition.md#findsignerstatic) -- [getInstance](conditions.TransferNFT721Condition.md#getinstance) -- [setInstanceConfig](conditions.TransferNFT721Condition.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new TransferNFT721Condition**(`contractName`) - -#### Parameters - -| Name | Type | -| :------------- | :------- | -| `contractName` | `string` | - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[constructor](conditions.ProviderCondition.md#constructor) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L32) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contract](conditions.ProviderCondition.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - ---- - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contractName](conditions.ProviderCondition.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - ---- - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[events](conditions.ProviderCondition.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - ---- - -### version - -• **version**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[version](conditions.ProviderCondition.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - ---- - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - ---- - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -ProviderCondition.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - ---- - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - ---- - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - ---- - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -ProviderCondition.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - ---- - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -ProviderCondition.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - ---- - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -ProviderCondition.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### abortByTimeOut - -▸ **abortByTimeOut**(`agreementId`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------------ | :---------------------- | -| `agreementId` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[abortByTimeOut](conditions.ProviderCondition.md#abortbytimeout) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L97) - ---- - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addresses](conditions.ProviderCondition.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - ---- - -### 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 - -[ProviderCondition](conditions.ProviderCondition.md).[call](conditions.ProviderCondition.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - ---- - -### 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 - -[ProviderCondition](conditions.ProviderCondition.md).[checkExists](conditions.ProviderCondition.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - ---- - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSigner](conditions.ProviderCondition.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - ---- - -### fulfill - -▸ **fulfill**(`agreementId`, `did`, `nftReceiver`, `lockPaymentCondition`, `nftTokenAddress`, `willBeTransferred?`, `from?`, `txParams?`): `Promise`<`ContractReceipt`\> - -Fulfill the transfer NFT condition. - -**`Remarks`** - -Only DID owner or DID provider can call this method. - -#### Parameters - -| Name | Type | Default value | Description | -| :--------------------- | :---------------------- | :------------ | :--------------------------------------------------- | -| `agreementId` | `string` | `undefined` | The agreement identifier. | -| `did` | `string` | `undefined` | The DID of the asset with NFTs. | -| `nftReceiver` | `string` | `undefined` | The address of the account to receive the NFT. | -| `lockPaymentCondition` | `string` | `undefined` | lock payment condition identifier. | -| `nftTokenAddress` | `string` | `undefined` | address of the nft token to use. | -| `willBeTransferred` | `boolean` | `true` | Indicates if the asset will be transferred or minted | -| `from?` | [`Account`](Account.md) | `undefined` | | -| `txParams?` | `TxParameters` | `undefined` | - | - -#### Returns - -`Promise`<`ContractReceipt`\> - -Condition state. - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[fulfill](conditions.ProviderCondition.md#fulfill) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts#L129) - ---- - -### fulfillGateway - -▸ **fulfillGateway**(`cond`, `additionalParams`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :----------------- | :---------------------------------------------------------------------------------------------------- | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | -| `additionalParams` | `Record`<`string`, `unknown`\> | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillGateway](conditions.ProviderCondition.md#fulfillgateway) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:204](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L204) - ---- - -### fulfillInstance - -▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------------------------------------------------- | :------------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillInstance](conditions.ProviderCondition.md#fulfillinstance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L162) - ---- - -### fulfillPlain - -▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------------ | :------------------------------------------------------------ | :------------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillPlain](conditions.ProviderCondition.md#fulfillplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L69) - ---- - -### gatewayMethod - -▸ **gatewayMethod**(): [`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Returns - -[`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[gatewayMethod](conditions.ProviderCondition.md#gatewaymethod) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts:154](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts#L154) - ---- - -### generateId - -▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateId](conditions.ProviderCondition.md#generateid) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:83](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L83) - ---- - -### generateIdHash - -▸ **generateIdHash**(`agreementId`, ...`values`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `...values` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdHash](conditions.ProviderCondition.md#generateidhash) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L79) - ---- - -### generateIdWithSeed - -▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<[`string`, `string`]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdWithSeed](conditions.ProviderCondition.md#generateidwithseed) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L87) - ---- - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getAddress](conditions.ProviderCondition.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - ---- - -### getConditionFulfilledEvent - -▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getConditionFulfilledEvent](conditions.ProviderCondition.md#getconditionfulfilledevent) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:101](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L101) - ---- - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getContract](conditions.ProviderCondition.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - ---- - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getFromAddress](conditions.ProviderCondition.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - ---- - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :----------- | :------- | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getInputsOfMethod](conditions.ProviderCondition.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - ---- - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :----------- | :------- | :------------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getSignatureOfMethod](conditions.ProviderCondition.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - ---- - -### hashValues - -▸ **hashValues**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValues](conditions.ProviderCondition.md#hashvalues) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L141) - ---- - -### hashValuesPlain - -▸ **hashValuesPlain**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValuesPlain](conditions.ProviderCondition.md#hashvaluesplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L145) - ---- - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :--------- | :------------------- | :------------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[init](conditions.ProviderCondition.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - ---- - -### instance - -▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------ | :-------------------------------------------------------------------------------------------------------- | -| `agreementId` | `string` | -| `params` | [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instance](conditions.ProviderCondition.md#instance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:184](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L184) - ---- - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementId`, `ctx`, ...`args`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------ | :------------------------------------------------------------------------------- | -| `agreementId` | `string` | -| `ctx` | `TransferNFT721ConditionContext` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instanceFromDDO](conditions.ProviderCondition.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L154) - ---- - -### params - -▸ **params**(`did`, `nftHolder`, `nftReceiver`, `lockCondition`, `nftTokenAddress`, `willBeTransferred?`, `expiration?`): [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -Generates the hash of condition inputs. - -#### Parameters - -| Name | Type | Default value | Description | -| :------------------ | :-------- | :------------ | :--------------------------------------------------- | -| `did` | `string` | `undefined` | The DID of the asset with NFTs. | -| `nftHolder` | `string` | `undefined` | The address of the Holder of the NFT. | -| `nftReceiver` | `string` | `undefined` | The address of the granted user or the DID provider. | -| `lockCondition` | `string` | `undefined` | Lock condition identifier. | -| `nftTokenAddress` | `string` | `undefined` | The address of the NFT token to use. | -| `willBeTransferred` | `boolean` | `true` | Indicates if the asset will be transferred or minted | -| `expiration` | `number` | `0` | - | - -#### Returns - -[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -Hash of all the values - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[params](conditions.ProviderCondition.md#params) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts:43](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts#L43) - ---- - -### paramsFromDDO - -▸ **paramsFromDDO**(`__namedParameters`, `lockCondition`): `Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------------ | :------------------------------- | -| `__namedParameters` | `TransferNFT721ConditionContext` | -| `lockCondition` | `any` | - -#### Returns - -`Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[paramsFromDDO](conditions.ProviderCondition.md#paramsfromddo) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts:88](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts#L88) - ---- - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :------------- | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[send](conditions.ProviderCondition.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - ---- - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :---------------------- | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[sendFrom](conditions.ProviderCondition.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - ---- - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - ---- - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addressesStatic](conditions.ProviderCondition.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - ---- - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSignerStatic](conditions.ProviderCondition.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - ---- - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`TransferNFT721Condition`](conditions.TransferNFT721Condition.md)\> - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`TransferNFT721Condition`](conditions.TransferNFT721Condition.md)\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[getInstance](conditions.ProviderCondition.md#getinstance) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts:22](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/TransferNFT721Condition.ts#L22) - ---- - -### 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 - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/api-reference/classes/conditions.TransferNFTCondition.md b/docs/api-reference/classes/conditions.TransferNFTCondition.md deleted file mode 100644 index 8a1d0ab76..000000000 --- a/docs/api-reference/classes/conditions.TransferNFTCondition.md +++ /dev/null @@ -1,1172 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [conditions](../modules/conditions.md) / TransferNFTCondition - -# Class: TransferNFTCondition - -[conditions](../modules/conditions.md).TransferNFTCondition - -Condition allowing to transfer an NFT between the original owner and a receiver - -## Hierarchy - -- [`ProviderCondition`](conditions.ProviderCondition.md)<`TransferNFTConditionContext`\> - - ↳ **`TransferNFTCondition`** - -## Table of contents - -### Constructors - -- [constructor](conditions.TransferNFTCondition.md#constructor) - -### Properties - -- [contract](conditions.TransferNFTCondition.md#contract) -- [contractName](conditions.TransferNFTCondition.md#contractname) -- [events](conditions.TransferNFTCondition.md#events) -- [version](conditions.TransferNFTCondition.md#version) - -### Accessors - -- [address](conditions.TransferNFTCondition.md#address) -- [artifactsFolder](conditions.TransferNFTCondition.md#artifactsfolder) -- [config](conditions.TransferNFTCondition.md#config) -- [instanceConfig](conditions.TransferNFTCondition.md#instanceconfig) -- [instantiableConfig](conditions.TransferNFTCondition.md#instantiableconfig) -- [logger](conditions.TransferNFTCondition.md#logger) -- [nevermined](conditions.TransferNFTCondition.md#nevermined) -- [web3](conditions.TransferNFTCondition.md#web3) - -### Methods - -- [abortByTimeOut](conditions.TransferNFTCondition.md#abortbytimeout) -- [addresses](conditions.TransferNFTCondition.md#addresses) -- [call](conditions.TransferNFTCondition.md#call) -- [checkExists](conditions.TransferNFTCondition.md#checkexists) -- [findSigner](conditions.TransferNFTCondition.md#findsigner) -- [fulfill](conditions.TransferNFTCondition.md#fulfill) -- [fulfillForDelegate](conditions.TransferNFTCondition.md#fulfillfordelegate) -- [fulfillGateway](conditions.TransferNFTCondition.md#fulfillgateway) -- [fulfillInstance](conditions.TransferNFTCondition.md#fulfillinstance) -- [fulfillPlain](conditions.TransferNFTCondition.md#fulfillplain) -- [gatewayMethod](conditions.TransferNFTCondition.md#gatewaymethod) -- [generateId](conditions.TransferNFTCondition.md#generateid) -- [generateIdHash](conditions.TransferNFTCondition.md#generateidhash) -- [generateIdWithSeed](conditions.TransferNFTCondition.md#generateidwithseed) -- [getAddress](conditions.TransferNFTCondition.md#getaddress) -- [getConditionFulfilledEvent](conditions.TransferNFTCondition.md#getconditionfulfilledevent) -- [getContract](conditions.TransferNFTCondition.md#getcontract) -- [getFromAddress](conditions.TransferNFTCondition.md#getfromaddress) -- [getInputsOfMethod](conditions.TransferNFTCondition.md#getinputsofmethod) -- [getSignatureOfMethod](conditions.TransferNFTCondition.md#getsignatureofmethod) -- [hashValues](conditions.TransferNFTCondition.md#hashvalues) -- [hashValuesPlain](conditions.TransferNFTCondition.md#hashvaluesplain) -- [init](conditions.TransferNFTCondition.md#init) -- [instance](conditions.TransferNFTCondition.md#instance) -- [instanceFromDDO](conditions.TransferNFTCondition.md#instancefromddo) -- [params](conditions.TransferNFTCondition.md#params) -- [paramsFromDDO](conditions.TransferNFTCondition.md#paramsfromddo) -- [send](conditions.TransferNFTCondition.md#send) -- [sendFrom](conditions.TransferNFTCondition.md#sendfrom) -- [setInstanceConfig](conditions.TransferNFTCondition.md#setinstanceconfig) -- [addressesStatic](conditions.TransferNFTCondition.md#addressesstatic) -- [findSignerStatic](conditions.TransferNFTCondition.md#findsignerstatic) -- [getInstance](conditions.TransferNFTCondition.md#getinstance) -- [setInstanceConfig](conditions.TransferNFTCondition.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• **new TransferNFTCondition**(`contractName`) - -#### Parameters - -| Name | Type | -| :------------- | :------- | -| `contractName` | `string` | - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[constructor](conditions.ProviderCondition.md#constructor) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L32) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contract](conditions.ProviderCondition.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - ---- - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[contractName](conditions.ProviderCondition.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - ---- - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[events](conditions.ProviderCondition.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - ---- - -### version - -• **version**: `string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[version](conditions.ProviderCondition.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - ---- - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -ProviderCondition.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - ---- - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -ProviderCondition.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - ---- - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - ---- - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -ProviderCondition.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - ---- - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -ProviderCondition.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - ---- - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -ProviderCondition.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - ---- - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -ProviderCondition.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### abortByTimeOut - -▸ **abortByTimeOut**(`agreementId`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------------ | :---------------------- | -| `agreementId` | `string` | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[abortByTimeOut](conditions.ProviderCondition.md#abortbytimeout) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L97) - ---- - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addresses](conditions.ProviderCondition.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - ---- - -### 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 - -[ProviderCondition](conditions.ProviderCondition.md).[call](conditions.ProviderCondition.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - ---- - -### 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 - -[ProviderCondition](conditions.ProviderCondition.md).[checkExists](conditions.ProviderCondition.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - ---- - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSigner](conditions.ProviderCondition.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - ---- - -### fulfill - -▸ **fulfill**(`agreementId`, `did`, `nftReceiver`, `nftAmount`, `lockPaymentCondition`, `from?`, `txParams?`): `Promise`<`ContractReceipt`\> - -Fulfill the transfer NFT condition. - -**`Remarks`** - -Only DID owner or DID provider can call this method. - -#### Parameters - -| Name | Type | Description | -| :--------------------- | :---------------------- | :--------------------------------------------- | -| `agreementId` | `string` | The agreement identifier. | -| `did` | `string` | The DID of the asset with NFTs. | -| `nftReceiver` | `string` | The address of the account to receive the NFT. | -| `nftAmount` | `default` | amount of NFTs to transfer. | -| `lockPaymentCondition` | `string` | lock payment condition identifier. | -| `from?` | [`Account`](Account.md) | | -| `txParams?` | `TxParameters` | - | - -#### Returns - -`Promise`<`ContractReceipt`\> - -Condition state. - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[fulfill](conditions.ProviderCondition.md#fulfill) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:124](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts#L124) - ---- - -### fulfillForDelegate - -▸ **fulfillForDelegate**(`agreementId`, `did`, `nftHolder`, `nftReceiver`, `nftAmount`, `lockPaymentCondition`, `transferAsset?`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -Fulfill the transfer NFT condition. - -**`Remarks`** - -Only DID owner or DID provider can call this method. - -#### Parameters - -| Name | Type | Default value | Description | -| :--------------------- | :---------------------- | :------------ | :---------------------------------------------------- | -| `agreementId` | `string` | `undefined` | The agreement identifier. | -| `did` | `string` | `undefined` | The DID of the asset with NFTs. | -| `nftHolder` | `string` | `undefined` | The address of the account currently holding the NFT. | -| `nftReceiver` | `string` | `undefined` | The address of the account to receive the NFT. | -| `nftAmount` | `default` | `undefined` | The amount of NFTs to transfer. | -| `lockPaymentCondition` | `string` | `undefined` | The lock payment condition identifier. | -| `transferAsset` | `boolean` | `true` | - | -| `from?` | [`Account`](Account.md) | `undefined` | | -| `params?` | `TxParameters` | `undefined` | - | - -#### Returns - -`Promise`<`ContractReceipt`\> - -Condition state. - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:156](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts#L156) - ---- - -### fulfillGateway - -▸ **fulfillGateway**(`cond`, `additionalParams`, `from?`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :----------------- | :---------------------------------------------------------------------------------------------------- | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | -| `additionalParams` | `Record`<`string`, `unknown`\> | -| `from?` | [`Account`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillGateway](conditions.ProviderCondition.md#fulfillgateway) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:204](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L204) - ---- - -### fulfillInstance - -▸ **fulfillInstance**(`cond`, `additionalParams`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :----------------- | :---------------------------------------------------------------------------------------------------- | :------------ | -| `cond` | [`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\> | `undefined` | -| `additionalParams` | `Record`<`string`, `unknown`\> | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillInstance](conditions.ProviderCondition.md#fulfillinstance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L162) - ---- - -### fulfillPlain - -▸ **fulfillPlain**(`agreementId`, `args`, `from?`, `params?`, `method?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | Default value | -| :------------ | :------------------------------------------------------------ | :------------ | -| `agreementId` | `string` | `undefined` | -| `args` | `any`[] | `undefined` | -| `from?` | [`Account`](Account.md) | `undefined` | -| `params?` | `TxParameters` | `undefined` | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | `'fulfill'` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[fulfillPlain](conditions.ProviderCondition.md#fulfillplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L69) - ---- - -### gatewayMethod - -▸ **gatewayMethod**(): [`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Returns - -[`ConditionMethod`](../modules/conditions.md#conditionmethod) - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[gatewayMethod](conditions.ProviderCondition.md#gatewaymethod) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:183](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts#L183) - ---- - -### generateId - -▸ **generateId**(`agreementId`, `valueHash`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateId](conditions.ProviderCondition.md#generateid) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:83](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L83) - ---- - -### generateIdHash - -▸ **generateIdHash**(`agreementId`, ...`values`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `...values` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdHash](conditions.ProviderCondition.md#generateidhash) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L79) - ---- - -### generateIdWithSeed - -▸ **generateIdWithSeed**(`agreementId`, `valueHash`): `Promise`<[`string`, `string`]\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `valueHash` | `string` | - -#### Returns - -`Promise`<[`string`, `string`]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[generateIdWithSeed](conditions.ProviderCondition.md#generateidwithseed) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L87) - ---- - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getAddress](conditions.ProviderCondition.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - ---- - -### getConditionFulfilledEvent - -▸ **getConditionFulfilledEvent**(`agreementId`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getConditionFulfilledEvent](conditions.ProviderCondition.md#getconditionfulfilledevent) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:101](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L101) - ---- - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getContract](conditions.ProviderCondition.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - ---- - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getFromAddress](conditions.ProviderCondition.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - ---- - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :----------- | :------- | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getInputsOfMethod](conditions.ProviderCondition.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - ---- - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :----------- | :------- | :------------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[getSignatureOfMethod](conditions.ProviderCondition.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - ---- - -### hashValues - -▸ **hashValues**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValues](conditions.ProviderCondition.md#hashvalues) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:141](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L141) - ---- - -### hashValuesPlain - -▸ **hashValuesPlain**(...`args`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[hashValuesPlain](conditions.ProviderCondition.md#hashvaluesplain) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:145](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L145) - ---- - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :--------- | :------------------- | :------------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[init](conditions.ProviderCondition.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - ---- - -### instance - -▸ **instance**(`agreementId`, `params`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------ | :-------------------------------------------------------------------------------------------------------- | -| `agreementId` | `string` | -| `params` | [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instance](conditions.ProviderCondition.md#instance) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:184](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L184) - ---- - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementId`, `ctx`, ...`args`): `Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------ | :------------------------------------------------------------------------------- | -| `agreementId` | `string` | -| `ctx` | `TransferNFTConditionContext` | -| `...args` | [`ConditionInstanceSmall`](../interfaces/conditions.ConditionInstanceSmall.md)[] | - -#### Returns - -`Promise`<[`ConditionInstance`](../interfaces/conditions.ConditionInstance.md)<`Record`<`string`, `unknown`\>\>\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[instanceFromDDO](conditions.ProviderCondition.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:154](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L154) - ---- - -### params - -▸ **params**(`did`, `nftHolder`, `nftReceiver`, `nftAmount`, `lockCondition`, `nftContractAddress?`, `willBeTransferred?`): [`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -Generates the hash of condition inputs. - -#### Parameters - -| Name | Type | Default value | Description | -| :-------------------- | :-------- | :------------ | :--------------------------------------------------- | -| `did` | `string` | `undefined` | The DID of the asset with NFTs. | -| `nftHolder` | `string` | `undefined` | The address of the holder of the NFT. | -| `nftReceiver` | `string` | `undefined` | The address of the granted user or the DID provider. | -| `nftAmount` | `default` | `undefined` | Amount of NFTs to transfer. | -| `lockCondition` | `string` | `undefined` | Lock condition identifier. | -| `nftContractAddress?` | `string` | `undefined` | The address of the NFT token to use. | -| `willBeTransferred` | `boolean` | `true` | Indicates if the asset will be transferred or minted | - -#### Returns - -[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\> - -Hash of all the values - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[params](conditions.ProviderCondition.md#params) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:42](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts#L42) - ---- - -### paramsFromDDO - -▸ **paramsFromDDO**(`__namedParameters`, `lockCondition`): `Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Parameters - -| Name | Type | -| :------------------ | :---------------------------- | -| `__namedParameters` | `TransferNFTConditionContext` | -| `lockCondition` | `any` | - -#### Returns - -`Promise`<[`ConditionParameters`](../interfaces/conditions.ConditionParameters.md)<`Record`<`string`, `unknown`\>\>\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[paramsFromDDO](conditions.ProviderCondition.md#paramsfromddo) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts#L90) - ---- - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :------------- | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[send](conditions.ProviderCondition.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - ---- - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :---------------------- | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[sendFrom](conditions.ProviderCondition.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - ---- - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - ---- - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[addressesStatic](conditions.ProviderCondition.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - ---- - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[ProviderCondition](conditions.ProviderCondition.md).[findSignerStatic](conditions.ProviderCondition.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - ---- - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`TransferNFTCondition`](conditions.TransferNFTCondition.md)\> - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`TransferNFTCondition`](conditions.TransferNFTCondition.md)\> - -#### Overrides - -[ProviderCondition](conditions.ProviderCondition.md).[getInstance](conditions.ProviderCondition.md#getinstance) - -#### Defined in - -[src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts#L24) - ---- - -### 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 - -[ProviderCondition](conditions.ProviderCondition.md).[setInstanceConfig](conditions.ProviderCondition.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/api-reference/classes/events.ContractEvent.md b/docs/api-reference/classes/events.ContractEvent.md deleted file mode 100644 index 12106d6db..000000000 --- a/docs/api-reference/classes/events.ContractEvent.md +++ /dev/null @@ -1,585 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [events](../modules/events.md) / ContractEvent - -# Class: ContractEvent - -[events](../modules/events.md).ContractEvent - -## Hierarchy - -- [`NeverminedEvent`](events.NeverminedEvent.md) - - ↳ **`ContractEvent`** - -## Table of contents - -### Constructors - -- [constructor](events.ContractEvent.md#constructor) - -### Properties - -- [contract](events.ContractEvent.md#contract) -- [eventEmitter](events.ContractEvent.md#eventemitter) - -### Accessors - -- [artifactsFolder](events.ContractEvent.md#artifactsfolder) -- [config](events.ContractEvent.md#config) -- [instanceConfig](events.ContractEvent.md#instanceconfig) -- [instantiableConfig](events.ContractEvent.md#instantiableconfig) -- [logger](events.ContractEvent.md#logger) -- [nevermined](events.ContractEvent.md#nevermined) -- [web3](events.ContractEvent.md#web3) - -### Methods - -- [addresses](events.ContractEvent.md#addresses) -- [checkExists](events.ContractEvent.md#checkexists) -- [eventExists](events.ContractEvent.md#eventexists) -- [filterToArgs](events.ContractEvent.md#filtertoargs) -- [findSigner](events.ContractEvent.md#findsigner) -- [getBlockNumber](events.ContractEvent.md#getblocknumber) -- [getEventData](events.ContractEvent.md#geteventdata) -- [getPastEvents](events.ContractEvent.md#getpastevents) -- [once](events.ContractEvent.md#once) -- [setInstanceConfig](events.ContractEvent.md#setinstanceconfig) -- [subscribe](events.ContractEvent.md#subscribe) -- [addressesStatic](events.ContractEvent.md#addressesstatic) -- [findSignerStatic](events.ContractEvent.md#findsignerstatic) -- [getInstance](events.ContractEvent.md#getinstance) -- [setInstanceConfig](events.ContractEvent.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• `Protected` **new ContractEvent**(`contract`, `eventEmitter`) - -#### Parameters - -| Name | Type | -| :------------- | :----------------------------------------------------- | -| `contract` | `ContractBase` | -| `eventEmitter` | [`EventEmitter`](../interfaces/events.EventEmitter.md) | - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[constructor](events.NeverminedEvent.md#constructor) - -#### Defined in - -[src/events/NeverminedEvent.ts:35](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L35) - -## Properties - -### contract - -• `Protected` **contract**: `ContractBase` = `null` - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[contract](events.NeverminedEvent.md#contract) - -#### Defined in - -[src/events/NeverminedEvent.ts:30](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L30) - ---- - -### eventEmitter - -• `Protected` **eventEmitter**: [`EventEmitter`](../interfaces/events.EventEmitter.md) - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[eventEmitter](events.NeverminedEvent.md#eventemitter) - -#### Defined in - -[src/events/NeverminedEvent.ts:29](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L29) - -## Accessors - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -NeverminedEvent.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - ---- - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -NeverminedEvent.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - ---- - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -NeverminedEvent.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - ---- - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -NeverminedEvent.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - ---- - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -NeverminedEvent.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - ---- - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -NeverminedEvent.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - ---- - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -NeverminedEvent.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[addresses](events.NeverminedEvent.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - ---- - -### 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 - -[NeverminedEvent](events.NeverminedEvent.md).[checkExists](events.NeverminedEvent.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - ---- - -### eventExists - -▸ `Private` **eventExists**(`eventName`): `boolean` - -#### Parameters - -| Name | Type | -| :---------- | :------- | -| `eventName` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -[src/events/ContractEvent.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/ContractEvent.ts#L69) - ---- - -### filterToArgs - -▸ `Private` **filterToArgs**(`eventName`, `filter`): `any`[] - -#### Parameters - -| Name | Type | -| :---------- | :----------------------------------------- | -| `eventName` | `string` | -| `filter` | [`Filter`](../interfaces/events.Filter.md) | - -#### Returns - -`any`[] - -#### Defined in - -[src/events/ContractEvent.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/ContractEvent.ts#L73) - ---- - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[findSigner](events.NeverminedEvent.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - ---- - -### getBlockNumber - -▸ **getBlockNumber**(): `Promise`<`number`\> - -#### Returns - -`Promise`<`number`\> - -#### Overrides - -[NeverminedEvent](events.NeverminedEvent.md).[getBlockNumber](events.NeverminedEvent.md#getblocknumber) - -#### Defined in - -[src/events/ContractEvent.ts:65](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/ContractEvent.ts#L65) - ---- - -### getEventData - -▸ **getEventData**(`options`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------- | -| `options` | [`EventOptions`](../interfaces/events.EventOptions.md) | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Overrides - -[NeverminedEvent](events.NeverminedEvent.md).[getEventData](events.NeverminedEvent.md#geteventdata) - -#### Defined in - -[src/events/ContractEvent.ts:29](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/ContractEvent.ts#L29) - ---- - -### getPastEvents - -▸ **getPastEvents**(`options`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------- | -| `options` | [`EventOptions`](../interfaces/events.EventOptions.md) | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Overrides - -[NeverminedEvent](events.NeverminedEvent.md).[getPastEvents](events.NeverminedEvent.md#getpastevents) - -#### Defined in - -[src/events/ContractEvent.ts:47](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/ContractEvent.ts#L47) - ---- - -### once - -▸ **once**(`callback?`, `options?`): `Promise`<[`EventResult`](../modules/events.md#eventresult)\> - -#### Parameters - -| Name | Type | -| :---------- | :------------------------------------------------------------------------ | -| `callback?` | (`events`: [`EventResult`](../modules/events.md#eventresult)[]) => `void` | -| `options?` | [`EventOptions`](../interfaces/events.EventOptions.md) | - -#### Returns - -`Promise`<[`EventResult`](../modules/events.md#eventresult)\> - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[once](events.NeverminedEvent.md#once) - -#### Defined in - -[src/events/NeverminedEvent.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L55) - ---- - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[setInstanceConfig](events.NeverminedEvent.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - ---- - -### subscribe - -▸ **subscribe**(`callback`, `options`): [`ContractEventSubscription`](../interfaces/events.ContractEventSubscription.md) - -#### Parameters - -| Name | Type | -| :--------- | :------------------------------------------------------------------------ | -| `callback` | (`events`: [`EventResult`](../modules/events.md#eventresult)[]) => `void` | -| `options` | [`EventOptions`](../interfaces/events.EventOptions.md) | - -#### Returns - -[`ContractEventSubscription`](../interfaces/events.ContractEventSubscription.md) - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[subscribe](events.NeverminedEvent.md#subscribe) - -#### Defined in - -[src/events/NeverminedEvent.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L41) - ---- - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[addressesStatic](events.NeverminedEvent.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - ---- - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[findSignerStatic](events.NeverminedEvent.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - ---- - -### getInstance - -▸ `Static` **getInstance**(`contract`, `eventEmitter`, `nevermined`, `web3`): [`ContractEvent`](events.ContractEvent.md) - -#### Parameters - -| Name | Type | -| :------------- | :----------------------------------------------------- | -| `contract` | `ContractBase` | -| `eventEmitter` | [`EventEmitter`](../interfaces/events.EventEmitter.md) | -| `nevermined` | [`Nevermined`](Nevermined.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -[`ContractEvent`](events.ContractEvent.md) - -#### Overrides - -[NeverminedEvent](events.NeverminedEvent.md).[getInstance](events.NeverminedEvent.md#getinstance) - -#### Defined in - -[src/events/ContractEvent.ts:14](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/ContractEvent.ts#L14) - ---- - -### 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 - -[NeverminedEvent](events.NeverminedEvent.md).[setInstanceConfig](events.NeverminedEvent.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/api-reference/classes/events.NeverminedEvent.md b/docs/api-reference/classes/events.NeverminedEvent.md deleted file mode 100644 index 584bf15e9..000000000 --- a/docs/api-reference/classes/events.NeverminedEvent.md +++ /dev/null @@ -1,521 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [events](../modules/events.md) / NeverminedEvent - -# Class: NeverminedEvent - -[events](../modules/events.md).NeverminedEvent - -## Hierarchy - -- `Instantiable` - - ↳ **`NeverminedEvent`** - - ↳↳ [`ContractEvent`](events.ContractEvent.md) - - ↳↳ [`SubgraphEvent`](events.SubgraphEvent.md) - -## Table of contents - -### Constructors - -- [constructor](events.NeverminedEvent.md#constructor) - -### Properties - -- [contract](events.NeverminedEvent.md#contract) -- [eventEmitter](events.NeverminedEvent.md#eventemitter) - -### Accessors - -- [artifactsFolder](events.NeverminedEvent.md#artifactsfolder) -- [config](events.NeverminedEvent.md#config) -- [instanceConfig](events.NeverminedEvent.md#instanceconfig) -- [instantiableConfig](events.NeverminedEvent.md#instantiableconfig) -- [logger](events.NeverminedEvent.md#logger) -- [nevermined](events.NeverminedEvent.md#nevermined) -- [web3](events.NeverminedEvent.md#web3) - -### Methods - -- [addresses](events.NeverminedEvent.md#addresses) -- [checkExists](events.NeverminedEvent.md#checkexists) -- [findSigner](events.NeverminedEvent.md#findsigner) -- [getBlockNumber](events.NeverminedEvent.md#getblocknumber) -- [getEventData](events.NeverminedEvent.md#geteventdata) -- [getPastEvents](events.NeverminedEvent.md#getpastevents) -- [once](events.NeverminedEvent.md#once) -- [setInstanceConfig](events.NeverminedEvent.md#setinstanceconfig) -- [subscribe](events.NeverminedEvent.md#subscribe) -- [addressesStatic](events.NeverminedEvent.md#addressesstatic) -- [findSignerStatic](events.NeverminedEvent.md#findsignerstatic) -- [getInstance](events.NeverminedEvent.md#getinstance) -- [setInstanceConfig](events.NeverminedEvent.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• `Protected` **new NeverminedEvent**(`contract`, `eventEmitter`) - -#### Parameters - -| Name | Type | -| :------------- | :----------------------------------------------------- | -| `contract` | `ContractBase` | -| `eventEmitter` | [`EventEmitter`](../interfaces/events.EventEmitter.md) | - -#### Overrides - -Instantiable.constructor - -#### Defined in - -[src/events/NeverminedEvent.ts:35](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L35) - -## Properties - -### contract - -• `Protected` **contract**: `ContractBase` = `null` - -#### Defined in - -[src/events/NeverminedEvent.ts:30](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L30) - ---- - -### eventEmitter - -• `Protected` **eventEmitter**: [`EventEmitter`](../interfaces/events.EventEmitter.md) - -#### Defined in - -[src/events/NeverminedEvent.ts:29](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L29) - -## Accessors - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -Instantiable.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - ---- - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -Instantiable.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - ---- - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -Instantiable.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - ---- - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -Instantiable.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - ---- - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -Instantiable.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - ---- - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -Instantiable.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - ---- - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -Instantiable.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -Instantiable.addresses - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - ---- - -### 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](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - ---- - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -Instantiable.findSigner - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - ---- - -### getBlockNumber - -▸ `Abstract` **getBlockNumber**(...`args`): `Promise`<`number`\> - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`Promise`<`number`\> - -#### Defined in - -[src/events/NeverminedEvent.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L33) - ---- - -### getEventData - -▸ `Abstract` **getEventData**(`options`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------- | -| `options` | [`EventOptions`](../interfaces/events.EventOptions.md) | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Defined in - -[src/events/NeverminedEvent.ts:31](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L31) - ---- - -### getPastEvents - -▸ `Abstract` **getPastEvents**(`options`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------- | -| `options` | [`EventOptions`](../interfaces/events.EventOptions.md) | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Defined in - -[src/events/NeverminedEvent.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L32) - ---- - -### once - -▸ **once**(`callback?`, `options?`): `Promise`<[`EventResult`](../modules/events.md#eventresult)\> - -#### Parameters - -| Name | Type | -| :---------- | :------------------------------------------------------------------------ | -| `callback?` | (`events`: [`EventResult`](../modules/events.md#eventresult)[]) => `void` | -| `options?` | [`EventOptions`](../interfaces/events.EventOptions.md) | - -#### Returns - -`Promise`<[`EventResult`](../modules/events.md#eventresult)\> - -#### Defined in - -[src/events/NeverminedEvent.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L55) - ---- - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -Instantiable.setInstanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - ---- - -### subscribe - -▸ **subscribe**(`callback`, `options`): [`ContractEventSubscription`](../interfaces/events.ContractEventSubscription.md) - -#### Parameters - -| Name | Type | -| :--------- | :------------------------------------------------------------------------ | -| `callback` | (`events`: [`EventResult`](../modules/events.md#eventresult)[]) => `void` | -| `options` | [`EventOptions`](../interfaces/events.EventOptions.md) | - -#### Returns - -[`ContractEventSubscription`](../interfaces/events.ContractEventSubscription.md) - -#### Defined in - -[src/events/NeverminedEvent.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L41) - ---- - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -Instantiable.addressesStatic - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - ---- - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -Instantiable.findSignerStatic - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - ---- - -### getInstance - -▸ `Static` **getInstance**(...`_args`): `any` - -#### Parameters - -| Name | Type | -| :--------- | :---- | -| `..._args` | `any` | - -#### Returns - -`any` - -#### Inherited from - -Instantiable.getInstance - -#### Defined in - -[src/Instantiable.abstract.ts:158](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L158) - ---- - -### 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 - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/api-reference/classes/events.SubgraphEvent.md b/docs/api-reference/classes/events.SubgraphEvent.md deleted file mode 100644 index 85234943f..000000000 --- a/docs/api-reference/classes/events.SubgraphEvent.md +++ /dev/null @@ -1,590 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [events](../modules/events.md) / SubgraphEvent - -# Class: SubgraphEvent - -[events](../modules/events.md).SubgraphEvent - -## Hierarchy - -- [`NeverminedEvent`](events.NeverminedEvent.md) - - ↳ **`SubgraphEvent`** - -## Table of contents - -### Constructors - -- [constructor](events.SubgraphEvent.md#constructor) - -### Properties - -- [contract](events.SubgraphEvent.md#contract) -- [eventEmitter](events.SubgraphEvent.md#eventemitter) -- [graphHttpUri](events.SubgraphEvent.md#graphhttpuri) -- [networkName](events.SubgraphEvent.md#networkname) -- [subgraph](events.SubgraphEvent.md#subgraph) - -### Accessors - -- [artifactsFolder](events.SubgraphEvent.md#artifactsfolder) -- [config](events.SubgraphEvent.md#config) -- [instanceConfig](events.SubgraphEvent.md#instanceconfig) -- [instantiableConfig](events.SubgraphEvent.md#instantiableconfig) -- [logger](events.SubgraphEvent.md#logger) -- [nevermined](events.SubgraphEvent.md#nevermined) -- [web3](events.SubgraphEvent.md#web3) - -### Methods - -- [addresses](events.SubgraphEvent.md#addresses) -- [checkExists](events.SubgraphEvent.md#checkexists) -- [findSigner](events.SubgraphEvent.md#findsigner) -- [getBlockNumber](events.SubgraphEvent.md#getblocknumber) -- [getEventData](events.SubgraphEvent.md#geteventdata) -- [getPastEvents](events.SubgraphEvent.md#getpastevents) -- [once](events.SubgraphEvent.md#once) -- [setInstanceConfig](events.SubgraphEvent.md#setinstanceconfig) -- [subgraphUrl](events.SubgraphEvent.md#subgraphurl) -- [subscribe](events.SubgraphEvent.md#subscribe) -- [addressesStatic](events.SubgraphEvent.md#addressesstatic) -- [findSignerStatic](events.SubgraphEvent.md#findsignerstatic) -- [getInstance](events.SubgraphEvent.md#getinstance) -- [setInstanceConfig](events.SubgraphEvent.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• `Protected` **new SubgraphEvent**(`contract`, `eventEmitter`) - -#### Parameters - -| Name | Type | -| :------------- | :----------------------------------------------------- | -| `contract` | `ContractBase` | -| `eventEmitter` | [`EventEmitter`](../interfaces/events.EventEmitter.md) | - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[constructor](events.NeverminedEvent.md#constructor) - -#### Defined in - -[src/events/NeverminedEvent.ts:35](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L35) - -## Properties - -### contract - -• `Protected` **contract**: `ContractBase` = `null` - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[contract](events.NeverminedEvent.md#contract) - -#### Defined in - -[src/events/NeverminedEvent.ts:30](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L30) - ---- - -### eventEmitter - -• `Protected` **eventEmitter**: [`EventEmitter`](../interfaces/events.EventEmitter.md) - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[eventEmitter](events.NeverminedEvent.md#eventemitter) - -#### Defined in - -[src/events/NeverminedEvent.ts:29](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L29) - ---- - -### graphHttpUri - -• `Private` **graphHttpUri**: `string` - -#### Defined in - -[src/events/SubgraphEvent.ts:14](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/SubgraphEvent.ts#L14) - ---- - -### networkName - -• `Private` **networkName**: `string` - -#### Defined in - -[src/events/SubgraphEvent.ts:16](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/SubgraphEvent.ts#L16) - ---- - -### subgraph - -• **subgraph**: `any` - -#### Defined in - -[src/events/SubgraphEvent.ts:15](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/SubgraphEvent.ts#L15) - -## Accessors - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -NeverminedEvent.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - ---- - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -NeverminedEvent.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - ---- - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -NeverminedEvent.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - ---- - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -NeverminedEvent.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - ---- - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -NeverminedEvent.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - ---- - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -NeverminedEvent.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - ---- - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -NeverminedEvent.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[addresses](events.NeverminedEvent.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - ---- - -### 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 - -[NeverminedEvent](events.NeverminedEvent.md).[checkExists](events.NeverminedEvent.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - ---- - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[findSigner](events.NeverminedEvent.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - ---- - -### getBlockNumber - -▸ **getBlockNumber**(): `Promise`<`number`\> - -#### Returns - -`Promise`<`number`\> - -#### Overrides - -[NeverminedEvent](events.NeverminedEvent.md).[getBlockNumber](events.NeverminedEvent.md#getblocknumber) - -#### Defined in - -[src/events/SubgraphEvent.ts:56](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/SubgraphEvent.ts#L56) - ---- - -### getEventData - -▸ **getEventData**(`options`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------- | -| `options` | [`EventOptions`](../interfaces/events.EventOptions.md) | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Overrides - -[NeverminedEvent](events.NeverminedEvent.md).[getEventData](events.NeverminedEvent.md#geteventdata) - -#### Defined in - -[src/events/SubgraphEvent.ts:31](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/SubgraphEvent.ts#L31) - ---- - -### getPastEvents - -▸ **getPastEvents**(`options`): [`EventResult`](../modules/events.md#eventresult) - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------- | -| `options` | [`EventOptions`](../interfaces/events.EventOptions.md) | - -#### Returns - -[`EventResult`](../modules/events.md#eventresult) - -#### Overrides - -[NeverminedEvent](events.NeverminedEvent.md).[getPastEvents](events.NeverminedEvent.md#getpastevents) - -#### Defined in - -[src/events/SubgraphEvent.ts:52](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/SubgraphEvent.ts#L52) - ---- - -### once - -▸ **once**(`callback?`, `options?`): `Promise`<[`EventResult`](../modules/events.md#eventresult)\> - -#### Parameters - -| Name | Type | -| :---------- | :------------------------------------------------------------------------ | -| `callback?` | (`events`: [`EventResult`](../modules/events.md#eventresult)[]) => `void` | -| `options?` | [`EventOptions`](../interfaces/events.EventOptions.md) | - -#### Returns - -`Promise`<[`EventResult`](../modules/events.md#eventresult)\> - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[once](events.NeverminedEvent.md#once) - -#### Defined in - -[src/events/NeverminedEvent.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L55) - ---- - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[setInstanceConfig](events.NeverminedEvent.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - ---- - -### subgraphUrl - -▸ `Private` **subgraphUrl**(): `Promise`<`string`\> - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[src/events/SubgraphEvent.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/SubgraphEvent.ts#L63) - ---- - -### subscribe - -▸ **subscribe**(`callback`, `options`): [`ContractEventSubscription`](../interfaces/events.ContractEventSubscription.md) - -#### Parameters - -| Name | Type | -| :--------- | :------------------------------------------------------------------------ | -| `callback` | (`events`: [`EventResult`](../modules/events.md#eventresult)[]) => `void` | -| `options` | [`EventOptions`](../interfaces/events.EventOptions.md) | - -#### Returns - -[`ContractEventSubscription`](../interfaces/events.ContractEventSubscription.md) - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[subscribe](events.NeverminedEvent.md#subscribe) - -#### Defined in - -[src/events/NeverminedEvent.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L41) - ---- - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[addressesStatic](events.NeverminedEvent.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - ---- - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[NeverminedEvent](events.NeverminedEvent.md).[findSignerStatic](events.NeverminedEvent.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - ---- - -### getInstance - -▸ `Static` **getInstance**(`contract`, `eventEmitter`, `graphHttpUri`, `networkName`): [`SubgraphEvent`](events.SubgraphEvent.md) - -#### Parameters - -| Name | Type | -| :------------- | :----------------------------------------------------- | -| `contract` | `ContractBase` | -| `eventEmitter` | [`EventEmitter`](../interfaces/events.EventEmitter.md) | -| `graphHttpUri` | `string` | -| `networkName` | `string` | - -#### Returns - -[`SubgraphEvent`](events.SubgraphEvent.md) - -#### Overrides - -[NeverminedEvent](events.NeverminedEvent.md).[getInstance](events.NeverminedEvent.md#getinstance) - -#### Defined in - -[src/events/SubgraphEvent.ts:17](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/SubgraphEvent.ts#L17) - ---- - -### 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 - -[NeverminedEvent](events.NeverminedEvent.md).[setInstanceConfig](events.NeverminedEvent.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/api-reference/classes/templates.AaveCreditTemplate.md b/docs/api-reference/classes/templates.AaveCreditTemplate.md deleted file mode 100644 index 37157cfc7..000000000 --- a/docs/api-reference/classes/templates.AaveCreditTemplate.md +++ /dev/null @@ -1,1723 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [templates](../modules/templates.md) / AaveCreditTemplate - -# Class: AaveCreditTemplate - -[templates](../modules/templates.md).AaveCreditTemplate - -## Hierarchy - -- [`BaseTemplate`](templates.BaseTemplate.md)<`AaveCreditTemplateParams`, `ServiceAaveCredit`\> - - ↳ **`AaveCreditTemplate`** - -## Table of contents - -### Constructors - -- [constructor](templates.AaveCreditTemplate.md#constructor) - -### Properties - -- [aaveConfig](templates.AaveCreditTemplate.md#aaveconfig) -- [contract](templates.AaveCreditTemplate.md#contract) -- [contractName](templates.AaveCreditTemplate.md#contractname) -- [events](templates.AaveCreditTemplate.md#events) -- [version](templates.AaveCreditTemplate.md#version) - -### Accessors - -- [address](templates.AaveCreditTemplate.md#address) -- [artifactsFolder](templates.AaveCreditTemplate.md#artifactsfolder) -- [config](templates.AaveCreditTemplate.md#config) -- [instanceConfig](templates.AaveCreditTemplate.md#instanceconfig) -- [instantiableConfig](templates.AaveCreditTemplate.md#instantiableconfig) -- [logger](templates.AaveCreditTemplate.md#logger) -- [nevermined](templates.AaveCreditTemplate.md#nevermined) -- [web3](templates.AaveCreditTemplate.md#web3) - -### Methods - -- [\_createAgreement](templates.AaveCreditTemplate.md#_createagreement) -- [accept](templates.AaveCreditTemplate.md#accept) -- [addresses](templates.AaveCreditTemplate.md#addresses) -- [agreementId](templates.AaveCreditTemplate.md#agreementid) -- [call](templates.AaveCreditTemplate.md#call) -- [checkExists](templates.AaveCreditTemplate.md#checkexists) -- [conditions](templates.AaveCreditTemplate.md#conditions) -- [createAgreement](templates.AaveCreditTemplate.md#createagreement) -- [createAgreementAndDeployVault](templates.AaveCreditTemplate.md#createagreementanddeployvault) -- [createAgreementAndPay](templates.AaveCreditTemplate.md#createagreementandpay) -- [createAgreementFromDDO](templates.AaveCreditTemplate.md#createagreementfromddo) -- [createAgreementWithPaymentFromDDO](templates.AaveCreditTemplate.md#createagreementwithpaymentfromddo) -- [createService](templates.AaveCreditTemplate.md#createservice) -- [deployVault](templates.AaveCreditTemplate.md#deployvault) -- [description](templates.AaveCreditTemplate.md#description) -- [extraGen](templates.AaveCreditTemplate.md#extragen) -- [findSigner](templates.AaveCreditTemplate.md#findsigner) -- [getAddress](templates.AaveCreditTemplate.md#getaddress) -- [getAgreementCreatedEvent](templates.AaveCreditTemplate.md#getagreementcreatedevent) -- [getAgreementData](templates.AaveCreditTemplate.md#getagreementdata) -- [getAgreementDid](templates.AaveCreditTemplate.md#getagreementdid) -- [getAgreementIdsFromDDO](templates.AaveCreditTemplate.md#getagreementidsfromddo) -- [getAgreementStatus](templates.AaveCreditTemplate.md#getagreementstatus) -- [getAgreementVaultAddress](templates.AaveCreditTemplate.md#getagreementvaultaddress) -- [getAgreementsForDID](templates.AaveCreditTemplate.md#getagreementsfordid) -- [getConditionTypes](templates.AaveCreditTemplate.md#getconditiontypes) -- [getConditions](templates.AaveCreditTemplate.md#getconditions) -- [getContract](templates.AaveCreditTemplate.md#getcontract) -- [getFromAddress](templates.AaveCreditTemplate.md#getfromaddress) -- [getInputsOfMethod](templates.AaveCreditTemplate.md#getinputsofmethod) -- [getServiceAgreementTemplate](templates.AaveCreditTemplate.md#getserviceagreementtemplate) -- [getServiceAgreementTemplateConditionByRef](templates.AaveCreditTemplate.md#getserviceagreementtemplateconditionbyref) -- [getServiceAgreementTemplateConditions](templates.AaveCreditTemplate.md#getserviceagreementtemplateconditions) -- [getServiceAgreementTemplateDependencies](templates.AaveCreditTemplate.md#getserviceagreementtemplatedependencies) -- [getSignatureOfMethod](templates.AaveCreditTemplate.md#getsignatureofmethod) -- [init](templates.AaveCreditTemplate.md#init) -- [instanceFromDDO](templates.AaveCreditTemplate.md#instancefromddo) -- [lockConditionIndex](templates.AaveCreditTemplate.md#lockconditionindex) -- [lockTokens](templates.AaveCreditTemplate.md#locktokens) -- [name](templates.AaveCreditTemplate.md#name) -- [params](templates.AaveCreditTemplate.md#params) -- [paramsGen](templates.AaveCreditTemplate.md#paramsgen) -- [paymentData](templates.AaveCreditTemplate.md#paymentdata) -- [printAgreementStatus](templates.AaveCreditTemplate.md#printagreementstatus) -- [process](templates.AaveCreditTemplate.md#process) -- [send](templates.AaveCreditTemplate.md#send) -- [sendFrom](templates.AaveCreditTemplate.md#sendfrom) -- [service](templates.AaveCreditTemplate.md#service) -- [serviceEndpoint](templates.AaveCreditTemplate.md#serviceendpoint) -- [setInstanceConfig](templates.AaveCreditTemplate.md#setinstanceconfig) -- [standardContext](templates.AaveCreditTemplate.md#standardcontext) -- [validateAgreement](templates.AaveCreditTemplate.md#validateagreement) -- [addressesStatic](templates.AaveCreditTemplate.md#addressesstatic) -- [findSignerStatic](templates.AaveCreditTemplate.md#findsignerstatic) -- [getInstance](templates.AaveCreditTemplate.md#getinstance) -- [setInstanceConfig](templates.AaveCreditTemplate.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• `Protected` **new AaveCreditTemplate**(`contractName`) - -#### Parameters - -| Name | Type | -| :------------- | :------- | -| `contractName` | `string` | - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[constructor](templates.BaseTemplate.md#constructor) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:75](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L75) - -## Properties - -### aaveConfig - -• **aaveConfig**: `AaveConfig` - -#### Defined in - -[src/keeper/contracts/defi/AaveCreditTemplate.ts:52](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCreditTemplate.ts#L52) - ---- - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[contract](templates.BaseTemplate.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - ---- - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[contractName](templates.BaseTemplate.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - ---- - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[events](templates.BaseTemplate.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - ---- - -### version - -• **version**: `string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[version](templates.BaseTemplate.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -BaseTemplate.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - ---- - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -BaseTemplate.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - ---- - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -BaseTemplate.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - ---- - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -BaseTemplate.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - ---- - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -BaseTemplate.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - ---- - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -BaseTemplate.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - ---- - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -BaseTemplate.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - ---- - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -BaseTemplate.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### \_createAgreement - -▸ `Private` **\_createAgreement**(`agreementIdSeed`, `ddo`, `vaultAddress`, `nftTokenContract`, `nftAmount`, `collateralToken`, `collateralAmount`, `delegatedToken`, `delegatedAmount`, `interestRateMode`, `timeLocks`, `timeOuts`, `txParams?`, `from?`): `Promise`<[`ContractReceipt`, [`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`AaveCreditTemplateParams`\>]\> - -#### Parameters - -| Name | Type | -| :----------------- | :---------------------- | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `vaultAddress` | `string` | -| `nftTokenContract` | `string` | -| `nftAmount` | `number` | -| `collateralToken` | `string` | -| `collateralAmount` | `number` | -| `delegatedToken` | `string` | -| `delegatedAmount` | `number` | -| `interestRateMode` | `number` | -| `timeLocks` | `number`[] | -| `timeOuts` | `number`[] | -| `txParams?` | `TxParameters` | -| `from?` | [`Account`](Account.md) | - -#### Returns - -`Promise`<[`ContractReceipt`, [`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`AaveCreditTemplateParams`\>]\> - -#### Defined in - -[src/keeper/contracts/defi/AaveCreditTemplate.ts:102](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCreditTemplate.ts#L102) - ---- - -### accept - -▸ **accept**(`_params`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :-------- | :----------------- | -| `_params` | `ValidationParams` | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[accept](templates.BaseTemplate.md#accept) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:112](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L112) - ---- - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[addresses](templates.BaseTemplate.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - ---- - -### agreementId - -▸ **agreementId**(`agreementIdSeed`, `creator`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :---------------- | :------- | -| `agreementIdSeed` | `string` | -| `creator` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[agreementId](templates.BaseTemplate.md#agreementid) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:213](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L213) - ---- - -### 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 - -[BaseTemplate](templates.BaseTemplate.md).[call](templates.BaseTemplate.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - ---- - -### 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 - -[BaseTemplate](templates.BaseTemplate.md).[checkExists](templates.BaseTemplate.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - ---- - -### conditions - -▸ **conditions**(): [[`NFT721LockCondition`](conditions.NFT721LockCondition.md), [`AaveCollateralDepositCondition`](conditions.AaveCollateralDepositCondition.md), [`AaveBorrowCondition`](conditions.AaveBorrowCondition.md), [`AaveRepayCondition`](conditions.AaveRepayCondition.md), [`AaveCollateralWithdrawCondition`](conditions.AaveCollateralWithdrawCondition.md), [`DistributeNFTCollateralCondition`](conditions.DistributeNFTCollateralCondition.md)] - -#### Returns - -[[`NFT721LockCondition`](conditions.NFT721LockCondition.md), [`AaveCollateralDepositCondition`](conditions.AaveCollateralDepositCondition.md), [`AaveBorrowCondition`](conditions.AaveBorrowCondition.md), [`AaveRepayCondition`](conditions.AaveRepayCondition.md), [`AaveCollateralWithdrawCondition`](conditions.AaveCollateralWithdrawCondition.md), [`DistributeNFTCollateralCondition`](conditions.DistributeNFTCollateralCondition.md)] - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[conditions](templates.BaseTemplate.md#conditions) - -#### Defined in - -[src/keeper/contracts/defi/AaveCreditTemplate.ts:285](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCreditTemplate.ts#L285) - ---- - -### 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`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreement](templates.BaseTemplate.md#createagreement) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L99) - ---- - -### createAgreementAndDeployVault - -▸ **createAgreementAndDeployVault**(`agreementIdSeed`, `ddo`, `nftTokenContract`, `nftAmount`, `collateralToken`, `collateralAmount`, `delegatedToken`, `delegatedAmount`, `interestRateMode`, `borrower`, `lender`, `timeLocks`, `timeOuts`, `txParams?`, `from?`): `Promise`<[`ContractReceipt`, `string`, [`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`AaveCreditTemplateParams`\>]\> - -#### Parameters - -| Name | Type | -| :----------------- | :---------------------- | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `nftTokenContract` | `string` | -| `nftAmount` | `number` | -| `collateralToken` | `string` | -| `collateralAmount` | `number` | -| `delegatedToken` | `string` | -| `delegatedAmount` | `number` | -| `interestRateMode` | `number` | -| `borrower` | `string` | -| `lender` | `string` | -| `timeLocks` | `number`[] | -| `timeOuts` | `number`[] | -| `txParams?` | `TxParameters` | -| `from?` | [`Account`](Account.md) | - -#### Returns - -`Promise`<[`ContractReceipt`, `string`, [`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`AaveCreditTemplateParams`\>]\> - -#### Defined in - -[src/keeper/contracts/defi/AaveCreditTemplate.ts:155](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCreditTemplate.ts#L155) - ---- - -### 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`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementAndPay](templates.BaseTemplate.md#createagreementandpay) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:124](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L124) - ---- - -### 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.md) | DDO. | -| `parameters` | `AaveCreditTemplateParams` | | -| `consumer` | [`Account`](Account.md) | - | -| `from` | [`Account`](Account.md) | - | -| `timeOuts?` | `number`[] | - | -| `params?` | `TxParameters` | - | - -#### Returns - -`Promise`<`string`\> - -true if the call was successful. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementFromDDO](templates.BaseTemplate.md#createagreementfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:225](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L225) - ---- - -### createAgreementWithPaymentFromDDO - -▸ **createAgreementWithPaymentFromDDO**(`agreementIdSeed`, `ddo`, `parameters`, `consumer`, `from`, `timeOuts?`, `txParams?`, `observer?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :---------------- | :------------------------------------- | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `parameters` | `AaveCreditTemplateParams` | -| `consumer` | [`Account`](Account.md) | -| `from` | [`Account`](Account.md) | -| `timeOuts?` | `number`[] | -| `txParams?` | `TxParameters` | -| `observer?` | (`OrderProgressStep`: `any`) => `void` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementWithPaymentFromDDO](templates.BaseTemplate.md#createagreementwithpaymentfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:255](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L255) - ---- - -### createService - -▸ **createService**(`publisher`, `metadata`, `assetPrice?`, `erc20TokenAddress?`, `priced?`): `Promise`<`ServiceAaveCredit`\> - -#### Parameters - -| Name | Type | Default value | -| :------------------- | :-------------------------------------- | :------------ | -| `publisher` | [`Account`](Account.md) | `undefined` | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | -| `assetPrice?` | `default` | `undefined` | -| `erc20TokenAddress?` | `string` | `undefined` | -| `priced` | `boolean` | `false` | - -#### Returns - -`Promise`<`ServiceAaveCredit`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createService](templates.BaseTemplate.md#createservice) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:65](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L65) - ---- - -### deployVault - -▸ **deployVault**(`lendingPool`, `dataProvider`, `weth`, `agreementFee`, `treasuryAddress`, `borrower`, `lender`, `from`): `Promise`<`string`\> - -Deploy a new credit vault that is required to facilitate an Aave credit agreement - -#### Parameters - -| Name | Type | -| :---------------- | :------- | -| `lendingPool` | `string` | -| `dataProvider` | `string` | -| `weth` | `string` | -| `agreementFee` | `number` | -| `treasuryAddress` | `string` | -| `borrower` | `string` | -| `lender` | `string` | -| `from` | `string` | - -#### Returns - -`Promise`<`string`\> - -Agreement ID. - -#### Defined in - -[src/keeper/contracts/defi/AaveCreditTemplate.ts:207](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCreditTemplate.ts#L207) - ---- - -### description - -▸ **description**(): `string` - -#### Returns - -`string` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[description](templates.BaseTemplate.md#description) - -#### Defined in - -[src/keeper/contracts/defi/AaveCreditTemplate.ts:49](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCreditTemplate.ts#L49) - ---- - -### extraGen - -▸ **extraGen**(`_params`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :-------- | :----------------- | -| `_params` | `ValidationParams` | - -#### Returns - -`Promise`<`any`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[extraGen](templates.BaseTemplate.md#extragen) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L108) - ---- - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[findSigner](templates.BaseTemplate.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - ---- - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAddress](templates.BaseTemplate.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - ---- - -### 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. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementCreatedEvent](templates.BaseTemplate.md#getagreementcreatedevent) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:469](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L469) - ---- - -### getAgreementData - -▸ **getAgreementData**(`agreementId`): `Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | - -#### Returns - -`Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementData](templates.BaseTemplate.md#getagreementdata) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:21](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L21) - ---- - -### getAgreementDid - -▸ **getAgreementDid**(`agreementId`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[src/keeper/contracts/defi/AaveCreditTemplate.ts:318](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCreditTemplate.ts#L318) - ---- - -### getAgreementIdsFromDDO - -▸ **getAgreementIdsFromDDO**(`agreementId`, `ddo`, `creator`, `params`): `Promise`<`string`[]\> - -Get agreement conditions IDs. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------------------------- | :------------ | -| `agreementId` | `string` | Agreement ID. | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `creator` | `string` | - | -| `params` | `AaveCreditTemplateParams` | - | - -#### Returns - -`Promise`<`string`[]\> - -The condition IDs. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementIdsFromDDO](templates.BaseTemplate.md#getagreementidsfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:183](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L183) - ---- - -### getAgreementStatus - -▸ **getAgreementStatus**(`agreementId`): `Promise`<`false` \| [`AgreementConditionsStatus`](../interfaces/templates.AgreementConditionsStatus.md)\> - -Returns the status of the conditions. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------- | :------------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<`false` \| [`AgreementConditionsStatus`](../interfaces/templates.AgreementConditionsStatus.md)\> - -The conditions status. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementStatus](templates.BaseTemplate.md#getagreementstatus) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:343](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L343) - ---- - -### getAgreementVaultAddress - -▸ **getAgreementVaultAddress**(`agreementId`, `from`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | -| `from` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[src/keeper/contracts/defi/AaveCreditTemplate.ts:311](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCreditTemplate.ts#L311) - ---- - -### getAgreementsForDID - -▸ **getAgreementsForDID**(`did`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :---- | :------- | -| `did` | `string` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementsForDID](templates.BaseTemplate.md#getagreementsfordid) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:496](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L496) - ---- - -### getConditionTypes - -▸ **getConditionTypes**(): `Promise`<`string`[]\> - -Conditions address list. - -#### Returns - -`Promise`<`string`[]\> - -A list of condition addresses. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getConditionTypes](templates.BaseTemplate.md#getconditiontypes) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:163](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L163) - ---- - -### getConditions - -▸ **getConditions**(): `Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)[]\> - -List of condition contracts. - -#### Returns - -`Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)[]\> - -A list of condition contracts. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getConditions](templates.BaseTemplate.md#getconditions) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L171) - ---- - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getContract](templates.BaseTemplate.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - ---- - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getFromAddress](templates.BaseTemplate.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - ---- - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :----------- | :------- | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getInputsOfMethod](templates.BaseTemplate.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - ---- - -### getServiceAgreementTemplate - -▸ **getServiceAgreementTemplate**(): `Promise`<`ServiceAgreementTemplate`\> - -#### Returns - -`Promise`<`ServiceAgreementTemplate`\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplate](templates.BaseTemplate.md#getserviceagreementtemplate) - -#### Defined in - -[src/keeper/contracts/defi/AaveCreditTemplate.ts:98](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCreditTemplate.ts#L98) - ---- - -### getServiceAgreementTemplateConditionByRef - -▸ **getServiceAgreementTemplateConditionByRef**(`ref`): `Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)\> - -#### Parameters - -| Name | Type | -| :---- | :------- | -| `ref` | `string` | - -#### Returns - -`Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateConditionByRef](templates.BaseTemplate.md#getserviceagreementtemplateconditionbyref) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:324](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L324) - ---- - -### getServiceAgreementTemplateConditions - -▸ **getServiceAgreementTemplateConditions**(): `Promise`<`ServiceAgreementTemplateCondition`[]\> - -#### Returns - -`Promise`<`ServiceAgreementTemplateCondition`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateConditions](templates.BaseTemplate.md#getserviceagreementtemplateconditions) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:319](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L319) - ---- - -### getServiceAgreementTemplateDependencies - -▸ **getServiceAgreementTemplateDependencies**(): `Promise`<{ `[condition: string]`: `string`[]; }\> - -#### Returns - -`Promise`<{ `[condition: string]`: `string`[]; }\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateDependencies](templates.BaseTemplate.md#getserviceagreementtemplatedependencies) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:333](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L333) - ---- - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :----------- | :------- | :------------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getSignatureOfMethod](templates.BaseTemplate.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - ---- - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :--------- | :------------------- | :------------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[init](templates.BaseTemplate.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - ---- - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementIdSeed`, `ddo`, `creator`, `parameters`): `Promise`<[`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`AaveCreditTemplateParams`\>\> - -#### Parameters - -| Name | Type | -| :---------------- | :------------------------- | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | -| `parameters` | `AaveCreditTemplateParams` | - -#### Returns - -`Promise`<[`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`AaveCreditTemplateParams`\>\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[instanceFromDDO](templates.BaseTemplate.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/defi/AaveCreditTemplate.ts:233](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCreditTemplate.ts#L233) - ---- - -### lockConditionIndex - -▸ **lockConditionIndex**(): `number` - -#### Returns - -`number` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[lockConditionIndex](templates.BaseTemplate.md#lockconditionindex) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L81) - ---- - -### lockTokens - -▸ **lockTokens**(`tokenAddress`, `amounts`, `from`, `txParams`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------------- | :---------------------- | -| `tokenAddress` | `any` | -| `amounts` | `any` | -| `from` | [`Account`](Account.md) | -| `txParams` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[lockTokens](templates.BaseTemplate.md#locktokens) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:398](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L398) - ---- - -### name - -▸ **name**(): `string` - -#### Returns - -`string` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[name](templates.BaseTemplate.md#name) - -#### Defined in - -[src/keeper/contracts/defi/AaveCreditTemplate.ts:46](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCreditTemplate.ts#L46) - ---- - -### params - -▸ **params**(`vaultAddress`, `nftContractAddress`, `nftAmount`, `collateralAsset`, `collateralAmount`, `delegatedAsset`, `delegatedAmount`, `interestRateMode`): `AaveCreditTemplateParams` - -#### Parameters - -| Name | Type | -| :------------------- | :------- | -| `vaultAddress` | `string` | -| `nftContractAddress` | `string` | -| `nftAmount` | `number` | -| `collateralAsset` | `string` | -| `collateralAmount` | `string` | -| `delegatedAsset` | `string` | -| `delegatedAmount` | `string` | -| `interestRateMode` | `number` | - -#### Returns - -`AaveCreditTemplateParams` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[params](templates.BaseTemplate.md#params) - -#### Defined in - -[src/keeper/contracts/defi/AaveCreditTemplate.ts:71](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCreditTemplate.ts#L71) - ---- - -### paramsGen - -▸ **paramsGen**(`_params`): `Promise`<`AaveCreditTemplateParams`\> - -Specialize params - -#### Parameters - -| Name | Type | Description | -| :-------- | :----------------- | :----------------- | -| `_params` | `ValidationParams` | Generic parameters | - -#### Returns - -`Promise`<`AaveCreditTemplateParams`\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[paramsGen](templates.BaseTemplate.md#paramsgen) - -#### Defined in - -[src/keeper/contracts/defi/AaveCreditTemplate.ts:43](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCreditTemplate.ts#L43) - ---- - -### paymentData - -▸ **paymentData**(`service`): [`PaymentData`](../interfaces/templates.PaymentData.md) - -#### Parameters - -| Name | Type | -| :-------- | :-------------- | -| `service` | `ServiceCommon` | - -#### Returns - -[`PaymentData`](../interfaces/templates.PaymentData.md) - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[paymentData](templates.BaseTemplate.md#paymentdata) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:85](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L85) - ---- - -### printAgreementStatus - -▸ **printAgreementStatus**(`agreementId`): `Promise`<`void`\> - -Prints the agreement status. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------- | :------------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[printAgreementStatus](templates.BaseTemplate.md#printagreementstatus) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:439](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L439) - ---- - -### process - -▸ **process**(`params`, `from`, `txparams?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :---------- | :---------------------- | -| `params` | `ValidationParams` | -| `from` | [`Account`](Account.md) | -| `txparams?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[process](templates.BaseTemplate.md#process) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:116](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L116) - ---- - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :------------- | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[send](templates.BaseTemplate.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - ---- - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :---------------------- | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[sendFrom](templates.BaseTemplate.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - ---- - -### service - -▸ **service**(): `ServiceType` - -#### Returns - -`ServiceType` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[service](templates.BaseTemplate.md#service) - -#### Defined in - -[src/keeper/contracts/defi/AaveCreditTemplate.ts:67](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCreditTemplate.ts#L67) - ---- - -### serviceEndpoint - -▸ **serviceEndpoint**(): `ServiceType` - -#### Returns - -`ServiceType` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[serviceEndpoint](templates.BaseTemplate.md#serviceendpoint) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:31](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L31) - ---- - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[setInstanceConfig](templates.BaseTemplate.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - ---- - -### standardContext - -▸ **standardContext**(`ddo`, `creator`): [`ConditionContext`](../interfaces/conditions.ConditionContext.md) - -#### Parameters - -| Name | Type | -| :-------- | :-------------- | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | - -#### Returns - -[`ConditionContext`](../interfaces/conditions.ConditionContext.md) - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[standardContext](templates.BaseTemplate.md#standardcontext) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:207](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L207) - ---- - -### validateAgreement - -▸ **validateAgreement**(`agreement_id`, `did`, `params`, `from`, `extra?`, `txparams?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------------- | :------------------------- | -| `agreement_id` | `string` | -| `did` | `string` | -| `params` | `AaveCreditTemplateParams` | -| `from` | [`Account`](Account.md) | -| `extra` | `any` | -| `txparams?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[validateAgreement](templates.BaseTemplate.md#validateagreement) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:131](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L131) - ---- - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[addressesStatic](templates.BaseTemplate.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - ---- - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[findSignerStatic](templates.BaseTemplate.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - ---- - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`AaveCreditTemplate`](templates.AaveCreditTemplate.md)\> - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`AaveCreditTemplate`](templates.AaveCreditTemplate.md)\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[getInstance](templates.BaseTemplate.md#getinstance) - -#### Defined in - -[src/keeper/contracts/defi/AaveCreditTemplate.ts:54](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/defi/AaveCreditTemplate.ts#L54) - ---- - -### 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 - -[BaseTemplate](templates.BaseTemplate.md).[setInstanceConfig](templates.BaseTemplate.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/api-reference/classes/templates.AccessTemplate.md b/docs/api-reference/classes/templates.AccessTemplate.md deleted file mode 100644 index b99e93dab..000000000 --- a/docs/api-reference/classes/templates.AccessTemplate.md +++ /dev/null @@ -1,1562 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [templates](../modules/templates.md) / AccessTemplate - -# Class: AccessTemplate - -[templates](../modules/templates.md).AccessTemplate - -## Hierarchy - -- [`BaseTemplate`](templates.BaseTemplate.md)<`AccessTemplateParams`, `ServiceAccess`\> - - ↳ **`AccessTemplate`** - -## Table of contents - -### Constructors - -- [constructor](templates.AccessTemplate.md#constructor) - -### Properties - -- [contract](templates.AccessTemplate.md#contract) -- [contractName](templates.AccessTemplate.md#contractname) -- [events](templates.AccessTemplate.md#events) -- [version](templates.AccessTemplate.md#version) - -### Accessors - -- [address](templates.AccessTemplate.md#address) -- [artifactsFolder](templates.AccessTemplate.md#artifactsfolder) -- [config](templates.AccessTemplate.md#config) -- [instanceConfig](templates.AccessTemplate.md#instanceconfig) -- [instantiableConfig](templates.AccessTemplate.md#instantiableconfig) -- [logger](templates.AccessTemplate.md#logger) -- [nevermined](templates.AccessTemplate.md#nevermined) -- [web3](templates.AccessTemplate.md#web3) - -### Methods - -- [accept](templates.AccessTemplate.md#accept) -- [addresses](templates.AccessTemplate.md#addresses) -- [agreementId](templates.AccessTemplate.md#agreementid) -- [call](templates.AccessTemplate.md#call) -- [checkExists](templates.AccessTemplate.md#checkexists) -- [conditions](templates.AccessTemplate.md#conditions) -- [createAgreement](templates.AccessTemplate.md#createagreement) -- [createAgreementAndPay](templates.AccessTemplate.md#createagreementandpay) -- [createAgreementFromDDO](templates.AccessTemplate.md#createagreementfromddo) -- [createAgreementWithPaymentFromDDO](templates.AccessTemplate.md#createagreementwithpaymentfromddo) -- [createService](templates.AccessTemplate.md#createservice) -- [description](templates.AccessTemplate.md#description) -- [extraGen](templates.AccessTemplate.md#extragen) -- [findSigner](templates.AccessTemplate.md#findsigner) -- [getAddress](templates.AccessTemplate.md#getaddress) -- [getAgreementCreatedEvent](templates.AccessTemplate.md#getagreementcreatedevent) -- [getAgreementData](templates.AccessTemplate.md#getagreementdata) -- [getAgreementIdsFromDDO](templates.AccessTemplate.md#getagreementidsfromddo) -- [getAgreementStatus](templates.AccessTemplate.md#getagreementstatus) -- [getAgreementsForDID](templates.AccessTemplate.md#getagreementsfordid) -- [getConditionTypes](templates.AccessTemplate.md#getconditiontypes) -- [getConditions](templates.AccessTemplate.md#getconditions) -- [getContract](templates.AccessTemplate.md#getcontract) -- [getFromAddress](templates.AccessTemplate.md#getfromaddress) -- [getInputsOfMethod](templates.AccessTemplate.md#getinputsofmethod) -- [getServiceAgreementTemplate](templates.AccessTemplate.md#getserviceagreementtemplate) -- [getServiceAgreementTemplateConditionByRef](templates.AccessTemplate.md#getserviceagreementtemplateconditionbyref) -- [getServiceAgreementTemplateConditions](templates.AccessTemplate.md#getserviceagreementtemplateconditions) -- [getServiceAgreementTemplateDependencies](templates.AccessTemplate.md#getserviceagreementtemplatedependencies) -- [getSignatureOfMethod](templates.AccessTemplate.md#getsignatureofmethod) -- [init](templates.AccessTemplate.md#init) -- [instanceFromDDO](templates.AccessTemplate.md#instancefromddo) -- [lockConditionIndex](templates.AccessTemplate.md#lockconditionindex) -- [lockTokens](templates.AccessTemplate.md#locktokens) -- [name](templates.AccessTemplate.md#name) -- [params](templates.AccessTemplate.md#params) -- [paramsGen](templates.AccessTemplate.md#paramsgen) -- [paymentData](templates.AccessTemplate.md#paymentdata) -- [printAgreementStatus](templates.AccessTemplate.md#printagreementstatus) -- [process](templates.AccessTemplate.md#process) -- [send](templates.AccessTemplate.md#send) -- [sendFrom](templates.AccessTemplate.md#sendfrom) -- [service](templates.AccessTemplate.md#service) -- [serviceEndpoint](templates.AccessTemplate.md#serviceendpoint) -- [setInstanceConfig](templates.AccessTemplate.md#setinstanceconfig) -- [standardContext](templates.AccessTemplate.md#standardcontext) -- [validateAgreement](templates.AccessTemplate.md#validateagreement) -- [addressesStatic](templates.AccessTemplate.md#addressesstatic) -- [findSignerStatic](templates.AccessTemplate.md#findsignerstatic) -- [getInstance](templates.AccessTemplate.md#getinstance) -- [setInstanceConfig](templates.AccessTemplate.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• `Protected` **new AccessTemplate**(`contractName`) - -#### Parameters - -| Name | Type | -| :------------- | :------- | -| `contractName` | `string` | - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[constructor](templates.BaseTemplate.md#constructor) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:75](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L75) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[contract](templates.BaseTemplate.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - ---- - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[contractName](templates.BaseTemplate.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - ---- - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[events](templates.BaseTemplate.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - ---- - -### version - -• **version**: `string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[version](templates.BaseTemplate.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -BaseTemplate.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - ---- - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -BaseTemplate.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - ---- - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -BaseTemplate.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - ---- - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -BaseTemplate.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - ---- - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -BaseTemplate.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - ---- - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -BaseTemplate.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - ---- - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -BaseTemplate.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - ---- - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -BaseTemplate.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### accept - -▸ **accept**(`params`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------- | :----------------- | -| `params` | `ValidationParams` | - -#### Returns - -`Promise`<`boolean`\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[accept](templates.BaseTemplate.md#accept) - -#### Defined in - -[src/keeper/contracts/templates/AccessTemplate.ts:112](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AccessTemplate.ts#L112) - ---- - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[addresses](templates.BaseTemplate.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - ---- - -### agreementId - -▸ **agreementId**(`agreementIdSeed`, `creator`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :---------------- | :------- | -| `agreementIdSeed` | `string` | -| `creator` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[agreementId](templates.BaseTemplate.md#agreementid) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:213](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L213) - ---- - -### 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 - -[BaseTemplate](templates.BaseTemplate.md).[call](templates.BaseTemplate.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - ---- - -### 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 - -[BaseTemplate](templates.BaseTemplate.md).[checkExists](templates.BaseTemplate.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - ---- - -### conditions - -▸ **conditions**(): [[`AccessCondition`](conditions.AccessCondition.md), [`LockPaymentCondition`](conditions.LockPaymentCondition.md), [`EscrowPaymentCondition`](conditions.EscrowPaymentCondition.md)] - -#### Returns - -[[`AccessCondition`](conditions.AccessCondition.md), [`LockPaymentCondition`](conditions.LockPaymentCondition.md), [`EscrowPaymentCondition`](conditions.EscrowPaymentCondition.md)] - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[conditions](templates.BaseTemplate.md#conditions) - -#### Defined in - -[src/keeper/contracts/templates/AccessTemplate.ts:62](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AccessTemplate.ts#L62) - ---- - -### 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`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreement](templates.BaseTemplate.md#createagreement) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L99) - ---- - -### 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`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementAndPay](templates.BaseTemplate.md#createagreementandpay) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:124](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L124) - ---- - -### 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.md) | DDO. | -| `parameters` | `AccessTemplateParams` | | -| `consumer` | [`Account`](Account.md) | - | -| `from` | [`Account`](Account.md) | - | -| `timeOuts?` | `number`[] | - | -| `params?` | `TxParameters` | - | - -#### Returns - -`Promise`<`string`\> - -true if the call was successful. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementFromDDO](templates.BaseTemplate.md#createagreementfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:225](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L225) - ---- - -### createAgreementWithPaymentFromDDO - -▸ **createAgreementWithPaymentFromDDO**(`agreementIdSeed`, `ddo`, `parameters`, `consumer`, `from`, `timeOuts?`, `txParams?`, `observer?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :---------------- | :------------------------------------- | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `parameters` | `AccessTemplateParams` | -| `consumer` | [`Account`](Account.md) | -| `from` | [`Account`](Account.md) | -| `timeOuts?` | `number`[] | -| `txParams?` | `TxParameters` | -| `observer?` | (`OrderProgressStep`: `any`) => `void` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementWithPaymentFromDDO](templates.BaseTemplate.md#createagreementwithpaymentfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:255](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L255) - ---- - -### createService - -▸ **createService**(`publisher`, `metadata`, `assetPrice?`, `erc20TokenAddress?`, `priced?`): `Promise`<`ServiceAccess`\> - -#### Parameters - -| Name | Type | Default value | -| :------------------- | :-------------------------------------- | :------------ | -| `publisher` | [`Account`](Account.md) | `undefined` | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | -| `assetPrice?` | `default` | `undefined` | -| `erc20TokenAddress?` | `string` | `undefined` | -| `priced` | `boolean` | `false` | - -#### Returns - -`Promise`<`ServiceAccess`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createService](templates.BaseTemplate.md#createservice) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:65](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L65) - ---- - -### description - -▸ **description**(): `string` - -#### Returns - -`string` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[description](templates.BaseTemplate.md#description) - -#### Defined in - -[src/keeper/contracts/templates/AccessTemplate.ts:35](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AccessTemplate.ts#L35) - ---- - -### extraGen - -▸ **extraGen**(`_params`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :-------- | :----------------- | -| `_params` | `ValidationParams` | - -#### Returns - -`Promise`<`any`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[extraGen](templates.BaseTemplate.md#extragen) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L108) - ---- - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[findSigner](templates.BaseTemplate.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - ---- - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAddress](templates.BaseTemplate.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - ---- - -### 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. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementCreatedEvent](templates.BaseTemplate.md#getagreementcreatedevent) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:469](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L469) - ---- - -### getAgreementData - -▸ **getAgreementData**(`agreementId`): `Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | - -#### Returns - -`Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementData](templates.BaseTemplate.md#getagreementdata) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:21](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L21) - ---- - -### getAgreementIdsFromDDO - -▸ **getAgreementIdsFromDDO**(`agreementId`, `ddo`, `creator`, `params`): `Promise`<`string`[]\> - -Get agreement conditions IDs. - -#### Parameters - -| Name | Type | Description | -| :------------ | :--------------------- | :------------ | -| `agreementId` | `string` | Agreement ID. | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `creator` | `string` | - | -| `params` | `AccessTemplateParams` | - | - -#### Returns - -`Promise`<`string`[]\> - -The condition IDs. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementIdsFromDDO](templates.BaseTemplate.md#getagreementidsfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:183](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L183) - ---- - -### getAgreementStatus - -▸ **getAgreementStatus**(`agreementId`): `Promise`<`false` \| [`AgreementConditionsStatus`](../interfaces/templates.AgreementConditionsStatus.md)\> - -Returns the status of the conditions. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------- | :------------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<`false` \| [`AgreementConditionsStatus`](../interfaces/templates.AgreementConditionsStatus.md)\> - -The conditions status. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementStatus](templates.BaseTemplate.md#getagreementstatus) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:343](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L343) - ---- - -### getAgreementsForDID - -▸ **getAgreementsForDID**(`did`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :---- | :------- | -| `did` | `string` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementsForDID](templates.BaseTemplate.md#getagreementsfordid) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:496](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L496) - ---- - -### getConditionTypes - -▸ **getConditionTypes**(): `Promise`<`string`[]\> - -Conditions address list. - -#### Returns - -`Promise`<`string`[]\> - -A list of condition addresses. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getConditionTypes](templates.BaseTemplate.md#getconditiontypes) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:163](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L163) - ---- - -### getConditions - -▸ **getConditions**(): `Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)[]\> - -List of condition contracts. - -#### Returns - -`Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)[]\> - -A list of condition contracts. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getConditions](templates.BaseTemplate.md#getconditions) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L171) - ---- - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getContract](templates.BaseTemplate.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - ---- - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getFromAddress](templates.BaseTemplate.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - ---- - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :----------- | :------- | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getInputsOfMethod](templates.BaseTemplate.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - ---- - -### getServiceAgreementTemplate - -▸ **getServiceAgreementTemplate**(): `Promise`<`ServiceAgreementTemplate`\> - -#### Returns - -`Promise`<`ServiceAgreementTemplate`\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplate](templates.BaseTemplate.md#getserviceagreementtemplate) - -#### Defined in - -[src/keeper/contracts/templates/AccessTemplate.ts:46](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AccessTemplate.ts#L46) - ---- - -### getServiceAgreementTemplateConditionByRef - -▸ **getServiceAgreementTemplateConditionByRef**(`ref`): `Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)\> - -#### Parameters - -| Name | Type | -| :---- | :------- | -| `ref` | `string` | - -#### Returns - -`Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateConditionByRef](templates.BaseTemplate.md#getserviceagreementtemplateconditionbyref) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:324](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L324) - ---- - -### getServiceAgreementTemplateConditions - -▸ **getServiceAgreementTemplateConditions**(): `Promise`<`ServiceAgreementTemplateCondition`[]\> - -#### Returns - -`Promise`<`ServiceAgreementTemplateCondition`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateConditions](templates.BaseTemplate.md#getserviceagreementtemplateconditions) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:319](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L319) - ---- - -### getServiceAgreementTemplateDependencies - -▸ **getServiceAgreementTemplateDependencies**(): `Promise`<{ `[condition: string]`: `string`[]; }\> - -#### Returns - -`Promise`<{ `[condition: string]`: `string`[]; }\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateDependencies](templates.BaseTemplate.md#getserviceagreementtemplatedependencies) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:333](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L333) - ---- - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :----------- | :------- | :------------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getSignatureOfMethod](templates.BaseTemplate.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - ---- - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :--------- | :------------------- | :------------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[init](templates.BaseTemplate.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - ---- - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementIdSeed`, `ddo`, `creator`, `parameters`): `Promise`<[`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`AccessTemplateParams`\>\> - -#### Parameters - -| Name | Type | -| :---------------- | :--------------------- | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | -| `parameters` | `AccessTemplateParams` | - -#### Returns - -`Promise`<[`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`AccessTemplateParams`\>\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[instanceFromDDO](templates.BaseTemplate.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/templates/AccessTemplate.ts:68](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AccessTemplate.ts#L68) - ---- - -### lockConditionIndex - -▸ **lockConditionIndex**(): `number` - -#### Returns - -`number` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[lockConditionIndex](templates.BaseTemplate.md#lockconditionindex) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L81) - ---- - -### lockTokens - -▸ **lockTokens**(`tokenAddress`, `amounts`, `from`, `txParams`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------------- | :---------------------- | -| `tokenAddress` | `any` | -| `amounts` | `any` | -| `from` | [`Account`](Account.md) | -| `txParams` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[lockTokens](templates.BaseTemplate.md#locktokens) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:398](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L398) - ---- - -### name - -▸ **name**(): `string` - -#### Returns - -`string` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[name](templates.BaseTemplate.md#name) - -#### Defined in - -[src/keeper/contracts/templates/AccessTemplate.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AccessTemplate.ts#L32) - ---- - -### params - -▸ **params**(`consumer`, `serviceType?`): `AccessTemplateParams` - -#### Parameters - -| Name | Type | Default value | -| :------------ | :---------------------- | :------------ | -| `consumer` | [`Account`](Account.md) | `undefined` | -| `serviceType` | `ServiceType` | `'access'` | - -#### Returns - -`AccessTemplateParams` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[params](templates.BaseTemplate.md#params) - -#### Defined in - -[src/keeper/contracts/templates/AccessTemplate.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AccessTemplate.ts#L50) - ---- - -### paramsGen - -▸ **paramsGen**(`__namedParameters`): `Promise`<`AccessTemplateParams`\> - -Specialize params - -#### Parameters - -| Name | Type | Description | -| :------------------ | :----------------- | :----------------- | -| `__namedParameters` | `ValidationParams` | Generic parameters | - -#### Returns - -`Promise`<`AccessTemplateParams`\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[paramsGen](templates.BaseTemplate.md#paramsgen) - -#### Defined in - -[src/keeper/contracts/templates/AccessTemplate.ts:22](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AccessTemplate.ts#L22) - ---- - -### paymentData - -▸ **paymentData**(`service`): [`PaymentData`](../interfaces/templates.PaymentData.md) - -#### Parameters - -| Name | Type | -| :-------- | :-------------- | -| `service` | `ServiceCommon` | - -#### Returns - -[`PaymentData`](../interfaces/templates.PaymentData.md) - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[paymentData](templates.BaseTemplate.md#paymentdata) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:85](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L85) - ---- - -### printAgreementStatus - -▸ **printAgreementStatus**(`agreementId`): `Promise`<`void`\> - -Prints the agreement status. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------- | :------------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[printAgreementStatus](templates.BaseTemplate.md#printagreementstatus) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:439](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L439) - ---- - -### process - -▸ **process**(`params`, `from`, `txparams?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :---------- | :---------------------- | -| `params` | `ValidationParams` | -| `from` | [`Account`](Account.md) | -| `txparams?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[process](templates.BaseTemplate.md#process) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:116](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L116) - ---- - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :------------- | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[send](templates.BaseTemplate.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - ---- - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :---------------------- | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[sendFrom](templates.BaseTemplate.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - ---- - -### service - -▸ **service**(): `ServiceType` - -#### Returns - -`ServiceType` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[service](templates.BaseTemplate.md#service) - -#### Defined in - -[src/keeper/contracts/templates/AccessTemplate.ts:42](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AccessTemplate.ts#L42) - ---- - -### serviceEndpoint - -▸ **serviceEndpoint**(): `ServiceType` - -#### Returns - -`ServiceType` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[serviceEndpoint](templates.BaseTemplate.md#serviceendpoint) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:31](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L31) - ---- - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[setInstanceConfig](templates.BaseTemplate.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - ---- - -### standardContext - -▸ **standardContext**(`ddo`, `creator`): [`ConditionContext`](../interfaces/conditions.ConditionContext.md) - -#### Parameters - -| Name | Type | -| :-------- | :-------------- | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | - -#### Returns - -[`ConditionContext`](../interfaces/conditions.ConditionContext.md) - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[standardContext](templates.BaseTemplate.md#standardcontext) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:207](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L207) - ---- - -### validateAgreement - -▸ **validateAgreement**(`agreement_id`, `did`, `params`, `from`, `extra?`, `txparams?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------------- | :---------------------- | -| `agreement_id` | `string` | -| `did` | `string` | -| `params` | `AccessTemplateParams` | -| `from` | [`Account`](Account.md) | -| `extra` | `any` | -| `txparams?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[validateAgreement](templates.BaseTemplate.md#validateagreement) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:131](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L131) - ---- - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[addressesStatic](templates.BaseTemplate.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - ---- - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[findSignerStatic](templates.BaseTemplate.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - ---- - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`AccessTemplate`](templates.AccessTemplate.md)\> - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`AccessTemplate`](templates.AccessTemplate.md)\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[getInstance](templates.BaseTemplate.md#getinstance) - -#### Defined in - -[src/keeper/contracts/templates/AccessTemplate.ts:38](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AccessTemplate.ts#L38) - ---- - -### 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 - -[BaseTemplate](templates.BaseTemplate.md).[setInstanceConfig](templates.BaseTemplate.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/api-reference/classes/templates.BaseTemplate.md b/docs/api-reference/classes/templates.BaseTemplate.md deleted file mode 100644 index 39ee460aa..000000000 --- a/docs/api-reference/classes/templates.BaseTemplate.md +++ /dev/null @@ -1,1594 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [templates](../modules/templates.md) / BaseTemplate - -# Class: BaseTemplate - -[templates](../modules/templates.md).BaseTemplate - -## Type parameters - -| Name | Type | -| :------- | :---------------- | -| `Params` | `Params` | -| `S` | extends `Service` | - -## Hierarchy - -- [`AgreementTemplate`](AgreementTemplate.md)<`Params`\> - - ↳ **`BaseTemplate`** - - ↳↳ [`AccessTemplate`](templates.AccessTemplate.md) - - ↳↳ [`EscrowComputeExecutionTemplate`](templates.EscrowComputeExecutionTemplate.md) - - ↳↳ [`DIDSalesTemplate`](templates.DIDSalesTemplate.md) - - ↳↳ [`NFTAccessTemplate`](templates.NFTAccessTemplate.md) - - ↳↳ [`NFT721AccessTemplate`](templates.NFT721AccessTemplate.md) - - ↳↳ [`NFTSalesTemplate`](templates.NFTSalesTemplate.md) - - ↳↳ [`NFT721SalesTemplate`](templates.NFT721SalesTemplate.md) - - ↳↳ [`AaveCreditTemplate`](templates.AaveCreditTemplate.md) - -## Implements - -- `ServicePlugin`<`S`\> - -## Table of contents - -### Constructors - -- [constructor](templates.BaseTemplate.md#constructor) - -### Properties - -- [contract](templates.BaseTemplate.md#contract) -- [contractName](templates.BaseTemplate.md#contractname) -- [events](templates.BaseTemplate.md#events) -- [version](templates.BaseTemplate.md#version) - -### Accessors - -- [address](templates.BaseTemplate.md#address) -- [artifactsFolder](templates.BaseTemplate.md#artifactsfolder) -- [config](templates.BaseTemplate.md#config) -- [instanceConfig](templates.BaseTemplate.md#instanceconfig) -- [instantiableConfig](templates.BaseTemplate.md#instantiableconfig) -- [logger](templates.BaseTemplate.md#logger) -- [nevermined](templates.BaseTemplate.md#nevermined) -- [web3](templates.BaseTemplate.md#web3) - -### Methods - -- [accept](templates.BaseTemplate.md#accept) -- [addresses](templates.BaseTemplate.md#addresses) -- [agreementId](templates.BaseTemplate.md#agreementid) -- [call](templates.BaseTemplate.md#call) -- [checkExists](templates.BaseTemplate.md#checkexists) -- [conditions](templates.BaseTemplate.md#conditions) -- [createAgreement](templates.BaseTemplate.md#createagreement) -- [createAgreementAndPay](templates.BaseTemplate.md#createagreementandpay) -- [createAgreementFromDDO](templates.BaseTemplate.md#createagreementfromddo) -- [createAgreementWithPaymentFromDDO](templates.BaseTemplate.md#createagreementwithpaymentfromddo) -- [createService](templates.BaseTemplate.md#createservice) -- [description](templates.BaseTemplate.md#description) -- [extraGen](templates.BaseTemplate.md#extragen) -- [findSigner](templates.BaseTemplate.md#findsigner) -- [getAddress](templates.BaseTemplate.md#getaddress) -- [getAgreementCreatedEvent](templates.BaseTemplate.md#getagreementcreatedevent) -- [getAgreementData](templates.BaseTemplate.md#getagreementdata) -- [getAgreementIdsFromDDO](templates.BaseTemplate.md#getagreementidsfromddo) -- [getAgreementStatus](templates.BaseTemplate.md#getagreementstatus) -- [getAgreementsForDID](templates.BaseTemplate.md#getagreementsfordid) -- [getConditionTypes](templates.BaseTemplate.md#getconditiontypes) -- [getConditions](templates.BaseTemplate.md#getconditions) -- [getContract](templates.BaseTemplate.md#getcontract) -- [getFromAddress](templates.BaseTemplate.md#getfromaddress) -- [getInputsOfMethod](templates.BaseTemplate.md#getinputsofmethod) -- [getPriced](templates.BaseTemplate.md#getpriced) -- [getServiceAgreementTemplate](templates.BaseTemplate.md#getserviceagreementtemplate) -- [getServiceAgreementTemplateConditionByRef](templates.BaseTemplate.md#getserviceagreementtemplateconditionbyref) -- [getServiceAgreementTemplateConditions](templates.BaseTemplate.md#getserviceagreementtemplateconditions) -- [getServiceAgreementTemplateDependencies](templates.BaseTemplate.md#getserviceagreementtemplatedependencies) -- [getSignatureOfMethod](templates.BaseTemplate.md#getsignatureofmethod) -- [init](templates.BaseTemplate.md#init) -- [instanceFromDDO](templates.BaseTemplate.md#instancefromddo) -- [lockConditionIndex](templates.BaseTemplate.md#lockconditionindex) -- [lockTokens](templates.BaseTemplate.md#locktokens) -- [name](templates.BaseTemplate.md#name) -- [params](templates.BaseTemplate.md#params) -- [paramsGen](templates.BaseTemplate.md#paramsgen) -- [paymentData](templates.BaseTemplate.md#paymentdata) -- [printAgreementStatus](templates.BaseTemplate.md#printagreementstatus) -- [process](templates.BaseTemplate.md#process) -- [send](templates.BaseTemplate.md#send) -- [sendFrom](templates.BaseTemplate.md#sendfrom) -- [service](templates.BaseTemplate.md#service) -- [serviceEndpoint](templates.BaseTemplate.md#serviceendpoint) -- [setInstanceConfig](templates.BaseTemplate.md#setinstanceconfig) -- [standardContext](templates.BaseTemplate.md#standardcontext) -- [validateAgreement](templates.BaseTemplate.md#validateagreement) -- [addressesStatic](templates.BaseTemplate.md#addressesstatic) -- [findSignerStatic](templates.BaseTemplate.md#findsignerstatic) -- [getInstance](templates.BaseTemplate.md#getinstance) -- [setInstanceConfig](templates.BaseTemplate.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• `Protected` **new BaseTemplate**<`Params`, `S`\>(`contractName`) - -#### Type parameters - -| Name | Type | -| :------- | :---------------------- | -| `Params` | `Params` | -| `S` | extends `ServiceCommon` | - -#### Parameters - -| Name | Type | -| :------------- | :------- | -| `contractName` | `string` | - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[constructor](AgreementTemplate.md#constructor) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:75](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L75) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[contract](AgreementTemplate.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - ---- - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[contractName](AgreementTemplate.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - ---- - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[events](AgreementTemplate.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - ---- - -### version - -• **version**: `string` - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[version](AgreementTemplate.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -AgreementTemplate.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - ---- - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -AgreementTemplate.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - ---- - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -AgreementTemplate.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - ---- - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -AgreementTemplate.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - ---- - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -AgreementTemplate.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - ---- - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -AgreementTemplate.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - ---- - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -AgreementTemplate.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - ---- - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -AgreementTemplate.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### accept - -▸ **accept**(`_params`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :-------- | :----------------- | -| `_params` | `ValidationParams` | - -#### Returns - -`Promise`<`boolean`\> - -#### Implementation of - -ServicePlugin.accept - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:112](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L112) - ---- - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[addresses](AgreementTemplate.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - ---- - -### agreementId - -▸ **agreementId**(`agreementIdSeed`, `creator`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :---------------- | :------- | -| `agreementIdSeed` | `string` | -| `creator` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[agreementId](AgreementTemplate.md#agreementid) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:213](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L213) - ---- - -### 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 - -[AgreementTemplate](AgreementTemplate.md).[call](AgreementTemplate.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - ---- - -### 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 - -[AgreementTemplate](AgreementTemplate.md).[checkExists](AgreementTemplate.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - ---- - -### conditions - -▸ `Abstract` **conditions**(): [`Condition`](Condition.md)<`any`, `any`\>[] - -#### Returns - -[`Condition`](Condition.md)<`any`, `any`\>[] - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:29](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L29) - ---- - -### 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`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[createAgreement](AgreementTemplate.md#createagreement) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L99) - ---- - -### 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`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[createAgreementAndPay](AgreementTemplate.md#createagreementandpay) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:124](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L124) - ---- - -### 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.md) | DDO. | -| `parameters` | `Params` | | -| `consumer` | [`Account`](Account.md) | - | -| `from` | [`Account`](Account.md) | - | -| `timeOuts?` | `number`[] | - | -| `params?` | `TxParameters` | - | - -#### Returns - -`Promise`<`string`\> - -true if the call was successful. - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[createAgreementFromDDO](AgreementTemplate.md#createagreementfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:225](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L225) - ---- - -### createAgreementWithPaymentFromDDO - -▸ **createAgreementWithPaymentFromDDO**(`agreementIdSeed`, `ddo`, `parameters`, `consumer`, `from`, `timeOuts?`, `txParams?`, `observer?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :---------------- | :------------------------------------- | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `parameters` | `Params` | -| `consumer` | [`Account`](Account.md) | -| `from` | [`Account`](Account.md) | -| `timeOuts?` | `number`[] | -| `txParams?` | `TxParameters` | -| `observer?` | (`OrderProgressStep`: `any`) => `void` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[createAgreementWithPaymentFromDDO](AgreementTemplate.md#createagreementwithpaymentfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:255](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L255) - ---- - -### createService - -▸ **createService**(`publisher`, `metadata`, `assetPrice?`, `erc20TokenAddress?`, `priced?`): `Promise`<`S`\> - -#### Parameters - -| Name | Type | Default value | -| :------------------- | :-------------------------------------- | :------------ | -| `publisher` | [`Account`](Account.md) | `undefined` | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | -| `assetPrice?` | `default` | `undefined` | -| `erc20TokenAddress?` | `string` | `undefined` | -| `priced` | `boolean` | `false` | - -#### Returns - -`Promise`<`S`\> - -#### Implementation of - -ServicePlugin.createService - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:65](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L65) - ---- - -### description - -▸ `Abstract` **description**(): `string` - -#### Returns - -`string` - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L28) - ---- - -### extraGen - -▸ **extraGen**(`_params`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :-------- | :----------------- | -| `_params` | `ValidationParams` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L108) - ---- - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[findSigner](AgreementTemplate.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - ---- - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[getAddress](AgreementTemplate.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - ---- - -### 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. - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[getAgreementCreatedEvent](AgreementTemplate.md#getagreementcreatedevent) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:469](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L469) - ---- - -### getAgreementData - -▸ **getAgreementData**(`agreementId`): `Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | - -#### Returns - -`Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:21](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L21) - ---- - -### getAgreementIdsFromDDO - -▸ **getAgreementIdsFromDDO**(`agreementId`, `ddo`, `creator`, `params`): `Promise`<`string`[]\> - -Get agreement conditions IDs. - -#### Parameters - -| Name | Type | Description | -| :------------ | :-------------- | :------------ | -| `agreementId` | `string` | Agreement ID. | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `creator` | `string` | - | -| `params` | `Params` | - | - -#### Returns - -`Promise`<`string`[]\> - -The condition IDs. - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[getAgreementIdsFromDDO](AgreementTemplate.md#getagreementidsfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:183](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L183) - ---- - -### getAgreementStatus - -▸ **getAgreementStatus**(`agreementId`): `Promise`<`false` \| [`AgreementConditionsStatus`](../interfaces/templates.AgreementConditionsStatus.md)\> - -Returns the status of the conditions. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------- | :------------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<`false` \| [`AgreementConditionsStatus`](../interfaces/templates.AgreementConditionsStatus.md)\> - -The conditions status. - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[getAgreementStatus](AgreementTemplate.md#getagreementstatus) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:343](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L343) - ---- - -### getAgreementsForDID - -▸ **getAgreementsForDID**(`did`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :---- | :------- | -| `did` | `string` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[getAgreementsForDID](AgreementTemplate.md#getagreementsfordid) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:496](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L496) - ---- - -### getConditionTypes - -▸ **getConditionTypes**(): `Promise`<`string`[]\> - -Conditions address list. - -#### Returns - -`Promise`<`string`[]\> - -A list of condition addresses. - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[getConditionTypes](AgreementTemplate.md#getconditiontypes) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:163](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L163) - ---- - -### getConditions - -▸ **getConditions**(): `Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)[]\> - -List of condition contracts. - -#### Returns - -`Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)[]\> - -A list of condition contracts. - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[getConditions](AgreementTemplate.md#getconditions) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L171) - ---- - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[getContract](AgreementTemplate.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - ---- - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[getFromAddress](AgreementTemplate.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - ---- - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :----------- | :------- | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[getInputsOfMethod](AgreementTemplate.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - ---- - -### getPriced - -▸ `Private` **getPriced**(`assetPrice`, `erc20TokenAddress`): `Promise`<`Priced`\> - -#### Parameters - -| Name | Type | -| :------------------ | :-------- | -| `assetPrice` | `default` | -| `erc20TokenAddress` | `string` | - -#### Returns - -`Promise`<`Priced`\> - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L35) - ---- - -### getServiceAgreementTemplate - -▸ `Abstract` **getServiceAgreementTemplate**(): `Promise`<`ServiceAgreementTemplate`\> - -#### Returns - -`Promise`<`ServiceAgreementTemplate`\> - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[getServiceAgreementTemplate](AgreementTemplate.md#getserviceagreementtemplate) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:317](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L317) - ---- - -### getServiceAgreementTemplateConditionByRef - -▸ **getServiceAgreementTemplateConditionByRef**(`ref`): `Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)\> - -#### Parameters - -| Name | Type | -| :---- | :------- | -| `ref` | `string` | - -#### Returns - -`Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)\> - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[getServiceAgreementTemplateConditionByRef](AgreementTemplate.md#getserviceagreementtemplateconditionbyref) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:324](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L324) - ---- - -### getServiceAgreementTemplateConditions - -▸ **getServiceAgreementTemplateConditions**(): `Promise`<`ServiceAgreementTemplateCondition`[]\> - -#### Returns - -`Promise`<`ServiceAgreementTemplateCondition`[]\> - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[getServiceAgreementTemplateConditions](AgreementTemplate.md#getserviceagreementtemplateconditions) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:319](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L319) - ---- - -### getServiceAgreementTemplateDependencies - -▸ **getServiceAgreementTemplateDependencies**(): `Promise`<{ `[condition: string]`: `string`[]; }\> - -#### Returns - -`Promise`<{ `[condition: string]`: `string`[]; }\> - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[getServiceAgreementTemplateDependencies](AgreementTemplate.md#getserviceagreementtemplatedependencies) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:333](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L333) - ---- - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :----------- | :------- | :------------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[getSignatureOfMethod](AgreementTemplate.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - ---- - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :--------- | :------------------- | :------------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[init](AgreementTemplate.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - ---- - -### instanceFromDDO - -▸ `Optional` `Abstract` **instanceFromDDO**(`agreementIdSeed`, `ddo`, `creator`, `parameters`): `Promise`<[`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`Params`\>\> - -#### Parameters - -| Name | Type | -| :---------------- | :-------------- | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | -| `parameters` | `Params` | - -#### Returns - -`Promise`<[`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`Params`\>\> - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[instanceFromDDO](AgreementTemplate.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:198](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L198) - ---- - -### lockConditionIndex - -▸ **lockConditionIndex**(): `number` - -#### Returns - -`number` - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[lockConditionIndex](AgreementTemplate.md#lockconditionindex) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L81) - ---- - -### lockTokens - -▸ **lockTokens**(`tokenAddress`, `amounts`, `from`, `txParams`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------------- | :---------------------- | -| `tokenAddress` | `any` | -| `amounts` | `any` | -| `from` | [`Account`](Account.md) | -| `txParams` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[lockTokens](AgreementTemplate.md#locktokens) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:398](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L398) - ---- - -### name - -▸ `Abstract` **name**(): `string` - -#### Returns - -`string` - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:27](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L27) - ---- - -### params - -▸ `Abstract` **params**(...`args`): `Params` - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`Params` - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[params](AgreementTemplate.md#params) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:79](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L79) - ---- - -### paramsGen - -▸ `Abstract` **paramsGen**(`params`): `Promise`<`Params`\> - -Specialize params - -#### Parameters - -| Name | Type | Description | -| :------- | :----------------- | :----------------- | -| `params` | `ValidationParams` | Generic parameters | - -#### Returns - -`Promise`<`Params`\> - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:106](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L106) - ---- - -### paymentData - -▸ **paymentData**(`service`): [`PaymentData`](../interfaces/templates.PaymentData.md) - -#### Parameters - -| Name | Type | -| :-------- | :-------------- | -| `service` | `ServiceCommon` | - -#### Returns - -[`PaymentData`](../interfaces/templates.PaymentData.md) - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[paymentData](AgreementTemplate.md#paymentdata) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:85](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L85) - ---- - -### printAgreementStatus - -▸ **printAgreementStatus**(`agreementId`): `Promise`<`void`\> - -Prints the agreement status. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------- | :------------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[printAgreementStatus](AgreementTemplate.md#printagreementstatus) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:439](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L439) - ---- - -### process - -▸ **process**(`params`, `from`, `txparams?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :---------- | :---------------------- | -| `params` | `ValidationParams` | -| `from` | [`Account`](Account.md) | -| `txparams?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Implementation of - -ServicePlugin.process - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:116](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L116) - ---- - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :------------- | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[send](AgreementTemplate.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - ---- - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :---------------------- | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[sendFrom](AgreementTemplate.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - ---- - -### service - -▸ `Abstract` **service**(): `ServiceType` - -#### Returns - -`ServiceType` - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[service](AgreementTemplate.md#service) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:205](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L205) - ---- - -### serviceEndpoint - -▸ **serviceEndpoint**(): `ServiceType` - -#### Returns - -`ServiceType` - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:31](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L31) - ---- - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[setInstanceConfig](AgreementTemplate.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - ---- - -### standardContext - -▸ **standardContext**(`ddo`, `creator`): [`ConditionContext`](../interfaces/conditions.ConditionContext.md) - -#### Parameters - -| Name | Type | -| :-------- | :-------------- | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | - -#### Returns - -[`ConditionContext`](../interfaces/conditions.ConditionContext.md) - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[standardContext](AgreementTemplate.md#standardcontext) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:207](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L207) - ---- - -### validateAgreement - -▸ **validateAgreement**(`agreement_id`, `did`, `params`, `from`, `extra?`, `txparams?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------------- | :---------------------- | -| `agreement_id` | `string` | -| `did` | `string` | -| `params` | `Params` | -| `from` | [`Account`](Account.md) | -| `extra` | `any` | -| `txparams?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:131](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L131) - ---- - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[addressesStatic](AgreementTemplate.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - ---- - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[findSignerStatic](AgreementTemplate.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - ---- - -### 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`\> - -#### Inherited from - -[AgreementTemplate](AgreementTemplate.md).[getInstance](AgreementTemplate.md#getinstance) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:62](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L62) - ---- - -### 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 - -[AgreementTemplate](AgreementTemplate.md).[setInstanceConfig](AgreementTemplate.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/api-reference/classes/templates.DIDSalesTemplate.md b/docs/api-reference/classes/templates.DIDSalesTemplate.md deleted file mode 100644 index 1738260d2..000000000 --- a/docs/api-reference/classes/templates.DIDSalesTemplate.md +++ /dev/null @@ -1,1561 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [templates](../modules/templates.md) / DIDSalesTemplate - -# Class: DIDSalesTemplate - -[templates](../modules/templates.md).DIDSalesTemplate - -## Hierarchy - -- [`BaseTemplate`](templates.BaseTemplate.md)<`DIDSalesTemplateParams`, `any`\> - - ↳ **`DIDSalesTemplate`** - -## Table of contents - -### Constructors - -- [constructor](templates.DIDSalesTemplate.md#constructor) - -### Properties - -- [contract](templates.DIDSalesTemplate.md#contract) -- [contractName](templates.DIDSalesTemplate.md#contractname) -- [events](templates.DIDSalesTemplate.md#events) -- [version](templates.DIDSalesTemplate.md#version) - -### Accessors - -- [address](templates.DIDSalesTemplate.md#address) -- [artifactsFolder](templates.DIDSalesTemplate.md#artifactsfolder) -- [config](templates.DIDSalesTemplate.md#config) -- [instanceConfig](templates.DIDSalesTemplate.md#instanceconfig) -- [instantiableConfig](templates.DIDSalesTemplate.md#instantiableconfig) -- [logger](templates.DIDSalesTemplate.md#logger) -- [nevermined](templates.DIDSalesTemplate.md#nevermined) -- [web3](templates.DIDSalesTemplate.md#web3) - -### Methods - -- [accept](templates.DIDSalesTemplate.md#accept) -- [addresses](templates.DIDSalesTemplate.md#addresses) -- [agreementId](templates.DIDSalesTemplate.md#agreementid) -- [call](templates.DIDSalesTemplate.md#call) -- [checkExists](templates.DIDSalesTemplate.md#checkexists) -- [conditions](templates.DIDSalesTemplate.md#conditions) -- [createAgreement](templates.DIDSalesTemplate.md#createagreement) -- [createAgreementAndPay](templates.DIDSalesTemplate.md#createagreementandpay) -- [createAgreementFromDDO](templates.DIDSalesTemplate.md#createagreementfromddo) -- [createAgreementWithPaymentFromDDO](templates.DIDSalesTemplate.md#createagreementwithpaymentfromddo) -- [createService](templates.DIDSalesTemplate.md#createservice) -- [description](templates.DIDSalesTemplate.md#description) -- [extraGen](templates.DIDSalesTemplate.md#extragen) -- [findSigner](templates.DIDSalesTemplate.md#findsigner) -- [getAddress](templates.DIDSalesTemplate.md#getaddress) -- [getAgreementCreatedEvent](templates.DIDSalesTemplate.md#getagreementcreatedevent) -- [getAgreementData](templates.DIDSalesTemplate.md#getagreementdata) -- [getAgreementIdsFromDDO](templates.DIDSalesTemplate.md#getagreementidsfromddo) -- [getAgreementStatus](templates.DIDSalesTemplate.md#getagreementstatus) -- [getAgreementsForDID](templates.DIDSalesTemplate.md#getagreementsfordid) -- [getConditionTypes](templates.DIDSalesTemplate.md#getconditiontypes) -- [getConditions](templates.DIDSalesTemplate.md#getconditions) -- [getContract](templates.DIDSalesTemplate.md#getcontract) -- [getFromAddress](templates.DIDSalesTemplate.md#getfromaddress) -- [getInputsOfMethod](templates.DIDSalesTemplate.md#getinputsofmethod) -- [getServiceAgreementTemplate](templates.DIDSalesTemplate.md#getserviceagreementtemplate) -- [getServiceAgreementTemplateConditionByRef](templates.DIDSalesTemplate.md#getserviceagreementtemplateconditionbyref) -- [getServiceAgreementTemplateConditions](templates.DIDSalesTemplate.md#getserviceagreementtemplateconditions) -- [getServiceAgreementTemplateDependencies](templates.DIDSalesTemplate.md#getserviceagreementtemplatedependencies) -- [getSignatureOfMethod](templates.DIDSalesTemplate.md#getsignatureofmethod) -- [init](templates.DIDSalesTemplate.md#init) -- [instanceFromDDO](templates.DIDSalesTemplate.md#instancefromddo) -- [lockConditionIndex](templates.DIDSalesTemplate.md#lockconditionindex) -- [lockTokens](templates.DIDSalesTemplate.md#locktokens) -- [name](templates.DIDSalesTemplate.md#name) -- [params](templates.DIDSalesTemplate.md#params) -- [paramsGen](templates.DIDSalesTemplate.md#paramsgen) -- [paymentData](templates.DIDSalesTemplate.md#paymentdata) -- [printAgreementStatus](templates.DIDSalesTemplate.md#printagreementstatus) -- [process](templates.DIDSalesTemplate.md#process) -- [send](templates.DIDSalesTemplate.md#send) -- [sendFrom](templates.DIDSalesTemplate.md#sendfrom) -- [service](templates.DIDSalesTemplate.md#service) -- [serviceEndpoint](templates.DIDSalesTemplate.md#serviceendpoint) -- [setInstanceConfig](templates.DIDSalesTemplate.md#setinstanceconfig) -- [standardContext](templates.DIDSalesTemplate.md#standardcontext) -- [validateAgreement](templates.DIDSalesTemplate.md#validateagreement) -- [addressesStatic](templates.DIDSalesTemplate.md#addressesstatic) -- [findSignerStatic](templates.DIDSalesTemplate.md#findsignerstatic) -- [getInstance](templates.DIDSalesTemplate.md#getinstance) -- [setInstanceConfig](templates.DIDSalesTemplate.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• `Protected` **new DIDSalesTemplate**(`contractName`) - -#### Parameters - -| Name | Type | -| :------------- | :------- | -| `contractName` | `string` | - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[constructor](templates.BaseTemplate.md#constructor) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:75](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L75) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[contract](templates.BaseTemplate.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - ---- - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[contractName](templates.BaseTemplate.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - ---- - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[events](templates.BaseTemplate.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - ---- - -### version - -• **version**: `string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[version](templates.BaseTemplate.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -BaseTemplate.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - ---- - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -BaseTemplate.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - ---- - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -BaseTemplate.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - ---- - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -BaseTemplate.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - ---- - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -BaseTemplate.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - ---- - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -BaseTemplate.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - ---- - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -BaseTemplate.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - ---- - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -BaseTemplate.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### accept - -▸ **accept**(`_params`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :-------- | :----------------- | -| `_params` | `ValidationParams` | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[accept](templates.BaseTemplate.md#accept) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:112](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L112) - ---- - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[addresses](templates.BaseTemplate.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - ---- - -### agreementId - -▸ **agreementId**(`agreementIdSeed`, `creator`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :---------------- | :------- | -| `agreementIdSeed` | `string` | -| `creator` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[agreementId](templates.BaseTemplate.md#agreementid) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:213](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L213) - ---- - -### 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 - -[BaseTemplate](templates.BaseTemplate.md).[call](templates.BaseTemplate.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - ---- - -### 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 - -[BaseTemplate](templates.BaseTemplate.md).[checkExists](templates.BaseTemplate.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - ---- - -### conditions - -▸ **conditions**(): [[`LockPaymentCondition`](conditions.LockPaymentCondition.md), [`TransferDIDOwnershipCondition`](conditions.TransferDIDOwnershipCondition.md), [`EscrowPaymentCondition`](conditions.EscrowPaymentCondition.md)] - -#### Returns - -[[`LockPaymentCondition`](conditions.LockPaymentCondition.md), [`TransferDIDOwnershipCondition`](conditions.TransferDIDOwnershipCondition.md), [`EscrowPaymentCondition`](conditions.EscrowPaymentCondition.md)] - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[conditions](templates.BaseTemplate.md#conditions) - -#### Defined in - -[src/keeper/contracts/templates/DIDSalesTemplate.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/DIDSalesTemplate.ts#L33) - ---- - -### 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`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreement](templates.BaseTemplate.md#createagreement) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L99) - ---- - -### 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`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementAndPay](templates.BaseTemplate.md#createagreementandpay) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:124](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L124) - ---- - -### 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.md) | DDO. | -| `parameters` | `DIDSalesTemplateParams` | | -| `consumer` | [`Account`](Account.md) | - | -| `from` | [`Account`](Account.md) | - | -| `timeOuts?` | `number`[] | - | -| `params?` | `TxParameters` | - | - -#### Returns - -`Promise`<`string`\> - -true if the call was successful. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementFromDDO](templates.BaseTemplate.md#createagreementfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:225](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L225) - ---- - -### createAgreementWithPaymentFromDDO - -▸ **createAgreementWithPaymentFromDDO**(`agreementIdSeed`, `ddo`, `parameters`, `consumer`, `from`, `timeOuts?`, `txParams?`, `observer?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :---------------- | :------------------------------------- | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `parameters` | `DIDSalesTemplateParams` | -| `consumer` | [`Account`](Account.md) | -| `from` | [`Account`](Account.md) | -| `timeOuts?` | `number`[] | -| `txParams?` | `TxParameters` | -| `observer?` | (`OrderProgressStep`: `any`) => `void` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementWithPaymentFromDDO](templates.BaseTemplate.md#createagreementwithpaymentfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:255](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L255) - ---- - -### createService - -▸ **createService**(`publisher`, `metadata`, `assetPrice?`, `erc20TokenAddress?`, `priced?`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | Default value | -| :------------------- | :-------------------------------------- | :------------ | -| `publisher` | [`Account`](Account.md) | `undefined` | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | -| `assetPrice?` | `default` | `undefined` | -| `erc20TokenAddress?` | `string` | `undefined` | -| `priced` | `boolean` | `false` | - -#### Returns - -`Promise`<`any`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createService](templates.BaseTemplate.md#createservice) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:65](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L65) - ---- - -### description - -▸ **description**(): `string` - -#### Returns - -`string` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[description](templates.BaseTemplate.md#description) - -#### Defined in - -[src/keeper/contracts/templates/DIDSalesTemplate.ts:29](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/DIDSalesTemplate.ts#L29) - ---- - -### extraGen - -▸ **extraGen**(`_params`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :-------- | :----------------- | -| `_params` | `ValidationParams` | - -#### Returns - -`Promise`<`any`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[extraGen](templates.BaseTemplate.md#extragen) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L108) - ---- - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[findSigner](templates.BaseTemplate.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - ---- - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAddress](templates.BaseTemplate.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - ---- - -### 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. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementCreatedEvent](templates.BaseTemplate.md#getagreementcreatedevent) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:469](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L469) - ---- - -### getAgreementData - -▸ **getAgreementData**(`agreementId`): `Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | - -#### Returns - -`Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementData](templates.BaseTemplate.md#getagreementdata) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:21](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L21) - ---- - -### getAgreementIdsFromDDO - -▸ **getAgreementIdsFromDDO**(`agreementId`, `ddo`, `creator`, `params`): `Promise`<`string`[]\> - -Get agreement conditions IDs. - -#### Parameters - -| Name | Type | Description | -| :------------ | :----------------------- | :------------ | -| `agreementId` | `string` | Agreement ID. | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `creator` | `string` | - | -| `params` | `DIDSalesTemplateParams` | - | - -#### Returns - -`Promise`<`string`[]\> - -The condition IDs. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementIdsFromDDO](templates.BaseTemplate.md#getagreementidsfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:183](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L183) - ---- - -### getAgreementStatus - -▸ **getAgreementStatus**(`agreementId`): `Promise`<`false` \| [`AgreementConditionsStatus`](../interfaces/templates.AgreementConditionsStatus.md)\> - -Returns the status of the conditions. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------- | :------------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<`false` \| [`AgreementConditionsStatus`](../interfaces/templates.AgreementConditionsStatus.md)\> - -The conditions status. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementStatus](templates.BaseTemplate.md#getagreementstatus) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:343](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L343) - ---- - -### getAgreementsForDID - -▸ **getAgreementsForDID**(`did`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :---- | :------- | -| `did` | `string` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementsForDID](templates.BaseTemplate.md#getagreementsfordid) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:496](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L496) - ---- - -### getConditionTypes - -▸ **getConditionTypes**(): `Promise`<`string`[]\> - -Conditions address list. - -#### Returns - -`Promise`<`string`[]\> - -A list of condition addresses. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getConditionTypes](templates.BaseTemplate.md#getconditiontypes) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:163](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L163) - ---- - -### getConditions - -▸ **getConditions**(): `Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)[]\> - -List of condition contracts. - -#### Returns - -`Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)[]\> - -A list of condition contracts. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getConditions](templates.BaseTemplate.md#getconditions) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L171) - ---- - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getContract](templates.BaseTemplate.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - ---- - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getFromAddress](templates.BaseTemplate.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - ---- - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :----------- | :------- | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getInputsOfMethod](templates.BaseTemplate.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - ---- - -### getServiceAgreementTemplate - -▸ **getServiceAgreementTemplate**(): `Promise`<`ServiceAgreementTemplate`\> - -#### Returns - -`Promise`<`ServiceAgreementTemplate`\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplate](templates.BaseTemplate.md#getserviceagreementtemplate) - -#### Defined in - -[src/keeper/contracts/templates/DIDSalesTemplate.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/DIDSalesTemplate.ts#L105) - ---- - -### getServiceAgreementTemplateConditionByRef - -▸ **getServiceAgreementTemplateConditionByRef**(`ref`): `Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)\> - -#### Parameters - -| Name | Type | -| :---- | :------- | -| `ref` | `string` | - -#### Returns - -`Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateConditionByRef](templates.BaseTemplate.md#getserviceagreementtemplateconditionbyref) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:324](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L324) - ---- - -### getServiceAgreementTemplateConditions - -▸ **getServiceAgreementTemplateConditions**(): `Promise`<`ServiceAgreementTemplateCondition`[]\> - -#### Returns - -`Promise`<`ServiceAgreementTemplateCondition`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateConditions](templates.BaseTemplate.md#getserviceagreementtemplateconditions) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:319](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L319) - ---- - -### getServiceAgreementTemplateDependencies - -▸ **getServiceAgreementTemplateDependencies**(): `Promise`<{ `[condition: string]`: `string`[]; }\> - -#### Returns - -`Promise`<{ `[condition: string]`: `string`[]; }\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateDependencies](templates.BaseTemplate.md#getserviceagreementtemplatedependencies) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:333](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L333) - ---- - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :----------- | :------- | :------------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getSignatureOfMethod](templates.BaseTemplate.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - ---- - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :--------- | :------------------- | :------------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[init](templates.BaseTemplate.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - ---- - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementIdSeed`, `ddo`, `creator`, `parameters`): `Promise`<[`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`DIDSalesTemplateParams`\>\> - -#### Parameters - -| Name | Type | -| :---------------- | :----------------------- | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | -| `parameters` | `DIDSalesTemplateParams` | - -#### Returns - -`Promise`<[`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`DIDSalesTemplateParams`\>\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[instanceFromDDO](templates.BaseTemplate.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/templates/DIDSalesTemplate.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/DIDSalesTemplate.ts#L50) - ---- - -### lockConditionIndex - -▸ **lockConditionIndex**(): `number` - -#### Returns - -`number` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[lockConditionIndex](templates.BaseTemplate.md#lockconditionindex) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L81) - ---- - -### lockTokens - -▸ **lockTokens**(`tokenAddress`, `amounts`, `from`, `txParams`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------------- | :---------------------- | -| `tokenAddress` | `any` | -| `amounts` | `any` | -| `from` | [`Account`](Account.md) | -| `txParams` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[lockTokens](templates.BaseTemplate.md#locktokens) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:398](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L398) - ---- - -### name - -▸ **name**(): `string` - -#### Returns - -`string` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[name](templates.BaseTemplate.md#name) - -#### Defined in - -[src/keeper/contracts/templates/DIDSalesTemplate.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/DIDSalesTemplate.ts#L26) - ---- - -### params - -▸ **params**(`receiverId`): `DIDSalesTemplateParams` - -#### Parameters - -| Name | Type | -| :----------- | :------- | -| `receiverId` | `string` | - -#### Returns - -`DIDSalesTemplateParams` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[params](templates.BaseTemplate.md#params) - -#### Defined in - -[src/keeper/contracts/templates/DIDSalesTemplate.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/DIDSalesTemplate.ts#L23) - ---- - -### paramsGen - -▸ **paramsGen**(`params`): `Promise`<`DIDSalesTemplateParams`\> - -Specialize params - -#### Parameters - -| Name | Type | Description | -| :------- | :----------------- | :----------------- | -| `params` | `ValidationParams` | Generic parameters | - -#### Returns - -`Promise`<`DIDSalesTemplateParams`\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[paramsGen](templates.BaseTemplate.md#paramsgen) - -#### Defined in - -[src/keeper/contracts/templates/DIDSalesTemplate.ts:20](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/DIDSalesTemplate.ts#L20) - ---- - -### paymentData - -▸ **paymentData**(`service`): [`PaymentData`](../interfaces/templates.PaymentData.md) - -#### Parameters - -| Name | Type | -| :-------- | :-------------- | -| `service` | `ServiceCommon` | - -#### Returns - -[`PaymentData`](../interfaces/templates.PaymentData.md) - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[paymentData](templates.BaseTemplate.md#paymentdata) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:85](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L85) - ---- - -### printAgreementStatus - -▸ **printAgreementStatus**(`agreementId`): `Promise`<`void`\> - -Prints the agreement status. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------- | :------------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[printAgreementStatus](templates.BaseTemplate.md#printagreementstatus) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:439](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L439) - ---- - -### process - -▸ **process**(`params`, `from`, `txparams?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :---------- | :---------------------- | -| `params` | `ValidationParams` | -| `from` | [`Account`](Account.md) | -| `txparams?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[process](templates.BaseTemplate.md#process) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:116](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L116) - ---- - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :------------- | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[send](templates.BaseTemplate.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - ---- - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :---------------------- | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[sendFrom](templates.BaseTemplate.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - ---- - -### service - -▸ **service**(): `ServiceType` - -#### Returns - -`ServiceType` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[service](templates.BaseTemplate.md#service) - -#### Defined in - -[src/keeper/contracts/templates/DIDSalesTemplate.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/DIDSalesTemplate.ts#L96) - ---- - -### serviceEndpoint - -▸ **serviceEndpoint**(): `ServiceType` - -#### Returns - -`ServiceType` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[serviceEndpoint](templates.BaseTemplate.md#serviceendpoint) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:31](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L31) - ---- - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[setInstanceConfig](templates.BaseTemplate.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - ---- - -### standardContext - -▸ **standardContext**(`ddo`, `creator`): [`ConditionContext`](../interfaces/conditions.ConditionContext.md) - -#### Parameters - -| Name | Type | -| :-------- | :-------------- | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | - -#### Returns - -[`ConditionContext`](../interfaces/conditions.ConditionContext.md) - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[standardContext](templates.BaseTemplate.md#standardcontext) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:207](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L207) - ---- - -### validateAgreement - -▸ **validateAgreement**(`agreement_id`, `did`, `params`, `from`, `extra?`, `txparams?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------------- | :----------------------- | -| `agreement_id` | `string` | -| `did` | `string` | -| `params` | `DIDSalesTemplateParams` | -| `from` | [`Account`](Account.md) | -| `extra` | `any` | -| `txparams?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[validateAgreement](templates.BaseTemplate.md#validateagreement) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:131](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L131) - ---- - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[addressesStatic](templates.BaseTemplate.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - ---- - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[findSignerStatic](templates.BaseTemplate.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - ---- - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`DIDSalesTemplate`](templates.DIDSalesTemplate.md)\> - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`DIDSalesTemplate`](templates.DIDSalesTemplate.md)\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[getInstance](templates.BaseTemplate.md#getinstance) - -#### Defined in - -[src/keeper/contracts/templates/DIDSalesTemplate.ts:99](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/DIDSalesTemplate.ts#L99) - ---- - -### 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 - -[BaseTemplate](templates.BaseTemplate.md).[setInstanceConfig](templates.BaseTemplate.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/api-reference/classes/templates.EscrowComputeExecutionTemplate.md b/docs/api-reference/classes/templates.EscrowComputeExecutionTemplate.md deleted file mode 100644 index 55840a4ad..000000000 --- a/docs/api-reference/classes/templates.EscrowComputeExecutionTemplate.md +++ /dev/null @@ -1,1576 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [templates](../modules/templates.md) / EscrowComputeExecutionTemplate - -# Class: EscrowComputeExecutionTemplate - -[templates](../modules/templates.md).EscrowComputeExecutionTemplate - -## Hierarchy - -- [`BaseTemplate`](templates.BaseTemplate.md)<`EscrowComputeExecutionParams`, `ServiceCompute`\> - - ↳ **`EscrowComputeExecutionTemplate`** - -## Table of contents - -### Constructors - -- [constructor](templates.EscrowComputeExecutionTemplate.md#constructor) - -### Properties - -- [contract](templates.EscrowComputeExecutionTemplate.md#contract) -- [contractName](templates.EscrowComputeExecutionTemplate.md#contractname) -- [events](templates.EscrowComputeExecutionTemplate.md#events) -- [version](templates.EscrowComputeExecutionTemplate.md#version) - -### Accessors - -- [address](templates.EscrowComputeExecutionTemplate.md#address) -- [artifactsFolder](templates.EscrowComputeExecutionTemplate.md#artifactsfolder) -- [config](templates.EscrowComputeExecutionTemplate.md#config) -- [instanceConfig](templates.EscrowComputeExecutionTemplate.md#instanceconfig) -- [instantiableConfig](templates.EscrowComputeExecutionTemplate.md#instantiableconfig) -- [logger](templates.EscrowComputeExecutionTemplate.md#logger) -- [nevermined](templates.EscrowComputeExecutionTemplate.md#nevermined) -- [web3](templates.EscrowComputeExecutionTemplate.md#web3) - -### Methods - -- [accept](templates.EscrowComputeExecutionTemplate.md#accept) -- [addresses](templates.EscrowComputeExecutionTemplate.md#addresses) -- [agreementId](templates.EscrowComputeExecutionTemplate.md#agreementid) -- [call](templates.EscrowComputeExecutionTemplate.md#call) -- [checkExists](templates.EscrowComputeExecutionTemplate.md#checkexists) -- [conditions](templates.EscrowComputeExecutionTemplate.md#conditions) -- [createAgreement](templates.EscrowComputeExecutionTemplate.md#createagreement) -- [createAgreementAndPay](templates.EscrowComputeExecutionTemplate.md#createagreementandpay) -- [createAgreementFromDDO](templates.EscrowComputeExecutionTemplate.md#createagreementfromddo) -- [createAgreementWithPaymentFromDDO](templates.EscrowComputeExecutionTemplate.md#createagreementwithpaymentfromddo) -- [createService](templates.EscrowComputeExecutionTemplate.md#createservice) -- [description](templates.EscrowComputeExecutionTemplate.md#description) -- [extraGen](templates.EscrowComputeExecutionTemplate.md#extragen) -- [findSigner](templates.EscrowComputeExecutionTemplate.md#findsigner) -- [getAddress](templates.EscrowComputeExecutionTemplate.md#getaddress) -- [getAgreementCreatedEvent](templates.EscrowComputeExecutionTemplate.md#getagreementcreatedevent) -- [getAgreementData](templates.EscrowComputeExecutionTemplate.md#getagreementdata) -- [getAgreementIdsFromDDO](templates.EscrowComputeExecutionTemplate.md#getagreementidsfromddo) -- [getAgreementStatus](templates.EscrowComputeExecutionTemplate.md#getagreementstatus) -- [getAgreementsForDID](templates.EscrowComputeExecutionTemplate.md#getagreementsfordid) -- [getConditionTypes](templates.EscrowComputeExecutionTemplate.md#getconditiontypes) -- [getConditions](templates.EscrowComputeExecutionTemplate.md#getconditions) -- [getContract](templates.EscrowComputeExecutionTemplate.md#getcontract) -- [getFromAddress](templates.EscrowComputeExecutionTemplate.md#getfromaddress) -- [getInputsOfMethod](templates.EscrowComputeExecutionTemplate.md#getinputsofmethod) -- [getServiceAgreementTemplate](templates.EscrowComputeExecutionTemplate.md#getserviceagreementtemplate) -- [getServiceAgreementTemplateConditionByRef](templates.EscrowComputeExecutionTemplate.md#getserviceagreementtemplateconditionbyref) -- [getServiceAgreementTemplateConditions](templates.EscrowComputeExecutionTemplate.md#getserviceagreementtemplateconditions) -- [getServiceAgreementTemplateDependencies](templates.EscrowComputeExecutionTemplate.md#getserviceagreementtemplatedependencies) -- [getSignatureOfMethod](templates.EscrowComputeExecutionTemplate.md#getsignatureofmethod) -- [init](templates.EscrowComputeExecutionTemplate.md#init) -- [instanceFromDDO](templates.EscrowComputeExecutionTemplate.md#instancefromddo) -- [lockConditionIndex](templates.EscrowComputeExecutionTemplate.md#lockconditionindex) -- [lockTokens](templates.EscrowComputeExecutionTemplate.md#locktokens) -- [name](templates.EscrowComputeExecutionTemplate.md#name) -- [params](templates.EscrowComputeExecutionTemplate.md#params) -- [paramsGen](templates.EscrowComputeExecutionTemplate.md#paramsgen) -- [paymentData](templates.EscrowComputeExecutionTemplate.md#paymentdata) -- [printAgreementStatus](templates.EscrowComputeExecutionTemplate.md#printagreementstatus) -- [process](templates.EscrowComputeExecutionTemplate.md#process) -- [providerConfig](templates.EscrowComputeExecutionTemplate.md#providerconfig) -- [send](templates.EscrowComputeExecutionTemplate.md#send) -- [sendFrom](templates.EscrowComputeExecutionTemplate.md#sendfrom) -- [service](templates.EscrowComputeExecutionTemplate.md#service) -- [serviceEndpoint](templates.EscrowComputeExecutionTemplate.md#serviceendpoint) -- [setInstanceConfig](templates.EscrowComputeExecutionTemplate.md#setinstanceconfig) -- [standardContext](templates.EscrowComputeExecutionTemplate.md#standardcontext) -- [validateAgreement](templates.EscrowComputeExecutionTemplate.md#validateagreement) -- [addressesStatic](templates.EscrowComputeExecutionTemplate.md#addressesstatic) -- [findSignerStatic](templates.EscrowComputeExecutionTemplate.md#findsignerstatic) -- [getInstance](templates.EscrowComputeExecutionTemplate.md#getinstance) -- [setInstanceConfig](templates.EscrowComputeExecutionTemplate.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• `Protected` **new EscrowComputeExecutionTemplate**(`contractName`) - -#### Parameters - -| Name | Type | -| :------------- | :------- | -| `contractName` | `string` | - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[constructor](templates.BaseTemplate.md#constructor) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:75](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L75) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[contract](templates.BaseTemplate.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - ---- - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[contractName](templates.BaseTemplate.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - ---- - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[events](templates.BaseTemplate.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - ---- - -### version - -• **version**: `string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[version](templates.BaseTemplate.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -BaseTemplate.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - ---- - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -BaseTemplate.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - ---- - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -BaseTemplate.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - ---- - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -BaseTemplate.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - ---- - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -BaseTemplate.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - ---- - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -BaseTemplate.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - ---- - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -BaseTemplate.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - ---- - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -BaseTemplate.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### accept - -▸ **accept**(`_params`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :-------- | :----------------- | -| `_params` | `ValidationParams` | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[accept](templates.BaseTemplate.md#accept) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:112](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L112) - ---- - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[addresses](templates.BaseTemplate.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - ---- - -### agreementId - -▸ **agreementId**(`agreementIdSeed`, `creator`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :---------------- | :------- | -| `agreementIdSeed` | `string` | -| `creator` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[agreementId](templates.BaseTemplate.md#agreementid) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:213](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L213) - ---- - -### 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 - -[BaseTemplate](templates.BaseTemplate.md).[call](templates.BaseTemplate.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - ---- - -### 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 - -[BaseTemplate](templates.BaseTemplate.md).[checkExists](templates.BaseTemplate.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - ---- - -### conditions - -▸ **conditions**(): [[`ComputeExecutionCondition`](conditions.ComputeExecutionCondition.md), [`LockPaymentCondition`](conditions.LockPaymentCondition.md), [`EscrowPaymentCondition`](conditions.EscrowPaymentCondition.md)] - -#### Returns - -[[`ComputeExecutionCondition`](conditions.ComputeExecutionCondition.md), [`LockPaymentCondition`](conditions.LockPaymentCondition.md), [`EscrowPaymentCondition`](conditions.EscrowPaymentCondition.md)] - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[conditions](templates.BaseTemplate.md#conditions) - -#### Defined in - -[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:107](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L107) - ---- - -### 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`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreement](templates.BaseTemplate.md#createagreement) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L99) - ---- - -### 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`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementAndPay](templates.BaseTemplate.md#createagreementandpay) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:124](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L124) - ---- - -### 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.md) | DDO. | -| `parameters` | `EscrowComputeExecutionParams` | | -| `consumer` | [`Account`](Account.md) | - | -| `from` | [`Account`](Account.md) | - | -| `timeOuts?` | `number`[] | - | -| `params?` | `TxParameters` | - | - -#### Returns - -`Promise`<`string`\> - -true if the call was successful. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementFromDDO](templates.BaseTemplate.md#createagreementfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:225](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L225) - ---- - -### createAgreementWithPaymentFromDDO - -▸ **createAgreementWithPaymentFromDDO**(`agreementIdSeed`, `ddo`, `parameters`, `consumer`, `from`, `timeOuts?`, `txParams?`, `observer?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :---------------- | :------------------------------------- | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `parameters` | `EscrowComputeExecutionParams` | -| `consumer` | [`Account`](Account.md) | -| `from` | [`Account`](Account.md) | -| `timeOuts?` | `number`[] | -| `txParams?` | `TxParameters` | -| `observer?` | (`OrderProgressStep`: `any`) => `void` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementWithPaymentFromDDO](templates.BaseTemplate.md#createagreementwithpaymentfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:255](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L255) - ---- - -### createService - -▸ **createService**(`publisher`, `metadata`, `assetPrice?`, `erc20TokenAddress?`, `priced?`): `Promise`<`ServiceCompute`\> - -#### Parameters - -| Name | Type | Default value | -| :------------------- | :-------------------------------------- | :------------ | -| `publisher` | [`Account`](Account.md) | `undefined` | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | -| `assetPrice?` | `default` | `undefined` | -| `erc20TokenAddress?` | `string` | `undefined` | -| `priced` | `boolean` | `false` | - -#### Returns - -`Promise`<`ServiceCompute`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createService](templates.BaseTemplate.md#createservice) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:65](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L65) - ---- - -### description - -▸ **description**(): `string` - -#### Returns - -`string` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[description](templates.BaseTemplate.md#description) - -#### Defined in - -[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:42](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L42) - ---- - -### extraGen - -▸ **extraGen**(`_params`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :-------- | :----------------- | -| `_params` | `ValidationParams` | - -#### Returns - -`Promise`<`any`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[extraGen](templates.BaseTemplate.md#extragen) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L108) - ---- - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[findSigner](templates.BaseTemplate.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - ---- - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAddress](templates.BaseTemplate.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - ---- - -### 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. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementCreatedEvent](templates.BaseTemplate.md#getagreementcreatedevent) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:469](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L469) - ---- - -### getAgreementData - -▸ **getAgreementData**(`agreementId`): `Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | - -#### Returns - -`Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementData](templates.BaseTemplate.md#getagreementdata) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:21](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L21) - ---- - -### getAgreementIdsFromDDO - -▸ **getAgreementIdsFromDDO**(`agreementId`, `ddo`, `creator`, `params`): `Promise`<`string`[]\> - -Get agreement conditions IDs. - -#### Parameters - -| Name | Type | Description | -| :------------ | :----------------------------- | :------------ | -| `agreementId` | `string` | Agreement ID. | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `creator` | `string` | - | -| `params` | `EscrowComputeExecutionParams` | - | - -#### Returns - -`Promise`<`string`[]\> - -The condition IDs. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementIdsFromDDO](templates.BaseTemplate.md#getagreementidsfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:183](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L183) - ---- - -### getAgreementStatus - -▸ **getAgreementStatus**(`agreementId`): `Promise`<`false` \| [`AgreementConditionsStatus`](../interfaces/templates.AgreementConditionsStatus.md)\> - -Returns the status of the conditions. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------- | :------------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<`false` \| [`AgreementConditionsStatus`](../interfaces/templates.AgreementConditionsStatus.md)\> - -The conditions status. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementStatus](templates.BaseTemplate.md#getagreementstatus) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:343](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L343) - ---- - -### getAgreementsForDID - -▸ **getAgreementsForDID**(`did`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :---- | :------- | -| `did` | `string` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementsForDID](templates.BaseTemplate.md#getagreementsfordid) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:496](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L496) - ---- - -### getConditionTypes - -▸ **getConditionTypes**(): `Promise`<`string`[]\> - -Conditions address list. - -#### Returns - -`Promise`<`string`[]\> - -A list of condition addresses. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getConditionTypes](templates.BaseTemplate.md#getconditiontypes) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:163](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L163) - ---- - -### getConditions - -▸ **getConditions**(): `Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)[]\> - -List of condition contracts. - -#### Returns - -`Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)[]\> - -A list of condition contracts. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getConditions](templates.BaseTemplate.md#getconditions) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L171) - ---- - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getContract](templates.BaseTemplate.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - ---- - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getFromAddress](templates.BaseTemplate.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - ---- - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :----------- | :------- | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getInputsOfMethod](templates.BaseTemplate.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - ---- - -### getServiceAgreementTemplate - -▸ **getServiceAgreementTemplate**(): `Promise`<`ServiceAgreementTemplate`\> - -#### Returns - -`Promise`<`ServiceAgreementTemplate`\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplate](templates.BaseTemplate.md#getserviceagreementtemplate) - -#### Defined in - -[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:95](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L95) - ---- - -### getServiceAgreementTemplateConditionByRef - -▸ **getServiceAgreementTemplateConditionByRef**(`ref`): `Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)\> - -#### Parameters - -| Name | Type | -| :---- | :------- | -| `ref` | `string` | - -#### Returns - -`Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateConditionByRef](templates.BaseTemplate.md#getserviceagreementtemplateconditionbyref) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:324](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L324) - ---- - -### getServiceAgreementTemplateConditions - -▸ **getServiceAgreementTemplateConditions**(): `Promise`<`ServiceAgreementTemplateCondition`[]\> - -#### Returns - -`Promise`<`ServiceAgreementTemplateCondition`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateConditions](templates.BaseTemplate.md#getserviceagreementtemplateconditions) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:319](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L319) - ---- - -### getServiceAgreementTemplateDependencies - -▸ **getServiceAgreementTemplateDependencies**(): `Promise`<{ `[condition: string]`: `string`[]; }\> - -#### Returns - -`Promise`<{ `[condition: string]`: `string`[]; }\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateDependencies](templates.BaseTemplate.md#getserviceagreementtemplatedependencies) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:333](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L333) - ---- - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :----------- | :------- | :------------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getSignatureOfMethod](templates.BaseTemplate.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - ---- - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :--------- | :------------------- | :------------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[init](templates.BaseTemplate.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - ---- - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementIdSeed`, `ddo`, `creator`, `parameters`): `Promise`<[`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`EscrowComputeExecutionParams`\>\> - -#### Parameters - -| Name | Type | -| :---------------- | :----------------------------- | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | -| `parameters` | `EscrowComputeExecutionParams` | - -#### Returns - -`Promise`<[`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`EscrowComputeExecutionParams`\>\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[instanceFromDDO](templates.BaseTemplate.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:120](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L120) - ---- - -### lockConditionIndex - -▸ **lockConditionIndex**(): `number` - -#### Returns - -`number` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[lockConditionIndex](templates.BaseTemplate.md#lockconditionindex) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L81) - ---- - -### lockTokens - -▸ **lockTokens**(`tokenAddress`, `amounts`, `from`, `txParams`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------------- | :---------------------- | -| `tokenAddress` | `any` | -| `amounts` | `any` | -| `from` | [`Account`](Account.md) | -| `txParams` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[lockTokens](templates.BaseTemplate.md#locktokens) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:398](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L398) - ---- - -### name - -▸ **name**(): `string` - -#### Returns - -`string` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[name](templates.BaseTemplate.md#name) - -#### Defined in - -[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:39](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L39) - ---- - -### params - -▸ **params**(`consumer`): `EscrowComputeExecutionParams` - -#### Parameters - -| Name | Type | -| :--------- | :---------------------- | -| `consumer` | [`Account`](Account.md) | - -#### Returns - -`EscrowComputeExecutionParams` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[params](templates.BaseTemplate.md#params) - -#### Defined in - -[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:103](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L103) - ---- - -### paramsGen - -▸ **paramsGen**(`params`): `Promise`<`EscrowComputeExecutionParams`\> - -Specialize params - -#### Parameters - -| Name | Type | Description | -| :------- | :----------------- | :----------------- | -| `params` | `ValidationParams` | Generic parameters | - -#### Returns - -`Promise`<`EscrowComputeExecutionParams`\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[paramsGen](templates.BaseTemplate.md#paramsgen) - -#### Defined in - -[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L23) - ---- - -### paymentData - -▸ **paymentData**(`service`): [`PaymentData`](../interfaces/templates.PaymentData.md) - -#### Parameters - -| Name | Type | -| :-------- | :-------------- | -| `service` | `ServiceCommon` | - -#### Returns - -[`PaymentData`](../interfaces/templates.PaymentData.md) - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[paymentData](templates.BaseTemplate.md#paymentdata) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:85](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L85) - ---- - -### printAgreementStatus - -▸ **printAgreementStatus**(`agreementId`): `Promise`<`void`\> - -Prints the agreement status. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------- | :------------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[printAgreementStatus](templates.BaseTemplate.md#printagreementstatus) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:439](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L439) - ---- - -### process - -▸ **process**(`params`, `from`, `txparams?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :---------- | :---------------------- | -| `params` | `ValidationParams` | -| `from` | [`Account`](Account.md) | -| `txparams?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[process](templates.BaseTemplate.md#process) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:116](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L116) - ---- - -### providerConfig - -▸ **providerConfig**(): `Promise`<{ `description`: `string` = ''; `environment`: { `cluster`: { `type`: `string` = 'Kubernetes'; `url`: `string` = 'http://10.0.0.17/xxx' } ; `supportedContainers`: { `checksum`: `string` = 'sha256:cb57ecfa6ebbefd8ffc7f75c0f00e57a7fa739578a429b6f72a0df19315deadc'; `image`: `string` = 'tensorflow/tensorflow'; `tag`: `string` = 'latest' }[] ; `supportedServers`: { `cpu`: `string` = '16'; `disk`: `string` = '160gb'; `gpu`: `string` = '0'; `maxExecutionTime`: `number` = 86400; `memory`: `string` = '128gb'; `price`: `string` = '50'; `serverId`: `string` = '1'; `serverType`: `string` = 'xlsize' }[] } ; `type`: `string` = 'Azure' }\> - -#### Returns - -`Promise`<{ `description`: `string` = ''; `environment`: { `cluster`: { `type`: `string` = 'Kubernetes'; `url`: `string` = 'http://10.0.0.17/xxx' } ; `supportedContainers`: { `checksum`: `string` = 'sha256:cb57ecfa6ebbefd8ffc7f75c0f00e57a7fa739578a429b6f72a0df19315deadc'; `image`: `string` = 'tensorflow/tensorflow'; `tag`: `string` = 'latest' }[] ; `supportedServers`: { `cpu`: `string` = '16'; `disk`: `string` = '160gb'; `gpu`: `string` = '0'; `maxExecutionTime`: `number` = 86400; `memory`: `string` = '128gb'; `price`: `string` = '50'; `serverId`: `string` = '1'; `serverType`: `string` = 'xlsize' }[] } ; `type`: `string` = 'Azure' }\> - -#### Defined in - -[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:46](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L46) - ---- - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :------------- | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[send](templates.BaseTemplate.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - ---- - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :---------------------- | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[sendFrom](templates.BaseTemplate.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - ---- - -### service - -▸ **service**(): `ServiceType` - -#### Returns - -`ServiceType` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[service](templates.BaseTemplate.md#service) - -#### Defined in - -[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:99](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L99) - ---- - -### serviceEndpoint - -▸ **serviceEndpoint**(): `ServiceType` - -#### Returns - -`ServiceType` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[serviceEndpoint](templates.BaseTemplate.md#serviceendpoint) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:31](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L31) - ---- - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[setInstanceConfig](templates.BaseTemplate.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - ---- - -### standardContext - -▸ **standardContext**(`ddo`, `creator`): [`ConditionContext`](../interfaces/conditions.ConditionContext.md) - -#### Parameters - -| Name | Type | -| :-------- | :-------------- | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | - -#### Returns - -[`ConditionContext`](../interfaces/conditions.ConditionContext.md) - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[standardContext](templates.BaseTemplate.md#standardcontext) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:207](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L207) - ---- - -### validateAgreement - -▸ **validateAgreement**(`agreement_id`, `did`, `params`, `from`, `extra?`, `txparams?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------------- | :----------------------------- | -| `agreement_id` | `string` | -| `did` | `string` | -| `params` | `EscrowComputeExecutionParams` | -| `from` | [`Account`](Account.md) | -| `extra` | `any` | -| `txparams?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[validateAgreement](templates.BaseTemplate.md#validateagreement) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:131](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L131) - ---- - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[addressesStatic](templates.BaseTemplate.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - ---- - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[findSignerStatic](templates.BaseTemplate.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - ---- - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`EscrowComputeExecutionTemplate`](templates.EscrowComputeExecutionTemplate.md)\> - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`EscrowComputeExecutionTemplate`](templates.EscrowComputeExecutionTemplate.md)\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[getInstance](templates.BaseTemplate.md#getinstance) - -#### Defined in - -[src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:30](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts#L30) - ---- - -### 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 - -[BaseTemplate](templates.BaseTemplate.md).[setInstanceConfig](templates.BaseTemplate.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/api-reference/classes/templates.NFT721AccessTemplate.md b/docs/api-reference/classes/templates.NFT721AccessTemplate.md deleted file mode 100644 index 07d12efba..000000000 --- a/docs/api-reference/classes/templates.NFT721AccessTemplate.md +++ /dev/null @@ -1,1561 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [templates](../modules/templates.md) / NFT721AccessTemplate - -# Class: NFT721AccessTemplate - -[templates](../modules/templates.md).NFT721AccessTemplate - -## Hierarchy - -- [`BaseTemplate`](templates.BaseTemplate.md)<`NFT721AccessTemplateParams`, `ServiceNFTAccess`\> - - ↳ **`NFT721AccessTemplate`** - -## Table of contents - -### Constructors - -- [constructor](templates.NFT721AccessTemplate.md#constructor) - -### Properties - -- [contract](templates.NFT721AccessTemplate.md#contract) -- [contractName](templates.NFT721AccessTemplate.md#contractname) -- [events](templates.NFT721AccessTemplate.md#events) -- [version](templates.NFT721AccessTemplate.md#version) - -### Accessors - -- [address](templates.NFT721AccessTemplate.md#address) -- [artifactsFolder](templates.NFT721AccessTemplate.md#artifactsfolder) -- [config](templates.NFT721AccessTemplate.md#config) -- [instanceConfig](templates.NFT721AccessTemplate.md#instanceconfig) -- [instantiableConfig](templates.NFT721AccessTemplate.md#instantiableconfig) -- [logger](templates.NFT721AccessTemplate.md#logger) -- [nevermined](templates.NFT721AccessTemplate.md#nevermined) -- [web3](templates.NFT721AccessTemplate.md#web3) - -### Methods - -- [accept](templates.NFT721AccessTemplate.md#accept) -- [addresses](templates.NFT721AccessTemplate.md#addresses) -- [agreementId](templates.NFT721AccessTemplate.md#agreementid) -- [call](templates.NFT721AccessTemplate.md#call) -- [checkExists](templates.NFT721AccessTemplate.md#checkexists) -- [conditions](templates.NFT721AccessTemplate.md#conditions) -- [createAgreement](templates.NFT721AccessTemplate.md#createagreement) -- [createAgreementAndPay](templates.NFT721AccessTemplate.md#createagreementandpay) -- [createAgreementFromDDO](templates.NFT721AccessTemplate.md#createagreementfromddo) -- [createAgreementWithPaymentFromDDO](templates.NFT721AccessTemplate.md#createagreementwithpaymentfromddo) -- [createService](templates.NFT721AccessTemplate.md#createservice) -- [description](templates.NFT721AccessTemplate.md#description) -- [extraGen](templates.NFT721AccessTemplate.md#extragen) -- [findSigner](templates.NFT721AccessTemplate.md#findsigner) -- [getAddress](templates.NFT721AccessTemplate.md#getaddress) -- [getAgreementCreatedEvent](templates.NFT721AccessTemplate.md#getagreementcreatedevent) -- [getAgreementData](templates.NFT721AccessTemplate.md#getagreementdata) -- [getAgreementIdsFromDDO](templates.NFT721AccessTemplate.md#getagreementidsfromddo) -- [getAgreementStatus](templates.NFT721AccessTemplate.md#getagreementstatus) -- [getAgreementsForDID](templates.NFT721AccessTemplate.md#getagreementsfordid) -- [getConditionTypes](templates.NFT721AccessTemplate.md#getconditiontypes) -- [getConditions](templates.NFT721AccessTemplate.md#getconditions) -- [getContract](templates.NFT721AccessTemplate.md#getcontract) -- [getFromAddress](templates.NFT721AccessTemplate.md#getfromaddress) -- [getInputsOfMethod](templates.NFT721AccessTemplate.md#getinputsofmethod) -- [getServiceAgreementTemplate](templates.NFT721AccessTemplate.md#getserviceagreementtemplate) -- [getServiceAgreementTemplateConditionByRef](templates.NFT721AccessTemplate.md#getserviceagreementtemplateconditionbyref) -- [getServiceAgreementTemplateConditions](templates.NFT721AccessTemplate.md#getserviceagreementtemplateconditions) -- [getServiceAgreementTemplateDependencies](templates.NFT721AccessTemplate.md#getserviceagreementtemplatedependencies) -- [getSignatureOfMethod](templates.NFT721AccessTemplate.md#getsignatureofmethod) -- [init](templates.NFT721AccessTemplate.md#init) -- [instanceFromDDO](templates.NFT721AccessTemplate.md#instancefromddo) -- [lockConditionIndex](templates.NFT721AccessTemplate.md#lockconditionindex) -- [lockTokens](templates.NFT721AccessTemplate.md#locktokens) -- [name](templates.NFT721AccessTemplate.md#name) -- [params](templates.NFT721AccessTemplate.md#params) -- [paramsGen](templates.NFT721AccessTemplate.md#paramsgen) -- [paymentData](templates.NFT721AccessTemplate.md#paymentdata) -- [printAgreementStatus](templates.NFT721AccessTemplate.md#printagreementstatus) -- [process](templates.NFT721AccessTemplate.md#process) -- [send](templates.NFT721AccessTemplate.md#send) -- [sendFrom](templates.NFT721AccessTemplate.md#sendfrom) -- [service](templates.NFT721AccessTemplate.md#service) -- [serviceEndpoint](templates.NFT721AccessTemplate.md#serviceendpoint) -- [setInstanceConfig](templates.NFT721AccessTemplate.md#setinstanceconfig) -- [standardContext](templates.NFT721AccessTemplate.md#standardcontext) -- [validateAgreement](templates.NFT721AccessTemplate.md#validateagreement) -- [addressesStatic](templates.NFT721AccessTemplate.md#addressesstatic) -- [findSignerStatic](templates.NFT721AccessTemplate.md#findsignerstatic) -- [getInstance](templates.NFT721AccessTemplate.md#getinstance) -- [setInstanceConfig](templates.NFT721AccessTemplate.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• `Protected` **new NFT721AccessTemplate**(`contractName`) - -#### Parameters - -| Name | Type | -| :------------- | :------- | -| `contractName` | `string` | - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[constructor](templates.BaseTemplate.md#constructor) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:75](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L75) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[contract](templates.BaseTemplate.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - ---- - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[contractName](templates.BaseTemplate.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - ---- - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[events](templates.BaseTemplate.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - ---- - -### version - -• **version**: `string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[version](templates.BaseTemplate.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -BaseTemplate.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - ---- - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -BaseTemplate.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - ---- - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -BaseTemplate.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - ---- - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -BaseTemplate.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - ---- - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -BaseTemplate.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - ---- - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -BaseTemplate.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - ---- - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -BaseTemplate.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - ---- - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -BaseTemplate.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### accept - -▸ **accept**(`params`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------- | :----------------- | -| `params` | `ValidationParams` | - -#### Returns - -`Promise`<`boolean`\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[accept](templates.BaseTemplate.md#accept) - -#### Defined in - -[src/keeper/contracts/templates/NFT721AccessTemplate.ts:93](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L93) - ---- - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[addresses](templates.BaseTemplate.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - ---- - -### agreementId - -▸ **agreementId**(`agreementIdSeed`, `creator`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :---------------- | :------- | -| `agreementIdSeed` | `string` | -| `creator` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[agreementId](templates.BaseTemplate.md#agreementid) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:213](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L213) - ---- - -### 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 - -[BaseTemplate](templates.BaseTemplate.md).[call](templates.BaseTemplate.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - ---- - -### 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 - -[BaseTemplate](templates.BaseTemplate.md).[checkExists](templates.BaseTemplate.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - ---- - -### conditions - -▸ **conditions**(): [[`NFT721HolderCondition`](conditions.NFT721HolderCondition.md), [`NFTAccessCondition`](conditions.NFTAccessCondition.md)] - -#### Returns - -[[`NFT721HolderCondition`](conditions.NFT721HolderCondition.md), [`NFTAccessCondition`](conditions.NFTAccessCondition.md)] - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[conditions](templates.BaseTemplate.md#conditions) - -#### Defined in - -[src/keeper/contracts/templates/NFT721AccessTemplate.ts:52](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L52) - ---- - -### 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`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreement](templates.BaseTemplate.md#createagreement) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L99) - ---- - -### 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`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementAndPay](templates.BaseTemplate.md#createagreementandpay) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:124](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L124) - ---- - -### 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.md) | DDO. | -| `parameters` | `NFT721AccessTemplateParams` | | -| `consumer` | [`Account`](Account.md) | - | -| `from` | [`Account`](Account.md) | - | -| `timeOuts?` | `number`[] | - | -| `params?` | `TxParameters` | - | - -#### Returns - -`Promise`<`string`\> - -true if the call was successful. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementFromDDO](templates.BaseTemplate.md#createagreementfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:225](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L225) - ---- - -### createAgreementWithPaymentFromDDO - -▸ **createAgreementWithPaymentFromDDO**(`agreementIdSeed`, `ddo`, `parameters`, `consumer`, `from`, `timeOuts?`, `txParams?`, `observer?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :---------------- | :------------------------------------- | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `parameters` | `NFT721AccessTemplateParams` | -| `consumer` | [`Account`](Account.md) | -| `from` | [`Account`](Account.md) | -| `timeOuts?` | `number`[] | -| `txParams?` | `TxParameters` | -| `observer?` | (`OrderProgressStep`: `any`) => `void` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementWithPaymentFromDDO](templates.BaseTemplate.md#createagreementwithpaymentfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:255](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L255) - ---- - -### createService - -▸ **createService**(`publisher`, `metadata`, `assetPrice?`, `erc20TokenAddress?`, `priced?`): `Promise`<`ServiceNFTAccess`\> - -#### Parameters - -| Name | Type | Default value | -| :------------------- | :-------------------------------------- | :------------ | -| `publisher` | [`Account`](Account.md) | `undefined` | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | -| `assetPrice?` | `default` | `undefined` | -| `erc20TokenAddress?` | `string` | `undefined` | -| `priced` | `boolean` | `false` | - -#### Returns - -`Promise`<`ServiceNFTAccess`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createService](templates.BaseTemplate.md#createservice) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:65](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L65) - ---- - -### description - -▸ **description**(): `string` - -#### Returns - -`string` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[description](templates.BaseTemplate.md#description) - -#### Defined in - -[src/keeper/contracts/templates/NFT721AccessTemplate.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L37) - ---- - -### extraGen - -▸ **extraGen**(`_params`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :-------- | :----------------- | -| `_params` | `ValidationParams` | - -#### Returns - -`Promise`<`any`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[extraGen](templates.BaseTemplate.md#extragen) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L108) - ---- - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[findSigner](templates.BaseTemplate.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - ---- - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAddress](templates.BaseTemplate.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - ---- - -### 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. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementCreatedEvent](templates.BaseTemplate.md#getagreementcreatedevent) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:469](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L469) - ---- - -### getAgreementData - -▸ **getAgreementData**(`agreementId`): `Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | - -#### Returns - -`Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementData](templates.BaseTemplate.md#getagreementdata) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:21](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L21) - ---- - -### getAgreementIdsFromDDO - -▸ **getAgreementIdsFromDDO**(`agreementId`, `ddo`, `creator`, `params`): `Promise`<`string`[]\> - -Get agreement conditions IDs. - -#### Parameters - -| Name | Type | Description | -| :------------ | :--------------------------- | :------------ | -| `agreementId` | `string` | Agreement ID. | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `creator` | `string` | - | -| `params` | `NFT721AccessTemplateParams` | - | - -#### Returns - -`Promise`<`string`[]\> - -The condition IDs. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementIdsFromDDO](templates.BaseTemplate.md#getagreementidsfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:183](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L183) - ---- - -### getAgreementStatus - -▸ **getAgreementStatus**(`agreementId`): `Promise`<`false` \| [`AgreementConditionsStatus`](../interfaces/templates.AgreementConditionsStatus.md)\> - -Returns the status of the conditions. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------- | :------------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<`false` \| [`AgreementConditionsStatus`](../interfaces/templates.AgreementConditionsStatus.md)\> - -The conditions status. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementStatus](templates.BaseTemplate.md#getagreementstatus) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:343](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L343) - ---- - -### getAgreementsForDID - -▸ **getAgreementsForDID**(`did`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :---- | :------- | -| `did` | `string` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementsForDID](templates.BaseTemplate.md#getagreementsfordid) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:496](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L496) - ---- - -### getConditionTypes - -▸ **getConditionTypes**(): `Promise`<`string`[]\> - -Conditions address list. - -#### Returns - -`Promise`<`string`[]\> - -A list of condition addresses. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getConditionTypes](templates.BaseTemplate.md#getconditiontypes) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:163](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L163) - ---- - -### getConditions - -▸ **getConditions**(): `Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)[]\> - -List of condition contracts. - -#### Returns - -`Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)[]\> - -A list of condition contracts. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getConditions](templates.BaseTemplate.md#getconditions) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L171) - ---- - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getContract](templates.BaseTemplate.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - ---- - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getFromAddress](templates.BaseTemplate.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - ---- - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :----------- | :------- | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getInputsOfMethod](templates.BaseTemplate.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - ---- - -### getServiceAgreementTemplate - -▸ **getServiceAgreementTemplate**(): `Promise`<`ServiceAgreementTemplate`\> - -#### Returns - -`Promise`<`ServiceAgreementTemplate`\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplate](templates.BaseTemplate.md#getserviceagreementtemplate) - -#### Defined in - -[src/keeper/contracts/templates/NFT721AccessTemplate.ts:89](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L89) - ---- - -### getServiceAgreementTemplateConditionByRef - -▸ **getServiceAgreementTemplateConditionByRef**(`ref`): `Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)\> - -#### Parameters - -| Name | Type | -| :---- | :------- | -| `ref` | `string` | - -#### Returns - -`Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateConditionByRef](templates.BaseTemplate.md#getserviceagreementtemplateconditionbyref) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:324](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L324) - ---- - -### getServiceAgreementTemplateConditions - -▸ **getServiceAgreementTemplateConditions**(): `Promise`<`ServiceAgreementTemplateCondition`[]\> - -#### Returns - -`Promise`<`ServiceAgreementTemplateCondition`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateConditions](templates.BaseTemplate.md#getserviceagreementtemplateconditions) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:319](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L319) - ---- - -### getServiceAgreementTemplateDependencies - -▸ **getServiceAgreementTemplateDependencies**(): `Promise`<{ `[condition: string]`: `string`[]; }\> - -#### Returns - -`Promise`<{ `[condition: string]`: `string`[]; }\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateDependencies](templates.BaseTemplate.md#getserviceagreementtemplatedependencies) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:333](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L333) - ---- - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :----------- | :------- | :------------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getSignatureOfMethod](templates.BaseTemplate.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - ---- - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :--------- | :------------------- | :------------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[init](templates.BaseTemplate.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - ---- - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementIdSeed`, `ddo`, `creator`, `parameters`): `Promise`<[`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`NFT721AccessTemplateParams`\>\> - -#### Parameters - -| Name | Type | -| :---------------- | :--------------------------- | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | -| `parameters` | `NFT721AccessTemplateParams` | - -#### Returns - -`Promise`<[`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`NFT721AccessTemplateParams`\>\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[instanceFromDDO](templates.BaseTemplate.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/templates/NFT721AccessTemplate.ts:58](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L58) - ---- - -### lockConditionIndex - -▸ **lockConditionIndex**(): `number` - -#### Returns - -`number` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[lockConditionIndex](templates.BaseTemplate.md#lockconditionindex) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L81) - ---- - -### lockTokens - -▸ **lockTokens**(`tokenAddress`, `amounts`, `from`, `txParams`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------------- | :---------------------- | -| `tokenAddress` | `any` | -| `amounts` | `any` | -| `from` | [`Account`](Account.md) | -| `txParams` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[lockTokens](templates.BaseTemplate.md#locktokens) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:398](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L398) - ---- - -### name - -▸ **name**(): `string` - -#### Returns - -`string` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[name](templates.BaseTemplate.md#name) - -#### Defined in - -[src/keeper/contracts/templates/NFT721AccessTemplate.ts:34](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L34) - ---- - -### params - -▸ **params**(`holderAddress`): `NFT721AccessTemplateParams` - -#### Parameters - -| Name | Type | -| :-------------- | :------- | -| `holderAddress` | `string` | - -#### Returns - -`NFT721AccessTemplateParams` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[params](templates.BaseTemplate.md#params) - -#### Defined in - -[src/keeper/contracts/templates/NFT721AccessTemplate.ts:48](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L48) - ---- - -### paramsGen - -▸ **paramsGen**(`__namedParameters`): `Promise`<`NFT721AccessTemplateParams`\> - -Specialize params - -#### Parameters - -| Name | Type | Description | -| :------------------ | :----------------- | :----------------- | -| `__namedParameters` | `ValidationParams` | Generic parameters | - -#### Returns - -`Promise`<`NFT721AccessTemplateParams`\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[paramsGen](templates.BaseTemplate.md#paramsgen) - -#### Defined in - -[src/keeper/contracts/templates/NFT721AccessTemplate.ts:19](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L19) - ---- - -### paymentData - -▸ **paymentData**(`service`): [`PaymentData`](../interfaces/templates.PaymentData.md) - -#### Parameters - -| Name | Type | -| :-------- | :-------------- | -| `service` | `ServiceCommon` | - -#### Returns - -[`PaymentData`](../interfaces/templates.PaymentData.md) - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[paymentData](templates.BaseTemplate.md#paymentdata) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:85](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L85) - ---- - -### printAgreementStatus - -▸ **printAgreementStatus**(`agreementId`): `Promise`<`void`\> - -Prints the agreement status. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------- | :------------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[printAgreementStatus](templates.BaseTemplate.md#printagreementstatus) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:439](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L439) - ---- - -### process - -▸ **process**(`params`, `from`, `txparams?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :---------- | :---------------------- | -| `params` | `ValidationParams` | -| `from` | [`Account`](Account.md) | -| `txparams?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[process](templates.BaseTemplate.md#process) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:116](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L116) - ---- - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :------------- | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[send](templates.BaseTemplate.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - ---- - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :---------------------- | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[sendFrom](templates.BaseTemplate.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - ---- - -### service - -▸ **service**(): `ServiceType` - -#### Returns - -`ServiceType` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[service](templates.BaseTemplate.md#service) - -#### Defined in - -[src/keeper/contracts/templates/NFT721AccessTemplate.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L41) - ---- - -### serviceEndpoint - -▸ **serviceEndpoint**(): `ServiceType` - -#### Returns - -`ServiceType` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[serviceEndpoint](templates.BaseTemplate.md#serviceendpoint) - -#### Defined in - -[src/keeper/contracts/templates/NFT721AccessTemplate.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L44) - ---- - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[setInstanceConfig](templates.BaseTemplate.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - ---- - -### standardContext - -▸ **standardContext**(`ddo`, `creator`): [`ConditionContext`](../interfaces/conditions.ConditionContext.md) - -#### Parameters - -| Name | Type | -| :-------- | :-------------- | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | - -#### Returns - -[`ConditionContext`](../interfaces/conditions.ConditionContext.md) - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[standardContext](templates.BaseTemplate.md#standardcontext) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:207](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L207) - ---- - -### validateAgreement - -▸ **validateAgreement**(`agreement_id`, `did`, `params`, `from`, `extra?`, `txparams?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------------- | :--------------------------- | -| `agreement_id` | `string` | -| `did` | `string` | -| `params` | `NFT721AccessTemplateParams` | -| `from` | [`Account`](Account.md) | -| `extra` | `any` | -| `txparams?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[validateAgreement](templates.BaseTemplate.md#validateagreement) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:131](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L131) - ---- - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[addressesStatic](templates.BaseTemplate.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - ---- - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[findSignerStatic](templates.BaseTemplate.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - ---- - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`NFT721AccessTemplate`](templates.NFT721AccessTemplate.md)\> - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`NFT721AccessTemplate`](templates.NFT721AccessTemplate.md)\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[getInstance](templates.BaseTemplate.md#getinstance) - -#### Defined in - -[src/keeper/contracts/templates/NFT721AccessTemplate.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721AccessTemplate.ts#L24) - ---- - -### 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 - -[BaseTemplate](templates.BaseTemplate.md).[setInstanceConfig](templates.BaseTemplate.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/api-reference/classes/templates.NFT721SalesTemplate.md b/docs/api-reference/classes/templates.NFT721SalesTemplate.md deleted file mode 100644 index 08bf325f8..000000000 --- a/docs/api-reference/classes/templates.NFT721SalesTemplate.md +++ /dev/null @@ -1,1562 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [templates](../modules/templates.md) / NFT721SalesTemplate - -# Class: NFT721SalesTemplate - -[templates](../modules/templates.md).NFT721SalesTemplate - -## Hierarchy - -- [`BaseTemplate`](templates.BaseTemplate.md)<`NFT721SalesTemplateParams`, `ServiceNFTSales`\> - - ↳ **`NFT721SalesTemplate`** - -## Table of contents - -### Constructors - -- [constructor](templates.NFT721SalesTemplate.md#constructor) - -### Properties - -- [contract](templates.NFT721SalesTemplate.md#contract) -- [contractName](templates.NFT721SalesTemplate.md#contractname) -- [events](templates.NFT721SalesTemplate.md#events) -- [version](templates.NFT721SalesTemplate.md#version) - -### Accessors - -- [address](templates.NFT721SalesTemplate.md#address) -- [artifactsFolder](templates.NFT721SalesTemplate.md#artifactsfolder) -- [config](templates.NFT721SalesTemplate.md#config) -- [instanceConfig](templates.NFT721SalesTemplate.md#instanceconfig) -- [instantiableConfig](templates.NFT721SalesTemplate.md#instantiableconfig) -- [logger](templates.NFT721SalesTemplate.md#logger) -- [nevermined](templates.NFT721SalesTemplate.md#nevermined) -- [web3](templates.NFT721SalesTemplate.md#web3) - -### Methods - -- [accept](templates.NFT721SalesTemplate.md#accept) -- [addresses](templates.NFT721SalesTemplate.md#addresses) -- [agreementId](templates.NFT721SalesTemplate.md#agreementid) -- [call](templates.NFT721SalesTemplate.md#call) -- [checkExists](templates.NFT721SalesTemplate.md#checkexists) -- [conditions](templates.NFT721SalesTemplate.md#conditions) -- [createAgreement](templates.NFT721SalesTemplate.md#createagreement) -- [createAgreementAndPay](templates.NFT721SalesTemplate.md#createagreementandpay) -- [createAgreementFromDDO](templates.NFT721SalesTemplate.md#createagreementfromddo) -- [createAgreementWithPaymentFromDDO](templates.NFT721SalesTemplate.md#createagreementwithpaymentfromddo) -- [createService](templates.NFT721SalesTemplate.md#createservice) -- [description](templates.NFT721SalesTemplate.md#description) -- [extraGen](templates.NFT721SalesTemplate.md#extragen) -- [findSigner](templates.NFT721SalesTemplate.md#findsigner) -- [getAddress](templates.NFT721SalesTemplate.md#getaddress) -- [getAgreementCreatedEvent](templates.NFT721SalesTemplate.md#getagreementcreatedevent) -- [getAgreementData](templates.NFT721SalesTemplate.md#getagreementdata) -- [getAgreementIdsFromDDO](templates.NFT721SalesTemplate.md#getagreementidsfromddo) -- [getAgreementStatus](templates.NFT721SalesTemplate.md#getagreementstatus) -- [getAgreementsForDID](templates.NFT721SalesTemplate.md#getagreementsfordid) -- [getConditionTypes](templates.NFT721SalesTemplate.md#getconditiontypes) -- [getConditions](templates.NFT721SalesTemplate.md#getconditions) -- [getContract](templates.NFT721SalesTemplate.md#getcontract) -- [getFromAddress](templates.NFT721SalesTemplate.md#getfromaddress) -- [getInputsOfMethod](templates.NFT721SalesTemplate.md#getinputsofmethod) -- [getServiceAgreementTemplate](templates.NFT721SalesTemplate.md#getserviceagreementtemplate) -- [getServiceAgreementTemplateConditionByRef](templates.NFT721SalesTemplate.md#getserviceagreementtemplateconditionbyref) -- [getServiceAgreementTemplateConditions](templates.NFT721SalesTemplate.md#getserviceagreementtemplateconditions) -- [getServiceAgreementTemplateDependencies](templates.NFT721SalesTemplate.md#getserviceagreementtemplatedependencies) -- [getSignatureOfMethod](templates.NFT721SalesTemplate.md#getsignatureofmethod) -- [init](templates.NFT721SalesTemplate.md#init) -- [instanceFromDDO](templates.NFT721SalesTemplate.md#instancefromddo) -- [lockConditionIndex](templates.NFT721SalesTemplate.md#lockconditionindex) -- [lockTokens](templates.NFT721SalesTemplate.md#locktokens) -- [name](templates.NFT721SalesTemplate.md#name) -- [params](templates.NFT721SalesTemplate.md#params) -- [paramsGen](templates.NFT721SalesTemplate.md#paramsgen) -- [paymentData](templates.NFT721SalesTemplate.md#paymentdata) -- [printAgreementStatus](templates.NFT721SalesTemplate.md#printagreementstatus) -- [process](templates.NFT721SalesTemplate.md#process) -- [send](templates.NFT721SalesTemplate.md#send) -- [sendFrom](templates.NFT721SalesTemplate.md#sendfrom) -- [service](templates.NFT721SalesTemplate.md#service) -- [serviceEndpoint](templates.NFT721SalesTemplate.md#serviceendpoint) -- [setInstanceConfig](templates.NFT721SalesTemplate.md#setinstanceconfig) -- [standardContext](templates.NFT721SalesTemplate.md#standardcontext) -- [validateAgreement](templates.NFT721SalesTemplate.md#validateagreement) -- [addressesStatic](templates.NFT721SalesTemplate.md#addressesstatic) -- [findSignerStatic](templates.NFT721SalesTemplate.md#findsignerstatic) -- [getInstance](templates.NFT721SalesTemplate.md#getinstance) -- [setInstanceConfig](templates.NFT721SalesTemplate.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• `Protected` **new NFT721SalesTemplate**(`contractName`) - -#### Parameters - -| Name | Type | -| :------------- | :------- | -| `contractName` | `string` | - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[constructor](templates.BaseTemplate.md#constructor) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:75](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L75) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[contract](templates.BaseTemplate.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - ---- - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[contractName](templates.BaseTemplate.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - ---- - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[events](templates.BaseTemplate.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - ---- - -### version - -• **version**: `string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[version](templates.BaseTemplate.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -BaseTemplate.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - ---- - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -BaseTemplate.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - ---- - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -BaseTemplate.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - ---- - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -BaseTemplate.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - ---- - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -BaseTemplate.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - ---- - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -BaseTemplate.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - ---- - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -BaseTemplate.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - ---- - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -BaseTemplate.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### accept - -▸ **accept**(`_params`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :-------- | :----------------- | -| `_params` | `ValidationParams` | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[accept](templates.BaseTemplate.md#accept) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:112](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L112) - ---- - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[addresses](templates.BaseTemplate.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - ---- - -### agreementId - -▸ **agreementId**(`agreementIdSeed`, `creator`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :---------------- | :------- | -| `agreementIdSeed` | `string` | -| `creator` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[agreementId](templates.BaseTemplate.md#agreementid) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:213](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L213) - ---- - -### 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 - -[BaseTemplate](templates.BaseTemplate.md).[call](templates.BaseTemplate.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - ---- - -### 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 - -[BaseTemplate](templates.BaseTemplate.md).[checkExists](templates.BaseTemplate.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - ---- - -### conditions - -▸ **conditions**(): [[`LockPaymentCondition`](conditions.LockPaymentCondition.md), [`TransferNFT721Condition`](conditions.TransferNFT721Condition.md), [`EscrowPaymentCondition`](conditions.EscrowPaymentCondition.md)] - -#### Returns - -[[`LockPaymentCondition`](conditions.LockPaymentCondition.md), [`TransferNFT721Condition`](conditions.TransferNFT721Condition.md), [`EscrowPaymentCondition`](conditions.EscrowPaymentCondition.md)] - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[conditions](templates.BaseTemplate.md#conditions) - -#### Defined in - -[src/keeper/contracts/templates/NFT721SalesTemplate.ts:61](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L61) - ---- - -### 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`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreement](templates.BaseTemplate.md#createagreement) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L99) - ---- - -### 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`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementAndPay](templates.BaseTemplate.md#createagreementandpay) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:124](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L124) - ---- - -### 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.md) | DDO. | -| `parameters` | `NFT721SalesTemplateParams` | | -| `consumer` | [`Account`](Account.md) | - | -| `from` | [`Account`](Account.md) | - | -| `timeOuts?` | `number`[] | - | -| `params?` | `TxParameters` | - | - -#### Returns - -`Promise`<`string`\> - -true if the call was successful. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementFromDDO](templates.BaseTemplate.md#createagreementfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:225](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L225) - ---- - -### createAgreementWithPaymentFromDDO - -▸ **createAgreementWithPaymentFromDDO**(`agreementIdSeed`, `ddo`, `parameters`, `consumer`, `from`, `timeOuts?`, `txParams?`, `observer?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :---------------- | :------------------------------------- | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `parameters` | `NFT721SalesTemplateParams` | -| `consumer` | [`Account`](Account.md) | -| `from` | [`Account`](Account.md) | -| `timeOuts?` | `number`[] | -| `txParams?` | `TxParameters` | -| `observer?` | (`OrderProgressStep`: `any`) => `void` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementWithPaymentFromDDO](templates.BaseTemplate.md#createagreementwithpaymentfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:255](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L255) - ---- - -### createService - -▸ **createService**(`publisher`, `metadata`, `assetPrice?`, `erc20TokenAddress?`, `priced?`): `Promise`<`ServiceNFTSales`\> - -#### Parameters - -| Name | Type | Default value | -| :------------------- | :-------------------------------------- | :------------ | -| `publisher` | [`Account`](Account.md) | `undefined` | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | -| `assetPrice?` | `default` | `undefined` | -| `erc20TokenAddress?` | `string` | `undefined` | -| `priced` | `boolean` | `false` | - -#### Returns - -`Promise`<`ServiceNFTSales`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createService](templates.BaseTemplate.md#createservice) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:65](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L65) - ---- - -### description - -▸ **description**(): `string` - -#### Returns - -`string` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[description](templates.BaseTemplate.md#description) - -#### Defined in - -[src/keeper/contracts/templates/NFT721SalesTemplate.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L44) - ---- - -### extraGen - -▸ **extraGen**(`_params`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :-------- | :----------------- | -| `_params` | `ValidationParams` | - -#### Returns - -`Promise`<`any`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[extraGen](templates.BaseTemplate.md#extragen) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L108) - ---- - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[findSigner](templates.BaseTemplate.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - ---- - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAddress](templates.BaseTemplate.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - ---- - -### 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. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementCreatedEvent](templates.BaseTemplate.md#getagreementcreatedevent) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:469](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L469) - ---- - -### getAgreementData - -▸ **getAgreementData**(`agreementId`): `Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | - -#### Returns - -`Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementData](templates.BaseTemplate.md#getagreementdata) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:21](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L21) - ---- - -### getAgreementIdsFromDDO - -▸ **getAgreementIdsFromDDO**(`agreementId`, `ddo`, `creator`, `params`): `Promise`<`string`[]\> - -Get agreement conditions IDs. - -#### Parameters - -| Name | Type | Description | -| :------------ | :-------------------------- | :------------ | -| `agreementId` | `string` | Agreement ID. | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `creator` | `string` | - | -| `params` | `NFT721SalesTemplateParams` | - | - -#### Returns - -`Promise`<`string`[]\> - -The condition IDs. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementIdsFromDDO](templates.BaseTemplate.md#getagreementidsfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:183](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L183) - ---- - -### getAgreementStatus - -▸ **getAgreementStatus**(`agreementId`): `Promise`<`false` \| [`AgreementConditionsStatus`](../interfaces/templates.AgreementConditionsStatus.md)\> - -Returns the status of the conditions. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------- | :------------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<`false` \| [`AgreementConditionsStatus`](../interfaces/templates.AgreementConditionsStatus.md)\> - -The conditions status. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementStatus](templates.BaseTemplate.md#getagreementstatus) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:343](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L343) - ---- - -### getAgreementsForDID - -▸ **getAgreementsForDID**(`did`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :---- | :------- | -| `did` | `string` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementsForDID](templates.BaseTemplate.md#getagreementsfordid) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:496](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L496) - ---- - -### getConditionTypes - -▸ **getConditionTypes**(): `Promise`<`string`[]\> - -Conditions address list. - -#### Returns - -`Promise`<`string`[]\> - -A list of condition addresses. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getConditionTypes](templates.BaseTemplate.md#getconditiontypes) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:163](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L163) - ---- - -### getConditions - -▸ **getConditions**(): `Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)[]\> - -List of condition contracts. - -#### Returns - -`Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)[]\> - -A list of condition contracts. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getConditions](templates.BaseTemplate.md#getconditions) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L171) - ---- - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getContract](templates.BaseTemplate.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - ---- - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getFromAddress](templates.BaseTemplate.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - ---- - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :----------- | :------- | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getInputsOfMethod](templates.BaseTemplate.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - ---- - -### getServiceAgreementTemplate - -▸ **getServiceAgreementTemplate**(): `Promise`<`ServiceAgreementTemplate`\> - -#### Returns - -`Promise`<`ServiceAgreementTemplate`\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplate](templates.BaseTemplate.md#getserviceagreementtemplate) - -#### Defined in - -[src/keeper/contracts/templates/NFT721SalesTemplate.ts:114](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L114) - ---- - -### getServiceAgreementTemplateConditionByRef - -▸ **getServiceAgreementTemplateConditionByRef**(`ref`): `Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)\> - -#### Parameters - -| Name | Type | -| :---- | :------- | -| `ref` | `string` | - -#### Returns - -`Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateConditionByRef](templates.BaseTemplate.md#getserviceagreementtemplateconditionbyref) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:324](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L324) - ---- - -### getServiceAgreementTemplateConditions - -▸ **getServiceAgreementTemplateConditions**(): `Promise`<`ServiceAgreementTemplateCondition`[]\> - -#### Returns - -`Promise`<`ServiceAgreementTemplateCondition`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateConditions](templates.BaseTemplate.md#getserviceagreementtemplateconditions) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:319](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L319) - ---- - -### getServiceAgreementTemplateDependencies - -▸ **getServiceAgreementTemplateDependencies**(): `Promise`<{ `[condition: string]`: `string`[]; }\> - -#### Returns - -`Promise`<{ `[condition: string]`: `string`[]; }\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateDependencies](templates.BaseTemplate.md#getserviceagreementtemplatedependencies) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:333](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L333) - ---- - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :----------- | :------- | :------------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getSignatureOfMethod](templates.BaseTemplate.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - ---- - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :--------- | :------------------- | :------------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[init](templates.BaseTemplate.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - ---- - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementIdSeed`, `ddo`, `creator`, `parameters`): `Promise`<[`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`NFT721SalesTemplateParams`\>\> - -#### Parameters - -| Name | Type | -| :---------------- | :-------------------------- | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | -| `parameters` | `NFT721SalesTemplateParams` | - -#### Returns - -`Promise`<[`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`NFT721SalesTemplateParams`\>\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[instanceFromDDO](templates.BaseTemplate.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/templates/NFT721SalesTemplate.ts:71](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L71) - ---- - -### lockConditionIndex - -▸ **lockConditionIndex**(): `number` - -#### Returns - -`number` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[lockConditionIndex](templates.BaseTemplate.md#lockconditionindex) - -#### Defined in - -[src/keeper/contracts/templates/NFT721SalesTemplate.ts:57](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L57) - ---- - -### lockTokens - -▸ **lockTokens**(`tokenAddress`, `amounts`, `from`, `txParams`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------------- | :---------------------- | -| `tokenAddress` | `any` | -| `amounts` | `any` | -| `from` | [`Account`](Account.md) | -| `txParams` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[lockTokens](templates.BaseTemplate.md#locktokens) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:398](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L398) - ---- - -### name - -▸ **name**(): `string` - -#### Returns - -`string` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[name](templates.BaseTemplate.md#name) - -#### Defined in - -[src/keeper/contracts/templates/NFT721SalesTemplate.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L41) - ---- - -### params - -▸ **params**(`consumerId`, `expiration?`): `NFT721SalesTemplateParams` - -#### Parameters - -| Name | Type | Default value | -| :----------- | :------- | :------------ | -| `consumerId` | `string` | `undefined` | -| `expiration` | `number` | `0` | - -#### Returns - -`NFT721SalesTemplateParams` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[params](templates.BaseTemplate.md#params) - -#### Defined in - -[src/keeper/contracts/templates/NFT721SalesTemplate.ts:48](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L48) - ---- - -### paramsGen - -▸ **paramsGen**(`__namedParameters`): `Promise`<`NFT721SalesTemplateParams`\> - -Specialize params - -#### Parameters - -| Name | Type | Description | -| :------------------ | :----------------- | :----------------- | -| `__namedParameters` | `ValidationParams` | Generic parameters | - -#### Returns - -`Promise`<`NFT721SalesTemplateParams`\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[paramsGen](templates.BaseTemplate.md#paramsgen) - -#### Defined in - -[src/keeper/contracts/templates/NFT721SalesTemplate.ts:51](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L51) - ---- - -### paymentData - -▸ **paymentData**(`service`): [`PaymentData`](../interfaces/templates.PaymentData.md) - -#### Parameters - -| Name | Type | -| :-------- | :-------------- | -| `service` | `ServiceCommon` | - -#### Returns - -[`PaymentData`](../interfaces/templates.PaymentData.md) - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[paymentData](templates.BaseTemplate.md#paymentdata) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:85](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L85) - ---- - -### printAgreementStatus - -▸ **printAgreementStatus**(`agreementId`): `Promise`<`void`\> - -Prints the agreement status. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------- | :------------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[printAgreementStatus](templates.BaseTemplate.md#printagreementstatus) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:439](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L439) - ---- - -### process - -▸ **process**(`params`, `from`, `txparams?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :---------- | :---------------------- | -| `params` | `ValidationParams` | -| `from` | [`Account`](Account.md) | -| `txparams?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[process](templates.BaseTemplate.md#process) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:116](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L116) - ---- - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :------------- | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[send](templates.BaseTemplate.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - ---- - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :---------------------- | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[sendFrom](templates.BaseTemplate.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - ---- - -### service - -▸ **service**(): `ServiceType` - -#### Returns - -`ServiceType` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[service](templates.BaseTemplate.md#service) - -#### Defined in - -[src/keeper/contracts/templates/NFT721SalesTemplate.ts:34](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L34) - ---- - -### serviceEndpoint - -▸ **serviceEndpoint**(): `ServiceType` - -#### Returns - -`ServiceType` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[serviceEndpoint](templates.BaseTemplate.md#serviceendpoint) - -#### Defined in - -[src/keeper/contracts/templates/NFT721SalesTemplate.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L37) - ---- - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[setInstanceConfig](templates.BaseTemplate.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - ---- - -### standardContext - -▸ **standardContext**(`ddo`, `creator`): [`ConditionContext`](../interfaces/conditions.ConditionContext.md) - -#### Parameters - -| Name | Type | -| :-------- | :-------------- | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | - -#### Returns - -[`ConditionContext`](../interfaces/conditions.ConditionContext.md) - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[standardContext](templates.BaseTemplate.md#standardcontext) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:207](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L207) - ---- - -### validateAgreement - -▸ **validateAgreement**(`agreement_id`, `did`, `params`, `from`, `extra?`, `txparams?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------------- | :-------------------------- | -| `agreement_id` | `string` | -| `did` | `string` | -| `params` | `NFT721SalesTemplateParams` | -| `from` | [`Account`](Account.md) | -| `extra` | `any` | -| `txparams?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[validateAgreement](templates.BaseTemplate.md#validateagreement) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:131](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L131) - ---- - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[addressesStatic](templates.BaseTemplate.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - ---- - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[findSignerStatic](templates.BaseTemplate.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - ---- - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`NFT721SalesTemplate`](templates.NFT721SalesTemplate.md)\> - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`NFT721SalesTemplate`](templates.NFT721SalesTemplate.md)\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[getInstance](templates.BaseTemplate.md#getinstance) - -#### Defined in - -[src/keeper/contracts/templates/NFT721SalesTemplate.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFT721SalesTemplate.ts#L23) - ---- - -### 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 - -[BaseTemplate](templates.BaseTemplate.md).[setInstanceConfig](templates.BaseTemplate.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/api-reference/classes/templates.NFTAccessTemplate.md b/docs/api-reference/classes/templates.NFTAccessTemplate.md deleted file mode 100644 index 718d48c95..000000000 --- a/docs/api-reference/classes/templates.NFTAccessTemplate.md +++ /dev/null @@ -1,1562 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [templates](../modules/templates.md) / NFTAccessTemplate - -# Class: NFTAccessTemplate - -[templates](../modules/templates.md).NFTAccessTemplate - -## Hierarchy - -- [`BaseTemplate`](templates.BaseTemplate.md)<`NFTAccessTemplateParams`, `ServiceNFTAccess`\> - - ↳ **`NFTAccessTemplate`** - -## Table of contents - -### Constructors - -- [constructor](templates.NFTAccessTemplate.md#constructor) - -### Properties - -- [contract](templates.NFTAccessTemplate.md#contract) -- [contractName](templates.NFTAccessTemplate.md#contractname) -- [events](templates.NFTAccessTemplate.md#events) -- [version](templates.NFTAccessTemplate.md#version) - -### Accessors - -- [address](templates.NFTAccessTemplate.md#address) -- [artifactsFolder](templates.NFTAccessTemplate.md#artifactsfolder) -- [config](templates.NFTAccessTemplate.md#config) -- [instanceConfig](templates.NFTAccessTemplate.md#instanceconfig) -- [instantiableConfig](templates.NFTAccessTemplate.md#instantiableconfig) -- [logger](templates.NFTAccessTemplate.md#logger) -- [nevermined](templates.NFTAccessTemplate.md#nevermined) -- [web3](templates.NFTAccessTemplate.md#web3) - -### Methods - -- [accept](templates.NFTAccessTemplate.md#accept) -- [addresses](templates.NFTAccessTemplate.md#addresses) -- [agreementId](templates.NFTAccessTemplate.md#agreementid) -- [call](templates.NFTAccessTemplate.md#call) -- [checkExists](templates.NFTAccessTemplate.md#checkexists) -- [conditions](templates.NFTAccessTemplate.md#conditions) -- [createAgreement](templates.NFTAccessTemplate.md#createagreement) -- [createAgreementAndPay](templates.NFTAccessTemplate.md#createagreementandpay) -- [createAgreementFromDDO](templates.NFTAccessTemplate.md#createagreementfromddo) -- [createAgreementWithPaymentFromDDO](templates.NFTAccessTemplate.md#createagreementwithpaymentfromddo) -- [createService](templates.NFTAccessTemplate.md#createservice) -- [description](templates.NFTAccessTemplate.md#description) -- [extraGen](templates.NFTAccessTemplate.md#extragen) -- [findSigner](templates.NFTAccessTemplate.md#findsigner) -- [getAddress](templates.NFTAccessTemplate.md#getaddress) -- [getAgreementCreatedEvent](templates.NFTAccessTemplate.md#getagreementcreatedevent) -- [getAgreementData](templates.NFTAccessTemplate.md#getagreementdata) -- [getAgreementIdsFromDDO](templates.NFTAccessTemplate.md#getagreementidsfromddo) -- [getAgreementStatus](templates.NFTAccessTemplate.md#getagreementstatus) -- [getAgreementsForDID](templates.NFTAccessTemplate.md#getagreementsfordid) -- [getConditionTypes](templates.NFTAccessTemplate.md#getconditiontypes) -- [getConditions](templates.NFTAccessTemplate.md#getconditions) -- [getContract](templates.NFTAccessTemplate.md#getcontract) -- [getFromAddress](templates.NFTAccessTemplate.md#getfromaddress) -- [getInputsOfMethod](templates.NFTAccessTemplate.md#getinputsofmethod) -- [getServiceAgreementTemplate](templates.NFTAccessTemplate.md#getserviceagreementtemplate) -- [getServiceAgreementTemplateConditionByRef](templates.NFTAccessTemplate.md#getserviceagreementtemplateconditionbyref) -- [getServiceAgreementTemplateConditions](templates.NFTAccessTemplate.md#getserviceagreementtemplateconditions) -- [getServiceAgreementTemplateDependencies](templates.NFTAccessTemplate.md#getserviceagreementtemplatedependencies) -- [getSignatureOfMethod](templates.NFTAccessTemplate.md#getsignatureofmethod) -- [init](templates.NFTAccessTemplate.md#init) -- [instanceFromDDO](templates.NFTAccessTemplate.md#instancefromddo) -- [lockConditionIndex](templates.NFTAccessTemplate.md#lockconditionindex) -- [lockTokens](templates.NFTAccessTemplate.md#locktokens) -- [name](templates.NFTAccessTemplate.md#name) -- [params](templates.NFTAccessTemplate.md#params) -- [paramsGen](templates.NFTAccessTemplate.md#paramsgen) -- [paymentData](templates.NFTAccessTemplate.md#paymentdata) -- [printAgreementStatus](templates.NFTAccessTemplate.md#printagreementstatus) -- [process](templates.NFTAccessTemplate.md#process) -- [send](templates.NFTAccessTemplate.md#send) -- [sendFrom](templates.NFTAccessTemplate.md#sendfrom) -- [service](templates.NFTAccessTemplate.md#service) -- [serviceEndpoint](templates.NFTAccessTemplate.md#serviceendpoint) -- [setInstanceConfig](templates.NFTAccessTemplate.md#setinstanceconfig) -- [standardContext](templates.NFTAccessTemplate.md#standardcontext) -- [validateAgreement](templates.NFTAccessTemplate.md#validateagreement) -- [addressesStatic](templates.NFTAccessTemplate.md#addressesstatic) -- [findSignerStatic](templates.NFTAccessTemplate.md#findsignerstatic) -- [getInstance](templates.NFTAccessTemplate.md#getinstance) -- [setInstanceConfig](templates.NFTAccessTemplate.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• `Protected` **new NFTAccessTemplate**(`contractName`) - -#### Parameters - -| Name | Type | -| :------------- | :------- | -| `contractName` | `string` | - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[constructor](templates.BaseTemplate.md#constructor) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:75](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L75) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[contract](templates.BaseTemplate.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - ---- - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[contractName](templates.BaseTemplate.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - ---- - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[events](templates.BaseTemplate.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - ---- - -### version - -• **version**: `string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[version](templates.BaseTemplate.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -BaseTemplate.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - ---- - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -BaseTemplate.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - ---- - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -BaseTemplate.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - ---- - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -BaseTemplate.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - ---- - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -BaseTemplate.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - ---- - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -BaseTemplate.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - ---- - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -BaseTemplate.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - ---- - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -BaseTemplate.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### accept - -▸ **accept**(`params`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :------- | :----------------- | -| `params` | `ValidationParams` | - -#### Returns - -`Promise`<`boolean`\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[accept](templates.BaseTemplate.md#accept) - -#### Defined in - -[src/keeper/contracts/templates/NFTAccessTemplate.ts:91](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFTAccessTemplate.ts#L91) - ---- - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[addresses](templates.BaseTemplate.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - ---- - -### agreementId - -▸ **agreementId**(`agreementIdSeed`, `creator`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :---------------- | :------- | -| `agreementIdSeed` | `string` | -| `creator` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[agreementId](templates.BaseTemplate.md#agreementid) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:213](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L213) - ---- - -### 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 - -[BaseTemplate](templates.BaseTemplate.md).[call](templates.BaseTemplate.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - ---- - -### 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 - -[BaseTemplate](templates.BaseTemplate.md).[checkExists](templates.BaseTemplate.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - ---- - -### conditions - -▸ **conditions**(): [[`NFTHolderCondition`](conditions.NFTHolderCondition.md), [`NFTAccessCondition`](conditions.NFTAccessCondition.md)] - -#### Returns - -[[`NFTHolderCondition`](conditions.NFTHolderCondition.md), [`NFTAccessCondition`](conditions.NFTAccessCondition.md)] - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[conditions](templates.BaseTemplate.md#conditions) - -#### Defined in - -[src/keeper/contracts/templates/NFTAccessTemplate.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFTAccessTemplate.ts#L50) - ---- - -### 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`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreement](templates.BaseTemplate.md#createagreement) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L99) - ---- - -### 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`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementAndPay](templates.BaseTemplate.md#createagreementandpay) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:124](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L124) - ---- - -### 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.md) | DDO. | -| `parameters` | `NFTAccessTemplateParams` | | -| `consumer` | [`Account`](Account.md) | - | -| `from` | [`Account`](Account.md) | - | -| `timeOuts?` | `number`[] | - | -| `params?` | `TxParameters` | - | - -#### Returns - -`Promise`<`string`\> - -true if the call was successful. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementFromDDO](templates.BaseTemplate.md#createagreementfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:225](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L225) - ---- - -### createAgreementWithPaymentFromDDO - -▸ **createAgreementWithPaymentFromDDO**(`agreementIdSeed`, `ddo`, `parameters`, `consumer`, `from`, `timeOuts?`, `txParams?`, `observer?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :---------------- | :------------------------------------- | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `parameters` | `NFTAccessTemplateParams` | -| `consumer` | [`Account`](Account.md) | -| `from` | [`Account`](Account.md) | -| `timeOuts?` | `number`[] | -| `txParams?` | `TxParameters` | -| `observer?` | (`OrderProgressStep`: `any`) => `void` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementWithPaymentFromDDO](templates.BaseTemplate.md#createagreementwithpaymentfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:255](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L255) - ---- - -### createService - -▸ **createService**(`publisher`, `metadata`, `assetPrice?`, `erc20TokenAddress?`, `priced?`): `Promise`<`ServiceNFTAccess`\> - -#### Parameters - -| Name | Type | Default value | -| :------------------- | :-------------------------------------- | :------------ | -| `publisher` | [`Account`](Account.md) | `undefined` | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | -| `assetPrice?` | `default` | `undefined` | -| `erc20TokenAddress?` | `string` | `undefined` | -| `priced` | `boolean` | `false` | - -#### Returns - -`Promise`<`ServiceNFTAccess`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createService](templates.BaseTemplate.md#createservice) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:65](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L65) - ---- - -### description - -▸ **description**(): `string` - -#### Returns - -`string` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[description](templates.BaseTemplate.md#description) - -#### Defined in - -[src/keeper/contracts/templates/NFTAccessTemplate.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFTAccessTemplate.ts#L37) - ---- - -### extraGen - -▸ **extraGen**(`_params`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :-------- | :----------------- | -| `_params` | `ValidationParams` | - -#### Returns - -`Promise`<`any`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[extraGen](templates.BaseTemplate.md#extragen) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L108) - ---- - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[findSigner](templates.BaseTemplate.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - ---- - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAddress](templates.BaseTemplate.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - ---- - -### 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. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementCreatedEvent](templates.BaseTemplate.md#getagreementcreatedevent) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:469](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L469) - ---- - -### getAgreementData - -▸ **getAgreementData**(`agreementId`): `Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | - -#### Returns - -`Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementData](templates.BaseTemplate.md#getagreementdata) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:21](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L21) - ---- - -### getAgreementIdsFromDDO - -▸ **getAgreementIdsFromDDO**(`agreementId`, `ddo`, `creator`, `params`): `Promise`<`string`[]\> - -Get agreement conditions IDs. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------------------------ | :------------ | -| `agreementId` | `string` | Agreement ID. | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `creator` | `string` | - | -| `params` | `NFTAccessTemplateParams` | - | - -#### Returns - -`Promise`<`string`[]\> - -The condition IDs. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementIdsFromDDO](templates.BaseTemplate.md#getagreementidsfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:183](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L183) - ---- - -### getAgreementStatus - -▸ **getAgreementStatus**(`agreementId`): `Promise`<`false` \| [`AgreementConditionsStatus`](../interfaces/templates.AgreementConditionsStatus.md)\> - -Returns the status of the conditions. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------- | :------------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<`false` \| [`AgreementConditionsStatus`](../interfaces/templates.AgreementConditionsStatus.md)\> - -The conditions status. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementStatus](templates.BaseTemplate.md#getagreementstatus) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:343](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L343) - ---- - -### getAgreementsForDID - -▸ **getAgreementsForDID**(`did`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :---- | :------- | -| `did` | `string` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementsForDID](templates.BaseTemplate.md#getagreementsfordid) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:496](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L496) - ---- - -### getConditionTypes - -▸ **getConditionTypes**(): `Promise`<`string`[]\> - -Conditions address list. - -#### Returns - -`Promise`<`string`[]\> - -A list of condition addresses. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getConditionTypes](templates.BaseTemplate.md#getconditiontypes) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:163](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L163) - ---- - -### getConditions - -▸ **getConditions**(): `Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)[]\> - -List of condition contracts. - -#### Returns - -`Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)[]\> - -A list of condition contracts. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getConditions](templates.BaseTemplate.md#getconditions) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L171) - ---- - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getContract](templates.BaseTemplate.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - ---- - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getFromAddress](templates.BaseTemplate.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - ---- - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :----------- | :------- | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getInputsOfMethod](templates.BaseTemplate.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - ---- - -### getServiceAgreementTemplate - -▸ **getServiceAgreementTemplate**(): `Promise`<`ServiceAgreementTemplate`\> - -#### Returns - -`Promise`<`ServiceAgreementTemplate`\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplate](templates.BaseTemplate.md#getserviceagreementtemplate) - -#### Defined in - -[src/keeper/contracts/templates/NFTAccessTemplate.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFTAccessTemplate.ts#L87) - ---- - -### getServiceAgreementTemplateConditionByRef - -▸ **getServiceAgreementTemplateConditionByRef**(`ref`): `Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)\> - -#### Parameters - -| Name | Type | -| :---- | :------- | -| `ref` | `string` | - -#### Returns - -`Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateConditionByRef](templates.BaseTemplate.md#getserviceagreementtemplateconditionbyref) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:324](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L324) - ---- - -### getServiceAgreementTemplateConditions - -▸ **getServiceAgreementTemplateConditions**(): `Promise`<`ServiceAgreementTemplateCondition`[]\> - -#### Returns - -`Promise`<`ServiceAgreementTemplateCondition`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateConditions](templates.BaseTemplate.md#getserviceagreementtemplateconditions) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:319](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L319) - ---- - -### getServiceAgreementTemplateDependencies - -▸ **getServiceAgreementTemplateDependencies**(): `Promise`<{ `[condition: string]`: `string`[]; }\> - -#### Returns - -`Promise`<{ `[condition: string]`: `string`[]; }\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateDependencies](templates.BaseTemplate.md#getserviceagreementtemplatedependencies) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:333](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L333) - ---- - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :----------- | :------- | :------------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getSignatureOfMethod](templates.BaseTemplate.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - ---- - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :--------- | :------------------- | :------------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[init](templates.BaseTemplate.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - ---- - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementIdSeed`, `ddo`, `creator`, `parameters`): `Promise`<[`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`NFTAccessTemplateParams`\>\> - -#### Parameters - -| Name | Type | -| :---------------- | :------------------------ | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | -| `parameters` | `NFTAccessTemplateParams` | - -#### Returns - -`Promise`<[`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`NFTAccessTemplateParams`\>\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[instanceFromDDO](templates.BaseTemplate.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/templates/NFTAccessTemplate.ts:56](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFTAccessTemplate.ts#L56) - ---- - -### lockConditionIndex - -▸ **lockConditionIndex**(): `number` - -#### Returns - -`number` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[lockConditionIndex](templates.BaseTemplate.md#lockconditionindex) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:81](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L81) - ---- - -### lockTokens - -▸ **lockTokens**(`tokenAddress`, `amounts`, `from`, `txParams`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------------- | :---------------------- | -| `tokenAddress` | `any` | -| `amounts` | `any` | -| `from` | [`Account`](Account.md) | -| `txParams` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[lockTokens](templates.BaseTemplate.md#locktokens) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:398](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L398) - ---- - -### name - -▸ **name**(): `string` - -#### Returns - -`string` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[name](templates.BaseTemplate.md#name) - -#### Defined in - -[src/keeper/contracts/templates/NFTAccessTemplate.ts:34](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFTAccessTemplate.ts#L34) - ---- - -### params - -▸ **params**(`holderAddress`, `amount?`): `NFTAccessTemplateParams` - -#### Parameters - -| Name | Type | -| :-------------- | :-------- | -| `holderAddress` | `string` | -| `amount?` | `default` | - -#### Returns - -`NFTAccessTemplateParams` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[params](templates.BaseTemplate.md#params) - -#### Defined in - -[src/keeper/contracts/templates/NFTAccessTemplate.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFTAccessTemplate.ts#L41) - ---- - -### paramsGen - -▸ **paramsGen**(`__namedParameters`): `Promise`<`NFTAccessTemplateParams`\> - -Specialize params - -#### Parameters - -| Name | Type | Description | -| :------------------ | :----------------- | :----------------- | -| `__namedParameters` | `ValidationParams` | Generic parameters | - -#### Returns - -`Promise`<`NFTAccessTemplateParams`\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[paramsGen](templates.BaseTemplate.md#paramsgen) - -#### Defined in - -[src/keeper/contracts/templates/NFTAccessTemplate.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFTAccessTemplate.ts#L44) - ---- - -### paymentData - -▸ **paymentData**(`service`): [`PaymentData`](../interfaces/templates.PaymentData.md) - -#### Parameters - -| Name | Type | -| :-------- | :-------------- | -| `service` | `ServiceCommon` | - -#### Returns - -[`PaymentData`](../interfaces/templates.PaymentData.md) - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[paymentData](templates.BaseTemplate.md#paymentdata) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:85](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L85) - ---- - -### printAgreementStatus - -▸ **printAgreementStatus**(`agreementId`): `Promise`<`void`\> - -Prints the agreement status. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------- | :------------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[printAgreementStatus](templates.BaseTemplate.md#printagreementstatus) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:439](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L439) - ---- - -### process - -▸ **process**(`params`, `from`, `txparams?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :---------- | :---------------------- | -| `params` | `ValidationParams` | -| `from` | [`Account`](Account.md) | -| `txparams?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[process](templates.BaseTemplate.md#process) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:116](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L116) - ---- - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :------------- | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[send](templates.BaseTemplate.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - ---- - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :---------------------- | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[sendFrom](templates.BaseTemplate.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - ---- - -### service - -▸ **service**(): `ServiceType` - -#### Returns - -`ServiceType` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[service](templates.BaseTemplate.md#service) - -#### Defined in - -[src/keeper/contracts/templates/NFTAccessTemplate.ts:31](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFTAccessTemplate.ts#L31) - ---- - -### serviceEndpoint - -▸ **serviceEndpoint**(): `ServiceType` - -#### Returns - -`ServiceType` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[serviceEndpoint](templates.BaseTemplate.md#serviceendpoint) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:31](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L31) - ---- - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[setInstanceConfig](templates.BaseTemplate.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - ---- - -### standardContext - -▸ **standardContext**(`ddo`, `creator`): [`ConditionContext`](../interfaces/conditions.ConditionContext.md) - -#### Parameters - -| Name | Type | -| :-------- | :-------------- | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | - -#### Returns - -[`ConditionContext`](../interfaces/conditions.ConditionContext.md) - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[standardContext](templates.BaseTemplate.md#standardcontext) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:207](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L207) - ---- - -### validateAgreement - -▸ **validateAgreement**(`agreement_id`, `did`, `params`, `from`, `extra?`, `txparams?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------------- | :------------------------ | -| `agreement_id` | `string` | -| `did` | `string` | -| `params` | `NFTAccessTemplateParams` | -| `from` | [`Account`](Account.md) | -| `extra` | `any` | -| `txparams?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[validateAgreement](templates.BaseTemplate.md#validateagreement) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:131](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L131) - ---- - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[addressesStatic](templates.BaseTemplate.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - ---- - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[findSignerStatic](templates.BaseTemplate.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - ---- - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`NFTAccessTemplate`](templates.NFTAccessTemplate.md)\> - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`NFTAccessTemplate`](templates.NFTAccessTemplate.md)\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[getInstance](templates.BaseTemplate.md#getinstance) - -#### Defined in - -[src/keeper/contracts/templates/NFTAccessTemplate.ts:21](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFTAccessTemplate.ts#L21) - ---- - -### 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 - -[BaseTemplate](templates.BaseTemplate.md).[setInstanceConfig](templates.BaseTemplate.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/api-reference/classes/templates.NFTSalesTemplate.md b/docs/api-reference/classes/templates.NFTSalesTemplate.md deleted file mode 100644 index c0a3732a7..000000000 --- a/docs/api-reference/classes/templates.NFTSalesTemplate.md +++ /dev/null @@ -1,1563 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [templates](../modules/templates.md) / NFTSalesTemplate - -# Class: NFTSalesTemplate - -[templates](../modules/templates.md).NFTSalesTemplate - -## Hierarchy - -- [`BaseTemplate`](templates.BaseTemplate.md)<`NFTSalesTemplateParams`, `ServiceNFTSales`\> - - ↳ **`NFTSalesTemplate`** - -## Table of contents - -### Constructors - -- [constructor](templates.NFTSalesTemplate.md#constructor) - -### Properties - -- [contract](templates.NFTSalesTemplate.md#contract) -- [contractName](templates.NFTSalesTemplate.md#contractname) -- [events](templates.NFTSalesTemplate.md#events) -- [version](templates.NFTSalesTemplate.md#version) - -### Accessors - -- [address](templates.NFTSalesTemplate.md#address) -- [artifactsFolder](templates.NFTSalesTemplate.md#artifactsfolder) -- [config](templates.NFTSalesTemplate.md#config) -- [instanceConfig](templates.NFTSalesTemplate.md#instanceconfig) -- [instantiableConfig](templates.NFTSalesTemplate.md#instantiableconfig) -- [logger](templates.NFTSalesTemplate.md#logger) -- [nevermined](templates.NFTSalesTemplate.md#nevermined) -- [web3](templates.NFTSalesTemplate.md#web3) - -### Methods - -- [accept](templates.NFTSalesTemplate.md#accept) -- [addresses](templates.NFTSalesTemplate.md#addresses) -- [agreementId](templates.NFTSalesTemplate.md#agreementid) -- [call](templates.NFTSalesTemplate.md#call) -- [checkExists](templates.NFTSalesTemplate.md#checkexists) -- [conditions](templates.NFTSalesTemplate.md#conditions) -- [createAgreement](templates.NFTSalesTemplate.md#createagreement) -- [createAgreementAndPay](templates.NFTSalesTemplate.md#createagreementandpay) -- [createAgreementFromDDO](templates.NFTSalesTemplate.md#createagreementfromddo) -- [createAgreementWithPaymentFromDDO](templates.NFTSalesTemplate.md#createagreementwithpaymentfromddo) -- [createService](templates.NFTSalesTemplate.md#createservice) -- [description](templates.NFTSalesTemplate.md#description) -- [extraGen](templates.NFTSalesTemplate.md#extragen) -- [findSigner](templates.NFTSalesTemplate.md#findsigner) -- [getAddress](templates.NFTSalesTemplate.md#getaddress) -- [getAgreementCreatedEvent](templates.NFTSalesTemplate.md#getagreementcreatedevent) -- [getAgreementData](templates.NFTSalesTemplate.md#getagreementdata) -- [getAgreementIdsFromDDO](templates.NFTSalesTemplate.md#getagreementidsfromddo) -- [getAgreementStatus](templates.NFTSalesTemplate.md#getagreementstatus) -- [getAgreementsForDID](templates.NFTSalesTemplate.md#getagreementsfordid) -- [getConditionTypes](templates.NFTSalesTemplate.md#getconditiontypes) -- [getConditions](templates.NFTSalesTemplate.md#getconditions) -- [getContract](templates.NFTSalesTemplate.md#getcontract) -- [getFromAddress](templates.NFTSalesTemplate.md#getfromaddress) -- [getInputsOfMethod](templates.NFTSalesTemplate.md#getinputsofmethod) -- [getServiceAgreementTemplate](templates.NFTSalesTemplate.md#getserviceagreementtemplate) -- [getServiceAgreementTemplateConditionByRef](templates.NFTSalesTemplate.md#getserviceagreementtemplateconditionbyref) -- [getServiceAgreementTemplateConditions](templates.NFTSalesTemplate.md#getserviceagreementtemplateconditions) -- [getServiceAgreementTemplateDependencies](templates.NFTSalesTemplate.md#getserviceagreementtemplatedependencies) -- [getSignatureOfMethod](templates.NFTSalesTemplate.md#getsignatureofmethod) -- [init](templates.NFTSalesTemplate.md#init) -- [instanceFromDDO](templates.NFTSalesTemplate.md#instancefromddo) -- [lockConditionIndex](templates.NFTSalesTemplate.md#lockconditionindex) -- [lockTokens](templates.NFTSalesTemplate.md#locktokens) -- [name](templates.NFTSalesTemplate.md#name) -- [params](templates.NFTSalesTemplate.md#params) -- [paramsGen](templates.NFTSalesTemplate.md#paramsgen) -- [paymentData](templates.NFTSalesTemplate.md#paymentdata) -- [printAgreementStatus](templates.NFTSalesTemplate.md#printagreementstatus) -- [process](templates.NFTSalesTemplate.md#process) -- [send](templates.NFTSalesTemplate.md#send) -- [sendFrom](templates.NFTSalesTemplate.md#sendfrom) -- [service](templates.NFTSalesTemplate.md#service) -- [serviceEndpoint](templates.NFTSalesTemplate.md#serviceendpoint) -- [setInstanceConfig](templates.NFTSalesTemplate.md#setinstanceconfig) -- [standardContext](templates.NFTSalesTemplate.md#standardcontext) -- [validateAgreement](templates.NFTSalesTemplate.md#validateagreement) -- [addressesStatic](templates.NFTSalesTemplate.md#addressesstatic) -- [findSignerStatic](templates.NFTSalesTemplate.md#findsignerstatic) -- [getInstance](templates.NFTSalesTemplate.md#getinstance) -- [setInstanceConfig](templates.NFTSalesTemplate.md#setinstanceconfig-1) - -## Constructors - -### constructor - -• `Protected` **new NFTSalesTemplate**(`contractName`) - -#### Parameters - -| Name | Type | -| :------------- | :------- | -| `contractName` | `string` | - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[constructor](templates.BaseTemplate.md#constructor) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:75](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L75) - -## Properties - -### contract - -• **contract**: `Contract` = `null` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[contract](templates.BaseTemplate.md#contract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L24) - ---- - -### contractName - -• **contractName**: `string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[contractName](templates.BaseTemplate.md#contractname) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L23) - ---- - -### events - -• **events**: [`ContractEvent`](events.ContractEvent.md) \| [`SubgraphEvent`](events.SubgraphEvent.md) = `null` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[events](templates.BaseTemplate.md#events) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L25) - ---- - -### version - -• **version**: `string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[version](templates.BaseTemplate.md#version) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L26) - -## Accessors - -### address - -• `get` **address**(): `string` - -#### Returns - -`string` - -#### Inherited from - -BaseTemplate.address - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L28) - ---- - -### artifactsFolder - -• `Protected` `get` **artifactsFolder**(): `string` - -#### Returns - -`string` - -#### Inherited from - -BaseTemplate.artifactsFolder - -#### Defined in - -[src/Instantiable.abstract.ts:96](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L96) - ---- - -### config - -• `Protected` `get` **config**(): [`Config`](Config.md) - -#### Returns - -[`Config`](Config.md) - -#### Inherited from - -BaseTemplate.config - -#### Defined in - -[src/Instantiable.abstract.ts:80](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L80) - ---- - -### instanceConfig - -• `Protected` `get` **instanceConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -BaseTemplate.instanceConfig - -#### Defined in - -[src/Instantiable.abstract.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L100) - ---- - -### instantiableConfig - -• `Protected` `get` **instantiableConfig**(): `InstantiableConfig` - -#### Returns - -`InstantiableConfig` - -#### Inherited from - -BaseTemplate.instantiableConfig - -#### Defined in - -[src/Instantiable.abstract.ts:73](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L73) - ---- - -### logger - -• `Protected` `get` **logger**(): [`Logger`](utils.Logger.md) - -#### Returns - -[`Logger`](utils.Logger.md) - -#### Inherited from - -BaseTemplate.logger - -#### Defined in - -[src/Instantiable.abstract.ts:87](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L87) - ---- - -### nevermined - -• `Protected` `get` **nevermined**(): [`Nevermined`](Nevermined.md) - -#### Returns - -[`Nevermined`](Nevermined.md) - -#### Inherited from - -BaseTemplate.nevermined - -#### Defined in - -[src/Instantiable.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L33) - ---- - -### web3 - -• `Protected` `get` **web3**(): `JsonRpcProvider` - -#### Returns - -`JsonRpcProvider` - -#### Inherited from - -BaseTemplate.web3 - -#### Defined in - -[src/Instantiable.abstract.ts:63](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L63) - -## Methods - -### accept - -▸ **accept**(`_params`): `Promise`<`boolean`\> - -#### Parameters - -| Name | Type | -| :-------- | :----------------- | -| `_params` | `ValidationParams` | - -#### Returns - -`Promise`<`boolean`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[accept](templates.BaseTemplate.md#accept) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:112](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L112) - ---- - -### addresses - -▸ **addresses**(): `Promise`<`string`[]\> - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[addresses](templates.BaseTemplate.md#addresses) - -#### Defined in - -[src/Instantiable.abstract.ts:129](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L129) - ---- - -### agreementId - -▸ **agreementId**(`agreementIdSeed`, `creator`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :---------------- | :------- | -| `agreementIdSeed` | `string` | -| `creator` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[agreementId](templates.BaseTemplate.md#agreementid) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:213](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L213) - ---- - -### 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 - -[BaseTemplate](templates.BaseTemplate.md).[call](templates.BaseTemplate.md#call) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:244](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L244) - ---- - -### 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 - -[BaseTemplate](templates.BaseTemplate.md).[checkExists](templates.BaseTemplate.md#checkexists) - -#### Defined in - -[src/Instantiable.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L44) - ---- - -### conditions - -▸ **conditions**(): [[`LockPaymentCondition`](conditions.LockPaymentCondition.md), [`TransferNFTCondition`](conditions.TransferNFTCondition.md), [`EscrowPaymentCondition`](conditions.EscrowPaymentCondition.md)] - -#### Returns - -[[`LockPaymentCondition`](conditions.LockPaymentCondition.md), [`TransferNFTCondition`](conditions.TransferNFTCondition.md), [`EscrowPaymentCondition`](conditions.EscrowPaymentCondition.md)] - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[conditions](templates.BaseTemplate.md#conditions) - -#### Defined in - -[src/keeper/contracts/templates/NFTSalesTemplate.ts:61](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFTSalesTemplate.ts#L61) - ---- - -### 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`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreement](templates.BaseTemplate.md#createagreement) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:99](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L99) - ---- - -### 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`](Account.md) | -| `params?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementAndPay](templates.BaseTemplate.md#createagreementandpay) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:124](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L124) - ---- - -### 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.md) | DDO. | -| `parameters` | `NFTSalesTemplateParams` | | -| `consumer` | [`Account`](Account.md) | - | -| `from` | [`Account`](Account.md) | - | -| `timeOuts?` | `number`[] | - | -| `params?` | `TxParameters` | - | - -#### Returns - -`Promise`<`string`\> - -true if the call was successful. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementFromDDO](templates.BaseTemplate.md#createagreementfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:225](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L225) - ---- - -### createAgreementWithPaymentFromDDO - -▸ **createAgreementWithPaymentFromDDO**(`agreementIdSeed`, `ddo`, `parameters`, `consumer`, `from`, `timeOuts?`, `txParams?`, `observer?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :---------------- | :------------------------------------- | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `parameters` | `NFTSalesTemplateParams` | -| `consumer` | [`Account`](Account.md) | -| `from` | [`Account`](Account.md) | -| `timeOuts?` | `number`[] | -| `txParams?` | `TxParameters` | -| `observer?` | (`OrderProgressStep`: `any`) => `void` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createAgreementWithPaymentFromDDO](templates.BaseTemplate.md#createagreementwithpaymentfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:255](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L255) - ---- - -### createService - -▸ **createService**(`publisher`, `metadata`, `assetPrice?`, `erc20TokenAddress?`, `priced?`): `Promise`<`ServiceNFTSales`\> - -#### Parameters - -| Name | Type | Default value | -| :------------------- | :-------------------------------------- | :------------ | -| `publisher` | [`Account`](Account.md) | `undefined` | -| `metadata` | [`MetaData`](../interfaces/MetaData.md) | `undefined` | -| `assetPrice?` | `default` | `undefined` | -| `erc20TokenAddress?` | `string` | `undefined` | -| `priced` | `boolean` | `false` | - -#### Returns - -`Promise`<`ServiceNFTSales`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[createService](templates.BaseTemplate.md#createservice) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:65](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L65) - ---- - -### description - -▸ **description**(): `string` - -#### Returns - -`string` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[description](templates.BaseTemplate.md#description) - -#### Defined in - -[src/keeper/contracts/templates/NFTSalesTemplate.ts:38](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFTSalesTemplate.ts#L38) - ---- - -### extraGen - -▸ **extraGen**(`_params`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :-------- | :----------------- | -| `_params` | `ValidationParams` | - -#### Returns - -`Promise`<`any`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[extraGen](templates.BaseTemplate.md#extragen) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:108](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L108) - ---- - -### findSigner - -▸ **findSigner**(`from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[findSigner](templates.BaseTemplate.md#findsigner) - -#### Defined in - -[src/Instantiable.abstract.ts:105](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L105) - ---- - -### getAddress - -▸ **getAddress**(): `string` - -#### Returns - -`string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAddress](templates.BaseTemplate.md#getaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L41) - ---- - -### 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. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementCreatedEvent](templates.BaseTemplate.md#getagreementcreatedevent) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:469](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L469) - ---- - -### getAgreementData - -▸ **getAgreementData**(`agreementId`): `Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `agreementId` | `string` | - -#### Returns - -`Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementData](templates.BaseTemplate.md#getagreementdata) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:21](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L21) - ---- - -### getAgreementIdsFromDDO - -▸ **getAgreementIdsFromDDO**(`agreementId`, `ddo`, `creator`, `params`): `Promise`<`string`[]\> - -Get agreement conditions IDs. - -#### Parameters - -| Name | Type | Description | -| :------------ | :----------------------- | :------------ | -| `agreementId` | `string` | Agreement ID. | -| `ddo` | [`DDO`](DDO.md) | DDO. | -| `creator` | `string` | - | -| `params` | `NFTSalesTemplateParams` | - | - -#### Returns - -`Promise`<`string`[]\> - -The condition IDs. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementIdsFromDDO](templates.BaseTemplate.md#getagreementidsfromddo) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:183](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L183) - ---- - -### getAgreementStatus - -▸ **getAgreementStatus**(`agreementId`): `Promise`<`false` \| [`AgreementConditionsStatus`](../interfaces/templates.AgreementConditionsStatus.md)\> - -Returns the status of the conditions. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------- | :------------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<`false` \| [`AgreementConditionsStatus`](../interfaces/templates.AgreementConditionsStatus.md)\> - -The conditions status. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementStatus](templates.BaseTemplate.md#getagreementstatus) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:343](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L343) - ---- - -### getAgreementsForDID - -▸ **getAgreementsForDID**(`did`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :---- | :------- | -| `did` | `string` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getAgreementsForDID](templates.BaseTemplate.md#getagreementsfordid) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:496](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L496) - ---- - -### getConditionTypes - -▸ **getConditionTypes**(): `Promise`<`string`[]\> - -Conditions address list. - -#### Returns - -`Promise`<`string`[]\> - -A list of condition addresses. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getConditionTypes](templates.BaseTemplate.md#getconditiontypes) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:163](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L163) - ---- - -### getConditions - -▸ **getConditions**(): `Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)[]\> - -List of condition contracts. - -#### Returns - -`Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)[]\> - -A list of condition contracts. - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getConditions](templates.BaseTemplate.md#getconditions) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L171) - ---- - -### getContract - -▸ **getContract**(): `Contract` - -#### Returns - -`Contract` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getContract](templates.BaseTemplate.md#getcontract) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L37) - ---- - -### getFromAddress - -▸ `Protected` **getFromAddress**(`from?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `from?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getFromAddress](templates.BaseTemplate.md#getfromaddress) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:90](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L90) - ---- - -### getInputsOfMethod - -▸ **getInputsOfMethod**(`methodName`): `any`[] - -#### Parameters - -| Name | Type | -| :----------- | :------- | -| `methodName` | `string` | - -#### Returns - -`any`[] - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getInputsOfMethod](templates.BaseTemplate.md#getinputsofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L50) - ---- - -### getServiceAgreementTemplate - -▸ **getServiceAgreementTemplate**(): `Promise`<`ServiceAgreementTemplate`\> - -#### Returns - -`Promise`<`ServiceAgreementTemplate`\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplate](templates.BaseTemplate.md#getserviceagreementtemplate) - -#### Defined in - -[src/keeper/contracts/templates/NFTSalesTemplate.ts:114](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFTSalesTemplate.ts#L114) - ---- - -### getServiceAgreementTemplateConditionByRef - -▸ **getServiceAgreementTemplateConditionByRef**(`ref`): `Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)\> - -#### Parameters - -| Name | Type | -| :---- | :------- | -| `ref` | `string` | - -#### Returns - -`Promise`<[`ConditionSmall`](conditions.ConditionSmall.md)\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateConditionByRef](templates.BaseTemplate.md#getserviceagreementtemplateconditionbyref) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:324](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L324) - ---- - -### getServiceAgreementTemplateConditions - -▸ **getServiceAgreementTemplateConditions**(): `Promise`<`ServiceAgreementTemplateCondition`[]\> - -#### Returns - -`Promise`<`ServiceAgreementTemplateCondition`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateConditions](templates.BaseTemplate.md#getserviceagreementtemplateconditions) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:319](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L319) - ---- - -### getServiceAgreementTemplateDependencies - -▸ **getServiceAgreementTemplateDependencies**(): `Promise`<{ `[condition: string]`: `string`[]; }\> - -#### Returns - -`Promise`<{ `[condition: string]`: `string`[]; }\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getServiceAgreementTemplateDependencies](templates.BaseTemplate.md#getserviceagreementtemplatedependencies) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:333](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L333) - ---- - -### getSignatureOfMethod - -▸ **getSignatureOfMethod**(`methodName`, `args?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :----------- | :------- | :------------ | -| `methodName` | `string` | `undefined` | -| `args` | `any`[] | `[]` | - -#### Returns - -`string` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[getSignatureOfMethod](templates.BaseTemplate.md#getsignatureofmethod) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L45) - ---- - -### init - -▸ `Protected` **init**(`config`, `optional?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | Default value | -| :--------- | :------------------- | :------------ | -| `config` | `InstantiableConfig` | `undefined` | -| `optional` | `boolean` | `false` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[init](templates.BaseTemplate.md#init) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L55) - ---- - -### instanceFromDDO - -▸ **instanceFromDDO**(`agreementIdSeed`, `ddo`, `creator`, `parameters`): `Promise`<[`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`NFTSalesTemplateParams`\>\> - -#### Parameters - -| Name | Type | -| :---------------- | :----------------------- | -| `agreementIdSeed` | `string` | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | -| `parameters` | `NFTSalesTemplateParams` | - -#### Returns - -`Promise`<[`AgreementInstance`](../interfaces/templates.AgreementInstance.md)<`NFTSalesTemplateParams`\>\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[instanceFromDDO](templates.BaseTemplate.md#instancefromddo) - -#### Defined in - -[src/keeper/contracts/templates/NFTSalesTemplate.ts:71](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFTSalesTemplate.ts#L71) - ---- - -### lockConditionIndex - -▸ **lockConditionIndex**(): `number` - -#### Returns - -`number` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[lockConditionIndex](templates.BaseTemplate.md#lockconditionindex) - -#### Defined in - -[src/keeper/contracts/templates/NFTSalesTemplate.ts:57](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFTSalesTemplate.ts#L57) - ---- - -### lockTokens - -▸ **lockTokens**(`tokenAddress`, `amounts`, `from`, `txParams`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------------- | :---------------------- | -| `tokenAddress` | `any` | -| `amounts` | `any` | -| `from` | [`Account`](Account.md) | -| `txParams` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[lockTokens](templates.BaseTemplate.md#locktokens) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:398](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L398) - ---- - -### name - -▸ **name**(): `string` - -#### Returns - -`string` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[name](templates.BaseTemplate.md#name) - -#### Defined in - -[src/keeper/contracts/templates/NFTSalesTemplate.ts:35](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFTSalesTemplate.ts#L35) - ---- - -### params - -▸ **params**(`consumerId`, `nftAmount`, `providerId?`): `NFTSalesTemplateParams` - -#### Parameters - -| Name | Type | -| :------------ | :-------- | -| `consumerId` | `string` | -| `nftAmount` | `default` | -| `providerId?` | `string` | - -#### Returns - -`NFTSalesTemplateParams` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[params](templates.BaseTemplate.md#params) - -#### Defined in - -[src/keeper/contracts/templates/NFTSalesTemplate.ts:42](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFTSalesTemplate.ts#L42) - ---- - -### paramsGen - -▸ **paramsGen**(`__namedParameters`): `Promise`<`NFTSalesTemplateParams`\> - -Specialize params - -#### Parameters - -| Name | Type | Description | -| :------------------ | :----------------- | :----------------- | -| `__namedParameters` | `ValidationParams` | Generic parameters | - -#### Returns - -`Promise`<`NFTSalesTemplateParams`\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[paramsGen](templates.BaseTemplate.md#paramsgen) - -#### Defined in - -[src/keeper/contracts/templates/NFTSalesTemplate.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFTSalesTemplate.ts#L50) - ---- - -### paymentData - -▸ **paymentData**(`service`): [`PaymentData`](../interfaces/templates.PaymentData.md) - -#### Parameters - -| Name | Type | -| :-------- | :-------------- | -| `service` | `ServiceCommon` | - -#### Returns - -[`PaymentData`](../interfaces/templates.PaymentData.md) - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[paymentData](templates.BaseTemplate.md#paymentdata) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:85](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L85) - ---- - -### printAgreementStatus - -▸ **printAgreementStatus**(`agreementId`): `Promise`<`void`\> - -Prints the agreement status. - -#### Parameters - -| Name | Type | Description | -| :------------ | :------- | :------------ | -| `agreementId` | `string` | Agreement ID. | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[printAgreementStatus](templates.BaseTemplate.md#printagreementstatus) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:439](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L439) - ---- - -### process - -▸ **process**(`params`, `from`, `txparams?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :---------- | :---------------------- | -| `params` | `ValidationParams` | -| `from` | [`Account`](Account.md) | -| `txparams?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[process](templates.BaseTemplate.md#process) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:116](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L116) - ---- - -### send - -▸ **send**(`name`, `from`, `args`, `params?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :------------- | -| `name` | `string` | -| `from` | `string` | -| `args` | `any`[] | -| `params` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[send](templates.BaseTemplate.md#send) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:117](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L117) - ---- - -### sendFrom - -▸ **sendFrom**(`name`, `args`, `from?`, `value?`): `Promise`<`ContractReceipt`\> - -#### Parameters - -| Name | Type | -| :------- | :---------------------- | -| `name` | `string` | -| `args` | `any`[] | -| `from?` | [`Account`](Account.md) | -| `value?` | `TxParameters` | - -#### Returns - -`Promise`<`ContractReceipt`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[sendFrom](templates.BaseTemplate.md#sendfrom) - -#### Defined in - -[src/keeper/contracts/ContractBase.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/ContractBase.ts#L97) - ---- - -### service - -▸ **service**(): `ServiceType` - -#### Returns - -`ServiceType` - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[service](templates.BaseTemplate.md#service) - -#### Defined in - -[src/keeper/contracts/templates/NFTSalesTemplate.ts:31](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFTSalesTemplate.ts#L31) - ---- - -### serviceEndpoint - -▸ **serviceEndpoint**(): `ServiceType` - -#### Returns - -`ServiceType` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[serviceEndpoint](templates.BaseTemplate.md#serviceendpoint) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:31](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L31) - ---- - -### setInstanceConfig - -▸ `Protected` **setInstanceConfig**(`config`): `void` - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`void` - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[setInstanceConfig](templates.BaseTemplate.md#setinstanceconfig) - -#### Defined in - -[src/Instantiable.abstract.ts:171](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L171) - ---- - -### standardContext - -▸ **standardContext**(`ddo`, `creator`): [`ConditionContext`](../interfaces/conditions.ConditionContext.md) - -#### Parameters - -| Name | Type | -| :-------- | :-------------- | -| `ddo` | [`DDO`](DDO.md) | -| `creator` | `string` | - -#### Returns - -[`ConditionContext`](../interfaces/conditions.ConditionContext.md) - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[standardContext](templates.BaseTemplate.md#standardcontext) - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:207](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L207) - ---- - -### validateAgreement - -▸ **validateAgreement**(`agreement_id`, `did`, `params`, `from`, `extra?`, `txparams?`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------------- | :----------------------- | -| `agreement_id` | `string` | -| `did` | `string` | -| `params` | `NFTSalesTemplateParams` | -| `from` | [`Account`](Account.md) | -| `extra` | `any` | -| `txparams?` | `TxParameters` | - -#### Returns - -`Promise`<`void`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[validateAgreement](templates.BaseTemplate.md#validateagreement) - -#### Defined in - -[src/keeper/contracts/templates/BaseTemplate.abstract.ts:131](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/BaseTemplate.abstract.ts#L131) - ---- - -### addressesStatic - -▸ `Static` **addressesStatic**(`config`, `web3`): `Promise`<`string`[]\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | - -#### Returns - -`Promise`<`string`[]\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[addressesStatic](templates.BaseTemplate.md#addressesstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:142](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L142) - ---- - -### findSignerStatic - -▸ `Static` **findSignerStatic**(`config`, `web3`, `from`): `Promise`<`Signer`\> - -#### Parameters - -| Name | Type | -| :------- | :-------------------- | -| `config` | [`Config`](Config.md) | -| `web3` | `JsonRpcProvider` | -| `from` | `string` | - -#### Returns - -`Promise`<`Signer`\> - -#### Inherited from - -[BaseTemplate](templates.BaseTemplate.md).[findSignerStatic](templates.BaseTemplate.md#findsignerstatic) - -#### Defined in - -[src/Instantiable.abstract.ts:115](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L115) - ---- - -### getInstance - -▸ `Static` **getInstance**(`config`): `Promise`<[`NFTSalesTemplate`](templates.NFTSalesTemplate.md)\> - -#### Parameters - -| Name | Type | -| :------- | :------------------- | -| `config` | `InstantiableConfig` | - -#### Returns - -`Promise`<[`NFTSalesTemplate`](templates.NFTSalesTemplate.md)\> - -#### Overrides - -[BaseTemplate](templates.BaseTemplate.md).[getInstance](templates.BaseTemplate.md#getinstance) - -#### Defined in - -[src/keeper/contracts/templates/NFTSalesTemplate.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/NFTSalesTemplate.ts#L25) - ---- - -### 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 - -[BaseTemplate](templates.BaseTemplate.md).[setInstanceConfig](templates.BaseTemplate.md#setinstanceconfig-1) - -#### Defined in - -[src/Instantiable.abstract.ts:162](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/Instantiable.abstract.ts#L162) diff --git a/docs/api-reference/classes/utils.Logger.md b/docs/api-reference/classes/utils.Logger.md deleted file mode 100644 index 218d1053a..000000000 --- a/docs/api-reference/classes/utils.Logger.md +++ /dev/null @@ -1,193 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [utils](../modules/utils.md) / Logger - -# Class: Logger - -[utils](../modules/utils.md).Logger - -## Table of contents - -### Constructors - -- [constructor](utils.Logger.md#constructor) - -### Properties - -- [logLevel](utils.Logger.md#loglevel) - -### Methods - -- [bypass](utils.Logger.md#bypass) -- [debug](utils.Logger.md#debug) -- [dispatch](utils.Logger.md#dispatch) -- [error](utils.Logger.md#error) -- [log](utils.Logger.md#log) -- [setLevel](utils.Logger.md#setlevel) -- [warn](utils.Logger.md#warn) - -## Constructors - -### constructor - -• **new Logger**(`logLevel?`) - -#### Parameters - -| Name | Type | Default value | -| :--------- | :--------------------------------------- | :-------------- | -| `logLevel` | [`LogLevel`](../enums/utils.LogLevel.md) | `LogLevel.Warn` | - -#### Defined in - -[src/utils/Logger.ts:10](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/Logger.ts#L10) - -## Properties - -### logLevel - -• `Private` **logLevel**: [`LogLevel`](../enums/utils.LogLevel.md) = `LogLevel.Warn` - -#### Defined in - -[src/utils/Logger.ts:10](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/Logger.ts#L10) - -## Methods - -### bypass - -▸ **bypass**(...`args`): `void` - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`void` - -#### Defined in - -[src/utils/Logger.ts:16](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/Logger.ts#L16) - ---- - -### debug - -▸ **debug**(...`args`): `void` - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`void` - -#### Defined in - -[src/utils/Logger.ts:20](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/Logger.ts#L20) - ---- - -### dispatch - -▸ `Private` **dispatch**(`verb`, `level`, ...`args`): `void` - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------- | -| `verb` | `string` | -| `level` | [`LogLevel`](../enums/utils.LogLevel.md) | -| `...args` | `any`[] | - -#### Returns - -`void` - -#### Defined in - -[src/utils/Logger.ts:36](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/Logger.ts#L36) - ---- - -### error - -▸ **error**(...`args`): `void` - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`void` - -#### Defined in - -[src/utils/Logger.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/Logger.ts#L32) - ---- - -### log - -▸ **log**(...`args`): `void` - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`void` - -#### Defined in - -[src/utils/Logger.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/Logger.ts#L24) - ---- - -### setLevel - -▸ **setLevel**(`logLevel`): `void` - -#### Parameters - -| Name | Type | -| :--------- | :--------------------------------------- | -| `logLevel` | [`LogLevel`](../enums/utils.LogLevel.md) | - -#### Returns - -`void` - -#### Defined in - -[src/utils/Logger.ts:12](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/Logger.ts#L12) - ---- - -### warn - -▸ **warn**(...`args`): `void` - -#### Parameters - -| Name | Type | -| :-------- | :------ | -| `...args` | `any`[] | - -#### Returns - -`void` - -#### Defined in - -[src/utils/Logger.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/Logger.ts#L28) diff --git a/docs/api-reference/code-reference.md b/docs/api-reference/code-reference.md index ae90f390e..1f2d67811 100644 --- a/docs/api-reference/code-reference.md +++ b/docs/api-reference/code-reference.md @@ -4,78 +4,1245 @@ ## Table of contents -### Namespaces +### References -- [KeyTransfer](modules/KeyTransfer.md) -- [conditions](modules/conditions.md) -- [events](modules/events.md) -- [subgraphs](modules/subgraphs.md) -- [templates](modules/templates.md) -- [utils](modules/utils.md) +- [LoggerInstance](code-reference.md#loggerinstance) ### Enumerations +- [AccessStatus](enums/AccessStatus.md) +- [AssetResult](enums/AssetResult.md) - [ConditionState](enums/ConditionState.md) - [CreateProgressStep](enums/CreateProgressStep.md) +- [DIDResolvePolicy](enums/DIDResolvePolicy.md) +- [ERCType](enums/ERCType.md) +- [ExecuteProgressStep](enums/ExecuteProgressStep.md) +- [ExternalResourceFileType](enums/ExternalResourceFileType.md) +- [ImmutableBackends](enums/ImmutableBackends.md) +- [LogLevel](enums/LogLevel.md) +- [NeverminedNFT1155Type](enums/NeverminedNFT1155Type.md) +- [NeverminedNFT721Type](enums/NeverminedNFT721Type.md) +- [NodeUploadBackends](enums/NodeUploadBackends.md) - [OrderProgressStep](enums/OrderProgressStep.md) - [PermissionType](enums/PermissionType.md) - [PlatformTechStatus](enums/PlatformTechStatus.md) - [ProvenanceMethod](enums/ProvenanceMethod.md) +- [PublishMetadataOptions](enums/PublishMetadataOptions.md) +- [PublishOnChainOptions](enums/PublishOnChainOptions.md) +- [RoyaltyKind](enums/RoyaltyKind.md) - [State](enums/State.md) +- [TemplateState](enums/TemplateState.md) +- [UpdateProgressStep](enums/UpdateProgressStep.md) +- [ValueType](enums/ValueType.md) ### Classes +- [AaveBorrowCondition](classes/AaveBorrowCondition.md) +- [AaveCollateralDepositCondition](classes/AaveCollateralDepositCondition.md) +- [AaveCollateralWithdrawCondition](classes/AaveCollateralWithdrawCondition.md) +- [AaveCredit](classes/AaveCredit.md) +- [AaveCreditTemplate](classes/AaveCreditTemplate.md) +- [AaveRepayCondition](classes/AaveRepayCondition.md) +- [AccessCondition](classes/AccessCondition.md) +- [AccessService](classes/AccessService.md) +- [AccessTemplate](classes/AccessTemplate.md) - [Account](classes/Account.md) -- [Accounts](classes/Accounts.md) +- [AccountsApi](classes/AccountsApi.md) +- [AgreementStoreManager](classes/AgreementStoreManager.md) - [AgreementTemplate](classes/AgreementTemplate.md) +- [AgreementsApi](classes/AgreementsApi.md) +- [ApiError](classes/ApiError.md) +- [AssetAttributes](classes/AssetAttributes.md) +- [AssetError](classes/AssetError.md) +- [AssetPrice](classes/AssetPrice.md) +- [AssetPublicationOptions](classes/AssetPublicationOptions.md) +- [AssetsApi](classes/AssetsApi.md) +- [BabyjubPublicKey](classes/BabyjubPublicKey.md) +- [BaseTemplate](classes/BaseTemplate.md) +- [Bookmarks](classes/Bookmarks.md) - [ClientError](classes/ClientError.md) +- [ComputeApi](classes/ComputeApi.md) +- [ComputeExecutionCondition](classes/ComputeExecutionCondition.md) - [Condition](classes/Condition.md) -- [Config](classes/Config.md) +- [ConditionSmall](classes/ConditionSmall.md) +- [ConditionStoreManager](classes/ConditionStoreManager.md) +- [ConsumerCondition](classes/ConsumerCondition.md) +- [ContractBase](classes/ContractBase.md) +- [ContractEvent](classes/ContractEvent.md) +- [ContractHandler](classes/ContractHandler.md) +- [CurveRoyalties](classes/CurveRoyalties.md) +- [CustomToken](classes/CustomToken.md) - [DDO](classes/DDO.md) +- [DDOError](classes/DDOError.md) +- [DDOPriceNotFoundError](classes/DDOPriceNotFoundError.md) +- [DDOServiceNotFoundError](classes/DDOServiceNotFoundError.md) - [DID](classes/DID.md) +- [DIDRegistry](classes/DIDRegistry.md) +- [DIDSalesTemplate](classes/DIDSalesTemplate.md) +- [Dispenser](classes/Dispenser.md) +- [DistributeNFTCollateralCondition](classes/DistributeNFTCollateralCondition.md) +- [EscrowComputeExecutionTemplate](classes/EscrowComputeExecutionTemplate.md) +- [EscrowPaymentCondition](classes/EscrowPaymentCondition.md) +- [EthSignJWT](classes/EthSignJWT.md) +- [EventHandler](classes/EventHandler.md) +- [Files](classes/Files.md) +- [GenericContract](classes/GenericContract.md) +- [GraphError](classes/GraphError.md) +- [HttpError](classes/HttpError.md) +- [Instantiable](classes/Instantiable.md) +- [JwtUtils](classes/JwtUtils.md) - [Keeper](classes/Keeper.md) +- [KeeperError](classes/KeeperError.md) +- [LockPaymentCondition](classes/LockPaymentCondition.md) +- [MarketplaceApi](classes/MarketplaceApi.md) +- [MetadataService](classes/MetadataService.md) +- [MimcCipher](classes/MimcCipher.md) +- [NFT1155Api](classes/NFT1155Api.md) +- [NFT721AccessTemplate](classes/NFT721AccessTemplate.md) +- [NFT721Api](classes/NFT721Api.md) +- [NFT721HolderCondition](classes/NFT721HolderCondition.md) +- [NFT721LockCondition](classes/NFT721LockCondition.md) +- [NFT721SalesTemplate](classes/NFT721SalesTemplate.md) +- [NFTAccessCondition](classes/NFTAccessCondition.md) +- [NFTAccessService](classes/NFTAccessService.md) +- [NFTAccessTemplate](classes/NFTAccessTemplate.md) +- [NFTAttributes](classes/NFTAttributes.md) +- [NFTContractsBase](classes/NFTContractsBase.md) +- [NFTError](classes/NFTError.md) +- [NFTHolderCondition](classes/NFTHolderCondition.md) +- [NFTLockCondition](classes/NFTLockCondition.md) +- [NFTSalesService](classes/NFTSalesService.md) +- [NFTSalesTemplate](classes/NFTSalesTemplate.md) +- [NFTServiceAttributes](classes/NFTServiceAttributes.md) +- [NFTsBaseApi](classes/NFTsBaseApi.md) - [Nevermined](classes/Nevermined.md) -- [Nft721](classes/Nft721.md) -- [Nfts](classes/Nfts.md) +- [NeverminedEvent](classes/NeverminedEvent.md) +- [NeverminedNode](classes/NeverminedNode.md) +- [NeverminedNodeError](classes/NeverminedNodeError.md) +- [NeverminedOptions](classes/NeverminedOptions.md) +- [Nft1155Contract](classes/Nft1155Contract.md) +- [Nft721Contract](classes/Nft721Contract.md) +- [Permissions](classes/Permissions.md) +- [Profiles](classes/Profiles.md) +- [ProvenanceApi](classes/ProvenanceApi.md) +- [ProviderCondition](classes/ProviderCondition.md) +- [Providers](classes/Providers.md) +- [RegistryBaseApi](classes/RegistryBaseApi.md) +- [RewardsDistributor](classes/RewardsDistributor.md) +- [RoyaltyScheme](classes/RoyaltyScheme.md) +- [SearchApi](classes/SearchApi.md) +- [ServiceAgreement](classes/ServiceAgreement.md) +- [ServicesApi](classes/ServicesApi.md) +- [SignatureUtils](classes/SignatureUtils.md) +- [StandardRoyalties](classes/StandardRoyalties.md) +- [SubgraphEvent](classes/SubgraphEvent.md) +- [SubscribableObserver](classes/SubscribableObserver.md) +- [SubscribablePromise](classes/SubscribablePromise.md) +- [SubscriptionCreditsNFTApi](classes/SubscriptionCreditsNFTApi.md) +- [SubscriptionNFTApi](classes/SubscriptionNFTApi.md) +- [TemplateStoreManager](classes/TemplateStoreManager.md) +- [Token](classes/Token.md) +- [TokenUtils](classes/TokenUtils.md) +- [TransferDIDOwnershipCondition](classes/TransferDIDOwnershipCondition.md) +- [TransferNFT721Condition](classes/TransferNFT721Condition.md) +- [TransferNFTCondition](classes/TransferNFTCondition.md) +- [UtilsApi](classes/UtilsApi.md) +- [Versions](classes/Versions.md) +- [Web3Error](classes/Web3Error.md) +- [Web3Provider](classes/Web3Provider.md) +- [Web3ProviderWrapper](classes/Web3ProviderWrapper.md) +- [WebServiceConnector](classes/WebServiceConnector.md) ### Interfaces +- [AaveConfig](interfaces/AaveConfig.md) +- [AaveCreditTemplateParams](interfaces/AaveCreditTemplateParams.md) +- [AccessProofTemplateParams](interfaces/AccessProofTemplateParams.md) +- [ActedOnBehalfEvent](interfaces/ActedOnBehalfEvent.md) - [AdditionalInformation](interfaces/AdditionalInformation.md) +- [AgreementConditionsStatus](interfaces/AgreementConditionsStatus.md) +- [AgreementData](interfaces/AgreementData.md) +- [AgreementInstance](interfaces/AgreementInstance.md) +- [AgreementPrepareResult](interfaces/AgreementPrepareResult.md) - [Algorithm](interfaces/Algorithm.md) +- [AuthToken](interfaces/AuthToken.md) +- [Authentication](interfaces/Authentication.md) +- [Babysig](interfaces/Babysig.md) +- [Balance](interfaces/Balance.md) - [Bookmark](interfaces/Bookmark.md) +- [ConditionContext](interfaces/ConditionContext.md) +- [ConditionData](interfaces/ConditionData.md) +- [ConditionInstance](interfaces/ConditionInstance.md) +- [ConditionInstanceSmall](interfaces/ConditionInstanceSmall.md) +- [ConditionParameters](interfaces/ConditionParameters.md) +- [ContractEventSubscription](interfaces/ContractEventSubscription.md) - [Curation](interfaces/Curation.md) -- [File](interfaces/File.md) +- [DDOStatus](interfaces/DDOStatus.md) +- [Eip712Data](interfaces/Eip712Data.md) +- [EventEmitter](interfaces/EventEmitter.md) +- [EventOptions](interfaces/EventOptions.md) +- [Filter](interfaces/Filter.md) +- [GenericAccess](interfaces/GenericAccess.md) +- [InputType](interfaces/InputType.md) +- [InstantiableConfig](interfaces/InstantiableConfig.md) +- [JsonRpcPayload](interfaces/JsonRpcPayload.md) +- [JsonRpcResponse](interfaces/JsonRpcResponse.md) +- [MarketplaceResults](interfaces/MarketplaceResults.md) - [MetaData](interfaces/MetaData.md) +- [MetaDataExternalResource](interfaces/MetaDataExternalResource.md) - [MetaDataMain](interfaces/MetaDataMain.md) +- [MethodReflection](interfaces/MethodReflection.md) +- [MintedEntry](interfaces/MintedEntry.md) - [NewBookmark](interfaces/NewBookmark.md) - [NewPermission](interfaces/NewPermission.md) - [NewProfile](interfaces/NewProfile.md) +- [NvmConfig](interfaces/NvmConfig.md) +- [NvmConfigVersions](interfaces/NvmConfigVersions.md) +- [PaymentData](interfaces/PaymentData.md) - [Permission](interfaces/Permission.md) - [PlatformKeeperTech](interfaces/PlatformKeeperTech.md) - [PlatformTech](interfaces/PlatformTech.md) - [PlatformVersions](interfaces/PlatformVersions.md) - [Profile](interfaces/Profile.md) +- [Proof](interfaces/Proof.md) +- [ProvenanceAttributeRegisteredEvent](interfaces/ProvenanceAttributeRegisteredEvent.md) +- [ProvenanceBaseEvent](interfaces/ProvenanceBaseEvent.md) - [ProvenanceRegistry](interfaces/ProvenanceRegistry.md) +- [Provider](interfaces/Provider.md) +- [PublicKey](interfaces/PublicKey.md) +- [QueryResult](interfaces/QueryResult.md) +- [ResourceAuthentication](interfaces/ResourceAuthentication.md) +- [RoyaltyAttributes](interfaces/RoyaltyAttributes.md) - [SearchQuery](interfaces/SearchQuery.md) -- [Service](interfaces/Service.md) +- [ServiceAaveCredit](interfaces/ServiceAaveCredit.md) +- [ServiceAccess](interfaces/ServiceAccess.md) +- [ServiceAgreementTemplate](interfaces/ServiceAgreementTemplate.md) +- [ServiceAgreementTemplateCondition](interfaces/ServiceAgreementTemplateCondition.md) +- [ServiceAgreementTemplateEvent](interfaces/ServiceAgreementTemplateEvent.md) +- [ServiceAgreementTemplateParameter](interfaces/ServiceAgreementTemplateParameter.md) +- [ServiceAttributes](interfaces/ServiceAttributes.md) +- [ServiceAuthorization](interfaces/ServiceAuthorization.md) +- [ServiceCommon](interfaces/ServiceCommon.md) +- [ServiceCompute](interfaces/ServiceCompute.md) - [ServiceDefinition](interfaces/ServiceDefinition.md) +- [ServiceMetadata](interfaces/ServiceMetadata.md) +- [ServiceNFTAccess](interfaces/ServiceNFTAccess.md) +- [ServiceNFTSales](interfaces/ServiceNFTSales.md) +- [ServicePlugin](interfaces/ServicePlugin.md) +- [ServiceSecondary](interfaces/ServiceSecondary.md) - [Stage](interfaces/Stage.md) - [StageInput](interfaces/StageInput.md) - [StageOutput](interfaces/StageOutput.md) -- [StageRequirements](interfaces/StageRequirements.md) - [StageTransformation](interfaces/StageTransformation.md) +- [SubscriptionToken](interfaces/SubscriptionToken.md) +- [TemplateMetadata](interfaces/TemplateMetadata.md) +- [TxParameters](interfaces/TxParameters.md) +- [TypedDataDomain](interfaces/TypedDataDomain.md) +- [TypedDataTypes](interfaces/TypedDataTypes.md) +- [UsedEvent](interfaces/UsedEvent.md) +- [ValidationParams](interfaces/ValidationParams.md) +- [ValuePair](interfaces/ValuePair.md) +- [WasAssociatedWithEvent](interfaces/WasAssociatedWithEvent.md) +- [WasDerivedFromEvent](interfaces/WasDerivedFromEvent.md) +- [WasGeneratedByEvent](interfaces/WasGeneratedByEvent.md) +- [WebService](interfaces/WebService.md) +- [WebServiceInternalAttributes](interfaces/WebServiceInternalAttributes.md) - [Workflow](interfaces/Workflow.md) +### Type Aliases + +- [AaveConditionType](code-reference.md#aaveconditiontype) +- [BigNumberish](code-reference.md#bignumberish) +- [ConditionMethod](code-reference.md#conditionmethod) +- [ConditionType](code-reference.md#conditiontype) +- [EncryptionMethod](code-reference.md#encryptionmethod) +- [EventResult](code-reference.md#eventresult) +- [NeverminedNFTType](code-reference.md#neverminednfttype) +- [ParameterType](code-reference.md#parametertype) +- [PricedMetadataInformation](code-reference.md#pricedmetadatainformation) +- [ProvenanceEvent](code-reference.md#provenanceevent) +- [Service](code-reference.md#service) +- [ServiceType](code-reference.md#servicetype) + ### Variables +- [AaveCreditConditions](code-reference.md#aavecreditconditions) +- [DEFAULT_REGISTRATION_ACTIVITY_ID](code-reference.md#default_registration_activity_id) +- [DEPENDENCIES_RELEASE_CONDITION](code-reference.md#dependencies_release_condition) - [Logger](code-reference.md#logger) +- [SALES_SERVICES](code-reference.md#sales_services) +- [ZeroAddress](code-reference.md#zeroaddress) +- [aaveCreditTemplateServiceAgreementTemplate](code-reference.md#aavecredittemplateserviceagreementtemplate) +- [apiPath](code-reference.md#apipath) +- [conditionStateNames](code-reference.md#conditionstatenames) +- [defaultNeverminedNFTType](code-reference.md#defaultneverminednfttype) +- [ercOfNeverminedNFTType](code-reference.md#ercofneverminednfttype) +- [serviceIndex](code-reference.md#serviceindex) +- [servicePath](code-reference.md#servicepath) + +### Functions + +- [buildQuery](code-reference.md#buildquery) +- [convertEthersV6SignerToAccountSigner](code-reference.md#convertethersv6signertoaccountsigner) +- [didPrefixed](code-reference.md#didprefixed) +- [didTransformer](code-reference.md#didtransformer) +- [didZeroX](code-reference.md#didzerox) +- [eventToObject](code-reference.md#eventtoobject) +- [formatEther](code-reference.md#formatether) +- [formatUnits](code-reference.md#formatunits) +- [generateId](code-reference.md#generateid) +- [generateInstantiableConfigFromConfig](code-reference.md#generateinstantiableconfigfromconfig) +- [getCircularReplacer](code-reference.md#getcircularreplacer) +- [getConditionsByParams](code-reference.md#getconditionsbyparams) +- [getNetworkName](code-reference.md#getnetworkname) +- [getRoyaltyAttributes](code-reference.md#getroyaltyattributes) +- [getRoyaltyScheme](code-reference.md#getroyaltyscheme) +- [jsonReplacer](code-reference.md#jsonreplacer) +- [makeAccount](code-reference.md#makeaccount) +- [makeAccounts](code-reference.md#makeaccounts) +- [makeBuffer](code-reference.md#makebuffer) +- [noDidPrefixed](code-reference.md#nodidprefixed) +- [noZeroX](code-reference.md#nozerox) +- [objectPromiseAll](code-reference.md#objectpromiseall) +- [parseEther](code-reference.md#parseether) +- [parseUnits](code-reference.md#parseunits) +- [zeroX](code-reference.md#zerox) +- [zeroXTransformer](code-reference.md#zeroxtransformer) + +## References + +### LoggerInstance + +Renames and re-exports [Logger](code-reference.md#logger) + +## Type Aliases + +### AaveConditionType + +Ƭ **AaveConditionType**: `"lockNft"` \| `"depositCollateral"` \| `"borrowCredit"` \| `"repayCredit"` \| `"withdrawCollateral"` \| `"distributeNft"` + +#### Defined in + +[src/keeper/contracts/defi/Service.ts:19](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/Service.ts#L19) + +--- + +### BigNumberish + +Ƭ **BigNumberish**: `string` \| `Numeric` + +Any type that can be used where a big number is needed. + +#### Defined in + +node_modules/ethers/lib.commonjs/utils/maths.d.ts:9 + +--- + +### ConditionMethod + +Ƭ **ConditionMethod**: `"fulfill"` \| `"fulfillForDelegate"` + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:16](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L16) + +--- + +### ConditionType + +Ƭ **ConditionType**: `"lockPayment"` \| `"escrowPayment"` \| `"nftHolder"` \| `"transferNFT"` \| [`AaveConditionType`](code-reference.md#aaveconditiontype) + +#### Defined in + +[src/ddo/types.ts:555](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L555) + +--- + +### EncryptionMethod + +Ƭ **EncryptionMethod**: `"PSK-RSA"` \| `"PSK-ECDSA"` + +#### Defined in + +[src/services/metadata/MetadataService.ts:16](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MetadataService.ts#L16) + +--- + +### EventResult + +Ƭ **EventResult**: `Promise`<`any`[]\> + +#### Defined in + +[src/events/NeverminedEvent.ts:25](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/NeverminedEvent.ts#L25) + +--- + +### NeverminedNFTType + +Ƭ **NeverminedNFTType**: [`NeverminedNFT721Type`](enums/NeverminedNFT721Type.md) \| [`NeverminedNFT1155Type`](enums/NeverminedNFT1155Type.md) + +#### Defined in + +[src/models/types.ts:40](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/types.ts#L40) + +--- + +### ParameterType + +Ƭ **ParameterType**: `string` \| `number` \| `number`[] \| [`Account`](classes/Account.md) \| [`BabyjubPublicKey`](classes/BabyjubPublicKey.md) \| [`Service`](code-reference.md#service) \| [`ServiceType`](code-reference.md#servicetype) \| [`TxParameters`](interfaces/TxParameters.md) + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:27](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L27) + +--- + +### PricedMetadataInformation + +Ƭ **PricedMetadataInformation**: `Object` + +#### Type declaration + +| Name | Type | +| :---------------------------------------------------------- | :---------------------------------------------------------------------------------------------------- | +| `attributes` | { `additionalInformation`: { `priceHighestDenomination`: `number` } ; `main`: { `price`: `string` } } | +| `attributes.additionalInformation` | { `priceHighestDenomination`: `number` } | +| `attributes.additionalInformation.priceHighestDenomination` | `number` | +| `attributes.main` | { `price`: `string` } | +| `attributes.main.price` | `string` | + +#### Defined in + +[src/ddo/types.ts:600](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L600) + +--- + +### ProvenanceEvent + +Ƭ **ProvenanceEvent**<`T`\>: `T` extends [`WAS_GENERATED_BY`](enums/ProvenanceMethod.md#was_generated_by) ? [`WasGeneratedByEvent`](interfaces/WasGeneratedByEvent.md) : `T` extends [`USED`](enums/ProvenanceMethod.md#used) ? [`UsedEvent`](interfaces/UsedEvent.md) : `T` extends [`WAS_DERIVED_FROM`](enums/ProvenanceMethod.md#was_derived_from) ? [`WasDerivedFromEvent`](interfaces/WasDerivedFromEvent.md) : `T` extends [`WAS_ASSOCIATED_WITH`](enums/ProvenanceMethod.md#was_associated_with) ? [`WasAssociatedWithEvent`](interfaces/WasAssociatedWithEvent.md) : `T` extends [`ACTED_ON_BEHALF`](enums/ProvenanceMethod.md#acted_on_behalf) ? [`ActedOnBehalfEvent`](interfaces/ActedOnBehalfEvent.md) : [`WasGeneratedByEvent`](interfaces/WasGeneratedByEvent.md) \| [`UsedEvent`](interfaces/UsedEvent.md) \| [`WasDerivedFromEvent`](interfaces/WasDerivedFromEvent.md) \| [`WasAssociatedWithEvent`](interfaces/WasAssociatedWithEvent.md) \| [`ActedOnBehalfEvent`](interfaces/ActedOnBehalfEvent.md) + +#### Type parameters + +| Name | Type | +| :--- | :----------------------------------------------------------------------- | +| `T` | extends [`ProvenanceMethod`](enums/ProvenanceMethod.md) \| `any` = `any` | + +#### Defined in + +[src/keeper/contracts/Provenance.ts:82](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L82) + +--- + +### Service + +Ƭ **Service**<`T`\>: `T` extends `"authorization"` ? [`ServiceAuthorization`](interfaces/ServiceAuthorization.md) : `T` extends `"metadata"` ? [`ServiceMetadata`](interfaces/ServiceMetadata.md) : `T` extends `"nft-access"` ? [`ServiceNFTAccess`](interfaces/ServiceNFTAccess.md) : `T` extends `"nft-sales"` ? [`ServiceNFTSales`](interfaces/ServiceNFTSales.md) : `T` extends `"access"` ? [`ServiceAccess`](interfaces/ServiceAccess.md) : `T` extends `"compute"` ? [`ServiceCompute`](interfaces/ServiceCompute.md) : `T` extends `"aave-credit"` ? [`ServiceAaveCredit`](interfaces/ServiceAaveCredit.md) : `T` extends `"default"` ? [`ServiceCommon`](interfaces/ServiceCommon.md) : [`ServiceCommon`](interfaces/ServiceCommon.md) + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------------------------------------------------- | +| `T` | extends [`ServiceType`](code-reference.md#servicetype) \| `"default"` = `"default"` | + +#### Defined in + +[src/ddo/types.ts:719](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L719) + +--- + +### ServiceType + +Ƭ **ServiceType**: `"authorization"` \| `"metadata"` \| `"access"` \| `"compute"` \| `"workflow"` \| `"nft-access"` \| `"nft-sales"` \| `"aave-credit"` \| `"nft-sales-proof"` + +#### Defined in + +[src/ddo/types.ts:562](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L562) ## Variables +### AaveCreditConditions + +• `Const` **AaveCreditConditions**: `string`[] + +#### Defined in + +[src/keeper/contracts/defi/Service.ts:10](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/Service.ts#L10) + +--- + +### DEFAULT_REGISTRATION_ACTIVITY_ID + +• `Const` **DEFAULT_REGISTRATION_ACTIVITY_ID**: `string` + +Identifies the default Provenance Activity Id to be recorded on-chain in the DIDRegistry Smart Contract when +an asset is registered. It associates to the new DID created the 'Asset Registration' activity. +(@see https://docs.nevermined.io/docs/architecture/specs/Spec-PROVENANCE#provenance-relations) + +#### Defined in + +[src/keeper/contracts/Provenance.ts:9](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L9) + +--- + +### DEPENDENCIES_RELEASE_CONDITION + +• `Const` **DEPENDENCIES_RELEASE_CONDITION**: `string`[] + +#### Defined in + +[src/ddo/DDO.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L31) + +--- + ### Logger -• `Const` **Logger**: [`Logger`](classes/utils.Logger.md) +• `Const` **Logger**: `Logger` + +#### Defined in + +[src/utils/Logger.ts:43](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/utils/Logger.ts#L43) + +--- + +### SALES_SERVICES + +• `Const` **SALES_SERVICES**: `string`[] + +#### Defined in + +[src/ddo/DDO.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/DDO.ts#L29) + +--- + +### ZeroAddress + +• `Const` **ZeroAddress**: `"0x0000000000000000000000000000000000000000"` + +#### Defined in + +[src/utils/ConversionTypeHelpers.ts:43](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/utils/ConversionTypeHelpers.ts#L43) + +--- + +### aaveCreditTemplateServiceAgreementTemplate + +• `Const` **aaveCreditTemplateServiceAgreementTemplate**: [`ServiceAgreementTemplate`](interfaces/ServiceAgreementTemplate.md) + +#### Defined in + +[src/keeper/contracts/defi/AaveCreditTemplate.serviceAgreementTemplate.ts:3](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveCreditTemplate.serviceAgreementTemplate.ts#L3) + +--- + +### apiPath + +• `Const` **apiPath**: `"/api/v1/metadata/assets/ddo"` + +#### Defined in + +[src/services/metadata/MetadataService.ts:6](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MetadataService.ts#L6) + +--- + +### conditionStateNames + +• `Const` **conditionStateNames**: `string`[] + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L42) + +--- + +### defaultNeverminedNFTType + +• `Const` **defaultNeverminedNFTType**: `Object` + +#### Type declaration + +| Name | Type | +| :----- | :-------------------------------------------------------- | +| `1155` | [`NeverminedNFT1155Type`](enums/NeverminedNFT1155Type.md) | +| `721` | [`NeverminedNFT721Type`](enums/NeverminedNFT721Type.md) | + +#### Defined in + +[src/models/types.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/types.ts#L49) + +--- + +### ercOfNeverminedNFTType + +• `Const` **ercOfNeverminedNFTType**: `Object` + +#### Type declaration + +| Name | Type | +| :-------------------- | :---------------------------- | +| `nft1155` | [`ERCType`](enums/ERCType.md) | +| `nft1155-credit` | [`ERCType`](enums/ERCType.md) | +| `nft721` | [`ERCType`](enums/ERCType.md) | +| `nft721-subscription` | [`ERCType`](enums/ERCType.md) | + +#### Defined in + +[src/models/types.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/types.ts#L42) + +--- + +### serviceIndex + +• `Const` **serviceIndex**: `Object` + +#### Type declaration + +| Name | Type | +| :-------------------- | :------- | +| `aave-credit` | `number` | +| `access` | `number` | +| `access-proof` | `number` | +| `authorization` | `number` | +| `compute` | `number` | +| `metadata` | `number` | +| `nft-access` | `number` | +| `nft-access-proof` | `number` | +| `nft-sales` | `number` | +| `nft-sales-proof` | `number` | +| `nft721-access` | `number` | +| `nft721-access-proof` | `number` | +| `nft721-sales` | `number` | +| `nft721-sales-proof` | `number` | +| `workflow` | `number` | + +#### Defined in + +[src/ddo/types.ts:573](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L573) + +--- + +### servicePath + +• `Const` **servicePath**: `"/api/v1/metadata/assets/service"` + +#### Defined in + +[src/services/metadata/MetadataService.ts:7](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MetadataService.ts#L7) + +## Functions + +### buildQuery + +▸ **buildQuery**(`url`, `query`): `any` + +#### Parameters + +| Name | Type | +| :------ | :----------------------------------------- | +| `url` | `string` | +| `query` | [`SearchQuery`](interfaces/SearchQuery.md) | + +#### Returns + +`any` + +#### Defined in + +[src/common/helpers.ts:4](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/common/helpers.ts#L4) + +--- + +### convertEthersV6SignerToAccountSigner + +▸ **convertEthersV6SignerToAccountSigner**(`signer`): `SmartAccountSigner` + +#### Parameters + +| Name | Type | +| :------- | :------------------- | +| `signer` | `Signer` \| `Wallet` | + +#### Returns + +`SmartAccountSigner` + +#### Defined in + +[src/keeper/utils.ts:100](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/utils.ts#L100) + +--- + +### didPrefixed + +▸ **didPrefixed**(`input`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `input` | `string` | + +#### Returns + +`string` + +#### Defined in + +[src/utils/ConversionTypeHelpers.ts:13](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/utils/ConversionTypeHelpers.ts#L13) + +--- + +### didTransformer + +▸ **didTransformer**(`input?`, `prefixOutput`): `string` + +#### Parameters + +| Name | Type | Default value | +| :------------- | :-------- | :------------ | +| `input` | `string` | `''` | +| `prefixOutput` | `boolean` | `undefined` | + +#### Returns + +`string` + +#### Defined in + +[src/utils/ConversionTypeHelpers.ts:16](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/utils/ConversionTypeHelpers.ts#L16) + +--- + +### didZeroX + +▸ **didZeroX**(`input`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `input` | `string` | + +#### Returns + +`string` + +#### Defined in + +[src/utils/ConversionTypeHelpers.ts:22](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/utils/ConversionTypeHelpers.ts#L22) + +--- + +### eventToObject + +▸ **eventToObject**(`event`): `any` + +#### Parameters + +| Name | Type | +| :------ | :---- | +| `event` | `any` | + +#### Returns + +`any` + +#### Defined in + +[src/utils/Events.ts:1](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/utils/Events.ts#L1) + +--- + +### formatEther + +▸ **formatEther**(`value`): `string` + +Converts a _wei_ value into _ether_. + +#### Parameters + +| Name | Type | Description | +| :------ | :----------------------------------------------- | :------------------- | +| `value` | [`BigNumberish`](code-reference.md#bignumberish) | The value to format. | + +#### Returns + +`string` + +The string of the formatted value + +**`Example`** + +```ts +const value = 1000000000000000000n + +formatEther(value) +// '1.0' +``` + +#### Defined in + +[src/utils/UnitConversion.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/utils/UnitConversion.ts#L57) + +--- + +### formatUnits + +▸ **formatUnits**(`value`, `decimals?`): `string` + +Returns a string representation of value formatted with _decimal_ digits. + +#### Parameters + +| Name | Type | Default value | Description | +| :--------- | :----------------------------------------------- | :------------ | :------------------- | +| `value` | [`BigNumberish`](code-reference.md#bignumberish) | `undefined` | The value to format. | +| `decimals` | `number` | `18` | - | + +#### Returns + +`string` + +The string of the formatted value + +**`Example`** + +```ts +const oneEther = 1000000000000000000n + +formatUnits(oneEther, 18) +// '1.0' +``` + +#### Defined in + +[src/utils/UnitConversion.ts:75](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/utils/UnitConversion.ts#L75) + +--- + +### generateId + +▸ **generateId**(`length?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :------- | :------- | :------------ | +| `length` | `number` | `64` | + +#### Returns + +`string` + +#### Defined in + +[src/utils/GeneratorHelpers.ts:3](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/utils/GeneratorHelpers.ts#L3) + +--- + +### generateInstantiableConfigFromConfig + +▸ **generateInstantiableConfigFromConfig**(`config`): `Promise`<`Partial`<[`InstantiableConfig`](interfaces/InstantiableConfig.md)\>\> + +#### Parameters + +| Name | Type | +| :------- | :-------------------------------------------------- | +| `config` | [`NeverminedOptions`](classes/NeverminedOptions.md) | + +#### Returns + +`Promise`<`Partial`<[`InstantiableConfig`](interfaces/InstantiableConfig.md)\>\> + +#### Defined in + +[src/Instantiable.abstract.ts:16](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L16) + +--- + +### getCircularReplacer + +▸ **getCircularReplacer**(): (`key`: `any`, `value`: `any`) => `any` + +#### Returns + +`fn` + +▸ (`key`, `value`): `any` + +##### Parameters + +| Name | Type | +| :------ | :---- | +| `key` | `any` | +| `value` | `any` | + +##### Returns + +`any` + +#### Defined in + +[src/common/helpers.ts:18](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/common/helpers.ts#L18) + +--- + +### getConditionsByParams + +▸ **getConditionsByParams**(`serviceType`, `conditions`, `owner`, `assetPrice?`, `did?`, `erc20TokenContract?`, `nftTokenContract?`, `nftHolder?`, `nftAmount?`, `nftTransfer?`, `duration?`, `fulfillAccessTimeout?`, `fulfillAccessTimelock?`, `tokenId?`): [`ServiceAgreementTemplateCondition`](interfaces/ServiceAgreementTemplateCondition.md)[] + +Fill some static parameters that depends on the metadata. + +#### Parameters + +| Name | Type | Default value | Description | +| :---------------------- | :------------------------------------------------------------------------------------------------ | :------------ | :----------------------- | +| `serviceType` | [`ServiceType`](code-reference.md#servicetype) | `undefined` | - | +| `conditions` | readonly [`ServiceAgreementTemplateCondition`](interfaces/ServiceAgreementTemplateCondition.md)[] | `undefined` | Conditions to fill. | +| `owner` | `string` | `undefined` | - | +| `assetPrice` | [`AssetPrice`](classes/AssetPrice.md) | `undefined` | Rewards distribution | +| `did?` | `string` | `undefined` | - | +| `erc20TokenContract?` | `string` | `undefined` | Number of nfts to handle | +| `nftTokenContract?` | `string` | `undefined` | Number of nfts to handle | +| `nftHolder?` | `string` | `undefined` | - | +| `nftAmount` | `bigint` | `undefined` | Number of nfts to handle | +| `nftTransfer` | `boolean` | `false` | - | +| `duration` | `number` | `0` | - | +| `fulfillAccessTimeout` | `number` | `0` | - | +| `fulfillAccessTimelock` | `number` | `0` | - | +| `tokenId` | `string` | `''` | - | + +#### Returns + +[`ServiceAgreementTemplateCondition`](interfaces/ServiceAgreementTemplateCondition.md)[] + +Filled conditions. + +#### Defined in + +[src/utils/DDOHelpers.ts:25](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/utils/DDOHelpers.ts#L25) + +--- + +### getNetworkName + +▸ **getNetworkName**(`networkId`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :---------- | :------- | +| `networkId` | `number` | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/keeper/utils.ts:5](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/utils.ts#L5) + +--- + +### getRoyaltyAttributes + +▸ **getRoyaltyAttributes**(`nvm`, `kind`, `amount`): [`RoyaltyAttributes`](interfaces/RoyaltyAttributes.md) + +It gets a `RoyaltyAttributes` instance + +#### Parameters + +| Name | Type | Description | +| :------- | :------------------------------------ | :----------------------------------------------------- | +| `nvm` | [`Nevermined`](classes/Nevermined.md) | Nevermined instance | +| `kind` | [`RoyaltyKind`](enums/RoyaltyKind.md) | The type of royalty | +| `amount` | `number` | The amount of royalties to get in the secondary market | + +#### Returns + +[`RoyaltyAttributes`](interfaces/RoyaltyAttributes.md) + +The RoyaltyAttributes instance + +#### Defined in + +[src/nevermined/api/AssetsApi.ts:96](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AssetsApi.ts#L96) + +--- + +### getRoyaltyScheme + +▸ **getRoyaltyScheme**(`nvm`, `kind`): [`RoyaltyScheme`](classes/RoyaltyScheme.md) + +It gets the on-chain royalties scheme + +#### Parameters + +| Name | Type | Description | +| :----- | :------------------------------------ | :------------------ | +| `nvm` | [`Nevermined`](classes/Nevermined.md) | Nevermined instance | +| `kind` | [`RoyaltyKind`](enums/RoyaltyKind.md) | The type of royalty | + +#### Returns + +[`RoyaltyScheme`](classes/RoyaltyScheme.md) + +The royalty scheme + +#### Defined in + +[src/nevermined/api/AssetsApi.ts:81](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AssetsApi.ts#L81) + +--- + +### jsonReplacer + +▸ **jsonReplacer**(`key`, `value`): `any` + +#### Parameters + +| Name | Type | +| :------ | :---- | +| `key` | `any` | +| `value` | `any` | + +#### Returns + +`any` + +#### Defined in + +[src/common/helpers.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/common/helpers.ts#L31) + +--- + +### makeAccount + +▸ **makeAccount**(`seedphrase`, `accountIndex?`): `ethers.Wallet` + +#### Parameters + +| Name | Type | Default value | +| :------------- | :------- | :------------ | +| `seedphrase` | `string` | `undefined` | +| `accountIndex` | `number` | `0` | + +#### Returns + +`ethers.Wallet` + +#### Defined in + +[src/utils/MakeAccounts.ts:16](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/utils/MakeAccounts.ts#L16) + +--- + +### makeAccounts + +▸ **makeAccounts**(`seedphrase`, `numAccounts?`): `ethers.Wallet`[] + +#### Parameters + +| Name | Type | Default value | +| :------------ | :------- | :------------ | +| `seedphrase` | `string` | `undefined` | +| `numAccounts` | `number` | `10` | + +#### Returns + +`ethers.Wallet`[] + +#### Defined in + +[src/utils/MakeAccounts.ts:3](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/utils/MakeAccounts.ts#L3) + +--- + +### makeBuffer + +▸ **makeBuffer**(`a`, `b`): `Buffer` + +#### Parameters + +| Name | Type | +| :--- | :---- | +| `a` | `any` | +| `b` | `any` | + +#### Returns + +`Buffer` + +#### Defined in + +[src/utils/index.ts:12](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/utils/index.ts#L12) + +--- + +### noDidPrefixed + +▸ **noDidPrefixed**(`input`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `input` | `string` | + +#### Returns + +`string` + +#### Defined in + +[src/utils/ConversionTypeHelpers.ts:14](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/utils/ConversionTypeHelpers.ts#L14) + +--- + +### noZeroX + +▸ **noZeroX**(`input`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `input` | `string` | + +#### Returns + +`string` + +#### Defined in + +[src/utils/ConversionTypeHelpers.ts:5](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/utils/ConversionTypeHelpers.ts#L5) + +--- + +### objectPromiseAll + +▸ **objectPromiseAll**(`obj`): `Promise`<`any`\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `obj` | `Object` | + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +[src/utils/PromiseResolver.ts:11](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/utils/PromiseResolver.ts#L11) + +--- + +### parseEther + +▸ **parseEther**(`value`): `bigint` + +Converts a ether _value_ into _wei_. + +#### Parameters + +| Name | Type | Description | +| :------ | :------- | :-------------------------- | +| `value` | `string` | The string value to convert | + +#### Returns + +`bigint` + +The BigInt representation of _value_ in _wei_ + +**`Example`** + +```ts +parseEther('1.0') +// 1000000000000000000n + +parseEther('-0.5') +// -500000000000000000n +``` + +#### Defined in + +[src/utils/UnitConversion.ts:19](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/utils/UnitConversion.ts#L19) + +--- + +### parseUnits + +▸ **parseUnits**(`value`, `decimals?`): `bigint` + +Returns a BigInt representation of value, parsed with _decimal_ digits. + +#### Parameters + +| Name | Type | Default value | Description | +| :--------- | :------- | :------------ | :-------------------------- | +| `value` | `string` | `undefined` | The string value to convert | +| `decimals` | `number` | `18` | The number of decimals | + +#### Returns + +`bigint` + +The BigInt representation of _value_ parsed with _decimals_ + +**`Example`** + +```ts +parseUnits('1.0', 18) +// 1000000000000000000n + +parseUnits('121.0', 9) +// 121000000000n +``` + +#### Defined in + +[src/utils/UnitConversion.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/utils/UnitConversion.ts#L39) + +--- + +### zeroX + +▸ **zeroX**(`input`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `input` | `string` | + +#### Returns + +`string` + +#### Defined in + +[src/utils/ConversionTypeHelpers.ts:4](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/utils/ConversionTypeHelpers.ts#L4) + +--- + +### zeroXTransformer + +▸ **zeroXTransformer**(`input?`, `zeroOutput`): `string` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :-------- | :------------ | +| `input` | `string` | `''` | +| `zeroOutput` | `boolean` | `undefined` | + +#### Returns + +`string` #### Defined in -[src/utils/Logger.ts:43](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/Logger.ts#L43) +[src/utils/ConversionTypeHelpers.ts:7](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/utils/ConversionTypeHelpers.ts#L7) diff --git a/docs/api-reference/enums/AccessStatus.md b/docs/api-reference/enums/AccessStatus.md new file mode 100644 index 000000000..247c97797 --- /dev/null +++ b/docs/api-reference/enums/AccessStatus.md @@ -0,0 +1,63 @@ +[@nevermined-io/sdk](../code-reference.md) / AccessStatus + +# Enumeration: AccessStatus + +## Table of contents + +### Enumeration Members + +- [Committed](AccessStatus.md#committed) +- [Delivered](AccessStatus.md#delivered) +- [Requested](AccessStatus.md#requested) +- [Revoked](AccessStatus.md#revoked) +- [Verified](AccessStatus.md#verified) + +## Enumeration Members + +### Committed + +• **Committed** = `1` + +#### Defined in + +[src/models/types.ts:11](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/types.ts#L11) + +--- + +### Delivered + +• **Delivered** = `2` + +#### Defined in + +[src/models/types.ts:12](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/types.ts#L12) + +--- + +### Requested + +• **Requested** = `0` + +#### Defined in + +[src/models/types.ts:10](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/types.ts#L10) + +--- + +### Revoked + +• **Revoked** = `4` + +#### Defined in + +[src/models/types.ts:14](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/types.ts#L14) + +--- + +### Verified + +• **Verified** = `3` + +#### Defined in + +[src/models/types.ts:13](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/types.ts#L13) diff --git a/docs/api-reference/enums/AssetResult.md b/docs/api-reference/enums/AssetResult.md new file mode 100644 index 000000000..2a0627615 --- /dev/null +++ b/docs/api-reference/enums/AssetResult.md @@ -0,0 +1,41 @@ +[@nevermined-io/sdk](../code-reference.md) / AssetResult + +# Enumeration: AssetResult + +## Table of contents + +### Enumeration Members + +- [DATA](AssetResult.md#data) +- [DECRYPTED](AssetResult.md#decrypted) +- [URL](AssetResult.md#url) + +## Enumeration Members + +### DATA + +• **DATA** = `"data"` + +#### Defined in + +[src/services/node/NeverminedNode.ts:19](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L19) + +--- + +### DECRYPTED + +• **DECRYPTED** = `"decrypted"` + +#### Defined in + +[src/services/node/NeverminedNode.ts:20](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L20) + +--- + +### URL + +• **URL** = `"url"` + +#### Defined in + +[src/services/node/NeverminedNode.ts:21](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L21) diff --git a/docs/api-reference/enums/ConditionState.md b/docs/api-reference/enums/ConditionState.md index 8c620ae6e..59cfd47b6 100644 --- a/docs/api-reference/enums/ConditionState.md +++ b/docs/api-reference/enums/ConditionState.md @@ -19,7 +19,7 @@ #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:14](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L14) +[src/keeper/contracts/conditions/Condition.abstract.ts:13](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L13) --- @@ -29,7 +29,7 @@ #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:13](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L13) +[src/keeper/contracts/conditions/Condition.abstract.ts:12](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L12) --- @@ -39,7 +39,7 @@ #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:12](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L12) +[src/keeper/contracts/conditions/Condition.abstract.ts:11](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L11) --- @@ -49,4 +49,4 @@ #### Defined in -[src/keeper/contracts/conditions/Condition.abstract.ts:11](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L11) +[src/keeper/contracts/conditions/Condition.abstract.ts:10](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L10) diff --git a/docs/api-reference/enums/CreateProgressStep.md b/docs/api-reference/enums/CreateProgressStep.md index 4b1465254..fc872002d 100644 --- a/docs/api-reference/enums/CreateProgressStep.md +++ b/docs/api-reference/enums/CreateProgressStep.md @@ -8,6 +8,7 @@ - [ConditionsFilled](CreateProgressStep.md#conditionsfilled) - [DdoStored](CreateProgressStep.md#ddostored) +- [DdoStoredImmutable](CreateProgressStep.md#ddostoredimmutable) - [DidRegistered](CreateProgressStep.md#didregistered) - [EncryptingFiles](CreateProgressStep.md#encryptingfiles) - [FilesEncrypted](CreateProgressStep.md#filesencrypted) @@ -27,7 +28,7 @@ #### Defined in -[src/nevermined/Assets.ts:38](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Assets.ts#L38) +[src/nevermined/ProgressSteps.ts:5](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/ProgressSteps.ts#L5) --- @@ -37,17 +38,27 @@ #### Defined in -[src/nevermined/Assets.ts:45](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Assets.ts#L45) +[src/nevermined/ProgressSteps.ts:12](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/ProgressSteps.ts#L12) + +--- + +### DdoStoredImmutable + +• **DdoStoredImmutable** = `11` + +#### Defined in + +[src/nevermined/ProgressSteps.ts:13](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/ProgressSteps.ts#L13) --- ### DidRegistered -• **DidRegistered** = `11` +• **DidRegistered** = `12` #### Defined in -[src/nevermined/Assets.ts:46](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Assets.ts#L46) +[src/nevermined/ProgressSteps.ts:14](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/ProgressSteps.ts#L14) --- @@ -57,7 +68,7 @@ #### Defined in -[src/nevermined/Assets.ts:39](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Assets.ts#L39) +[src/nevermined/ProgressSteps.ts:6](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/ProgressSteps.ts#L6) --- @@ -67,7 +78,7 @@ #### Defined in -[src/nevermined/Assets.ts:40](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Assets.ts#L40) +[src/nevermined/ProgressSteps.ts:7](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/ProgressSteps.ts#L7) --- @@ -77,7 +88,7 @@ #### Defined in -[src/nevermined/Assets.ts:36](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Assets.ts#L36) +[src/nevermined/ProgressSteps.ts:3](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/ProgressSteps.ts#L3) --- @@ -87,7 +98,7 @@ #### Defined in -[src/nevermined/Assets.ts:37](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Assets.ts#L37) +[src/nevermined/ProgressSteps.ts:4](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/ProgressSteps.ts#L4) --- @@ -97,7 +108,7 @@ #### Defined in -[src/nevermined/Assets.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Assets.ts#L41) +[src/nevermined/ProgressSteps.ts:8](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/ProgressSteps.ts#L8) --- @@ -107,7 +118,7 @@ #### Defined in -[src/nevermined/Assets.ts:35](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Assets.ts#L35) +[src/nevermined/ProgressSteps.ts:2](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/ProgressSteps.ts#L2) --- @@ -117,7 +128,7 @@ #### Defined in -[src/nevermined/Assets.ts:43](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Assets.ts#L43) +[src/nevermined/ProgressSteps.ts:10](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/ProgressSteps.ts#L10) --- @@ -127,7 +138,7 @@ #### Defined in -[src/nevermined/Assets.ts:42](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Assets.ts#L42) +[src/nevermined/ProgressSteps.ts:9](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/ProgressSteps.ts#L9) --- @@ -137,4 +148,4 @@ #### Defined in -[src/nevermined/Assets.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Assets.ts#L44) +[src/nevermined/ProgressSteps.ts:11](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/ProgressSteps.ts#L11) diff --git a/docs/api-reference/enums/DIDResolvePolicy.md b/docs/api-reference/enums/DIDResolvePolicy.md new file mode 100644 index 000000000..bab33380e --- /dev/null +++ b/docs/api-reference/enums/DIDResolvePolicy.md @@ -0,0 +1,71 @@ +[@nevermined-io/sdk](../code-reference.md) / DIDResolvePolicy + +# Enumeration: DIDResolvePolicy + +It described the policy to be used when resolving an asset. It has the following options: + +- ImmutableFirst - It checks if there is a reference to an immutable data-store (IPFS, Filecoin, etc) on-chain. If that's the case uses the URL to resolve the Metadata. If not try to resolve the metadata using the URL of the Metadata/Marketplace API +- MetadataAPIFirst - Try to resolve the metadata from the Marketplace/Metadata API, if it can't tries to resolve using the immutable url +- OnlyImmutable - Try to resolve the metadata only from the immutable data store URL +- OnlyMetadataAPI - Try to resolve the metadata only from the Metadata API. It gets the metadata api url from the DIDRegistry +- NoRegisry - Gets the metadata from the Metadata API using as endpoint the metadata api url from the SDK config. This method don't gets any on-chain information because assumes the DID is not registered on-chain + +## Table of contents + +### Enumeration Members + +- [ImmutableFirst](DIDResolvePolicy.md#immutablefirst) +- [MetadataAPIFirst](DIDResolvePolicy.md#metadataapifirst) +- [NoRegistry](DIDResolvePolicy.md#noregistry) +- [OnlyImmutable](DIDResolvePolicy.md#onlyimmutable) +- [OnlyMetadataAPI](DIDResolvePolicy.md#onlymetadataapi) + +## Enumeration Members + +### ImmutableFirst + +• **ImmutableFirst** = `0` + +#### Defined in + +[src/nevermined/api/AssetsApi.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AssetsApi.ts#L50) + +--- + +### MetadataAPIFirst + +• **MetadataAPIFirst** = `1` + +#### Defined in + +[src/nevermined/api/AssetsApi.ts:51](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AssetsApi.ts#L51) + +--- + +### NoRegistry + +• **NoRegistry** = `4` + +#### Defined in + +[src/nevermined/api/AssetsApi.ts:54](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AssetsApi.ts#L54) + +--- + +### OnlyImmutable + +• **OnlyImmutable** = `2` + +#### Defined in + +[src/nevermined/api/AssetsApi.ts:52](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AssetsApi.ts#L52) + +--- + +### OnlyMetadataAPI + +• **OnlyMetadataAPI** = `3` + +#### Defined in + +[src/nevermined/api/AssetsApi.ts:53](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AssetsApi.ts#L53) diff --git a/docs/api-reference/enums/ERCType.md b/docs/api-reference/enums/ERCType.md new file mode 100644 index 000000000..354dab75b --- /dev/null +++ b/docs/api-reference/enums/ERCType.md @@ -0,0 +1,30 @@ +[@nevermined-io/sdk](../code-reference.md) / ERCType + +# Enumeration: ERCType + +## Table of contents + +### Enumeration Members + +- [nft1155](ERCType.md#nft1155) +- [nft721](ERCType.md#nft721) + +## Enumeration Members + +### nft1155 + +• **nft1155** = `1155` + +#### Defined in + +[src/models/types.ts:25](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/types.ts#L25) + +--- + +### nft721 + +• **nft721** = `721` + +#### Defined in + +[src/models/types.ts:24](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/types.ts#L24) diff --git a/docs/api-reference/enums/ExecuteProgressStep.md b/docs/api-reference/enums/ExecuteProgressStep.md new file mode 100644 index 000000000..41517f46c --- /dev/null +++ b/docs/api-reference/enums/ExecuteProgressStep.md @@ -0,0 +1,52 @@ +[@nevermined-io/sdk](../code-reference.md) / ExecuteProgressStep + +# Enumeration: ExecuteProgressStep + +## Table of contents + +### Enumeration Members + +- [AgreementInitialized](ExecuteProgressStep.md#agreementinitialized) +- [CreatingAgreement](ExecuteProgressStep.md#creatingagreement) +- [LockedPayment](ExecuteProgressStep.md#lockedpayment) +- [LockingPayment](ExecuteProgressStep.md#lockingpayment) + +## Enumeration Members + +### AgreementInitialized + +• **AgreementInitialized** = `1` + +#### Defined in + +[src/nevermined/ProgressSteps.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/ProgressSteps.ts#L39) + +--- + +### CreatingAgreement + +• **CreatingAgreement** = `0` + +#### Defined in + +[src/nevermined/ProgressSteps.ts:38](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/ProgressSteps.ts#L38) + +--- + +### LockedPayment + +• **LockedPayment** = `3` + +#### Defined in + +[src/nevermined/ProgressSteps.ts:41](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/ProgressSteps.ts#L41) + +--- + +### LockingPayment + +• **LockingPayment** = `2` + +#### Defined in + +[src/nevermined/ProgressSteps.ts:40](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/ProgressSteps.ts#L40) diff --git a/docs/api-reference/enums/ExternalResourceFileType.md b/docs/api-reference/enums/ExternalResourceFileType.md new file mode 100644 index 000000000..ddd425b2a --- /dev/null +++ b/docs/api-reference/enums/ExternalResourceFileType.md @@ -0,0 +1,74 @@ +[@nevermined-io/sdk](../code-reference.md) / ExternalResourceFileType + +# Enumeration: ExternalResourceFileType + +## Table of contents + +### Enumeration Members + +- [Avatar](ExternalResourceFileType.md#avatar) +- [CoverImage](ExternalResourceFileType.md#coverimage) +- [Other](ExternalResourceFileType.md#other) +- [Private](ExternalResourceFileType.md#private) +- [SampleData](ExternalResourceFileType.md#sampledata) +- [TermsAndConditions](ExternalResourceFileType.md#termsandconditions) + +## Enumeration Members + +### Avatar + +• **Avatar** = `"Avatar"` + +#### Defined in + +[src/ddo/types.ts:105](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L105) + +--- + +### CoverImage + +• **CoverImage** = `"CoverImage"` + +#### Defined in + +[src/ddo/types.ts:107](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L107) + +--- + +### Other + +• **Other** = `"Other"` + +#### Defined in + +[src/ddo/types.ts:110](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L110) + +--- + +### Private + +• **Private** = `"Private"` + +#### Defined in + +[src/ddo/types.ts:106](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L106) + +--- + +### SampleData + +• **SampleData** = `"SampleData"` + +#### Defined in + +[src/ddo/types.ts:109](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L109) + +--- + +### TermsAndConditions + +• **TermsAndConditions** = `"TermsAndConditions"` + +#### Defined in + +[src/ddo/types.ts:108](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L108) diff --git a/docs/api-reference/enums/ImmutableBackends.md b/docs/api-reference/enums/ImmutableBackends.md new file mode 100644 index 000000000..d9c8dbe0e --- /dev/null +++ b/docs/api-reference/enums/ImmutableBackends.md @@ -0,0 +1,30 @@ +[@nevermined-io/sdk](../code-reference.md) / ImmutableBackends + +# Enumeration: ImmutableBackends + +## Table of contents + +### Enumeration Members + +- [Filecoin](ImmutableBackends.md#filecoin) +- [IPFS](ImmutableBackends.md#ipfs) + +## Enumeration Members + +### Filecoin + +• **Filecoin** = `"filecoin"` + +#### Defined in + +[src/ddo/types.ts:523](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L523) + +--- + +### IPFS + +• **IPFS** = `"ipfs"` + +#### Defined in + +[src/ddo/types.ts:524](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L524) diff --git a/docs/api-reference/enums/utils.LogLevel.md b/docs/api-reference/enums/LogLevel.md similarity index 58% rename from docs/api-reference/enums/utils.LogLevel.md rename to docs/api-reference/enums/LogLevel.md index ed555f79d..12561dc9f 100644 --- a/docs/api-reference/enums/utils.LogLevel.md +++ b/docs/api-reference/enums/LogLevel.md @@ -1,18 +1,16 @@ -[@nevermined-io/sdk](../code-reference.md) / [utils](../modules/utils.md) / LogLevel +[@nevermined-io/sdk](../code-reference.md) / LogLevel # Enumeration: LogLevel -[utils](../modules/utils.md).LogLevel - ## Table of contents ### Enumeration Members -- [Error](utils.LogLevel.md#error) -- [Log](utils.LogLevel.md#log) -- [None](utils.LogLevel.md#none) -- [Verbose](utils.LogLevel.md#verbose) -- [Warn](utils.LogLevel.md#warn) +- [Error](LogLevel.md#error) +- [Log](LogLevel.md#log) +- [None](LogLevel.md#none) +- [Verbose](LogLevel.md#verbose) +- [Warn](LogLevel.md#warn) ## Enumeration Members @@ -22,7 +20,7 @@ #### Defined in -[src/utils/Logger.ts:3](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/Logger.ts#L3) +[src/utils/Logger.ts:3](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/utils/Logger.ts#L3) --- @@ -32,7 +30,7 @@ #### Defined in -[src/utils/Logger.ts:5](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/Logger.ts#L5) +[src/utils/Logger.ts:5](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/utils/Logger.ts#L5) --- @@ -42,7 +40,7 @@ #### Defined in -[src/utils/Logger.ts:2](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/Logger.ts#L2) +[src/utils/Logger.ts:2](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/utils/Logger.ts#L2) --- @@ -52,7 +50,7 @@ #### Defined in -[src/utils/Logger.ts:6](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/Logger.ts#L6) +[src/utils/Logger.ts:6](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/utils/Logger.ts#L6) --- @@ -62,4 +60,4 @@ #### Defined in -[src/utils/Logger.ts:4](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/Logger.ts#L4) +[src/utils/Logger.ts:4](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/utils/Logger.ts#L4) diff --git a/docs/api-reference/enums/NeverminedNFT1155Type.md b/docs/api-reference/enums/NeverminedNFT1155Type.md new file mode 100644 index 000000000..42feba082 --- /dev/null +++ b/docs/api-reference/enums/NeverminedNFT1155Type.md @@ -0,0 +1,30 @@ +[@nevermined-io/sdk](../code-reference.md) / NeverminedNFT1155Type + +# Enumeration: NeverminedNFT1155Type + +## Table of contents + +### Enumeration Members + +- [nft1155](NeverminedNFT1155Type.md#nft1155) +- [nft1155Credit](NeverminedNFT1155Type.md#nft1155credit) + +## Enumeration Members + +### nft1155 + +• **nft1155** = `"nft1155"` + +#### Defined in + +[src/models/types.ts:36](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/types.ts#L36) + +--- + +### nft1155Credit + +• **nft1155Credit** = `"nft1155-credit"` + +#### Defined in + +[src/models/types.ts:37](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/types.ts#L37) diff --git a/docs/api-reference/enums/NeverminedNFT721Type.md b/docs/api-reference/enums/NeverminedNFT721Type.md new file mode 100644 index 000000000..ff8bc5e61 --- /dev/null +++ b/docs/api-reference/enums/NeverminedNFT721Type.md @@ -0,0 +1,52 @@ +[@nevermined-io/sdk](../code-reference.md) / NeverminedNFT721Type + +# Enumeration: NeverminedNFT721Type + +## Table of contents + +### Enumeration Members + +- [nft721](NeverminedNFT721Type.md#nft721) +- [nft721POAP](NeverminedNFT721Type.md#nft721poap) +- [nft721SoulBound](NeverminedNFT721Type.md#nft721soulbound) +- [nft721Subscription](NeverminedNFT721Type.md#nft721subscription) + +## Enumeration Members + +### nft721 + +• **nft721** = `"nft721"` + +#### Defined in + +[src/models/types.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/types.ts#L29) + +--- + +### nft721POAP + +• **nft721POAP** = `"nft721-poap"` + +#### Defined in + +[src/models/types.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/types.ts#L31) + +--- + +### nft721SoulBound + +• **nft721SoulBound** = `"nft721-soulbound"` + +#### Defined in + +[src/models/types.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/types.ts#L32) + +--- + +### nft721Subscription + +• **nft721Subscription** = `"nft721-subscription"` + +#### Defined in + +[src/models/types.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/types.ts#L30) diff --git a/docs/api-reference/enums/NodeUploadBackends.md b/docs/api-reference/enums/NodeUploadBackends.md new file mode 100644 index 000000000..acb30c0fa --- /dev/null +++ b/docs/api-reference/enums/NodeUploadBackends.md @@ -0,0 +1,41 @@ +[@nevermined-io/sdk](../code-reference.md) / NodeUploadBackends + +# Enumeration: NodeUploadBackends + +## Table of contents + +### Enumeration Members + +- [AmazonS3](NodeUploadBackends.md#amazons3) +- [Filecoin](NodeUploadBackends.md#filecoin) +- [IPFS](NodeUploadBackends.md#ipfs) + +## Enumeration Members + +### AmazonS3 + +• **AmazonS3** = `"s3"` + +#### Defined in + +[src/services/node/NeverminedNode.ts:15](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L15) + +--- + +### Filecoin + +• **Filecoin** = `"filecoin"` + +#### Defined in + +[src/services/node/NeverminedNode.ts:13](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L13) + +--- + +### IPFS + +• **IPFS** = `"ipfs"` + +#### Defined in + +[src/services/node/NeverminedNode.ts:14](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L14) diff --git a/docs/api-reference/enums/OrderProgressStep.md b/docs/api-reference/enums/OrderProgressStep.md index 1affbfe2f..53f9a83c5 100644 --- a/docs/api-reference/enums/OrderProgressStep.md +++ b/docs/api-reference/enums/OrderProgressStep.md @@ -7,6 +7,8 @@ ### Enumeration Members - [AgreementInitialized](OrderProgressStep.md#agreementinitialized) +- [ApprovedPayment](OrderProgressStep.md#approvedpayment) +- [ApprovingPayment](OrderProgressStep.md#approvingpayment) - [CreatingAgreement](OrderProgressStep.md#creatingagreement) - [LockedPayment](OrderProgressStep.md#lockedpayment) - [LockingPayment](OrderProgressStep.md#lockingpayment) @@ -15,38 +17,58 @@ ### AgreementInitialized -• **AgreementInitialized** = `1` +• **AgreementInitialized** = `5` #### Defined in -[src/nevermined/Assets.ts:51](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Assets.ts#L51) +[src/nevermined/ProgressSteps.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/ProgressSteps.ts#L34) + +--- + +### ApprovedPayment + +• **ApprovedPayment** = `3` + +#### Defined in + +[src/nevermined/ProgressSteps.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/ProgressSteps.ts#L32) + +--- + +### ApprovingPayment + +• **ApprovingPayment** = `2` + +#### Defined in + +[src/nevermined/ProgressSteps.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/ProgressSteps.ts#L31) --- ### CreatingAgreement -• **CreatingAgreement** = `0` +• **CreatingAgreement** = `4` #### Defined in -[src/nevermined/Assets.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Assets.ts#L50) +[src/nevermined/ProgressSteps.ts:33](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/ProgressSteps.ts#L33) --- ### LockedPayment -• **LockedPayment** = `3` +• **LockedPayment** = `1` #### Defined in -[src/nevermined/Assets.ts:53](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Assets.ts#L53) +[src/nevermined/ProgressSteps.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/ProgressSteps.ts#L30) --- ### LockingPayment -• **LockingPayment** = `2` +• **LockingPayment** = `0` #### Defined in -[src/nevermined/Assets.ts:52](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Assets.ts#L52) +[src/nevermined/ProgressSteps.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/ProgressSteps.ts#L29) diff --git a/docs/api-reference/enums/PermissionType.md b/docs/api-reference/enums/PermissionType.md index 9ddecd8a4..11fb48347 100644 --- a/docs/api-reference/enums/PermissionType.md +++ b/docs/api-reference/enums/PermissionType.md @@ -19,7 +19,7 @@ #### Defined in -[src/permissions/Permissions.interfaces.ts:5](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/permissions/Permissions.interfaces.ts#L5) +[src/services/metadata/types.ts:16](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/types.ts#L16) --- @@ -29,7 +29,7 @@ #### Defined in -[src/permissions/Permissions.interfaces.ts:4](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/permissions/Permissions.interfaces.ts#L4) +[src/services/metadata/types.ts:15](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/types.ts#L15) --- @@ -39,7 +39,7 @@ #### Defined in -[src/permissions/Permissions.interfaces.ts:2](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/permissions/Permissions.interfaces.ts#L2) +[src/services/metadata/types.ts:13](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/types.ts#L13) --- @@ -49,4 +49,4 @@ #### Defined in -[src/permissions/Permissions.interfaces.ts:3](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/permissions/Permissions.interfaces.ts#L3) +[src/services/metadata/types.ts:14](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/types.ts#L14) diff --git a/docs/api-reference/enums/PlatformTechStatus.md b/docs/api-reference/enums/PlatformTechStatus.md index 571652294..e108b0060 100644 --- a/docs/api-reference/enums/PlatformTechStatus.md +++ b/docs/api-reference/enums/PlatformTechStatus.md @@ -19,7 +19,7 @@ #### Defined in -[src/nevermined/Versions.ts:6](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Versions.ts#L6) +[src/nevermined/Versions.ts:6](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Versions.ts#L6) --- @@ -29,7 +29,7 @@ #### Defined in -[src/nevermined/Versions.ts:8](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Versions.ts#L8) +[src/nevermined/Versions.ts:8](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Versions.ts#L8) --- @@ -39,7 +39,7 @@ #### Defined in -[src/nevermined/Versions.ts:7](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Versions.ts#L7) +[src/nevermined/Versions.ts:7](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Versions.ts#L7) --- @@ -49,4 +49,4 @@ #### Defined in -[src/nevermined/Versions.ts:9](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Versions.ts#L9) +[src/nevermined/Versions.ts:9](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Versions.ts#L9) diff --git a/docs/api-reference/enums/ProvenanceMethod.md b/docs/api-reference/enums/ProvenanceMethod.md index 07d1e9d1c..824c64150 100644 --- a/docs/api-reference/enums/ProvenanceMethod.md +++ b/docs/api-reference/enums/ProvenanceMethod.md @@ -28,7 +28,7 @@ #### Defined in -[src/keeper.ts:20](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper.ts#L20) +[src/keeper/contracts/Provenance.ts:24](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L24) --- @@ -38,7 +38,7 @@ #### Defined in -[src/keeper.ts:9](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper.ts#L9) +[src/keeper/contracts/Provenance.ts:13](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L13) --- @@ -48,7 +48,7 @@ #### Defined in -[src/keeper.ts:17](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper.ts#L17) +[src/keeper/contracts/Provenance.ts:21](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L21) --- @@ -58,7 +58,7 @@ #### Defined in -[src/keeper.ts:8](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper.ts#L8) +[src/keeper/contracts/Provenance.ts:12](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L12) --- @@ -68,7 +68,7 @@ #### Defined in -[src/keeper.ts:11](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper.ts#L11) +[src/keeper/contracts/Provenance.ts:15](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L15) --- @@ -78,7 +78,7 @@ #### Defined in -[src/keeper.ts:19](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper.ts#L19) +[src/keeper/contracts/Provenance.ts:23](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L23) --- @@ -88,7 +88,7 @@ #### Defined in -[src/keeper.ts:18](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper.ts#L18) +[src/keeper/contracts/Provenance.ts:22](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L22) --- @@ -98,7 +98,7 @@ #### Defined in -[src/keeper.ts:16](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper.ts#L16) +[src/keeper/contracts/Provenance.ts:20](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L20) --- @@ -108,7 +108,7 @@ #### Defined in -[src/keeper.ts:14](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper.ts#L14) +[src/keeper/contracts/Provenance.ts:18](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L18) --- @@ -118,7 +118,7 @@ #### Defined in -[src/keeper.ts:10](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper.ts#L10) +[src/keeper/contracts/Provenance.ts:14](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L14) --- @@ -128,7 +128,7 @@ #### Defined in -[src/keeper.ts:12](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper.ts#L12) +[src/keeper/contracts/Provenance.ts:16](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L16) --- @@ -138,7 +138,7 @@ #### Defined in -[src/keeper.ts:15](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper.ts#L15) +[src/keeper/contracts/Provenance.ts:19](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L19) --- @@ -148,4 +148,4 @@ #### Defined in -[src/keeper.ts:13](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper.ts#L13) +[src/keeper/contracts/Provenance.ts:17](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L17) diff --git a/docs/api-reference/enums/PublishMetadataOptions.md b/docs/api-reference/enums/PublishMetadataOptions.md new file mode 100644 index 000000000..80b01519f --- /dev/null +++ b/docs/api-reference/enums/PublishMetadataOptions.md @@ -0,0 +1,59 @@ +[@nevermined-io/sdk](../code-reference.md) / PublishMetadataOptions + +# Enumeration: PublishMetadataOptions + +Where the metadata will be published. Options: + +- OnlyMetadataAPI, The metadata will be stored only in the Metadata/Marketplace API +- IPFS, The metadata will be stored in the Metadata/Marketplace API and IPFS +- Filecoin, The metadata will be stored in the Metadata/Marketplace API and Filecoin +- Arweave, The metadata will be stored in the Metadata/Marketplace API and Arweave + +## Table of contents + +### Enumeration Members + +- [Arweave](PublishMetadataOptions.md#arweave) +- [Filecoin](PublishMetadataOptions.md#filecoin) +- [IPFS](PublishMetadataOptions.md#ipfs) +- [OnlyMetadataAPI](PublishMetadataOptions.md#onlymetadataapi) + +## Enumeration Members + +### Arweave + +• **Arweave** = `3` + +#### Defined in + +[src/nevermined/api/AssetsApi.ts:25](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AssetsApi.ts#L25) + +--- + +### Filecoin + +• **Filecoin** = `2` + +#### Defined in + +[src/nevermined/api/AssetsApi.ts:24](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AssetsApi.ts#L24) + +--- + +### IPFS + +• **IPFS** = `1` + +#### Defined in + +[src/nevermined/api/AssetsApi.ts:23](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AssetsApi.ts#L23) + +--- + +### OnlyMetadataAPI + +• **OnlyMetadataAPI** = `0` + +#### Defined in + +[src/nevermined/api/AssetsApi.ts:22](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AssetsApi.ts#L22) diff --git a/docs/api-reference/enums/PublishOnChainOptions.md b/docs/api-reference/enums/PublishOnChainOptions.md new file mode 100644 index 000000000..6ff4fc108 --- /dev/null +++ b/docs/api-reference/enums/PublishOnChainOptions.md @@ -0,0 +1,32 @@ +[@nevermined-io/sdk](../code-reference.md) / PublishOnChainOptions + +# Enumeration: PublishOnChainOptions + +It specifies if the DID will be published on-chain initially or not. + +## Table of contents + +### Enumeration Members + +- [DIDRegistry](PublishOnChainOptions.md#didregistry) +- [OnlyOffchain](PublishOnChainOptions.md#onlyoffchain) + +## Enumeration Members + +### DIDRegistry + +• **DIDRegistry** = `0` + +#### Defined in + +[src/nevermined/api/AssetsApi.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AssetsApi.ts#L32) + +--- + +### OnlyOffchain + +• **OnlyOffchain** = `1` + +#### Defined in + +[src/nevermined/api/AssetsApi.ts:33](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AssetsApi.ts#L33) diff --git a/docs/api-reference/enums/RoyaltyKind.md b/docs/api-reference/enums/RoyaltyKind.md new file mode 100644 index 000000000..43f404559 --- /dev/null +++ b/docs/api-reference/enums/RoyaltyKind.md @@ -0,0 +1,43 @@ +[@nevermined-io/sdk](../code-reference.md) / RoyaltyKind + +# Enumeration: RoyaltyKind + +The type of royalty + +## Table of contents + +### Enumeration Members + +- [Curve](RoyaltyKind.md#curve) +- [Legacy](RoyaltyKind.md#legacy) +- [Standard](RoyaltyKind.md#standard) + +## Enumeration Members + +### Curve + +• **Curve** = `1` + +#### Defined in + +[src/nevermined/api/AssetsApi.ts:71](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AssetsApi.ts#L71) + +--- + +### Legacy + +• **Legacy** = `2` + +#### Defined in + +[src/nevermined/api/AssetsApi.ts:72](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AssetsApi.ts#L72) + +--- + +### Standard + +• **Standard** = `0` + +#### Defined in + +[src/nevermined/api/AssetsApi.ts:70](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AssetsApi.ts#L70) diff --git a/docs/api-reference/enums/State.md b/docs/api-reference/enums/State.md index c360c9f09..8aa17e0b2 100644 --- a/docs/api-reference/enums/State.md +++ b/docs/api-reference/enums/State.md @@ -18,7 +18,7 @@ #### Defined in -[src/profiles/Profiles.interfaces.ts:4](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/profiles/Profiles.interfaces.ts#L4) +[src/services/metadata/types.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/types.ts#L34) --- @@ -28,7 +28,7 @@ #### Defined in -[src/profiles/Profiles.interfaces.ts:2](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/profiles/Profiles.interfaces.ts#L2) +[src/services/metadata/types.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/types.ts#L32) --- @@ -38,4 +38,4 @@ #### Defined in -[src/profiles/Profiles.interfaces.ts:3](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/profiles/Profiles.interfaces.ts#L3) +[src/services/metadata/types.ts:33](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/types.ts#L33) diff --git a/docs/api-reference/enums/TemplateState.md b/docs/api-reference/enums/TemplateState.md new file mode 100644 index 000000000..08a5fac73 --- /dev/null +++ b/docs/api-reference/enums/TemplateState.md @@ -0,0 +1,52 @@ +[@nevermined-io/sdk](../code-reference.md) / TemplateState + +# Enumeration: TemplateState + +## Table of contents + +### Enumeration Members + +- [Approved](TemplateState.md#approved) +- [Proposed](TemplateState.md#proposed) +- [Revoked](TemplateState.md#revoked) +- [Uninitialized](TemplateState.md#uninitialized) + +## Enumeration Members + +### Approved + +• **Approved** = `2` + +#### Defined in + +[src/keeper/contracts/managers/TemplateStoreManager.ts:9](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/TemplateStoreManager.ts#L9) + +--- + +### Proposed + +• **Proposed** = `1` + +#### Defined in + +[src/keeper/contracts/managers/TemplateStoreManager.ts:8](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/TemplateStoreManager.ts#L8) + +--- + +### Revoked + +• **Revoked** = `3` + +#### Defined in + +[src/keeper/contracts/managers/TemplateStoreManager.ts:10](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/TemplateStoreManager.ts#L10) + +--- + +### Uninitialized + +• **Uninitialized** = `0` + +#### Defined in + +[src/keeper/contracts/managers/TemplateStoreManager.ts:7](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/TemplateStoreManager.ts#L7) diff --git a/docs/api-reference/enums/UpdateProgressStep.md b/docs/api-reference/enums/UpdateProgressStep.md new file mode 100644 index 000000000..a43d67282 --- /dev/null +++ b/docs/api-reference/enums/UpdateProgressStep.md @@ -0,0 +1,96 @@ +[@nevermined-io/sdk](../code-reference.md) / UpdateProgressStep + +# Enumeration: UpdateProgressStep + +## Table of contents + +### Enumeration Members + +- [AddVersionInDDO](UpdateProgressStep.md#addversioninddo) +- [AssetUpdated](UpdateProgressStep.md#assetupdated) +- [CalculateChecksum](UpdateProgressStep.md#calculatechecksum) +- [ResolveAsset](UpdateProgressStep.md#resolveasset) +- [StoringDDOMarketplaceAPI](UpdateProgressStep.md#storingddomarketplaceapi) +- [StoringImmutableDDO](UpdateProgressStep.md#storingimmutableddo) +- [UpdateMetadataInDDO](UpdateProgressStep.md#updatemetadatainddo) +- [UpdatingAssetOnChain](UpdateProgressStep.md#updatingassetonchain) + +## Enumeration Members + +### AddVersionInDDO + +• **AddVersionInDDO** = `2` + +#### Defined in + +[src/nevermined/ProgressSteps.ts:20](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/ProgressSteps.ts#L20) + +--- + +### AssetUpdated + +• **AssetUpdated** = `7` + +#### Defined in + +[src/nevermined/ProgressSteps.ts:25](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/ProgressSteps.ts#L25) + +--- + +### CalculateChecksum + +• **CalculateChecksum** = `3` + +#### Defined in + +[src/nevermined/ProgressSteps.ts:21](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/ProgressSteps.ts#L21) + +--- + +### ResolveAsset + +• **ResolveAsset** = `0` + +#### Defined in + +[src/nevermined/ProgressSteps.ts:18](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/ProgressSteps.ts#L18) + +--- + +### StoringDDOMarketplaceAPI + +• **StoringDDOMarketplaceAPI** = `6` + +#### Defined in + +[src/nevermined/ProgressSteps.ts:24](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/ProgressSteps.ts#L24) + +--- + +### StoringImmutableDDO + +• **StoringImmutableDDO** = `4` + +#### Defined in + +[src/nevermined/ProgressSteps.ts:22](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/ProgressSteps.ts#L22) + +--- + +### UpdateMetadataInDDO + +• **UpdateMetadataInDDO** = `1` + +#### Defined in + +[src/nevermined/ProgressSteps.ts:19](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/ProgressSteps.ts#L19) + +--- + +### UpdatingAssetOnChain + +• **UpdatingAssetOnChain** = `5` + +#### Defined in + +[src/nevermined/ProgressSteps.ts:23](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/ProgressSteps.ts#L23) diff --git a/docs/api-reference/enums/ValueType.md b/docs/api-reference/enums/ValueType.md new file mode 100644 index 000000000..e762704c0 --- /dev/null +++ b/docs/api-reference/enums/ValueType.md @@ -0,0 +1,52 @@ +[@nevermined-io/sdk](../code-reference.md) / ValueType + +# Enumeration: ValueType + +## Table of contents + +### Enumeration Members + +- [DDO](ValueType.md#ddo) +- [DID](ValueType.md#did) +- [DIDRef](ValueType.md#didref) +- [URL](ValueType.md#url) + +## Enumeration Members + +### DDO + +• **DDO** = `3` + +#### Defined in + +[src/models/types.ts:58](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/types.ts#L58) + +--- + +### DID + +• **DID** = `0` + +#### Defined in + +[src/models/types.ts:55](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/types.ts#L55) + +--- + +### DIDRef + +• **DIDRef** = `1` + +#### Defined in + +[src/models/types.ts:56](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/types.ts#L56) + +--- + +### URL + +• **URL** = `2` + +#### Defined in + +[src/models/types.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/types.ts#L57) diff --git a/docs/api-reference/enums/utils.OrderProgressStep.md b/docs/api-reference/enums/utils.OrderProgressStep.md deleted file mode 100644 index 062d67956..000000000 --- a/docs/api-reference/enums/utils.OrderProgressStep.md +++ /dev/null @@ -1,54 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [utils](../modules/utils.md) / OrderProgressStep - -# Enumeration: OrderProgressStep - -[utils](../modules/utils.md).OrderProgressStep - -## Table of contents - -### Enumeration Members - -- [AgreementInitialized](utils.OrderProgressStep.md#agreementinitialized) -- [ApprovedPayment](utils.OrderProgressStep.md#approvedpayment) -- [ApprovingPayment](utils.OrderProgressStep.md#approvingpayment) -- [CreatingAgreement](utils.OrderProgressStep.md#creatingagreement) - -## Enumeration Members - -### AgreementInitialized - -• **AgreementInitialized** = `3` - -#### Defined in - -[src/utils/index.ts:20](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/index.ts#L20) - ---- - -### ApprovedPayment - -• **ApprovedPayment** = `1` - -#### Defined in - -[src/utils/index.ts:18](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/index.ts#L18) - ---- - -### ApprovingPayment - -• **ApprovingPayment** = `0` - -#### Defined in - -[src/utils/index.ts:17](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/index.ts#L17) - ---- - -### CreatingAgreement - -• **CreatingAgreement** = `2` - -#### Defined in - -[src/utils/index.ts:19](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/index.ts#L19) diff --git a/docs/api-reference/interfaces/AaveConfig.md b/docs/api-reference/interfaces/AaveConfig.md new file mode 100644 index 000000000..09b90fe38 --- /dev/null +++ b/docs/api-reference/interfaces/AaveConfig.md @@ -0,0 +1,63 @@ +[@nevermined-io/sdk](../code-reference.md) / AaveConfig + +# Interface: AaveConfig + +## Table of contents + +### Properties + +- [agreementFee](AaveConfig.md#agreementfee) +- [dataProviderAddress](AaveConfig.md#dataprovideraddress) +- [lendingPoolAddress](AaveConfig.md#lendingpooladdress) +- [treasuryAddress](AaveConfig.md#treasuryaddress) +- [wethAddress](AaveConfig.md#wethaddress) + +## Properties + +### agreementFee + +• **agreementFee**: `number` + +#### Defined in + +[src/models/types.ts:6](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/types.ts#L6) + +--- + +### dataProviderAddress + +• **dataProviderAddress**: `string` + +#### Defined in + +[src/models/types.ts:3](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/types.ts#L3) + +--- + +### lendingPoolAddress + +• **lendingPoolAddress**: `string` + +#### Defined in + +[src/models/types.ts:2](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/types.ts#L2) + +--- + +### treasuryAddress + +• **treasuryAddress**: `string` + +#### Defined in + +[src/models/types.ts:5](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/types.ts#L5) + +--- + +### wethAddress + +• **wethAddress**: `string` + +#### Defined in + +[src/models/types.ts:4](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/types.ts#L4) diff --git a/docs/api-reference/interfaces/AaveCreditTemplateParams.md b/docs/api-reference/interfaces/AaveCreditTemplateParams.md new file mode 100644 index 000000000..499c610c3 --- /dev/null +++ b/docs/api-reference/interfaces/AaveCreditTemplateParams.md @@ -0,0 +1,151 @@ +[@nevermined-io/sdk](../code-reference.md) / AaveCreditTemplateParams + +# Interface: AaveCreditTemplateParams + +## Table of contents + +### Properties + +- [amountToBorrow](AaveCreditTemplateParams.md#amounttoborrow) +- [amountToRepay](AaveCreditTemplateParams.md#amounttorepay) +- [assetToBorrow](AaveCreditTemplateParams.md#assettoborrow) +- [assetToRepay](AaveCreditTemplateParams.md#assettorepay) +- [collateralAmount](AaveCreditTemplateParams.md#collateralamount) +- [collateralAsset](AaveCreditTemplateParams.md#collateralasset) +- [delegatedAmount](AaveCreditTemplateParams.md#delegatedamount) +- [delegatedAsset](AaveCreditTemplateParams.md#delegatedasset) +- [interestRateMode](AaveCreditTemplateParams.md#interestratemode) +- [lockAddress](AaveCreditTemplateParams.md#lockaddress) +- [nftAmount](AaveCreditTemplateParams.md#nftamount) +- [nftContractAddress](AaveCreditTemplateParams.md#nftcontractaddress) +- [vaultAddress](AaveCreditTemplateParams.md#vaultaddress) + +## Properties + +### amountToBorrow + +• **amountToBorrow**: `string` + +#### Defined in + +[src/keeper/contracts/defi/AaveCreditTemplate.ts:25](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveCreditTemplate.ts#L25) + +--- + +### amountToRepay + +• **amountToRepay**: `string` + +#### Defined in + +[src/keeper/contracts/defi/AaveCreditTemplate.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveCreditTemplate.ts#L32) + +--- + +### assetToBorrow + +• **assetToBorrow**: `string` + +#### Defined in + +[src/keeper/contracts/defi/AaveCreditTemplate.ts:24](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveCreditTemplate.ts#L24) + +--- + +### assetToRepay + +• **assetToRepay**: `string` + +#### Defined in + +[src/keeper/contracts/defi/AaveCreditTemplate.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveCreditTemplate.ts#L31) + +--- + +### collateralAmount + +• **collateralAmount**: `string` + +#### Defined in + +[src/keeper/contracts/defi/AaveCreditTemplate.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveCreditTemplate.ts#L28) + +--- + +### collateralAsset + +• **collateralAsset**: `string` + +#### Defined in + +[src/keeper/contracts/defi/AaveCreditTemplate.ts:27](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveCreditTemplate.ts#L27) + +--- + +### delegatedAmount + +• **delegatedAmount**: `string` + +#### Defined in + +[src/keeper/contracts/defi/AaveCreditTemplate.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveCreditTemplate.ts#L30) + +--- + +### delegatedAsset + +• **delegatedAsset**: `string` + +#### Defined in + +[src/keeper/contracts/defi/AaveCreditTemplate.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveCreditTemplate.ts#L29) + +--- + +### interestRateMode + +• **interestRateMode**: `number` + +#### Defined in + +[src/keeper/contracts/defi/AaveCreditTemplate.ts:26](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveCreditTemplate.ts#L26) + +--- + +### lockAddress + +• **lockAddress**: `string` + +#### Defined in + +[src/keeper/contracts/defi/AaveCreditTemplate.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveCreditTemplate.ts#L34) + +--- + +### nftAmount + +• **nftAmount**: `number` + +#### Defined in + +[src/keeper/contracts/defi/AaveCreditTemplate.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveCreditTemplate.ts#L35) + +--- + +### nftContractAddress + +• **nftContractAddress**: `string` + +#### Defined in + +[src/keeper/contracts/defi/AaveCreditTemplate.ts:33](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveCreditTemplate.ts#L33) + +--- + +### vaultAddress + +• **vaultAddress**: `string` + +#### Defined in + +[src/keeper/contracts/defi/AaveCreditTemplate.ts:23](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/AaveCreditTemplate.ts#L23) diff --git a/docs/api-reference/interfaces/AccessProofTemplateParams.md b/docs/api-reference/interfaces/AccessProofTemplateParams.md new file mode 100644 index 000000000..4dd038955 --- /dev/null +++ b/docs/api-reference/interfaces/AccessProofTemplateParams.md @@ -0,0 +1,41 @@ +[@nevermined-io/sdk](../code-reference.md) / AccessProofTemplateParams + +# Interface: AccessProofTemplateParams + +## Table of contents + +### Properties + +- [consumer](AccessProofTemplateParams.md#consumer) +- [consumerId](AccessProofTemplateParams.md#consumerid) +- [type](AccessProofTemplateParams.md#type) + +## Properties + +### consumer + +• **consumer**: [`Account`](../classes/Account.md) + +#### Defined in + +[src/nevermined/AccessService.ts:26](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/AccessService.ts#L26) + +--- + +### consumerId + +• **consumerId**: `string` + +#### Defined in + +[src/nevermined/AccessService.ts:27](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/AccessService.ts#L27) + +--- + +### type + +• **type**: `"access-proof"` + +#### Defined in + +[src/nevermined/AccessService.ts:25](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/AccessService.ts#L25) diff --git a/docs/api-reference/interfaces/ActedOnBehalfEvent.md b/docs/api-reference/interfaces/ActedOnBehalfEvent.md new file mode 100644 index 000000000..2c74d5cd9 --- /dev/null +++ b/docs/api-reference/interfaces/ActedOnBehalfEvent.md @@ -0,0 +1,137 @@ +[@nevermined-io/sdk](../code-reference.md) / ActedOnBehalfEvent + +# Interface: ActedOnBehalfEvent + +## Hierarchy + +- [`ProvenanceBaseEvent`](ProvenanceBaseEvent.md) + + ↳ **`ActedOnBehalfEvent`** + +## Table of contents + +### Properties + +- [activityId](ActedOnBehalfEvent.md#activityid) +- [attributes](ActedOnBehalfEvent.md#attributes) +- [blockNumberUpdated](ActedOnBehalfEvent.md#blocknumberupdated) +- [delegateAgentId](ActedOnBehalfEvent.md#delegateagentid) +- [entityDid](ActedOnBehalfEvent.md#entitydid) +- [event](ActedOnBehalfEvent.md#event) +- [method](ActedOnBehalfEvent.md#method) +- [provId](ActedOnBehalfEvent.md#provid) +- [responsibleAgentId](ActedOnBehalfEvent.md#responsibleagentid) + +## Properties + +### activityId + +• **activityId**: `string` + +#### Inherited from + +[ProvenanceBaseEvent](ProvenanceBaseEvent.md).[activityId](ProvenanceBaseEvent.md#activityid) + +#### Defined in + +[src/keeper/contracts/Provenance.ts:55](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L55) + +--- + +### attributes + +• `Optional` **attributes**: `string` + +#### Inherited from + +[ProvenanceBaseEvent](ProvenanceBaseEvent.md).[attributes](ProvenanceBaseEvent.md#attributes) + +#### Defined in + +[src/keeper/contracts/Provenance.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L57) + +--- + +### blockNumberUpdated + +• **blockNumberUpdated**: `number` + +#### Inherited from + +[ProvenanceBaseEvent](ProvenanceBaseEvent.md).[blockNumberUpdated](ProvenanceBaseEvent.md#blocknumberupdated) + +#### Defined in + +[src/keeper/contracts/Provenance.ts:58](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L58) + +--- + +### delegateAgentId + +• **delegateAgentId**: `string` + +#### Defined in + +[src/keeper/contracts/Provenance.ts:79](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L79) + +--- + +### entityDid + +• **entityDid**: `string` + +#### Defined in + +[src/keeper/contracts/Provenance.ts:78](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L78) + +--- + +### event + +• **event**: `string` + +#### Inherited from + +[ProvenanceBaseEvent](ProvenanceBaseEvent.md).[event](ProvenanceBaseEvent.md#event) + +#### Defined in + +[src/keeper/contracts/Provenance.ts:53](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L53) + +--- + +### method + +• **method**: [`ProvenanceMethod`](../enums/ProvenanceMethod.md) + +#### Inherited from + +[ProvenanceBaseEvent](ProvenanceBaseEvent.md).[method](ProvenanceBaseEvent.md#method) + +#### Defined in + +[src/keeper/contracts/Provenance.ts:54](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L54) + +--- + +### provId + +• **provId**: `string` + +#### Inherited from + +[ProvenanceBaseEvent](ProvenanceBaseEvent.md).[provId](ProvenanceBaseEvent.md#provid) + +#### Defined in + +[src/keeper/contracts/Provenance.ts:56](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L56) + +--- + +### responsibleAgentId + +• **responsibleAgentId**: `string` + +#### Defined in + +[src/keeper/contracts/Provenance.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L80) diff --git a/docs/api-reference/interfaces/AdditionalInformation.md b/docs/api-reference/interfaces/AdditionalInformation.md index f75b5fc81..031dbe7dc 100644 --- a/docs/api-reference/interfaces/AdditionalInformation.md +++ b/docs/api-reference/interfaces/AdditionalInformation.md @@ -13,6 +13,7 @@ https://github.com/nevermined-io/docs/blob/master/docs/architecture/specs/metada ### Properties - [categories](AdditionalInformation.md#categories) +- [cipher](AdditionalInformation.md#cipher) - [copyrightHolder](AdditionalInformation.md#copyrightholder) - [customData](AdditionalInformation.md#customdata) - [description](AdditionalInformation.md#description) @@ -21,6 +22,7 @@ https://github.com/nevermined-io/docs/blob/master/docs/architecture/specs/metada - [poseidonHash](AdditionalInformation.md#poseidonhash) - [priceHighestDenomination](AdditionalInformation.md#pricehighestdenomination) - [providerKey](AdditionalInformation.md#providerkey) +- [secretId](AdditionalInformation.md#secretid) - [structuredMarkup](AdditionalInformation.md#structuredmarkup) - [tags](AdditionalInformation.md#tags) - [updateFrequency](AdditionalInformation.md#updatefrequency) @@ -42,7 +44,17 @@ Categories used to describe this content. Empty by default. #### Defined in -[src/ddo/MetaData.ts:285](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L285) +[src/ddo/types.ts:374](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L374) + +--- + +### cipher + +• `Optional` **cipher**: `string` + +#### Defined in + +[src/ddo/types.ts:408](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L408) --- @@ -60,7 +72,7 @@ The party holding the legal copyright. Empty by default. #### Defined in -[src/ddo/MetaData.ts:245](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L245) +[src/ddo/types.ts:334](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L334) --- @@ -77,7 +89,7 @@ Can be used to store any non-default data, needs to be checked #### Defined in -[src/ddo/MetaData.ts:314](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L314) +[src/ddo/types.ts:403](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L403) --- @@ -96,7 +108,7 @@ explains what the data represents and what it can be used for. #### Defined in -[src/ddo/MetaData.ts:239](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L239) +[src/ddo/types.ts:328](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L328) --- @@ -115,7 +127,7 @@ codes from the [IETF BCP 47 standard](https://tools.ietf.org/html/bcp47). #### Defined in -[src/ddo/MetaData.ts:279](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L279) +[src/ddo/types.ts:368](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L368) --- @@ -145,7 +157,7 @@ to be domain-specific. #### Defined in -[src/ddo/MetaData.ts:272](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L272) +[src/ddo/types.ts:361](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L361) --- @@ -155,7 +167,7 @@ to be domain-specific. #### Defined in -[src/ddo/MetaData.ts:318](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L318) +[src/ddo/types.ts:407](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L407) --- @@ -173,7 +185,7 @@ BigNumbers #### Defined in -[src/ddo/MetaData.ts:333](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L333) +[src/ddo/types.ts:428](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L428) --- @@ -190,7 +202,24 @@ BigNumbers #### Defined in -[src/ddo/MetaData.ts:320](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L320) +[src/ddo/types.ts:410](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L410) + +--- + +### secretId + +• `Optional` **secretId**: `Object` + +#### Type declaration + +| Name | Type | +| :--- | :------- | +| `x` | `string` | +| `y` | `string` | + +#### Defined in + +[src/ddo/types.ts:415](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L415) --- @@ -203,7 +232,7 @@ describing the dataset. #### Defined in -[src/ddo/MetaData.ts:305](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L305) +[src/ddo/types.ts:394](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L394) --- @@ -221,7 +250,7 @@ Keywords or tags used to describe this content. Empty by default. #### Defined in -[src/ddo/MetaData.ts:291](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L291) +[src/ddo/types.ts:380](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L380) --- @@ -241,7 +270,7 @@ to get updated. #### Defined in -[src/ddo/MetaData.ts:299](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L299) +[src/ddo/types.ts:388](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L388) --- @@ -260,4 +289,4 @@ of the metadata, not an external link. #### Defined in -[src/ddo/MetaData.ts:252](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L252) +[src/ddo/types.ts:341](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L341) diff --git a/docs/api-reference/interfaces/templates.AgreementConditionsStatus.md b/docs/api-reference/interfaces/AgreementConditionsStatus.md similarity index 58% rename from docs/api-reference/interfaces/templates.AgreementConditionsStatus.md rename to docs/api-reference/interfaces/AgreementConditionsStatus.md index 2b5c3afab..03ba84eb7 100644 --- a/docs/api-reference/interfaces/templates.AgreementConditionsStatus.md +++ b/docs/api-reference/interfaces/AgreementConditionsStatus.md @@ -1,9 +1,7 @@ -[@nevermined-io/sdk](../code-reference.md) / [templates](../modules/templates.md) / AgreementConditionsStatus +[@nevermined-io/sdk](../code-reference.md) / AgreementConditionsStatus # Interface: AgreementConditionsStatus -[templates](../modules/templates.md).AgreementConditionsStatus - ## Indexable ▪ [condition: `string`]: { `blocked`: `boolean` ; `blockedBy`: `string`[] ; `condition`: `string` ; `contractName`: `string` ; `state`: [`ConditionState`](../enums/ConditionState.md) } diff --git a/docs/api-reference/interfaces/AgreementData.md b/docs/api-reference/interfaces/AgreementData.md new file mode 100644 index 000000000..61e418af8 --- /dev/null +++ b/docs/api-reference/interfaces/AgreementData.md @@ -0,0 +1,96 @@ +[@nevermined-io/sdk](../code-reference.md) / AgreementData + +# Interface: AgreementData + +## Table of contents + +### Properties + +- [agreementId](AgreementData.md#agreementid) +- [agreementIdSeed](AgreementData.md#agreementidseed) +- [conditionIdSeeds](AgreementData.md#conditionidseeds) +- [conditionIds](AgreementData.md#conditionids) +- [creator](AgreementData.md#creator) +- [did](AgreementData.md#did) +- [didOwner](AgreementData.md#didowner) +- [templateId](AgreementData.md#templateid) + +## Properties + +### agreementId + +• **agreementId**: `string` + +#### Defined in + +[src/keeper/contracts/managers/AgreementStoreManager.ts:9](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/AgreementStoreManager.ts#L9) + +--- + +### agreementIdSeed + +• **agreementIdSeed**: `string` + +#### Defined in + +[src/keeper/contracts/managers/AgreementStoreManager.ts:10](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/AgreementStoreManager.ts#L10) + +--- + +### conditionIdSeeds + +• **conditionIdSeeds**: `string`[] + +#### Defined in + +[src/keeper/contracts/managers/AgreementStoreManager.ts:15](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/AgreementStoreManager.ts#L15) + +--- + +### conditionIds + +• **conditionIds**: `string`[] + +#### Defined in + +[src/keeper/contracts/managers/AgreementStoreManager.ts:14](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/AgreementStoreManager.ts#L14) + +--- + +### creator + +• **creator**: `string` + +#### Defined in + +[src/keeper/contracts/managers/AgreementStoreManager.ts:11](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/AgreementStoreManager.ts#L11) + +--- + +### did + +• **did**: `string` + +#### Defined in + +[src/keeper/contracts/managers/AgreementStoreManager.ts:8](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/AgreementStoreManager.ts#L8) + +--- + +### didOwner + +• **didOwner**: `string` + +#### Defined in + +[src/keeper/contracts/managers/AgreementStoreManager.ts:12](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/AgreementStoreManager.ts#L12) + +--- + +### templateId + +• **templateId**: `string` + +#### Defined in + +[src/keeper/contracts/managers/AgreementStoreManager.ts:13](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/AgreementStoreManager.ts#L13) diff --git a/docs/api-reference/interfaces/AgreementInstance.md b/docs/api-reference/interfaces/AgreementInstance.md new file mode 100644 index 000000000..5e7f701eb --- /dev/null +++ b/docs/api-reference/interfaces/AgreementInstance.md @@ -0,0 +1,47 @@ +[@nevermined-io/sdk](../code-reference.md) / AgreementInstance + +# Interface: AgreementInstance + +## Type parameters + +| Name | +| :------- | +| `Params` | + +## Table of contents + +### Properties + +- [agreementId](AgreementInstance.md#agreementid) +- [instances](AgreementInstance.md#instances) +- [list](AgreementInstance.md#list) + +## Properties + +### agreementId + +• **agreementId**: `string` + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L39) + +--- + +### instances + +• **instances**: [`ConditionInstanceSmall`](ConditionInstanceSmall.md)[] + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:40](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L40) + +--- + +### list + +• **list**: `Params` + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:38](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L38) diff --git a/docs/api-reference/interfaces/AgreementPrepareResult.md b/docs/api-reference/interfaces/AgreementPrepareResult.md new file mode 100644 index 000000000..75122c3c9 --- /dev/null +++ b/docs/api-reference/interfaces/AgreementPrepareResult.md @@ -0,0 +1,30 @@ +[@nevermined-io/sdk](../code-reference.md) / AgreementPrepareResult + +# Interface: AgreementPrepareResult + +## Table of contents + +### Properties + +- [agreementIdSeed](AgreementPrepareResult.md#agreementidseed) +- [signature](AgreementPrepareResult.md#signature) + +## Properties + +### agreementIdSeed + +• **agreementIdSeed**: `string` + +#### Defined in + +[src/nevermined/api/AgreementsApi.ts:10](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AgreementsApi.ts#L10) + +--- + +### signature + +• **signature**: `string` + +#### Defined in + +[src/nevermined/api/AgreementsApi.ts:11](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AgreementsApi.ts#L11) diff --git a/docs/api-reference/interfaces/Algorithm.md b/docs/api-reference/interfaces/Algorithm.md index 152813916..341a24993 100644 --- a/docs/api-reference/interfaces/Algorithm.md +++ b/docs/api-reference/interfaces/Algorithm.md @@ -20,7 +20,7 @@ #### Defined in -[src/ddo/MetaData.ts:43](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L43) +[src/ddo/types.ts:75](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L75) --- @@ -30,7 +30,7 @@ #### Defined in -[src/ddo/MetaData.ts:41](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L41) +[src/ddo/types.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L73) --- @@ -40,7 +40,7 @@ #### Defined in -[src/ddo/MetaData.ts:40](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L40) +[src/ddo/types.ts:72](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L72) --- @@ -58,7 +58,7 @@ #### Defined in -[src/ddo/MetaData.ts:44](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L44) +[src/ddo/types.ts:76](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L76) --- @@ -68,4 +68,4 @@ #### Defined in -[src/ddo/MetaData.ts:42](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L42) +[src/ddo/types.ts:74](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L74) diff --git a/docs/api-reference/interfaces/AuthToken.md b/docs/api-reference/interfaces/AuthToken.md new file mode 100644 index 000000000..4a81888b6 --- /dev/null +++ b/docs/api-reference/interfaces/AuthToken.md @@ -0,0 +1,19 @@ +[@nevermined-io/sdk](../code-reference.md) / AuthToken + +# Interface: AuthToken + +## Table of contents + +### Properties + +- [access_token](AuthToken.md#access_token) + +## Properties + +### access_token + +• **access_token**: `string` + +#### Defined in + +[src/services/metadata/MetadataService.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MetadataService.ts#L34) diff --git a/docs/api-reference/interfaces/Authentication.md b/docs/api-reference/interfaces/Authentication.md new file mode 100644 index 000000000..2de062545 --- /dev/null +++ b/docs/api-reference/interfaces/Authentication.md @@ -0,0 +1,30 @@ +[@nevermined-io/sdk](../code-reference.md) / Authentication + +# Interface: Authentication + +## Table of contents + +### Properties + +- [publicKey](Authentication.md#publickey) +- [type](Authentication.md#type) + +## Properties + +### publicKey + +• **publicKey**: `string` + +#### Defined in + +[src/ddo/types.ts:14](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L14) + +--- + +### type + +• **type**: `string` + +#### Defined in + +[src/ddo/types.ts:13](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L13) diff --git a/docs/api-reference/interfaces/Babysig.md b/docs/api-reference/interfaces/Babysig.md new file mode 100644 index 000000000..401dae091 --- /dev/null +++ b/docs/api-reference/interfaces/Babysig.md @@ -0,0 +1,30 @@ +[@nevermined-io/sdk](../code-reference.md) / Babysig + +# Interface: Babysig + +## Table of contents + +### Properties + +- [R8](Babysig.md#r8) +- [S](Babysig.md#s) + +## Properties + +### R8 + +• **R8**: [`string`, `string`] + +#### Defined in + +[src/models/types.ts:79](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/types.ts#L79) + +--- + +### S + +• **S**: `string` + +#### Defined in + +[src/models/types.ts:80](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/types.ts#L80) diff --git a/docs/api-reference/interfaces/Balance.md b/docs/api-reference/interfaces/Balance.md new file mode 100644 index 000000000..b7aca36cb --- /dev/null +++ b/docs/api-reference/interfaces/Balance.md @@ -0,0 +1,30 @@ +[@nevermined-io/sdk](../code-reference.md) / Balance + +# Interface: Balance + +## Table of contents + +### Properties + +- [eth](Balance.md#eth) +- [nevermined](Balance.md#nevermined) + +## Properties + +### eth + +• **eth**: `bigint` + +#### Defined in + +[src/models/types.ts:84](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/types.ts#L84) + +--- + +### nevermined + +• **nevermined**: `bigint` + +#### Defined in + +[src/models/types.ts:85](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/types.ts#L85) diff --git a/docs/api-reference/interfaces/Bookmark.md b/docs/api-reference/interfaces/Bookmark.md index 284dceaed..55178c824 100644 --- a/docs/api-reference/interfaces/Bookmark.md +++ b/docs/api-reference/interfaces/Bookmark.md @@ -26,7 +26,7 @@ #### Defined in -[src/bookmarks/Bookmarks.interfaces.ts:9](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/bookmarks/Bookmarks.interfaces.ts#L9) +[src/services/metadata/types.ts:9](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/types.ts#L9) --- @@ -40,7 +40,7 @@ #### Defined in -[src/bookmarks/Bookmarks.interfaces.ts:4](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/bookmarks/Bookmarks.interfaces.ts#L4) +[src/services/metadata/types.ts:4](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/types.ts#L4) --- @@ -54,7 +54,7 @@ #### Defined in -[src/bookmarks/Bookmarks.interfaces.ts:2](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/bookmarks/Bookmarks.interfaces.ts#L2) +[src/services/metadata/types.ts:2](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/types.ts#L2) --- @@ -64,7 +64,7 @@ #### Defined in -[src/bookmarks/Bookmarks.interfaces.ts:8](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/bookmarks/Bookmarks.interfaces.ts#L8) +[src/services/metadata/types.ts:8](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/types.ts#L8) --- @@ -78,4 +78,4 @@ #### Defined in -[src/bookmarks/Bookmarks.interfaces.ts:3](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/bookmarks/Bookmarks.interfaces.ts#L3) +[src/services/metadata/types.ts:3](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/types.ts#L3) diff --git a/docs/api-reference/interfaces/ConditionContext.md b/docs/api-reference/interfaces/ConditionContext.md new file mode 100644 index 000000000..18cf9ffea --- /dev/null +++ b/docs/api-reference/interfaces/ConditionContext.md @@ -0,0 +1,52 @@ +[@nevermined-io/sdk](../code-reference.md) / ConditionContext + +# Interface: ConditionContext + +## Table of contents + +### Properties + +- [creator](ConditionContext.md#creator) +- [ddo](ConditionContext.md#ddo) +- [price](ConditionContext.md#price) +- [service](ConditionContext.md#service) + +## Properties + +### creator + +• **creator**: `string` + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:22](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L22) + +--- + +### ddo + +• **ddo**: [`DDO`](../classes/DDO.md) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:19](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L19) + +--- + +### price + +• **price**: [`AssetPrice`](../classes/AssetPrice.md) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:21](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L21) + +--- + +### service + +• **service**: [`ServiceCommon`](ServiceCommon.md) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:20](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L20) diff --git a/docs/api-reference/interfaces/ConditionData.md b/docs/api-reference/interfaces/ConditionData.md new file mode 100644 index 000000000..1904978a9 --- /dev/null +++ b/docs/api-reference/interfaces/ConditionData.md @@ -0,0 +1,85 @@ +[@nevermined-io/sdk](../code-reference.md) / ConditionData + +# Interface: ConditionData + +## Table of contents + +### Properties + +- [blockNumber](ConditionData.md#blocknumber) +- [blockNumberUpdated](ConditionData.md#blocknumberupdated) +- [lastUpdatedBy](ConditionData.md#lastupdatedby) +- [state](ConditionData.md#state) +- [timeLock](ConditionData.md#timelock) +- [timeOut](ConditionData.md#timeout) +- [typeRef](ConditionData.md#typeref) + +## Properties + +### blockNumber + +• **blockNumber**: `number` + +#### Defined in + +[src/keeper/contracts/managers/ConditionStoreManager.ts:12](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/ConditionStoreManager.ts#L12) + +--- + +### blockNumberUpdated + +• **blockNumberUpdated**: `number` + +#### Defined in + +[src/keeper/contracts/managers/ConditionStoreManager.ts:14](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/ConditionStoreManager.ts#L14) + +--- + +### lastUpdatedBy + +• **lastUpdatedBy**: `string` + +#### Defined in + +[src/keeper/contracts/managers/ConditionStoreManager.ts:13](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/ConditionStoreManager.ts#L13) + +--- + +### state + +• **state**: [`ConditionState`](../enums/ConditionState.md) + +#### Defined in + +[src/keeper/contracts/managers/ConditionStoreManager.ts:9](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/ConditionStoreManager.ts#L9) + +--- + +### timeLock + +• **timeLock**: `number` + +#### Defined in + +[src/keeper/contracts/managers/ConditionStoreManager.ts:10](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/ConditionStoreManager.ts#L10) + +--- + +### timeOut + +• **timeOut**: `number` + +#### Defined in + +[src/keeper/contracts/managers/ConditionStoreManager.ts:11](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/ConditionStoreManager.ts#L11) + +--- + +### typeRef + +• **typeRef**: `string` + +#### Defined in + +[src/keeper/contracts/managers/ConditionStoreManager.ts:8](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/ConditionStoreManager.ts#L8) diff --git a/docs/api-reference/interfaces/ConditionInstance.md b/docs/api-reference/interfaces/ConditionInstance.md new file mode 100644 index 000000000..56fd87677 --- /dev/null +++ b/docs/api-reference/interfaces/ConditionInstance.md @@ -0,0 +1,121 @@ +[@nevermined-io/sdk](../code-reference.md) / ConditionInstance + +# Interface: ConditionInstance + +## Type parameters + +| Name | +| :------ | +| `Extra` | + +## Hierarchy + +- [`ConditionInstanceSmall`](ConditionInstanceSmall.md) + + ↳ **`ConditionInstance`** + +## Table of contents + +### Properties + +- [agreementId](ConditionInstance.md#agreementid) +- [condition](ConditionInstance.md#condition) +- [id](ConditionInstance.md#id) +- [list](ConditionInstance.md#list) +- [params](ConditionInstance.md#params) +- [seed](ConditionInstance.md#seed) + +## Properties + +### agreementId + +• **agreementId**: `string` + +#### Inherited from + +[ConditionInstanceSmall](ConditionInstanceSmall.md).[agreementId](ConditionInstanceSmall.md#agreementid) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L34) + +--- + +### condition + +• **condition**: `string` + +#### Inherited from + +[ConditionInstanceSmall](ConditionInstanceSmall.md).[condition](ConditionInstanceSmall.md#condition) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L35) + +--- + +### id + +• **id**: `string` + +#### Inherited from + +[ConditionInstanceSmall](ConditionInstanceSmall.md).[id](ConditionInstanceSmall.md#id) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L33) + +--- + +### list + +• **list**: `any`[] + +#### Inherited from + +[ConditionInstanceSmall](ConditionInstanceSmall.md).[list](ConditionInstanceSmall.md#list) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L31) + +--- + +### params + +• **params**: (`method`: [`ConditionMethod`](../code-reference.md#conditionmethod), `arg`: `Extra`) => `Promise`<`any`[]\> + +#### Type declaration + +▸ (`method`, `arg`): `Promise`<`any`[]\> + +##### Parameters + +| Name | Type | +| :------- | :-------------------------------------------------------- | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | +| `arg` | `Extra` | + +##### Returns + +`Promise`<`any`[]\> + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L39) + +--- + +### seed + +• **seed**: `string` + +#### Inherited from + +[ConditionInstanceSmall](ConditionInstanceSmall.md).[seed](ConditionInstanceSmall.md#seed) + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L32) diff --git a/docs/api-reference/interfaces/ConditionInstanceSmall.md b/docs/api-reference/interfaces/ConditionInstanceSmall.md new file mode 100644 index 000000000..e688855d2 --- /dev/null +++ b/docs/api-reference/interfaces/ConditionInstanceSmall.md @@ -0,0 +1,69 @@ +[@nevermined-io/sdk](../code-reference.md) / ConditionInstanceSmall + +# Interface: ConditionInstanceSmall + +## Hierarchy + +- **`ConditionInstanceSmall`** + + ↳ [`ConditionInstance`](ConditionInstance.md) + +## Table of contents + +### Properties + +- [agreementId](ConditionInstanceSmall.md#agreementid) +- [condition](ConditionInstanceSmall.md#condition) +- [id](ConditionInstanceSmall.md#id) +- [list](ConditionInstanceSmall.md#list) +- [seed](ConditionInstanceSmall.md#seed) + +## Properties + +### agreementId + +• **agreementId**: `string` + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L34) + +--- + +### condition + +• **condition**: `string` + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L35) + +--- + +### id + +• **id**: `string` + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L33) + +--- + +### list + +• **list**: `any`[] + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L31) + +--- + +### seed + +• **seed**: `string` + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L32) diff --git a/docs/api-reference/interfaces/ConditionParameters.md b/docs/api-reference/interfaces/ConditionParameters.md new file mode 100644 index 000000000..a08221e64 --- /dev/null +++ b/docs/api-reference/interfaces/ConditionParameters.md @@ -0,0 +1,51 @@ +[@nevermined-io/sdk](../code-reference.md) / ConditionParameters + +# Interface: ConditionParameters + +## Type parameters + +| Name | +| :------ | +| `Extra` | + +## Table of contents + +### Properties + +- [list](ConditionParameters.md#list) +- [params](ConditionParameters.md#params) + +## Properties + +### list + +• **list**: `any`[] + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:26](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L26) + +--- + +### params + +• **params**: (`method`: [`ConditionMethod`](../code-reference.md#conditionmethod), `arg`: `Extra`) => `Promise`<`any`[]\> + +#### Type declaration + +▸ (`method`, `arg`): `Promise`<`any`[]\> + +##### Parameters + +| Name | Type | +| :------- | :-------------------------------------------------------- | +| `method` | [`ConditionMethod`](../code-reference.md#conditionmethod) | +| `arg` | `Extra` | + +##### Returns + +`Promise`<`any`[]\> + +#### Defined in + +[src/keeper/contracts/conditions/Condition.abstract.ts:27](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/conditions/Condition.abstract.ts#L27) diff --git a/docs/api-reference/interfaces/ContractEventSubscription.md b/docs/api-reference/interfaces/ContractEventSubscription.md new file mode 100644 index 000000000..02c09c835 --- /dev/null +++ b/docs/api-reference/interfaces/ContractEventSubscription.md @@ -0,0 +1,27 @@ +[@nevermined-io/sdk](../code-reference.md) / ContractEventSubscription + +# Interface: ContractEventSubscription + +## Table of contents + +### Properties + +- [unsubscribe](ContractEventSubscription.md#unsubscribe) + +## Properties + +### unsubscribe + +• **unsubscribe**: () => `void` + +#### Type declaration + +▸ (): `void` + +##### Returns + +`void` + +#### Defined in + +[src/events/NeverminedEvent.ts:22](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/NeverminedEvent.ts#L22) diff --git a/docs/api-reference/interfaces/Curation.md b/docs/api-reference/interfaces/Curation.md index c0c922cdd..0ae233af1 100644 --- a/docs/api-reference/interfaces/Curation.md +++ b/docs/api-reference/interfaces/Curation.md @@ -33,7 +33,7 @@ true #### Defined in -[src/ddo/MetaData.ts:226](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L226) +[src/ddo/types.ts:315](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L315) --- @@ -51,7 +51,7 @@ Number of votes. 0 is the default value. #### Defined in -[src/ddo/MetaData.ts:214](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L214) +[src/ddo/types.ts:303](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L303) --- @@ -69,7 +69,7 @@ Decimal value between 0 and 1. 0 is the default value. #### Defined in -[src/ddo/MetaData.ts:208](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L208) +[src/ddo/types.ts:297](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L297) --- @@ -87,4 +87,4 @@ Schema applied to calculate the rating. #### Defined in -[src/ddo/MetaData.ts:220](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L220) +[src/ddo/types.ts:309](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L309) diff --git a/docs/api-reference/interfaces/DDOStatus.md b/docs/api-reference/interfaces/DDOStatus.md new file mode 100644 index 000000000..69f9eb024 --- /dev/null +++ b/docs/api-reference/interfaces/DDOStatus.md @@ -0,0 +1,48 @@ +[@nevermined-io/sdk](../code-reference.md) / DDOStatus + +# Interface: DDOStatus + +## Table of contents + +### Properties + +- [external](DDOStatus.md#external) +- [internal](DDOStatus.md#internal) + +## Properties + +### external + +• **external**: `Object` + +#### Type declaration + +| Name | Type | +| :------- | :------- | +| `id` | `string` | +| `status` | `string` | +| `type` | `string` | +| `url` | `string` | + +#### Defined in + +[src/services/metadata/MetadataService.ts:25](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MetadataService.ts#L25) + +--- + +### internal + +• **internal**: `Object` + +#### Type declaration + +| Name | Type | +| :------- | :------- | +| `id` | `string` | +| `status` | `string` | +| `type` | `string` | +| `url` | `string` | + +#### Defined in + +[src/services/metadata/MetadataService.ts:19](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MetadataService.ts#L19) diff --git a/docs/api-reference/interfaces/Eip712Data.md b/docs/api-reference/interfaces/Eip712Data.md new file mode 100644 index 000000000..06b3a3b29 --- /dev/null +++ b/docs/api-reference/interfaces/Eip712Data.md @@ -0,0 +1,30 @@ +[@nevermined-io/sdk](../code-reference.md) / Eip712Data + +# Interface: Eip712Data + +## Table of contents + +### Properties + +- [chainId](Eip712Data.md#chainid) +- [message](Eip712Data.md#message) + +## Properties + +### chainId + +• **chainId**: `number` + +#### Defined in + +[src/nevermined/utils/JwtUtils.ts:10](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/JwtUtils.ts#L10) + +--- + +### message + +• **message**: `string` + +#### Defined in + +[src/nevermined/utils/JwtUtils.ts:9](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/JwtUtils.ts#L9) diff --git a/docs/api-reference/interfaces/events.EventEmitter.md b/docs/api-reference/interfaces/EventEmitter.md similarity index 67% rename from docs/api-reference/interfaces/events.EventEmitter.md rename to docs/api-reference/interfaces/EventEmitter.md index 413ed2a1e..a7512e530 100644 --- a/docs/api-reference/interfaces/events.EventEmitter.md +++ b/docs/api-reference/interfaces/EventEmitter.md @@ -1,15 +1,13 @@ -[@nevermined-io/sdk](../code-reference.md) / [events](../modules/events.md) / EventEmitter +[@nevermined-io/sdk](../code-reference.md) / EventEmitter # Interface: EventEmitter -[events](../modules/events.md).EventEmitter - ## Table of contents ### Properties -- [subscribe](events.EventEmitter.md#subscribe) -- [unsubscribe](events.EventEmitter.md#unsubscribe) +- [subscribe](EventEmitter.md#subscribe) +- [unsubscribe](EventEmitter.md#unsubscribe) ## Properties @@ -34,7 +32,7 @@ #### Defined in -[src/events/NeverminedEvent.ts:18](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L18) +[src/events/NeverminedEvent.ts:17](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/NeverminedEvent.ts#L17) --- @@ -58,4 +56,4 @@ #### Defined in -[src/events/NeverminedEvent.ts:19](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L19) +[src/events/NeverminedEvent.ts:18](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/NeverminedEvent.ts#L18) diff --git a/docs/api-reference/interfaces/EventOptions.md b/docs/api-reference/interfaces/EventOptions.md new file mode 100644 index 000000000..3903a6dbb --- /dev/null +++ b/docs/api-reference/interfaces/EventOptions.md @@ -0,0 +1,74 @@ +[@nevermined-io/sdk](../code-reference.md) / EventOptions + +# Interface: EventOptions + +## Table of contents + +### Properties + +- [eventName](EventOptions.md#eventname) +- [filterJsonRpc](EventOptions.md#filterjsonrpc) +- [filterSubgraph](EventOptions.md#filtersubgraph) +- [fromBlock](EventOptions.md#fromblock) +- [result](EventOptions.md#result) +- [toBlock](EventOptions.md#toblock) + +## Properties + +### eventName + +• **eventName**: `string` + +#### Defined in + +[src/events/NeverminedEvent.ts:8](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/NeverminedEvent.ts#L8) + +--- + +### filterJsonRpc + +• `Optional` **filterJsonRpc**: [`Filter`](Filter.md) + +#### Defined in + +[src/events/NeverminedEvent.ts:9](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/NeverminedEvent.ts#L9) + +--- + +### filterSubgraph + +• `Optional` **filterSubgraph**: `Record`<`string`, `unknown`\> + +#### Defined in + +[src/events/NeverminedEvent.ts:10](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/NeverminedEvent.ts#L10) + +--- + +### fromBlock + +• `Optional` **fromBlock**: `string` \| `number` + +#### Defined in + +[src/events/NeverminedEvent.ts:12](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/NeverminedEvent.ts#L12) + +--- + +### result + +• `Optional` **result**: `Record`<`string`, `unknown`\> + +#### Defined in + +[src/events/NeverminedEvent.ts:11](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/NeverminedEvent.ts#L11) + +--- + +### toBlock + +• `Optional` **toBlock**: `string` \| `number` + +#### Defined in + +[src/events/NeverminedEvent.ts:13](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/events/NeverminedEvent.ts#L13) diff --git a/docs/api-reference/interfaces/File.md b/docs/api-reference/interfaces/File.md deleted file mode 100644 index 27d1d4102..000000000 --- a/docs/api-reference/interfaces/File.md +++ /dev/null @@ -1,173 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / File - -# Interface: File - -## Table of contents - -### Properties - -- [checksum](File.md#checksum) -- [checksumType](File.md#checksumtype) -- [compression](File.md#compression) -- [contentLength](File.md#contentlength) -- [contentType](File.md#contenttype) -- [encoding](File.md#encoding) -- [encryption](File.md#encryption) -- [index](File.md#index) -- [name](File.md#name) -- [resourceId](File.md#resourceid) -- [url](File.md#url) - -## Properties - -### checksum - -• `Optional` **checksum**: `string` - -File checksum. - -#### Defined in - -[src/ddo/MetaData.ts:97](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L97) - ---- - -### checksumType - -• `Optional` **checksumType**: `string` - -Checksum hash algorithm. - -#### Defined in - -[src/ddo/MetaData.ts:102](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L102) - ---- - -### compression - -• `Optional` **compression**: `string` - -File compression (e.g. no, gzip, bzip2, etc). - -**`Example`** - -```ts -'zip' -``` - -#### Defined in - -[src/ddo/MetaData.ts:124](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L124) - ---- - -### contentLength - -• `Optional` **contentLength**: `string` - -File content length. - -#### Defined in - -[src/ddo/MetaData.ts:107](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L107) - ---- - -### contentType - -• **contentType**: `string` - -File format, if applicable. - -**`Example`** - -```ts -'text/csv' -``` - -#### Defined in - -[src/ddo/MetaData.ts:92](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L92) - ---- - -### encoding - -• `Optional` **encoding**: `string` - -File encoding. - -**`Example`** - -```ts -'UTF-8' -``` - -#### Defined in - -[src/ddo/MetaData.ts:118](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L118) - ---- - -### encryption - -• `Optional` **encryption**: `"dtp"` - -Encryption mode used. - -**`Remarks`** - -If not provided is assumed the files are not encrypted. Currently only `dtp` is implemented. - -#### Defined in - -[src/ddo/MetaData.ts:132](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L132) - ---- - -### index - -• `Optional` **index**: `number` - -File index. - -#### Defined in - -[src/ddo/MetaData.ts:86](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L86) - ---- - -### name - -• `Optional` **name**: `string` - -File name. - -#### Defined in - -[src/ddo/MetaData.ts:76](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L76) - ---- - -### resourceId - -• `Optional` **resourceId**: `string` - -Resource ID (depending on the source). - -#### Defined in - -[src/ddo/MetaData.ts:112](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L112) - ---- - -### url - -• **url**: `string` - -File URL. - -#### Defined in - -[src/ddo/MetaData.ts:81](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L81) diff --git a/docs/api-reference/interfaces/Filter.md b/docs/api-reference/interfaces/Filter.md new file mode 100644 index 000000000..73d3073cd --- /dev/null +++ b/docs/api-reference/interfaces/Filter.md @@ -0,0 +1,7 @@ +[@nevermined-io/sdk](../code-reference.md) / Filter + +# Interface: Filter + +## Indexable + +▪ [key: `string`]: `number` \| `string` \| `string`[] \| `number`[] diff --git a/docs/api-reference/interfaces/GenericAccess.md b/docs/api-reference/interfaces/GenericAccess.md new file mode 100644 index 000000000..1de352cbf --- /dev/null +++ b/docs/api-reference/interfaces/GenericAccess.md @@ -0,0 +1,93 @@ +[@nevermined-io/sdk](../code-reference.md) / GenericAccess + +# Interface: GenericAccess + +## Table of contents + +### Properties + +- [contractName](GenericAccess.md#contractname) + +### Methods + +- [createAgreementWithPaymentFromDDO](GenericAccess.md#createagreementwithpaymentfromddo) +- [getAgreementData](GenericAccess.md#getagreementdata) +- [params](GenericAccess.md#params) + +## Properties + +### contractName + +• **contractName**: `string` + +#### Defined in + +[src/keeper/contracts/templates/GenericAccess.ts:20](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/GenericAccess.ts#L20) + +## Methods + +### createAgreementWithPaymentFromDDO + +▸ **createAgreementWithPaymentFromDDO**(`agreementIdSeed`, `ddo`, `serviceReference`, `parameters`, `consumer`, `from`, `txParams?`, `observer?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :----------------- | :------------------------------------------------------------------------------------ | +| `agreementIdSeed` | `string` | +| `ddo` | [`DDO`](../classes/DDO.md) | +| `serviceReference` | `number` \| [`ServiceType`](../code-reference.md#servicetype) | +| `parameters` | `any` | +| `consumer` | [`Account`](../classes/Account.md) | +| `from` | [`Account`](../classes/Account.md) | +| `txParams?` | [`TxParameters`](TxParameters.md) | +| `observer?` | (`orderProgressStep`: [`OrderProgressStep`](../enums/OrderProgressStep.md)) => `void` | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[src/keeper/contracts/templates/GenericAccess.ts:6](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/GenericAccess.ts#L6) + +--- + +### getAgreementData + +▸ **getAgreementData**(`agreementId`): `Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `agreementId` | `string` | + +#### Returns + +`Promise`<{ `accessConsumer`: `string` ; `accessProvider`: `string` }\> + +#### Defined in + +[src/keeper/contracts/templates/GenericAccess.ts:17](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/GenericAccess.ts#L17) + +--- + +### params + +▸ **params**(`consumer`, `...args`): `any` + +#### Parameters + +| Name | Type | +| :--------- | :------ | +| `consumer` | `any` | +| `...args` | `any`[] | + +#### Returns + +`any` + +#### Defined in + +[src/keeper/contracts/templates/GenericAccess.ts:19](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/GenericAccess.ts#L19) diff --git a/docs/api-reference/interfaces/InputType.md b/docs/api-reference/interfaces/InputType.md new file mode 100644 index 000000000..fed4677fd --- /dev/null +++ b/docs/api-reference/interfaces/InputType.md @@ -0,0 +1,30 @@ +[@nevermined-io/sdk](../code-reference.md) / InputType + +# Interface: InputType + +## Table of contents + +### Properties + +- [name](InputType.md#name) +- [type](InputType.md#type) + +## Properties + +### name + +• **name**: `string` + +#### Defined in + +[src/models/types.ts:18](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/types.ts#L18) + +--- + +### type + +• **type**: `string` + +#### Defined in + +[src/models/types.ts:20](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/types.ts#L20) diff --git a/docs/api-reference/interfaces/InstantiableConfig.md b/docs/api-reference/interfaces/InstantiableConfig.md new file mode 100644 index 000000000..f7c4ac012 --- /dev/null +++ b/docs/api-reference/interfaces/InstantiableConfig.md @@ -0,0 +1,74 @@ +[@nevermined-io/sdk](../code-reference.md) / InstantiableConfig + +# Interface: InstantiableConfig + +## Table of contents + +### Properties + +- [artifactsFolder](InstantiableConfig.md#artifactsfolder) +- [circuitsFolder](InstantiableConfig.md#circuitsfolder) +- [config](InstantiableConfig.md#config) +- [logger](InstantiableConfig.md#logger) +- [nevermined](InstantiableConfig.md#nevermined) +- [web3](InstantiableConfig.md#web3) + +## Properties + +### artifactsFolder + +• `Optional` **artifactsFolder**: `string` + +#### Defined in + +[src/Instantiable.abstract.ts:12](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L12) + +--- + +### circuitsFolder + +• `Optional` **circuitsFolder**: `string` + +#### Defined in + +[src/Instantiable.abstract.ts:13](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L13) + +--- + +### config + +• `Optional` **config**: [`NeverminedOptions`](../classes/NeverminedOptions.md) + +#### Defined in + +[src/Instantiable.abstract.ts:9](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L9) + +--- + +### logger + +• `Optional` **logger**: `Logger` + +#### Defined in + +[src/Instantiable.abstract.ts:11](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L11) + +--- + +### nevermined + +• **nevermined**: [`Nevermined`](../classes/Nevermined.md) + +#### Defined in + +[src/Instantiable.abstract.ts:8](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L8) + +--- + +### web3 + +• `Optional` **web3**: `JsonRpcProvider` \| `BrowserProvider` + +#### Defined in + +[src/Instantiable.abstract.ts:10](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/Instantiable.abstract.ts#L10) diff --git a/docs/api-reference/interfaces/JsonRpcPayload.md b/docs/api-reference/interfaces/JsonRpcPayload.md new file mode 100644 index 000000000..3a02f6909 --- /dev/null +++ b/docs/api-reference/interfaces/JsonRpcPayload.md @@ -0,0 +1,52 @@ +[@nevermined-io/sdk](../code-reference.md) / JsonRpcPayload + +# Interface: JsonRpcPayload + +## Table of contents + +### Properties + +- [id](JsonRpcPayload.md#id) +- [jsonrpc](JsonRpcPayload.md#jsonrpc) +- [method](JsonRpcPayload.md#method) +- [params](JsonRpcPayload.md#params) + +## Properties + +### id + +• `Optional` **id**: `string` \| `number` + +#### Defined in + +[src/keeper/utils.ts:69](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/utils.ts#L69) + +--- + +### jsonrpc + +• **jsonrpc**: `string` + +#### Defined in + +[src/keeper/utils.ts:66](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/utils.ts#L66) + +--- + +### method + +• **method**: `string` + +#### Defined in + +[src/keeper/utils.ts:67](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/utils.ts#L67) + +--- + +### params + +• **params**: `any`[] + +#### Defined in + +[src/keeper/utils.ts:68](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/utils.ts#L68) diff --git a/docs/api-reference/interfaces/JsonRpcResponse.md b/docs/api-reference/interfaces/JsonRpcResponse.md new file mode 100644 index 000000000..714031ec1 --- /dev/null +++ b/docs/api-reference/interfaces/JsonRpcResponse.md @@ -0,0 +1,52 @@ +[@nevermined-io/sdk](../code-reference.md) / JsonRpcResponse + +# Interface: JsonRpcResponse + +## Table of contents + +### Properties + +- [error](JsonRpcResponse.md#error) +- [id](JsonRpcResponse.md#id) +- [jsonrpc](JsonRpcResponse.md#jsonrpc) +- [result](JsonRpcResponse.md#result) + +## Properties + +### error + +• `Optional` **error**: `string` + +#### Defined in + +[src/keeper/utils.ts:76](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/utils.ts#L76) + +--- + +### id + +• **id**: `number` + +#### Defined in + +[src/keeper/utils.ts:74](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/utils.ts#L74) + +--- + +### jsonrpc + +• **jsonrpc**: `string` + +#### Defined in + +[src/keeper/utils.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/utils.ts#L73) + +--- + +### result + +• `Optional` **result**: `any` + +#### Defined in + +[src/keeper/utils.ts:75](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/utils.ts#L75) diff --git a/docs/api-reference/interfaces/KeyTransfer.Babysig.md b/docs/api-reference/interfaces/KeyTransfer.Babysig.md deleted file mode 100644 index 349009b32..000000000 --- a/docs/api-reference/interfaces/KeyTransfer.Babysig.md +++ /dev/null @@ -1,32 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [KeyTransfer](../modules/KeyTransfer.md) / Babysig - -# Interface: Babysig - -[KeyTransfer](../modules/KeyTransfer.md).Babysig - -## Table of contents - -### Properties - -- [R8](KeyTransfer.Babysig.md#r8) -- [S](KeyTransfer.Babysig.md#s) - -## Properties - -### R8 - -• **R8**: [`string`, `string`] - -#### Defined in - -[src/models/KeyTransfer.ts:34](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/KeyTransfer.ts#L34) - ---- - -### S - -• **S**: `string` - -#### Defined in - -[src/models/KeyTransfer.ts:35](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/models/KeyTransfer.ts#L35) diff --git a/docs/api-reference/interfaces/MarketplaceResults.md b/docs/api-reference/interfaces/MarketplaceResults.md new file mode 100644 index 000000000..21bc2f8c0 --- /dev/null +++ b/docs/api-reference/interfaces/MarketplaceResults.md @@ -0,0 +1,58 @@ +[@nevermined-io/sdk](../code-reference.md) / MarketplaceResults + +# Interface: MarketplaceResults + +## Type parameters + +| Name | +| :------- | +| `Entity` | + +## Table of contents + +### Properties + +- [page](MarketplaceResults.md#page) +- [results](MarketplaceResults.md#results) +- [total_pages](MarketplaceResults.md#total_pages) +- [total_results](MarketplaceResults.md#total_results) + +## Properties + +### page + +• **page**: `number` + +#### Defined in + +[src/common/interfaces.ts:7](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/common/interfaces.ts#L7) + +--- + +### results + +• **results**: `Entity`[] + +#### Defined in + +[src/common/interfaces.ts:8](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/common/interfaces.ts#L8) + +--- + +### total_pages + +• **total_pages**: `number` + +#### Defined in + +[src/common/interfaces.ts:9](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/common/interfaces.ts#L9) + +--- + +### total_results + +• **total_results**: `SearchResults` + +#### Defined in + +[src/common/interfaces.ts:10](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/common/interfaces.ts#L10) diff --git a/docs/api-reference/interfaces/MetaData.md b/docs/api-reference/interfaces/MetaData.md index ce634b7c2..2748c7b22 100644 --- a/docs/api-reference/interfaces/MetaData.md +++ b/docs/api-reference/interfaces/MetaData.md @@ -20,7 +20,7 @@ #### Defined in -[src/ddo/MetaData.ts:340](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L340) +[src/ddo/types.ts:435](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L435) --- @@ -30,7 +30,7 @@ #### Defined in -[src/ddo/MetaData.ts:341](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L341) +[src/ddo/types.ts:436](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L436) --- @@ -40,7 +40,7 @@ #### Defined in -[src/ddo/MetaData.ts:339](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L339) +[src/ddo/types.ts:434](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L434) --- @@ -50,7 +50,7 @@ #### Defined in -[src/ddo/MetaData.ts:338](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L338) +[src/ddo/types.ts:433](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L433) --- @@ -60,4 +60,4 @@ #### Defined in -[src/ddo/MetaData.ts:337](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L337) +[src/ddo/types.ts:432](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L432) diff --git a/docs/api-reference/interfaces/MetaDataExternalResource.md b/docs/api-reference/interfaces/MetaDataExternalResource.md new file mode 100644 index 000000000..91b149f19 --- /dev/null +++ b/docs/api-reference/interfaces/MetaDataExternalResource.md @@ -0,0 +1,187 @@ +[@nevermined-io/sdk](../code-reference.md) / MetaDataExternalResource + +# Interface: MetaDataExternalResource + +## Table of contents + +### Properties + +- [checksum](MetaDataExternalResource.md#checksum) +- [checksumType](MetaDataExternalResource.md#checksumtype) +- [compression](MetaDataExternalResource.md#compression) +- [contentLength](MetaDataExternalResource.md#contentlength) +- [contentType](MetaDataExternalResource.md#contenttype) +- [encoding](MetaDataExternalResource.md#encoding) +- [encryption](MetaDataExternalResource.md#encryption) +- [index](MetaDataExternalResource.md#index) +- [name](MetaDataExternalResource.md#name) +- [resourceId](MetaDataExternalResource.md#resourceid) +- [resourceType](MetaDataExternalResource.md#resourcetype) +- [url](MetaDataExternalResource.md#url) + +## Properties + +### checksum + +• `Optional` **checksum**: `string` + +File checksum. + +#### Defined in + +[src/ddo/types.ts:138](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L138) + +--- + +### checksumType + +• `Optional` **checksumType**: `string` + +Checksum hash algorithm. + +#### Defined in + +[src/ddo/types.ts:143](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L143) + +--- + +### compression + +• `Optional` **compression**: `string` + +File compression (e.g. no, gzip, bzip2, etc). + +**`Example`** + +```ts +'zip' +``` + +#### Defined in + +[src/ddo/types.ts:171](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L171) + +--- + +### contentLength + +• `Optional` **contentLength**: `string` + +File content length. + +#### Defined in + +[src/ddo/types.ts:148](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L148) + +--- + +### contentType + +• **contentType**: `string` + +File format, if applicable. + +**`Example`** + +```ts +'text/csv' +``` + +#### Defined in + +[src/ddo/types.ts:133](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L133) + +--- + +### encoding + +• `Optional` **encoding**: `string` + +File encoding. + +**`Example`** + +```ts +'UTF-8' +``` + +#### Defined in + +[src/ddo/types.ts:165](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L165) + +--- + +### encryption + +• `Optional` **encryption**: `"dtp"` \| `"dleq"` + +Encryption mode used. + +**`Remarks`** + +If not provided is assumed the files are not encrypted. Currently only `dtp` is implemented. + +#### Defined in + +[src/ddo/types.ts:179](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L179) + +--- + +### index + +• `Optional` **index**: `number` + +File index. + +#### Defined in + +[src/ddo/types.ts:127](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L127) + +--- + +### name + +• `Optional` **name**: `string` + +File name. + +#### Defined in + +[src/ddo/types.ts:117](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L117) + +--- + +### resourceId + +• `Optional` **resourceId**: `string` + +Resource ID (depending on the source). It is used to reference the id of the file in an external source. +For example the `ugcId` + +#### Defined in + +[src/ddo/types.ts:159](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L159) + +--- + +### resourceType + +• `Optional` **resourceType**: [`ExternalResourceFileType`](../enums/ExternalResourceFileType.md) + +The type of the external resource file + +#### Defined in + +[src/ddo/types.ts:153](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L153) + +--- + +### url + +• **url**: `string` + +File URL. + +#### Defined in + +[src/ddo/types.ts:122](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L122) diff --git a/docs/api-reference/interfaces/MetaDataMain.md b/docs/api-reference/interfaces/MetaDataMain.md index 524658cfa..004350b37 100644 --- a/docs/api-reference/interfaces/MetaDataMain.md +++ b/docs/api-reference/interfaces/MetaDataMain.md @@ -19,11 +19,13 @@ https://github.com/nevermined-io/docs/blob/master/docs/architecture/specs/metada - [encryptedService](MetaDataMain.md#encryptedservice) - [ercType](MetaDataMain.md#erctype) - [files](MetaDataMain.md#files) +- [isDTP](MetaDataMain.md#isdtp) - [license](MetaDataMain.md#license) - [name](MetaDataMain.md#name) - [nftType](MetaDataMain.md#nfttype) - [service](MetaDataMain.md#service) - [type](MetaDataMain.md#type) +- [webService](MetaDataMain.md#webservice) - [workflow](MetaDataMain.md#workflow) ## Properties @@ -34,7 +36,7 @@ https://github.com/nevermined-io/docs/blob/master/docs/architecture/specs/metada #### Defined in -[src/ddo/MetaData.ts:190](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L190) +[src/ddo/types.ts:277](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L277) --- @@ -52,7 +54,7 @@ Name of the entity generating this data (e.g. Tfl, Disney Corp, etc.). #### Defined in -[src/ddo/MetaData.ts:172](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L172) +[src/ddo/types.ts:257](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L257) --- @@ -71,7 +73,7 @@ ISO 8601 format, Coordinated Universal Time. #### Defined in -[src/ddo/MetaData.ts:158](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L158) +[src/ddo/types.ts:243](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L243) --- @@ -91,7 +93,7 @@ so this value can't be set. #### Defined in -[src/ddo/MetaData.ts:166](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L166) +[src/ddo/types.ts:251](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L251) --- @@ -101,29 +103,39 @@ so this value can't be set. #### Defined in -[src/ddo/MetaData.ts:186](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L186) +[src/ddo/types.ts:273](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L273) --- ### ercType -• `Optional` **ercType**: `ERCType` +• `Optional` **ercType**: [`ERCType`](../enums/ERCType.md) #### Defined in -[src/ddo/MetaData.ts:194](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L194) +[src/ddo/types.ts:281](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L281) --- ### files -• `Optional` **files**: [`File`](File.md)[] +• `Optional` **files**: [`MetaDataExternalResource`](MetaDataExternalResource.md)[] Array of File objects including the encrypted file urls and some additional information. #### Defined in -[src/ddo/MetaData.ts:184](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L184) +[src/ddo/types.ts:269](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L269) + +--- + +### isDTP + +• `Optional` **isDTP**: `boolean` + +#### Defined in + +[src/ddo/types.ts:285](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L285) --- @@ -142,7 +154,7 @@ If it's not specified, the following value will be added: "No License Specified" #### Defined in -[src/ddo/MetaData.ts:179](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L179) +[src/ddo/types.ts:264](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L264) --- @@ -160,36 +172,36 @@ Descriptive name of the Asset. #### Defined in -[src/ddo/MetaData.ts:144](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L144) +[src/ddo/types.ts:221](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L221) --- ### nftType -• `Optional` **nftType**: `NeverminedNFTType` +• `Optional` **nftType**: [`NeverminedNFTType`](../code-reference.md#neverminednfttype) #### Defined in -[src/ddo/MetaData.ts:196](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L196) +[src/ddo/types.ts:283](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L283) --- ### service -• `Optional` **service**: [`Service`](Service.md) +• `Optional` **service**: [`ServiceCommon`](ServiceCommon.md) #### Defined in -[src/ddo/MetaData.ts:192](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L192) +[src/ddo/types.ts:279](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L279) --- ### type -• **type**: `"dataset"` \| `"compute"` \| `"workflow"` \| `"algorithm"` +• **type**: `"compute"` \| `"workflow"` \| `"service"` \| `"dataset"` \| `"algorithm"` \| `"subscription"` \| `"other"` Type of the Asset. Helps to filter by the type of asset, -initially ("dataset", "algorithm", "compute", "workflow", "compute", "other"). +initially ("dataset", "algorithm", "compute", "workflow", "compute", "subscription", "other"). **`Example`** @@ -199,7 +211,17 @@ initially ("dataset", "algorithm", "compute", "workflow", "compute", "other"). #### Defined in -[src/ddo/MetaData.ts:151](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L151) +[src/ddo/types.ts:228](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L228) + +--- + +### webService + +• `Optional` **webService**: [`WebService`](WebService.md) + +#### Defined in + +[src/ddo/types.ts:271](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L271) --- @@ -209,4 +231,4 @@ initially ("dataset", "algorithm", "compute", "workflow", "compute", "other"). #### Defined in -[src/ddo/MetaData.ts:188](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L188) +[src/ddo/types.ts:275](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L275) diff --git a/docs/api-reference/interfaces/MethodReflection.md b/docs/api-reference/interfaces/MethodReflection.md new file mode 100644 index 000000000..a8cf958b1 --- /dev/null +++ b/docs/api-reference/interfaces/MethodReflection.md @@ -0,0 +1,63 @@ +[@nevermined-io/sdk](../code-reference.md) / MethodReflection + +# Interface: MethodReflection + +## Table of contents + +### Properties + +- [address](MethodReflection.md#address) +- [contractName](MethodReflection.md#contractname) +- [inputs](MethodReflection.md#inputs) +- [methodName](MethodReflection.md#methodname) +- [signature](MethodReflection.md#signature) + +## Properties + +### address + +• **address**: `string` + +#### Defined in + +[src/models/types.ts:71](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/types.ts#L71) + +--- + +### contractName + +• **contractName**: `string` + +#### Defined in + +[src/models/types.ts:67](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/types.ts#L67) + +--- + +### inputs + +• **inputs**: [`InputType`](InputType.md)[] + +#### Defined in + +[src/models/types.ts:75](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/types.ts#L75) + +--- + +### methodName + +• **methodName**: `string` + +#### Defined in + +[src/models/types.ts:69](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/types.ts#L69) + +--- + +### signature + +• **signature**: `string` + +#### Defined in + +[src/models/types.ts:73](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/types.ts#L73) diff --git a/docs/api-reference/interfaces/MintedEntry.md b/docs/api-reference/interfaces/MintedEntry.md new file mode 100644 index 000000000..c00570a78 --- /dev/null +++ b/docs/api-reference/interfaces/MintedEntry.md @@ -0,0 +1,41 @@ +[@nevermined-io/sdk](../code-reference.md) / MintedEntry + +# Interface: MintedEntry + +## Table of contents + +### Properties + +- [amountMinted](MintedEntry.md#amountminted) +- [expirationBlock](MintedEntry.md#expirationblock) +- [mintBlock](MintedEntry.md#mintblock) + +## Properties + +### amountMinted + +• **amountMinted**: `bigint` + +#### Defined in + +[src/keeper/contracts/NFTContractsBase.ts:8](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/NFTContractsBase.ts#L8) + +--- + +### expirationBlock + +• **expirationBlock**: `bigint` + +#### Defined in + +[src/keeper/contracts/NFTContractsBase.ts:9](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/NFTContractsBase.ts#L9) + +--- + +### mintBlock + +• **mintBlock**: `bigint` + +#### Defined in + +[src/keeper/contracts/NFTContractsBase.ts:10](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/NFTContractsBase.ts#L10) diff --git a/docs/api-reference/interfaces/NewBookmark.md b/docs/api-reference/interfaces/NewBookmark.md index 14e286112..b91d6e5d4 100644 --- a/docs/api-reference/interfaces/NewBookmark.md +++ b/docs/api-reference/interfaces/NewBookmark.md @@ -24,7 +24,7 @@ #### Defined in -[src/bookmarks/Bookmarks.interfaces.ts:4](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/bookmarks/Bookmarks.interfaces.ts#L4) +[src/services/metadata/types.ts:4](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/types.ts#L4) --- @@ -34,7 +34,7 @@ #### Defined in -[src/bookmarks/Bookmarks.interfaces.ts:2](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/bookmarks/Bookmarks.interfaces.ts#L2) +[src/services/metadata/types.ts:2](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/types.ts#L2) --- @@ -44,4 +44,4 @@ #### Defined in -[src/bookmarks/Bookmarks.interfaces.ts:3](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/bookmarks/Bookmarks.interfaces.ts#L3) +[src/services/metadata/types.ts:3](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/types.ts#L3) diff --git a/docs/api-reference/interfaces/NewPermission.md b/docs/api-reference/interfaces/NewPermission.md index fb39a0553..e4e5ac3db 100644 --- a/docs/api-reference/interfaces/NewPermission.md +++ b/docs/api-reference/interfaces/NewPermission.md @@ -25,7 +25,7 @@ #### Defined in -[src/permissions/Permissions.interfaces.ts:12](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/permissions/Permissions.interfaces.ts#L12) +[src/services/metadata/types.ts:23](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/types.ts#L23) --- @@ -35,7 +35,7 @@ #### Defined in -[src/permissions/Permissions.interfaces.ts:11](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/permissions/Permissions.interfaces.ts#L11) +[src/services/metadata/types.ts:22](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/types.ts#L22) --- @@ -45,7 +45,7 @@ #### Defined in -[src/permissions/Permissions.interfaces.ts:10](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/permissions/Permissions.interfaces.ts#L10) +[src/services/metadata/types.ts:21](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/types.ts#L21) --- @@ -55,4 +55,4 @@ #### Defined in -[src/permissions/Permissions.interfaces.ts:9](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/permissions/Permissions.interfaces.ts#L9) +[src/services/metadata/types.ts:20](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/types.ts#L20) diff --git a/docs/api-reference/interfaces/NewProfile.md b/docs/api-reference/interfaces/NewProfile.md index a7af3fef2..8357a3d39 100644 --- a/docs/api-reference/interfaces/NewProfile.md +++ b/docs/api-reference/interfaces/NewProfile.md @@ -28,7 +28,7 @@ #### Defined in -[src/profiles/Profiles.interfaces.ts:14](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/profiles/Profiles.interfaces.ts#L14) +[src/services/metadata/types.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/types.ts#L44) --- @@ -38,7 +38,7 @@ #### Defined in -[src/profiles/Profiles.interfaces.ts:10](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/profiles/Profiles.interfaces.ts#L10) +[src/services/metadata/types.ts:40](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/types.ts#L40) --- @@ -48,7 +48,7 @@ #### Defined in -[src/profiles/Profiles.interfaces.ts:13](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/profiles/Profiles.interfaces.ts#L13) +[src/services/metadata/types.ts:43](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/types.ts#L43) --- @@ -58,7 +58,7 @@ #### Defined in -[src/profiles/Profiles.interfaces.ts:8](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/profiles/Profiles.interfaces.ts#L8) +[src/services/metadata/types.ts:38](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/types.ts#L38) --- @@ -68,7 +68,7 @@ #### Defined in -[src/profiles/Profiles.interfaces.ts:12](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/profiles/Profiles.interfaces.ts#L12) +[src/services/metadata/types.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/types.ts#L42) --- @@ -78,7 +78,7 @@ #### Defined in -[src/profiles/Profiles.interfaces.ts:11](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/profiles/Profiles.interfaces.ts#L11) +[src/services/metadata/types.ts:41](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/types.ts#L41) --- @@ -88,4 +88,4 @@ #### Defined in -[src/profiles/Profiles.interfaces.ts:9](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/profiles/Profiles.interfaces.ts#L9) +[src/services/metadata/types.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/types.ts#L39) diff --git a/docs/api-reference/interfaces/NvmConfig.md b/docs/api-reference/interfaces/NvmConfig.md new file mode 100644 index 000000000..6579668e8 --- /dev/null +++ b/docs/api-reference/interfaces/NvmConfig.md @@ -0,0 +1,97 @@ +[@nevermined-io/sdk](../code-reference.md) / NvmConfig + +# Interface: NvmConfig + +Nevermined Config DDO section + +**`Example`** + +```ts +"_nvm": { + "userId": "dff40170-37fc-11ed-be5b-9984d9f9ec35", + "appId": "acde070d-8c4c-4f0d-9d8a-162843c10333", + "versions": [ + { + "id": 1, + "updated": "2020-01-01T19:13:24Z", + "checksum": "89328493849328493284932" + }, + { + "id": 2, + "updated": "2021-02-21T20:13:24Z", + "checksum": "045328094852309483203443" + } + ] + } +``` + +## Table of contents + +### Properties + +- [appId](NvmConfig.md#appid) +- [networks](NvmConfig.md#networks) +- [userId](NvmConfig.md#userid) +- [versions](NvmConfig.md#versions) + +## Properties + +### appId + +• **appId**: `string` + +The `appId` will be a `string` storing an identifier in `UUID` format. + +**`Remarks`** + +Used to identity the application responsible for the DDO in the marketplace-api. +Useful for querying assets belonging to a particular app, allowing us to have multiple +apps using the same marketplace api + +#### Defined in + +[src/ddo/types.ts:508](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L508) + +--- + +### networks + +• `Optional` **networks**: `Object` + +Block networks where the asset is available. It is represented as a map of network Id and a boolean value. + +#### Index signature + +▪ [key: `string`]: `boolean` + +#### Defined in + +[src/ddo/types.ts:517](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L517) + +--- + +### userId + +• **userId**: `string` + +The `userId` will be a `string` storing an identifier in `UUID` format. + +**`Remarks`** + +Used to identify a user in the marketplace api + +#### Defined in + +[src/ddo/types.ts:499](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L499) + +--- + +### versions + +• **versions**: [`NvmConfigVersions`](NvmConfigVersions.md)[] + +The `versions` list stores the reference to all the changes done to the Metadata document. + +#### Defined in + +[src/ddo/types.ts:512](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L512) diff --git a/docs/api-reference/interfaces/NvmConfigVersions.md b/docs/api-reference/interfaces/NvmConfigVersions.md new file mode 100644 index 000000000..9e5de2bf7 --- /dev/null +++ b/docs/api-reference/interfaces/NvmConfigVersions.md @@ -0,0 +1,77 @@ +[@nevermined-io/sdk](../code-reference.md) / NvmConfigVersions + +# Interface: NvmConfigVersions + +## Table of contents + +### Properties + +- [checksum](NvmConfigVersions.md#checksum) +- [id](NvmConfigVersions.md#id) +- [immutableBackend](NvmConfigVersions.md#immutablebackend) +- [immutableUrl](NvmConfigVersions.md#immutableurl) +- [updated](NvmConfigVersions.md#updated) + +## Properties + +### checksum + +• **checksum**: `string` + +The checksum of the document + +#### Defined in + +[src/ddo/types.ts:542](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L542) + +--- + +### id + +• **id**: `number` + +The id of the DDO revision. + +**`Remarks`** + +This is a self incrementing number + +#### Defined in + +[src/ddo/types.ts:534](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L534) + +--- + +### immutableBackend + +• `Optional` **immutableBackend**: [`ImmutableBackends`](../enums/ImmutableBackends.md) + +The immutable solution to record the DDO + +#### Defined in + +[src/ddo/types.ts:552](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L552) + +--- + +### immutableUrl + +• `Optional` **immutableUrl**: `string` + +ID Hash of the metadata recorded in an immutable data store (IPFS, Filecoin, Arweave, ..) + +#### Defined in + +[src/ddo/types.ts:547](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L547) + +--- + +### updated + +• **updated**: `string` + +The date when the update occurred. + +#### Defined in + +[src/ddo/types.ts:538](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L538) diff --git a/docs/api-reference/interfaces/PaymentData.md b/docs/api-reference/interfaces/PaymentData.md new file mode 100644 index 000000000..00dd9f7b9 --- /dev/null +++ b/docs/api-reference/interfaces/PaymentData.md @@ -0,0 +1,52 @@ +[@nevermined-io/sdk](../code-reference.md) / PaymentData + +# Interface: PaymentData + +## Table of contents + +### Properties + +- [amounts](PaymentData.md#amounts) +- [receivers](PaymentData.md#receivers) +- [rewardAddress](PaymentData.md#rewardaddress) +- [tokenAddress](PaymentData.md#tokenaddress) + +## Properties + +### amounts + +• **amounts**: `bigint`[] + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:46](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L46) + +--- + +### receivers + +• **receivers**: `string`[] + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:47](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L47) + +--- + +### rewardAddress + +• **rewardAddress**: `string` + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L44) + +--- + +### tokenAddress + +• **tokenAddress**: `string` + +#### Defined in + +[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:45](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L45) diff --git a/docs/api-reference/interfaces/Permission.md b/docs/api-reference/interfaces/Permission.md index fb32f47a0..f4aa28c0c 100644 --- a/docs/api-reference/interfaces/Permission.md +++ b/docs/api-reference/interfaces/Permission.md @@ -31,7 +31,7 @@ #### Defined in -[src/permissions/Permissions.interfaces.ts:12](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/permissions/Permissions.interfaces.ts#L12) +[src/services/metadata/types.ts:23](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/types.ts#L23) --- @@ -41,7 +41,7 @@ #### Defined in -[src/permissions/Permissions.interfaces.ts:16](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/permissions/Permissions.interfaces.ts#L16) +[src/services/metadata/types.ts:27](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/types.ts#L27) --- @@ -51,7 +51,7 @@ #### Defined in -[src/permissions/Permissions.interfaces.ts:17](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/permissions/Permissions.interfaces.ts#L17) +[src/services/metadata/types.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/types.ts#L28) --- @@ -65,7 +65,7 @@ #### Defined in -[src/permissions/Permissions.interfaces.ts:11](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/permissions/Permissions.interfaces.ts#L11) +[src/services/metadata/types.ts:22](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/types.ts#L22) --- @@ -79,7 +79,7 @@ #### Defined in -[src/permissions/Permissions.interfaces.ts:10](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/permissions/Permissions.interfaces.ts#L10) +[src/services/metadata/types.ts:21](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/types.ts#L21) --- @@ -93,4 +93,4 @@ #### Defined in -[src/permissions/Permissions.interfaces.ts:9](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/permissions/Permissions.interfaces.ts#L9) +[src/services/metadata/types.ts:20](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/types.ts#L20) diff --git a/docs/api-reference/interfaces/PlatformKeeperTech.md b/docs/api-reference/interfaces/PlatformKeeperTech.md index fff8569d9..f3ad88e85 100644 --- a/docs/api-reference/interfaces/PlatformKeeperTech.md +++ b/docs/api-reference/interfaces/PlatformKeeperTech.md @@ -33,7 +33,7 @@ #### Defined in -[src/nevermined/Versions.ts:15](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Versions.ts#L15) +[src/nevermined/Versions.ts:15](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Versions.ts#L15) --- @@ -47,7 +47,7 @@ #### Defined in -[src/nevermined/Versions.ts:22](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Versions.ts#L22) +[src/nevermined/Versions.ts:22](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Versions.ts#L22) --- @@ -57,7 +57,7 @@ #### Defined in -[src/nevermined/Versions.ts:21](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Versions.ts#L21) +[src/nevermined/Versions.ts:21](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Versions.ts#L21) --- @@ -71,7 +71,7 @@ #### Defined in -[src/nevermined/Versions.ts:13](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Versions.ts#L13) +[src/nevermined/Versions.ts:13](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Versions.ts#L13) --- @@ -81,7 +81,7 @@ #### Defined in -[src/nevermined/Versions.ts:20](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Versions.ts#L20) +[src/nevermined/Versions.ts:20](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Versions.ts#L20) --- @@ -91,7 +91,7 @@ #### Defined in -[src/nevermined/Versions.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Versions.ts#L23) +[src/nevermined/Versions.ts:23](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Versions.ts#L23) --- @@ -105,7 +105,7 @@ #### Defined in -[src/nevermined/Versions.ts:16](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Versions.ts#L16) +[src/nevermined/Versions.ts:16](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Versions.ts#L16) --- @@ -119,4 +119,4 @@ #### Defined in -[src/nevermined/Versions.ts:14](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Versions.ts#L14) +[src/nevermined/Versions.ts:14](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Versions.ts#L14) diff --git a/docs/api-reference/interfaces/PlatformTech.md b/docs/api-reference/interfaces/PlatformTech.md index 339e5e990..6765eb25a 100644 --- a/docs/api-reference/interfaces/PlatformTech.md +++ b/docs/api-reference/interfaces/PlatformTech.md @@ -25,7 +25,7 @@ #### Defined in -[src/nevermined/Versions.ts:15](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Versions.ts#L15) +[src/nevermined/Versions.ts:15](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Versions.ts#L15) --- @@ -35,7 +35,7 @@ #### Defined in -[src/nevermined/Versions.ts:13](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Versions.ts#L13) +[src/nevermined/Versions.ts:13](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Versions.ts#L13) --- @@ -45,7 +45,7 @@ #### Defined in -[src/nevermined/Versions.ts:16](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Versions.ts#L16) +[src/nevermined/Versions.ts:16](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Versions.ts#L16) --- @@ -55,4 +55,4 @@ #### Defined in -[src/nevermined/Versions.ts:14](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Versions.ts#L14) +[src/nevermined/Versions.ts:14](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Versions.ts#L14) diff --git a/docs/api-reference/interfaces/PlatformVersions.md b/docs/api-reference/interfaces/PlatformVersions.md index 7b97cd7dd..56ff9d33c 100644 --- a/docs/api-reference/interfaces/PlatformVersions.md +++ b/docs/api-reference/interfaces/PlatformVersions.md @@ -6,30 +6,30 @@ ### Properties -- [gateway](PlatformVersions.md#gateway) - [metadata](PlatformVersions.md#metadata) +- [node](PlatformVersions.md#node) - [sdk](PlatformVersions.md#sdk) - [status](PlatformVersions.md#status) ## Properties -### gateway +### metadata -• **gateway**: [`PlatformKeeperTech`](PlatformKeeperTech.md) +• **metadata**: [`PlatformTech`](PlatformTech.md) #### Defined in -[src/nevermined/Versions.ts:29](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Versions.ts#L29) +[src/nevermined/Versions.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Versions.ts#L28) --- -### metadata +### node -• **metadata**: [`PlatformTech`](PlatformTech.md) +• **node**: [`PlatformKeeperTech`](PlatformKeeperTech.md) #### Defined in -[src/nevermined/Versions.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Versions.ts#L28) +[src/nevermined/Versions.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Versions.ts#L29) --- @@ -39,7 +39,7 @@ #### Defined in -[src/nevermined/Versions.ts:27](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Versions.ts#L27) +[src/nevermined/Versions.ts:27](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Versions.ts#L27) --- @@ -57,4 +57,4 @@ #### Defined in -[src/nevermined/Versions.ts:30](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/nevermined/Versions.ts#L30) +[src/nevermined/Versions.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/Versions.ts#L30) diff --git a/docs/api-reference/interfaces/Profile.md b/docs/api-reference/interfaces/Profile.md index 80e04a980..9e3c8c5a8 100644 --- a/docs/api-reference/interfaces/Profile.md +++ b/docs/api-reference/interfaces/Profile.md @@ -35,7 +35,7 @@ #### Defined in -[src/profiles/Profiles.interfaces.ts:14](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/profiles/Profiles.interfaces.ts#L14) +[src/services/metadata/types.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/types.ts#L44) --- @@ -49,7 +49,7 @@ #### Defined in -[src/profiles/Profiles.interfaces.ts:10](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/profiles/Profiles.interfaces.ts#L10) +[src/services/metadata/types.ts:40](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/types.ts#L40) --- @@ -59,7 +59,7 @@ #### Defined in -[src/profiles/Profiles.interfaces.ts:19](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/profiles/Profiles.interfaces.ts#L19) +[src/services/metadata/types.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/types.ts#L49) --- @@ -73,7 +73,7 @@ #### Defined in -[src/profiles/Profiles.interfaces.ts:13](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/profiles/Profiles.interfaces.ts#L13) +[src/services/metadata/types.ts:43](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/types.ts#L43) --- @@ -87,7 +87,7 @@ #### Defined in -[src/profiles/Profiles.interfaces.ts:8](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/profiles/Profiles.interfaces.ts#L8) +[src/services/metadata/types.ts:38](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/types.ts#L38) --- @@ -101,7 +101,7 @@ #### Defined in -[src/profiles/Profiles.interfaces.ts:12](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/profiles/Profiles.interfaces.ts#L12) +[src/services/metadata/types.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/types.ts#L42) --- @@ -115,7 +115,7 @@ #### Defined in -[src/profiles/Profiles.interfaces.ts:11](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/profiles/Profiles.interfaces.ts#L11) +[src/services/metadata/types.ts:41](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/types.ts#L41) --- @@ -129,7 +129,7 @@ #### Defined in -[src/profiles/Profiles.interfaces.ts:9](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/profiles/Profiles.interfaces.ts#L9) +[src/services/metadata/types.ts:39](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/types.ts#L39) --- @@ -139,7 +139,7 @@ #### Defined in -[src/profiles/Profiles.interfaces.ts:20](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/profiles/Profiles.interfaces.ts#L20) +[src/services/metadata/types.ts:50](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/types.ts#L50) --- @@ -149,4 +149,4 @@ #### Defined in -[src/profiles/Profiles.interfaces.ts:18](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/profiles/Profiles.interfaces.ts#L18) +[src/services/metadata/types.ts:48](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/types.ts#L48) diff --git a/docs/api-reference/interfaces/Proof.md b/docs/api-reference/interfaces/Proof.md new file mode 100644 index 000000000..4753f2759 --- /dev/null +++ b/docs/api-reference/interfaces/Proof.md @@ -0,0 +1,63 @@ +[@nevermined-io/sdk](../code-reference.md) / Proof + +# Interface: Proof + +## Table of contents + +### Properties + +- [checksum](Proof.md#checksum) +- [created](Proof.md#created) +- [creator](Proof.md#creator) +- [signatureValue](Proof.md#signaturevalue) +- [type](Proof.md#type) + +## Properties + +### checksum + +• **checksum**: `any` + +#### Defined in + +[src/ddo/types.ts:616](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L616) + +--- + +### created + +• **created**: `string` + +#### Defined in + +[src/ddo/types.ts:613](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L613) + +--- + +### creator + +• **creator**: `string` + +#### Defined in + +[src/ddo/types.ts:614](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L614) + +--- + +### signatureValue + +• **signatureValue**: `string` + +#### Defined in + +[src/ddo/types.ts:615](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L615) + +--- + +### type + +• **type**: `string` + +#### Defined in + +[src/ddo/types.ts:612](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L612) diff --git a/docs/api-reference/interfaces/ProvenanceAttributeRegisteredEvent.md b/docs/api-reference/interfaces/ProvenanceAttributeRegisteredEvent.md new file mode 100644 index 000000000..316b8aa63 --- /dev/null +++ b/docs/api-reference/interfaces/ProvenanceAttributeRegisteredEvent.md @@ -0,0 +1,118 @@ +[@nevermined-io/sdk](../code-reference.md) / ProvenanceAttributeRegisteredEvent + +# Interface: ProvenanceAttributeRegisteredEvent + +## Table of contents + +### Properties + +- [activityId](ProvenanceAttributeRegisteredEvent.md#activityid) +- [agentId](ProvenanceAttributeRegisteredEvent.md#agentid) +- [agentInvolvedId](ProvenanceAttributeRegisteredEvent.md#agentinvolvedid) +- [attributes](ProvenanceAttributeRegisteredEvent.md#attributes) +- [blockNumberUpdated](ProvenanceAttributeRegisteredEvent.md#blocknumberupdated) +- [did](ProvenanceAttributeRegisteredEvent.md#did) +- [id](ProvenanceAttributeRegisteredEvent.md#id) +- [method](ProvenanceAttributeRegisteredEvent.md#method) +- [provId](ProvenanceAttributeRegisteredEvent.md#provid) +- [relatedDid](ProvenanceAttributeRegisteredEvent.md#relateddid) + +## Properties + +### activityId + +• **activityId**: `string` + +#### Defined in + +[src/keeper/contracts/Provenance.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L44) + +--- + +### agentId + +• **agentId**: `string` + +#### Defined in + +[src/keeper/contracts/Provenance.ts:43](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L43) + +--- + +### agentInvolvedId + +• **agentInvolvedId**: `string` + +#### Defined in + +[src/keeper/contracts/Provenance.ts:46](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L46) + +--- + +### attributes + +• `Optional` **attributes**: `string` + +#### Defined in + +[src/keeper/contracts/Provenance.ts:48](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L48) + +--- + +### blockNumberUpdated + +• **blockNumberUpdated**: `number` + +#### Defined in + +[src/keeper/contracts/Provenance.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L49) + +--- + +### did + +• **did**: `string` + +#### Defined in + +[src/keeper/contracts/Provenance.ts:42](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L42) + +--- + +### id + +• **id**: `string` + +#### Defined in + +[src/keeper/contracts/Provenance.ts:40](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L40) + +--- + +### method + +• **method**: [`ProvenanceMethod`](../enums/ProvenanceMethod.md) + +#### Defined in + +[src/keeper/contracts/Provenance.ts:47](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L47) + +--- + +### provId + +• **provId**: `string` + +#### Defined in + +[src/keeper/contracts/Provenance.ts:41](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L41) + +--- + +### relatedDid + +• **relatedDid**: `string` + +#### Defined in + +[src/keeper/contracts/Provenance.ts:45](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L45) diff --git a/docs/api-reference/interfaces/ProvenanceBaseEvent.md b/docs/api-reference/interfaces/ProvenanceBaseEvent.md new file mode 100644 index 000000000..fec025c78 --- /dev/null +++ b/docs/api-reference/interfaces/ProvenanceBaseEvent.md @@ -0,0 +1,88 @@ +[@nevermined-io/sdk](../code-reference.md) / ProvenanceBaseEvent + +# Interface: ProvenanceBaseEvent + +## Hierarchy + +- **`ProvenanceBaseEvent`** + + ↳ [`WasGeneratedByEvent`](WasGeneratedByEvent.md) + + ↳ [`UsedEvent`](UsedEvent.md) + + ↳ [`WasDerivedFromEvent`](WasDerivedFromEvent.md) + + ↳ [`WasAssociatedWithEvent`](WasAssociatedWithEvent.md) + + ↳ [`ActedOnBehalfEvent`](ActedOnBehalfEvent.md) + +## Table of contents + +### Properties + +- [activityId](ProvenanceBaseEvent.md#activityid) +- [attributes](ProvenanceBaseEvent.md#attributes) +- [blockNumberUpdated](ProvenanceBaseEvent.md#blocknumberupdated) +- [event](ProvenanceBaseEvent.md#event) +- [method](ProvenanceBaseEvent.md#method) +- [provId](ProvenanceBaseEvent.md#provid) + +## Properties + +### activityId + +• **activityId**: `string` + +#### Defined in + +[src/keeper/contracts/Provenance.ts:55](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L55) + +--- + +### attributes + +• `Optional` **attributes**: `string` + +#### Defined in + +[src/keeper/contracts/Provenance.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L57) + +--- + +### blockNumberUpdated + +• **blockNumberUpdated**: `number` + +#### Defined in + +[src/keeper/contracts/Provenance.ts:58](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L58) + +--- + +### event + +• **event**: `string` + +#### Defined in + +[src/keeper/contracts/Provenance.ts:53](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L53) + +--- + +### method + +• **method**: [`ProvenanceMethod`](../enums/ProvenanceMethod.md) + +#### Defined in + +[src/keeper/contracts/Provenance.ts:54](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L54) + +--- + +### provId + +• **provId**: `string` + +#### Defined in + +[src/keeper/contracts/Provenance.ts:56](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L56) diff --git a/docs/api-reference/interfaces/ProvenanceRegistry.md b/docs/api-reference/interfaces/ProvenanceRegistry.md index 0fca644e7..1c3737af9 100644 --- a/docs/api-reference/interfaces/ProvenanceRegistry.md +++ b/docs/api-reference/interfaces/ProvenanceRegistry.md @@ -24,7 +24,7 @@ #### Defined in -[src/keeper.ts:27](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper.ts#L27) +[src/keeper/contracts/Provenance.ts:31](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L31) --- @@ -34,7 +34,7 @@ #### Defined in -[src/keeper.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper.ts#L26) +[src/keeper/contracts/Provenance.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L30) --- @@ -44,7 +44,7 @@ #### Defined in -[src/keeper.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper.ts#L28) +[src/keeper/contracts/Provenance.ts:32](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L32) --- @@ -54,7 +54,7 @@ #### Defined in -[src/keeper.ts:31](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper.ts#L31) +[src/keeper/contracts/Provenance.ts:35](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L35) --- @@ -64,7 +64,7 @@ #### Defined in -[src/keeper.ts:30](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper.ts#L30) +[src/keeper/contracts/Provenance.ts:34](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L34) --- @@ -74,7 +74,7 @@ #### Defined in -[src/keeper.ts:24](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper.ts#L24) +[src/keeper/contracts/Provenance.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L28) --- @@ -84,7 +84,7 @@ #### Defined in -[src/keeper.ts:29](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper.ts#L29) +[src/keeper/contracts/Provenance.ts:33](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L33) --- @@ -94,7 +94,7 @@ #### Defined in -[src/keeper.ts:25](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper.ts#L25) +[src/keeper/contracts/Provenance.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L29) --- @@ -104,4 +104,4 @@ #### Defined in -[src/keeper.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper.ts#L32) +[src/keeper/contracts/Provenance.ts:36](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L36) diff --git a/docs/api-reference/interfaces/Provider.md b/docs/api-reference/interfaces/Provider.md new file mode 100644 index 000000000..88ce0cd06 --- /dev/null +++ b/docs/api-reference/interfaces/Provider.md @@ -0,0 +1,51 @@ +[@nevermined-io/sdk](../code-reference.md) / Provider + +# Interface: Provider + +## Table of contents + +### Properties + +- [description](Provider.md#description) +- [environment](Provider.md#environment) +- [type](Provider.md#type) + +## Properties + +### description + +• **description**: `string` + +#### Defined in + +[src/ddo/types.ts:19](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L19) + +--- + +### environment + +• **environment**: `Object` + +#### Type declaration + +| Name | Type | +| :-------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `cluster` | { `type`: `string` ; `url`: `string` } | +| `cluster.type` | `string` | +| `cluster.url` | `string` | +| `supportedContainers` | { `checksum`: `string` ; `image`: `string` ; `tag`: `string` }[] | +| `supportedServers` | { `cpu`: `string` ; `disk`: `string` ; `gpu`: `string` ; `maxExecutionTime`: `number` ; `memory`: `string` ; `price`: `string` ; `serverId`: `string` ; `serverType`: `string` }[] | + +#### Defined in + +[src/ddo/types.ts:20](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L20) + +--- + +### type + +• **type**: `string` + +#### Defined in + +[src/ddo/types.ts:18](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L18) diff --git a/docs/api-reference/interfaces/PublicKey.md b/docs/api-reference/interfaces/PublicKey.md new file mode 100644 index 000000000..ce7423d95 --- /dev/null +++ b/docs/api-reference/interfaces/PublicKey.md @@ -0,0 +1,94 @@ +[@nevermined-io/sdk](../code-reference.md) / PublicKey + +# Interface: PublicKey + +Public key data. + +## Table of contents + +### Properties + +- [id](PublicKey.md#id) +- [owner](PublicKey.md#owner) +- [publicKeyBase58](PublicKey.md#publickeybase58) +- [publicKeyHex](PublicKey.md#publickeyhex) +- [publicKeyPem](PublicKey.md#publickeypem) +- [type](PublicKey.md#type) + +## Properties + +### id + +• **id**: `string` + +ID of the key. + +**`Example`** + +```ts +'did:nv:123456789abcdefghi#keys-1' +``` + +#### Defined in + +[src/ddo/types.ts:447](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L447) + +--- + +### owner + +• **owner**: `string` + +Key owner. + +**`Example`** + +```ts +'did:nv:123456789abcdefghi' +``` + +#### Defined in + +[src/ddo/types.ts:462](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L462) + +--- + +### publicKeyBase58 + +• `Optional` **publicKeyBase58**: `string` + +#### Defined in + +[src/ddo/types.ts:465](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L465) + +--- + +### publicKeyHex + +• `Optional` **publicKeyHex**: `string` + +#### Defined in + +[src/ddo/types.ts:466](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L466) + +--- + +### publicKeyPem + +• `Optional` **publicKeyPem**: `string` + +#### Defined in + +[src/ddo/types.ts:464](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L464) + +--- + +### type + +• **type**: `"Ed25519VerificationKey2018"` \| `"RsaVerificationKey2018"` \| `"EdDsaSAPublicKeySecp256k1"` \| `"EthereumECDSAKey"` + +Type of key. + +#### Defined in + +[src/ddo/types.ts:452](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L452) diff --git a/docs/api-reference/interfaces/QueryResult.md b/docs/api-reference/interfaces/QueryResult.md new file mode 100644 index 000000000..0f6406cfd --- /dev/null +++ b/docs/api-reference/interfaces/QueryResult.md @@ -0,0 +1,56 @@ +[@nevermined-io/sdk](../code-reference.md) / QueryResult + +# Interface: QueryResult + +## Table of contents + +### Properties + +- [page](QueryResult.md#page) +- [results](QueryResult.md#results) +- [totalPages](QueryResult.md#totalpages) +- [totalResults](QueryResult.md#totalresults) + +## Properties + +### page + +• **page**: `number` + +#### Defined in + +[src/services/metadata/MetadataService.ts:11](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MetadataService.ts#L11) + +--- + +### results + +• **results**: [`DDO`](../classes/DDO.md)[] + +#### Defined in + +[src/services/metadata/MetadataService.ts:10](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MetadataService.ts#L10) + +--- + +### totalPages + +• **totalPages**: `number` + +#### Defined in + +[src/services/metadata/MetadataService.ts:12](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MetadataService.ts#L12) + +--- + +### totalResults + +• **totalResults**: `Object` + +#### Index signature + +▪ [jsonPath: `string`]: `any` + +#### Defined in + +[src/services/metadata/MetadataService.ts:13](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/metadata/MetadataService.ts#L13) diff --git a/docs/api-reference/interfaces/ResourceAuthentication.md b/docs/api-reference/interfaces/ResourceAuthentication.md new file mode 100644 index 000000000..478afff32 --- /dev/null +++ b/docs/api-reference/interfaces/ResourceAuthentication.md @@ -0,0 +1,63 @@ +[@nevermined-io/sdk](../code-reference.md) / ResourceAuthentication + +# Interface: ResourceAuthentication + +## Table of contents + +### Properties + +- [password](ResourceAuthentication.md#password) +- [privateParameters](ResourceAuthentication.md#privateparameters) +- [token](ResourceAuthentication.md#token) +- [type](ResourceAuthentication.md#type) +- [user](ResourceAuthentication.md#user) + +## Properties + +### password + +• `Optional` **password**: `string` + +#### Defined in + +[src/ddo/types.ts:207](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L207) + +--- + +### privateParameters + +• `Optional` **privateParameters**: { `[name: string]`: `string`; }[] + +#### Defined in + +[src/ddo/types.ts:209](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L209) + +--- + +### token + +• `Optional` **token**: `string` + +#### Defined in + +[src/ddo/types.ts:208](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L208) + +--- + +### type + +• **type**: `"none"` \| `"basic"` \| `"oauth"` + +#### Defined in + +[src/ddo/types.ts:204](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L204) + +--- + +### user + +• `Optional` **user**: `string` + +#### Defined in + +[src/ddo/types.ts:206](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L206) diff --git a/docs/api-reference/interfaces/RoyaltyAttributes.md b/docs/api-reference/interfaces/RoyaltyAttributes.md new file mode 100644 index 000000000..41fdf4435 --- /dev/null +++ b/docs/api-reference/interfaces/RoyaltyAttributes.md @@ -0,0 +1,43 @@ +[@nevermined-io/sdk](../code-reference.md) / RoyaltyAttributes + +# Interface: RoyaltyAttributes + +Attributes defining the royalties model attached to the asset + +## Table of contents + +### Properties + +- [amount](RoyaltyAttributes.md#amount) +- [royaltyKind](RoyaltyAttributes.md#royaltykind) +- [scheme](RoyaltyAttributes.md#scheme) + +## Properties + +### amount + +• **amount**: `number` + +#### Defined in + +[src/nevermined/api/AssetsApi.ts:63](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AssetsApi.ts#L63) + +--- + +### royaltyKind + +• **royaltyKind**: [`RoyaltyKind`](../enums/RoyaltyKind.md) + +#### Defined in + +[src/nevermined/api/AssetsApi.ts:61](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AssetsApi.ts#L61) + +--- + +### scheme + +• **scheme**: [`RoyaltyScheme`](../classes/RoyaltyScheme.md) + +#### Defined in + +[src/nevermined/api/AssetsApi.ts:62](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/api/AssetsApi.ts#L62) diff --git a/docs/api-reference/interfaces/SearchQuery.md b/docs/api-reference/interfaces/SearchQuery.md index 10b8d913f..d9b69b219 100644 --- a/docs/api-reference/interfaces/SearchQuery.md +++ b/docs/api-reference/interfaces/SearchQuery.md @@ -22,7 +22,7 @@ #### Defined in -[src/common/interfaces.ts:20](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/common/interfaces.ts#L20) +[src/common/interfaces.ts:20](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/common/interfaces.ts#L20) --- @@ -32,7 +32,7 @@ #### Defined in -[src/common/interfaces.ts:14](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/common/interfaces.ts#L14) +[src/common/interfaces.ts:14](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/common/interfaces.ts#L14) --- @@ -42,7 +42,7 @@ #### Defined in -[src/common/interfaces.ts:15](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/common/interfaces.ts#L15) +[src/common/interfaces.ts:15](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/common/interfaces.ts#L15) --- @@ -52,7 +52,7 @@ #### Defined in -[src/common/interfaces.ts:17](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/common/interfaces.ts#L17) +[src/common/interfaces.ts:17](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/common/interfaces.ts#L17) --- @@ -62,7 +62,7 @@ #### Defined in -[src/common/interfaces.ts:19](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/common/interfaces.ts#L19) +[src/common/interfaces.ts:19](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/common/interfaces.ts#L19) --- @@ -72,7 +72,7 @@ #### Defined in -[src/common/interfaces.ts:18](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/common/interfaces.ts#L18) +[src/common/interfaces.ts:18](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/common/interfaces.ts#L18) --- @@ -82,4 +82,4 @@ #### Defined in -[src/common/interfaces.ts:16](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/common/interfaces.ts#L16) +[src/common/interfaces.ts:16](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/common/interfaces.ts#L16) diff --git a/docs/api-reference/interfaces/Service.md b/docs/api-reference/interfaces/Service.md deleted file mode 100644 index 4cc908053..000000000 --- a/docs/api-reference/interfaces/Service.md +++ /dev/null @@ -1,41 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / Service - -# Interface: Service - -## Table of contents - -### Properties - -- [definition](Service.md#definition) -- [spec](Service.md#spec) -- [specChecksum](Service.md#specchecksum) - -## Properties - -### definition - -• **definition**: [`ServiceDefinition`](ServiceDefinition.md) - -#### Defined in - -[src/ddo/MetaData.ts:69](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L69) - ---- - -### spec - -• `Optional` **spec**: `string` - -#### Defined in - -[src/ddo/MetaData.ts:67](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L67) - ---- - -### specChecksum - -• `Optional` **specChecksum**: `string` - -#### Defined in - -[src/ddo/MetaData.ts:68](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L68) diff --git a/docs/api-reference/interfaces/ServiceAaveCredit.md b/docs/api-reference/interfaces/ServiceAaveCredit.md new file mode 100644 index 000000000..9ffd27048 --- /dev/null +++ b/docs/api-reference/interfaces/ServiceAaveCredit.md @@ -0,0 +1,104 @@ +[@nevermined-io/sdk](../code-reference.md) / ServiceAaveCredit + +# Interface: ServiceAaveCredit + +## Hierarchy + +- [`ServiceCommon`](ServiceCommon.md) + + ↳ **`ServiceAaveCredit`** + +## Table of contents + +### Properties + +- [attributes](ServiceAaveCredit.md#attributes) +- [index](ServiceAaveCredit.md#index) +- [serviceEndpoint](ServiceAaveCredit.md#serviceendpoint) +- [templateId](ServiceAaveCredit.md#templateid) +- [type](ServiceAaveCredit.md#type) + +## Properties + +### attributes + +• **attributes**: `Object` + +#### Type declaration + +| Name | Type | +| :----------------------------------------------- | :--------------------------------------------------------------------------------------------------------------- | +| `additionalInformation` | { `description`: `string` ; `priceHighestDenomination`: `number` } | +| `additionalInformation.description` | `string` | +| `additionalInformation.priceHighestDenomination` | `number` | +| `main` | { `creator`: `string` ; `datePublished`: `string` ; `name`: `string` ; `price`: `string` ; `timeout`: `number` } | +| `main.creator` | `string` | +| `main.datePublished` | `string` | +| `main.name` | `string` | +| `main.price` | `string` | +| `main.timeout` | `number` | +| `serviceAgreementTemplate?` | [`ServiceAgreementTemplate`](ServiceAgreementTemplate.md) | + +#### Overrides + +[ServiceCommon](ServiceCommon.md).[attributes](ServiceCommon.md#attributes) + +#### Defined in + +[src/keeper/contracts/defi/Service.ts:30](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/Service.ts#L30) + +--- + +### index + +• **index**: `number` + +#### Inherited from + +[ServiceCommon](ServiceCommon.md).[index](ServiceCommon.md#index) + +#### Defined in + +[src/ddo/types.ts:592](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L592) + +--- + +### serviceEndpoint + +• `Optional` **serviceEndpoint**: `string` + +#### Inherited from + +[ServiceCommon](ServiceCommon.md).[serviceEndpoint](ServiceCommon.md#serviceendpoint) + +#### Defined in + +[src/ddo/types.ts:593](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L593) + +--- + +### templateId + +• `Optional` **templateId**: `string` + +#### Overrides + +[ServiceCommon](ServiceCommon.md).[templateId](ServiceCommon.md#templateid) + +#### Defined in + +[src/keeper/contracts/defi/Service.ts:29](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/Service.ts#L29) + +--- + +### type + +• **type**: `"aave-credit"` + +#### Overrides + +[ServiceCommon](ServiceCommon.md).[type](ServiceCommon.md#type) + +#### Defined in + +[src/keeper/contracts/defi/Service.ts:28](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/defi/Service.ts#L28) diff --git a/docs/api-reference/interfaces/ServiceAccess.md b/docs/api-reference/interfaces/ServiceAccess.md new file mode 100644 index 000000000..2f7a85b8c --- /dev/null +++ b/docs/api-reference/interfaces/ServiceAccess.md @@ -0,0 +1,106 @@ +[@nevermined-io/sdk](../code-reference.md) / ServiceAccess + +# Interface: ServiceAccess + +## Hierarchy + +- [`ServiceCommon`](ServiceCommon.md) + +- [`PricedMetadataInformation`](../code-reference.md#pricedmetadatainformation) + + ↳ **`ServiceAccess`** + +## Table of contents + +### Properties + +- [attributes](ServiceAccess.md#attributes) +- [index](ServiceAccess.md#index) +- [serviceEndpoint](ServiceAccess.md#serviceendpoint) +- [templateId](ServiceAccess.md#templateid) +- [type](ServiceAccess.md#type) + +## Properties + +### attributes + +• **attributes**: `Object` + +#### Type declaration + +| Name | Type | +| :----------------------------------------------- | :--------------------------------------------------------------------------------------------------------------- | +| `additionalInformation` | { `description`: `string` ; `priceHighestDenomination`: `number` } | +| `additionalInformation.description` | `string` | +| `additionalInformation.priceHighestDenomination` | `number` | +| `main` | { `creator`: `string` ; `datePublished`: `string` ; `name`: `string` ; `price`: `string` ; `timeout`: `number` } | +| `main.creator` | `string` | +| `main.datePublished` | `string` | +| `main.name` | `string` | +| `main.price` | `string` | +| `main.timeout` | `number` | +| `serviceAgreementTemplate?` | [`ServiceAgreementTemplate`](ServiceAgreementTemplate.md) | + +#### Overrides + +[ServiceCommon](ServiceCommon.md).[attributes](ServiceCommon.md#attributes) + +#### Defined in + +[src/ddo/types.ts:639](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L639) + +--- + +### index + +• **index**: `number` + +#### Inherited from + +[ServiceCommon](ServiceCommon.md).[index](ServiceCommon.md#index) + +#### Defined in + +[src/ddo/types.ts:592](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L592) + +--- + +### serviceEndpoint + +• `Optional` **serviceEndpoint**: `string` + +#### Inherited from + +[ServiceCommon](ServiceCommon.md).[serviceEndpoint](ServiceCommon.md#serviceendpoint) + +#### Defined in + +[src/ddo/types.ts:593](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L593) + +--- + +### templateId + +• `Optional` **templateId**: `string` + +#### Overrides + +[ServiceCommon](ServiceCommon.md).[templateId](ServiceCommon.md#templateid) + +#### Defined in + +[src/ddo/types.ts:638](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L638) + +--- + +### type + +• **type**: `"access"` + +#### Overrides + +[ServiceCommon](ServiceCommon.md).[type](ServiceCommon.md#type) + +#### Defined in + +[src/ddo/types.ts:637](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L637) diff --git a/docs/api-reference/interfaces/ServiceAgreementTemplate.md b/docs/api-reference/interfaces/ServiceAgreementTemplate.md new file mode 100644 index 000000000..fbe545c97 --- /dev/null +++ b/docs/api-reference/interfaces/ServiceAgreementTemplate.md @@ -0,0 +1,67 @@ +[@nevermined-io/sdk](../code-reference.md) / ServiceAgreementTemplate + +# Interface: ServiceAgreementTemplate + +## Table of contents + +### Properties + +- [conditionDependency](ServiceAgreementTemplate.md#conditiondependency) +- [conditions](ServiceAgreementTemplate.md#conditions) +- [contractName](ServiceAgreementTemplate.md#contractname) +- [events](ServiceAgreementTemplate.md#events) +- [fulfillmentOrder](ServiceAgreementTemplate.md#fulfillmentorder) + +## Properties + +### conditionDependency + +• **conditionDependency**: `Object` + +#### Index signature + +▪ [condition: `string`]: `string`[] + +#### Defined in + +[src/ddo/types.ts:796](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L796) + +--- + +### conditions + +• **conditions**: [`ServiceAgreementTemplateCondition`](ServiceAgreementTemplateCondition.md)[] + +#### Defined in + +[src/ddo/types.ts:797](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L797) + +--- + +### contractName + +• **contractName**: `string` + +#### Defined in + +[src/ddo/types.ts:793](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L793) + +--- + +### events + +• **events**: [`ServiceAgreementTemplateEvent`](ServiceAgreementTemplateEvent.md)[] + +#### Defined in + +[src/ddo/types.ts:794](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L794) + +--- + +### fulfillmentOrder + +• **fulfillmentOrder**: `string`[] + +#### Defined in + +[src/ddo/types.ts:795](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L795) diff --git a/docs/api-reference/interfaces/ServiceAgreementTemplateCondition.md b/docs/api-reference/interfaces/ServiceAgreementTemplateCondition.md new file mode 100644 index 000000000..11853e0d6 --- /dev/null +++ b/docs/api-reference/interfaces/ServiceAgreementTemplateCondition.md @@ -0,0 +1,85 @@ +[@nevermined-io/sdk](../code-reference.md) / ServiceAgreementTemplateCondition + +# Interface: ServiceAgreementTemplateCondition + +## Table of contents + +### Properties + +- [contractName](ServiceAgreementTemplateCondition.md#contractname) +- [events](ServiceAgreementTemplateCondition.md#events) +- [functionName](ServiceAgreementTemplateCondition.md#functionname) +- [name](ServiceAgreementTemplateCondition.md#name) +- [parameters](ServiceAgreementTemplateCondition.md#parameters) +- [timelock](ServiceAgreementTemplateCondition.md#timelock) +- [timeout](ServiceAgreementTemplateCondition.md#timeout) + +## Properties + +### contractName + +• **contractName**: `string` + +#### Defined in + +[src/ddo/types.ts:786](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L786) + +--- + +### events + +• **events**: [`ServiceAgreementTemplateEvent`](ServiceAgreementTemplateEvent.md)[] + +#### Defined in + +[src/ddo/types.ts:789](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L789) + +--- + +### functionName + +• **functionName**: `string` + +#### Defined in + +[src/ddo/types.ts:787](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L787) + +--- + +### name + +• **name**: `string` + +#### Defined in + +[src/ddo/types.ts:783](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L783) + +--- + +### parameters + +• **parameters**: [`ServiceAgreementTemplateParameter`](ServiceAgreementTemplateParameter.md)[] + +#### Defined in + +[src/ddo/types.ts:788](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L788) + +--- + +### timelock + +• **timelock**: `number` + +#### Defined in + +[src/ddo/types.ts:784](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L784) + +--- + +### timeout + +• **timeout**: `number` + +#### Defined in + +[src/ddo/types.ts:785](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L785) diff --git a/docs/api-reference/interfaces/ServiceAgreementTemplateEvent.md b/docs/api-reference/interfaces/ServiceAgreementTemplateEvent.md new file mode 100644 index 000000000..0294496da --- /dev/null +++ b/docs/api-reference/interfaces/ServiceAgreementTemplateEvent.md @@ -0,0 +1,49 @@ +[@nevermined-io/sdk](../code-reference.md) / ServiceAgreementTemplateEvent + +# Interface: ServiceAgreementTemplateEvent + +## Table of contents + +### Properties + +- [actorType](ServiceAgreementTemplateEvent.md#actortype) +- [handler](ServiceAgreementTemplateEvent.md#handler) +- [name](ServiceAgreementTemplateEvent.md#name) + +## Properties + +### actorType + +• **actorType**: `string` + +#### Defined in + +[src/ddo/types.ts:774](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L774) + +--- + +### handler + +• **handler**: `Object` + +#### Type declaration + +| Name | Type | +| :------------- | :------- | +| `functionName` | `string` | +| `moduleName` | `string` | +| `version` | `string` | + +#### Defined in + +[src/ddo/types.ts:775](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L775) + +--- + +### name + +• **name**: `string` + +#### Defined in + +[src/ddo/types.ts:773](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L773) diff --git a/docs/api-reference/interfaces/ServiceAgreementTemplateParameter.md b/docs/api-reference/interfaces/ServiceAgreementTemplateParameter.md new file mode 100644 index 000000000..f6e479670 --- /dev/null +++ b/docs/api-reference/interfaces/ServiceAgreementTemplateParameter.md @@ -0,0 +1,41 @@ +[@nevermined-io/sdk](../code-reference.md) / ServiceAgreementTemplateParameter + +# Interface: ServiceAgreementTemplateParameter + +## Table of contents + +### Properties + +- [name](ServiceAgreementTemplateParameter.md#name) +- [type](ServiceAgreementTemplateParameter.md#type) +- [value](ServiceAgreementTemplateParameter.md#value) + +## Properties + +### name + +• **name**: `string` + +#### Defined in + +[src/ddo/types.ts:767](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L767) + +--- + +### type + +• **type**: `string` + +#### Defined in + +[src/ddo/types.ts:768](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L768) + +--- + +### value + +• **value**: `string` \| `number` \| `string`[] + +#### Defined in + +[src/ddo/types.ts:769](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L769) diff --git a/docs/api-reference/interfaces/ServiceAttributes.md b/docs/api-reference/interfaces/ServiceAttributes.md new file mode 100644 index 000000000..fe30f7a7b --- /dev/null +++ b/docs/api-reference/interfaces/ServiceAttributes.md @@ -0,0 +1,52 @@ +[@nevermined-io/sdk](../code-reference.md) / ServiceAttributes + +# Interface: ServiceAttributes + +## Table of contents + +### Properties + +- [nft](ServiceAttributes.md#nft) +- [price](ServiceAttributes.md#price) +- [serviceIndex](ServiceAttributes.md#serviceindex) +- [serviceType](ServiceAttributes.md#servicetype) + +## Properties + +### nft + +• `Optional` **nft**: [`NFTServiceAttributes`](../classes/NFTServiceAttributes.md) + +#### Defined in + +[src/ddo/types.ts:623](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L623) + +--- + +### price + +• `Optional` **price**: [`AssetPrice`](../classes/AssetPrice.md) + +#### Defined in + +[src/ddo/types.ts:622](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L622) + +--- + +### serviceIndex + +• `Optional` **serviceIndex**: `number` + +#### Defined in + +[src/ddo/types.ts:621](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L621) + +--- + +### serviceType + +• **serviceType**: [`ServiceType`](../code-reference.md#servicetype) + +#### Defined in + +[src/ddo/types.ts:620](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L620) diff --git a/docs/api-reference/interfaces/ServiceAuthorization.md b/docs/api-reference/interfaces/ServiceAuthorization.md new file mode 100644 index 000000000..f65f258c1 --- /dev/null +++ b/docs/api-reference/interfaces/ServiceAuthorization.md @@ -0,0 +1,100 @@ +[@nevermined-io/sdk](../code-reference.md) / ServiceAuthorization + +# Interface: ServiceAuthorization + +## Hierarchy + +- [`ServiceCommon`](ServiceCommon.md) + + ↳ **`ServiceAuthorization`** + +## Table of contents + +### Properties + +- [attributes](ServiceAuthorization.md#attributes) +- [index](ServiceAuthorization.md#index) +- [service](ServiceAuthorization.md#service) +- [serviceEndpoint](ServiceAuthorization.md#serviceendpoint) +- [templateId](ServiceAuthorization.md#templateid) +- [type](ServiceAuthorization.md#type) + +## Properties + +### attributes + +• **attributes**: `any` + +#### Inherited from + +[ServiceCommon](ServiceCommon.md).[attributes](ServiceCommon.md#attributes) + +#### Defined in + +[src/ddo/types.ts:595](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L595) + +--- + +### index + +• **index**: `number` + +#### Inherited from + +[ServiceCommon](ServiceCommon.md).[index](ServiceCommon.md#index) + +#### Defined in + +[src/ddo/types.ts:592](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L592) + +--- + +### service + +• **service**: `"None"` \| `"RSAES-OAEP"` + +#### Defined in + +[src/ddo/types.ts:628](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L628) + +--- + +### serviceEndpoint + +• `Optional` **serviceEndpoint**: `string` + +#### Inherited from + +[ServiceCommon](ServiceCommon.md).[serviceEndpoint](ServiceCommon.md#serviceendpoint) + +#### Defined in + +[src/ddo/types.ts:593](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L593) + +--- + +### templateId + +• `Optional` **templateId**: `string` + +#### Inherited from + +[ServiceCommon](ServiceCommon.md).[templateId](ServiceCommon.md#templateid) + +#### Defined in + +[src/ddo/types.ts:594](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L594) + +--- + +### type + +• **type**: `"authorization"` + +#### Overrides + +[ServiceCommon](ServiceCommon.md).[type](ServiceCommon.md#type) + +#### Defined in + +[src/ddo/types.ts:627](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L627) diff --git a/docs/api-reference/interfaces/ServiceCommon.md b/docs/api-reference/interfaces/ServiceCommon.md new file mode 100644 index 000000000..dd18ce3e2 --- /dev/null +++ b/docs/api-reference/interfaces/ServiceCommon.md @@ -0,0 +1,81 @@ +[@nevermined-io/sdk](../code-reference.md) / ServiceCommon + +# Interface: ServiceCommon + +## Hierarchy + +- **`ServiceCommon`** + + ↳ [`ServiceMetadata`](ServiceMetadata.md) + + ↳ [`ServiceAuthorization`](ServiceAuthorization.md) + + ↳ [`ServiceAccess`](ServiceAccess.md) + + ↳ [`ServiceCompute`](ServiceCompute.md) + + ↳ [`ServiceNFTAccess`](ServiceNFTAccess.md) + + ↳ [`ServiceNFTSales`](ServiceNFTSales.md) + + ↳ [`ServiceAaveCredit`](ServiceAaveCredit.md) + +## Table of contents + +### Properties + +- [attributes](ServiceCommon.md#attributes) +- [index](ServiceCommon.md#index) +- [serviceEndpoint](ServiceCommon.md#serviceendpoint) +- [templateId](ServiceCommon.md#templateid) +- [type](ServiceCommon.md#type) + +## Properties + +### attributes + +• **attributes**: `any` + +#### Defined in + +[src/ddo/types.ts:595](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L595) + +--- + +### index + +• **index**: `number` + +#### Defined in + +[src/ddo/types.ts:592](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L592) + +--- + +### serviceEndpoint + +• `Optional` **serviceEndpoint**: `string` + +#### Defined in + +[src/ddo/types.ts:593](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L593) + +--- + +### templateId + +• `Optional` **templateId**: `string` + +#### Defined in + +[src/ddo/types.ts:594](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L594) + +--- + +### type + +• **type**: [`ServiceType`](../code-reference.md#servicetype) + +#### Defined in + +[src/ddo/types.ts:591](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L591) diff --git a/docs/api-reference/interfaces/ServiceCompute.md b/docs/api-reference/interfaces/ServiceCompute.md new file mode 100644 index 000000000..0a105ae0d --- /dev/null +++ b/docs/api-reference/interfaces/ServiceCompute.md @@ -0,0 +1,106 @@ +[@nevermined-io/sdk](../code-reference.md) / ServiceCompute + +# Interface: ServiceCompute + +## Hierarchy + +- [`ServiceCommon`](ServiceCommon.md) + +- [`PricedMetadataInformation`](../code-reference.md#pricedmetadatainformation) + + ↳ **`ServiceCompute`** + +## Table of contents + +### Properties + +- [attributes](ServiceCompute.md#attributes) +- [index](ServiceCompute.md#index) +- [serviceEndpoint](ServiceCompute.md#serviceendpoint) +- [templateId](ServiceCompute.md#templateid) +- [type](ServiceCompute.md#type) + +## Properties + +### attributes + +• **attributes**: `Object` + +#### Type declaration + +| Name | Type | +| :----------------------------------------------- | :--------------------------------------------------------------------------------------------------------------- | +| `additionalInformation` | { `description`: `string` ; `priceHighestDenomination`: `number` } | +| `additionalInformation.description` | `string` | +| `additionalInformation.priceHighestDenomination` | `number` | +| `main` | { `creator`: `string` ; `datePublished`: `string` ; `name`: `string` ; `price`: `string` ; `timeout`: `number` } | +| `main.creator` | `string` | +| `main.datePublished` | `string` | +| `main.name` | `string` | +| `main.price` | `string` | +| `main.timeout` | `number` | +| `serviceAgreementTemplate?` | [`ServiceAgreementTemplate`](ServiceAgreementTemplate.md) | + +#### Overrides + +[ServiceCommon](ServiceCommon.md).[attributes](ServiceCommon.md#attributes) + +#### Defined in + +[src/ddo/types.ts:658](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L658) + +--- + +### index + +• **index**: `number` + +#### Inherited from + +[ServiceCommon](ServiceCommon.md).[index](ServiceCommon.md#index) + +#### Defined in + +[src/ddo/types.ts:592](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L592) + +--- + +### serviceEndpoint + +• `Optional` **serviceEndpoint**: `string` + +#### Inherited from + +[ServiceCommon](ServiceCommon.md).[serviceEndpoint](ServiceCommon.md#serviceendpoint) + +#### Defined in + +[src/ddo/types.ts:593](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L593) + +--- + +### templateId + +• `Optional` **templateId**: `string` + +#### Overrides + +[ServiceCommon](ServiceCommon.md).[templateId](ServiceCommon.md#templateid) + +#### Defined in + +[src/ddo/types.ts:657](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L657) + +--- + +### type + +• **type**: `"compute"` + +#### Overrides + +[ServiceCommon](ServiceCommon.md).[type](ServiceCommon.md#type) + +#### Defined in + +[src/ddo/types.ts:656](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L656) diff --git a/docs/api-reference/interfaces/ServiceDefinition.md b/docs/api-reference/interfaces/ServiceDefinition.md index a348870c6..4555be3e3 100644 --- a/docs/api-reference/interfaces/ServiceDefinition.md +++ b/docs/api-reference/interfaces/ServiceDefinition.md @@ -26,7 +26,7 @@ #### Defined in -[src/ddo/MetaData.ts:52](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L52) +[src/ddo/types.ts:84](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L84) --- @@ -45,4 +45,4 @@ #### Defined in -[src/ddo/MetaData.ts:58](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L58) +[src/ddo/types.ts:90](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L90) diff --git a/docs/api-reference/interfaces/ServiceMetadata.md b/docs/api-reference/interfaces/ServiceMetadata.md new file mode 100644 index 000000000..b2fc94f92 --- /dev/null +++ b/docs/api-reference/interfaces/ServiceMetadata.md @@ -0,0 +1,122 @@ +[@nevermined-io/sdk](../code-reference.md) / ServiceMetadata + +# Interface: ServiceMetadata + +## Hierarchy + +- [`ServiceCommon`](ServiceCommon.md) + + ↳ **`ServiceMetadata`** + +## Table of contents + +### Properties + +- [attributes](ServiceMetadata.md#attributes) +- [definition](ServiceMetadata.md#definition) +- [index](ServiceMetadata.md#index) +- [serviceEndpoint](ServiceMetadata.md#serviceendpoint) +- [spec](ServiceMetadata.md#spec) +- [specChecksum](ServiceMetadata.md#specchecksum) +- [templateId](ServiceMetadata.md#templateid) +- [type](ServiceMetadata.md#type) + +## Properties + +### attributes + +• **attributes**: [`MetaData`](MetaData.md) + +#### Inherited from + +[ServiceCommon](ServiceCommon.md).[attributes](ServiceCommon.md#attributes) + +#### Defined in + +[src/ddo/types.ts:633](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L633) + +--- + +### definition + +• **definition**: [`ServiceDefinition`](ServiceDefinition.md) + +#### Defined in + +[src/ddo/types.ts:101](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L101) + +--- + +### index + +• **index**: `number` + +#### Inherited from + +[ServiceCommon](ServiceCommon.md).[index](ServiceCommon.md#index) + +#### Defined in + +[src/ddo/types.ts:592](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L592) + +--- + +### serviceEndpoint + +• `Optional` **serviceEndpoint**: `string` + +#### Inherited from + +[ServiceCommon](ServiceCommon.md).[serviceEndpoint](ServiceCommon.md#serviceendpoint) + +#### Defined in + +[src/ddo/types.ts:593](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L593) + +--- + +### spec + +• `Optional` **spec**: `string` + +#### Defined in + +[src/ddo/types.ts:99](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L99) + +--- + +### specChecksum + +• `Optional` **specChecksum**: `string` + +#### Defined in + +[src/ddo/types.ts:100](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L100) + +--- + +### templateId + +• `Optional` **templateId**: `string` + +#### Inherited from + +[ServiceCommon](ServiceCommon.md).[templateId](ServiceCommon.md#templateid) + +#### Defined in + +[src/ddo/types.ts:594](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L594) + +--- + +### type + +• **type**: `"metadata"` + +#### Inherited from + +[ServiceCommon](ServiceCommon.md).[type](ServiceCommon.md#type) + +#### Defined in + +[src/ddo/types.ts:632](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L632) diff --git a/docs/api-reference/interfaces/ServiceNFTAccess.md b/docs/api-reference/interfaces/ServiceNFTAccess.md new file mode 100644 index 000000000..5a30c3fca --- /dev/null +++ b/docs/api-reference/interfaces/ServiceNFTAccess.md @@ -0,0 +1,104 @@ +[@nevermined-io/sdk](../code-reference.md) / ServiceNFTAccess + +# Interface: ServiceNFTAccess + +## Hierarchy + +- [`ServiceCommon`](ServiceCommon.md) + + ↳ **`ServiceNFTAccess`** + +## Table of contents + +### Properties + +- [attributes](ServiceNFTAccess.md#attributes) +- [index](ServiceNFTAccess.md#index) +- [serviceEndpoint](ServiceNFTAccess.md#serviceendpoint) +- [templateId](ServiceNFTAccess.md#templateid) +- [type](ServiceNFTAccess.md#type) + +## Properties + +### attributes + +• **attributes**: `Object` + +#### Type declaration + +| Name | Type | +| :---------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `additionalInformation` | { `description`: `string` } | +| `additionalInformation.description` | `string` | +| `main` | { `creator`: `string` ; `datePublished`: `string` ; `ercType`: [`ERCType`](../enums/ERCType.md) ; `name`: `string` ; `nftType`: [`NeverminedNFTType`](../code-reference.md#neverminednfttype) ; `timeout`: `number` } | +| `main.creator` | `string` | +| `main.datePublished` | `string` | +| `main.ercType` | [`ERCType`](../enums/ERCType.md) | +| `main.name` | `string` | +| `main.nftType` | [`NeverminedNFTType`](../code-reference.md#neverminednfttype) | +| `main.timeout` | `number` | +| `serviceAgreementTemplate?` | [`ServiceAgreementTemplate`](ServiceAgreementTemplate.md) | + +#### Overrides + +[ServiceCommon](ServiceCommon.md).[attributes](ServiceCommon.md#attributes) + +#### Defined in + +[src/ddo/types.ts:677](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L677) + +--- + +### index + +• **index**: `number` + +#### Inherited from + +[ServiceCommon](ServiceCommon.md).[index](ServiceCommon.md#index) + +#### Defined in + +[src/ddo/types.ts:592](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L592) + +--- + +### serviceEndpoint + +• `Optional` **serviceEndpoint**: `string` + +#### Inherited from + +[ServiceCommon](ServiceCommon.md).[serviceEndpoint](ServiceCommon.md#serviceendpoint) + +#### Defined in + +[src/ddo/types.ts:593](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L593) + +--- + +### templateId + +• `Optional` **templateId**: `string` + +#### Overrides + +[ServiceCommon](ServiceCommon.md).[templateId](ServiceCommon.md#templateid) + +#### Defined in + +[src/ddo/types.ts:676](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L676) + +--- + +### type + +• **type**: `"nft-access"` + +#### Overrides + +[ServiceCommon](ServiceCommon.md).[type](ServiceCommon.md#type) + +#### Defined in + +[src/ddo/types.ts:675](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L675) diff --git a/docs/api-reference/interfaces/ServiceNFTSales.md b/docs/api-reference/interfaces/ServiceNFTSales.md new file mode 100644 index 000000000..7adc8de62 --- /dev/null +++ b/docs/api-reference/interfaces/ServiceNFTSales.md @@ -0,0 +1,108 @@ +[@nevermined-io/sdk](../code-reference.md) / ServiceNFTSales + +# Interface: ServiceNFTSales + +## Hierarchy + +- [`ServiceCommon`](ServiceCommon.md) + +- [`PricedMetadataInformation`](../code-reference.md#pricedmetadatainformation) + + ↳ **`ServiceNFTSales`** + +## Table of contents + +### Properties + +- [attributes](ServiceNFTSales.md#attributes) +- [index](ServiceNFTSales.md#index) +- [serviceEndpoint](ServiceNFTSales.md#serviceendpoint) +- [templateId](ServiceNFTSales.md#templateid) +- [type](ServiceNFTSales.md#type) + +## Properties + +### attributes + +• **attributes**: `Object` + +#### Type declaration + +| Name | Type | +| :----------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `additionalInformation` | { `description`: `string` ; `priceHighestDenomination`: `number` } | +| `additionalInformation.description` | `string` | +| `additionalInformation.priceHighestDenomination` | `number` | +| `main` | { `creator`: `string` ; `datePublished`: `string` ; `ercType`: [`ERCType`](../enums/ERCType.md) ; `name`: `string` ; `nftType`: [`NeverminedNFTType`](../code-reference.md#neverminednfttype) ; `price`: `string` ; `timeout`: `number` } | +| `main.creator` | `string` | +| `main.datePublished` | `string` | +| `main.ercType` | [`ERCType`](../enums/ERCType.md) | +| `main.name` | `string` | +| `main.nftType` | [`NeverminedNFTType`](../code-reference.md#neverminednfttype) | +| `main.price` | `string` | +| `main.timeout` | `number` | +| `serviceAgreementTemplate?` | [`ServiceAgreementTemplate`](ServiceAgreementTemplate.md) | + +#### Overrides + +[ServiceCommon](ServiceCommon.md).[attributes](ServiceCommon.md#attributes) + +#### Defined in + +[src/ddo/types.ts:696](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L696) + +--- + +### index + +• **index**: `number` + +#### Inherited from + +[ServiceCommon](ServiceCommon.md).[index](ServiceCommon.md#index) + +#### Defined in + +[src/ddo/types.ts:592](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L592) + +--- + +### serviceEndpoint + +• `Optional` **serviceEndpoint**: `string` + +#### Inherited from + +[ServiceCommon](ServiceCommon.md).[serviceEndpoint](ServiceCommon.md#serviceendpoint) + +#### Defined in + +[src/ddo/types.ts:593](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L593) + +--- + +### templateId + +• `Optional` **templateId**: `string` + +#### Overrides + +[ServiceCommon](ServiceCommon.md).[templateId](ServiceCommon.md#templateid) + +#### Defined in + +[src/ddo/types.ts:695](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L695) + +--- + +### type + +• **type**: `"nft-sales"` + +#### Overrides + +[ServiceCommon](ServiceCommon.md).[type](ServiceCommon.md#type) + +#### Defined in + +[src/ddo/types.ts:694](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L694) diff --git a/docs/api-reference/interfaces/ServicePlugin.md b/docs/api-reference/interfaces/ServicePlugin.md new file mode 100644 index 000000000..36a83fce2 --- /dev/null +++ b/docs/api-reference/interfaces/ServicePlugin.md @@ -0,0 +1,113 @@ +[@nevermined-io/sdk](../code-reference.md) / ServicePlugin + +# Interface: ServicePlugin + +## Type parameters + +| Name | Type | +| :--- | :------------------------------------------------ | +| `T` | extends [`Service`](../code-reference.md#service) | + +## Implemented by + +- [`AccessService`](../classes/AccessService.md) +- [`BaseTemplate`](../classes/BaseTemplate.md) +- [`NFTAccessService`](../classes/NFTAccessService.md) +- [`NFTSalesService`](../classes/NFTSalesService.md) + +## Table of contents + +### Methods + +- [accept](ServicePlugin.md#accept) +- [createService](ServicePlugin.md#createservice) +- [process](ServicePlugin.md#process) +- [track](ServicePlugin.md#track) + +## Methods + +### accept + +▸ **accept**(`params`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :------- | :---------------------------------------- | +| `params` | [`ValidationParams`](ValidationParams.md) | + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[src/ddo/types.ts:761](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L761) + +--- + +### createService + +▸ **createService**(`publisher`, `metadata`, `serviceAttributes`, `nftAttributes`, `pricedData?`): `T` + +#### Parameters + +| Name | Type | +| :------------------ | :---------------------------------------------------------------------------- | +| `publisher` | [`Account`](../classes/Account.md) | +| `metadata` | [`MetaData`](MetaData.md) | +| `serviceAttributes` | [`ServiceAttributes`](ServiceAttributes.md) | +| `nftAttributes` | [`NFTAttributes`](../classes/NFTAttributes.md) | +| `pricedData?` | [`PricedMetadataInformation`](../code-reference.md#pricedmetadatainformation) | + +#### Returns + +`T` + +#### Defined in + +[src/ddo/types.ts:751](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L751) + +--- + +### process + +▸ **process**(`params`, `from`, `txparams?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :---------- | :---------------------------------------- | +| `params` | [`ValidationParams`](ValidationParams.md) | +| `from` | [`Account`](../classes/Account.md) | +| `txparams?` | [`TxParameters`](TxParameters.md) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[src/ddo/types.ts:759](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L759) + +--- + +### track + +▸ **track**(`params`, `from`, `txparams?`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :---------- | :---------------------------------------- | +| `params` | [`ValidationParams`](ValidationParams.md) | +| `from` | [`Account`](../classes/Account.md) | +| `txparams?` | [`TxParameters`](TxParameters.md) | + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[src/ddo/types.ts:763](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L763) diff --git a/docs/api-reference/interfaces/ServiceSecondary.md b/docs/api-reference/interfaces/ServiceSecondary.md new file mode 100644 index 000000000..1737f8842 --- /dev/null +++ b/docs/api-reference/interfaces/ServiceSecondary.md @@ -0,0 +1,111 @@ +[@nevermined-io/sdk](../code-reference.md) / ServiceSecondary + +# Interface: ServiceSecondary + +## Hierarchy + +- [`Service`](../code-reference.md#service) + + ↳ **`ServiceSecondary`** + +## Table of contents + +### Properties + +- [agreementId](ServiceSecondary.md#agreementid) +- [attributes](ServiceSecondary.md#attributes) +- [did](ServiceSecondary.md#did) +- [index](ServiceSecondary.md#index) +- [serviceEndpoint](ServiceSecondary.md#serviceendpoint) +- [templateId](ServiceSecondary.md#templateid) +- [type](ServiceSecondary.md#type) + +## Properties + +### agreementId + +• **agreementId**: `string` + +#### Defined in + +[src/ddo/types.ts:715](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L715) + +--- + +### attributes + +• **attributes**: `any` + +#### Inherited from + +Service.attributes + +#### Defined in + +[src/ddo/types.ts:595](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L595) + +--- + +### did + +• **did**: `string` + +#### Defined in + +[src/ddo/types.ts:716](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L716) + +--- + +### index + +• **index**: `number` + +#### Inherited from + +Service.index + +#### Defined in + +[src/ddo/types.ts:592](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L592) + +--- + +### serviceEndpoint + +• `Optional` **serviceEndpoint**: `string` + +#### Inherited from + +Service.serviceEndpoint + +#### Defined in + +[src/ddo/types.ts:593](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L593) + +--- + +### templateId + +• `Optional` **templateId**: `string` + +#### Inherited from + +Service.templateId + +#### Defined in + +[src/ddo/types.ts:594](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L594) + +--- + +### type + +• **type**: [`ServiceType`](../code-reference.md#servicetype) + +#### Inherited from + +Service.type + +#### Defined in + +[src/ddo/types.ts:591](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L591) diff --git a/docs/api-reference/interfaces/Stage.md b/docs/api-reference/interfaces/Stage.md index 9319aaf3e..cfaa58235 100644 --- a/docs/api-reference/interfaces/Stage.md +++ b/docs/api-reference/interfaces/Stage.md @@ -9,7 +9,6 @@ - [index](Stage.md#index) - [input](Stage.md#input) - [output](Stage.md#output) -- [requirements](Stage.md#requirements) - [stageType](Stage.md#stagetype) - [transformation](Stage.md#transformation) @@ -21,17 +20,17 @@ #### Defined in -[src/ddo/MetaData.ts:27](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L27) +[src/ddo/types.ts:59](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L59) --- ### input -• **input**: [`StageInput`](StageInput.md) +• **input**: [`StageInput`](StageInput.md)[] #### Defined in -[src/ddo/MetaData.ts:30](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L30) +[src/ddo/types.ts:61](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L61) --- @@ -41,17 +40,7 @@ #### Defined in -[src/ddo/MetaData.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L32) - ---- - -### requirements - -• **requirements**: [`StageRequirements`](StageRequirements.md) - -#### Defined in - -[src/ddo/MetaData.ts:29](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L29) +[src/ddo/types.ts:63](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L63) --- @@ -61,7 +50,7 @@ #### Defined in -[src/ddo/MetaData.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L28) +[src/ddo/types.ts:60](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L60) --- @@ -71,4 +60,4 @@ #### Defined in -[src/ddo/MetaData.ts:31](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L31) +[src/ddo/types.ts:62](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L62) diff --git a/docs/api-reference/interfaces/StageInput.md b/docs/api-reference/interfaces/StageInput.md index 56725b726..2d0a790ee 100644 --- a/docs/api-reference/interfaces/StageInput.md +++ b/docs/api-reference/interfaces/StageInput.md @@ -17,7 +17,7 @@ #### Defined in -[src/ddo/MetaData.ts:13](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L13) +[src/ddo/types.ts:45](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L45) --- @@ -27,4 +27,4 @@ #### Defined in -[src/ddo/MetaData.ts:12](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L12) +[src/ddo/types.ts:44](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L44) diff --git a/docs/api-reference/interfaces/StageOutput.md b/docs/api-reference/interfaces/StageOutput.md index a373b351a..5bc58419b 100644 --- a/docs/api-reference/interfaces/StageOutput.md +++ b/docs/api-reference/interfaces/StageOutput.md @@ -18,7 +18,7 @@ #### Defined in -[src/ddo/MetaData.ts:22](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L22) +[src/ddo/types.ts:54](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L54) --- @@ -28,7 +28,7 @@ #### Defined in -[src/ddo/MetaData.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L23) +[src/ddo/types.ts:55](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L55) --- @@ -38,4 +38,4 @@ #### Defined in -[src/ddo/MetaData.ts:21](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L21) +[src/ddo/types.ts:53](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L53) diff --git a/docs/api-reference/interfaces/StageRequirements.md b/docs/api-reference/interfaces/StageRequirements.md deleted file mode 100644 index b0619be17..000000000 --- a/docs/api-reference/interfaces/StageRequirements.md +++ /dev/null @@ -1,27 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / StageRequirements - -# Interface: StageRequirements - -## Table of contents - -### Properties - -- [container](StageRequirements.md#container) - -## Properties - -### container - -• **container**: `Object` - -#### Type declaration - -| Name | Type | -| :--------- | :------- | -| `checksum` | `string` | -| `image` | `string` | -| `tag` | `string` | - -#### Defined in - -[src/ddo/MetaData.ts:4](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L4) diff --git a/docs/api-reference/interfaces/StageTransformation.md b/docs/api-reference/interfaces/StageTransformation.md index ebab8b3b9..76c9a7d7f 100644 --- a/docs/api-reference/interfaces/StageTransformation.md +++ b/docs/api-reference/interfaces/StageTransformation.md @@ -16,4 +16,4 @@ #### Defined in -[src/ddo/MetaData.ts:17](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L17) +[src/ddo/types.ts:49](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L49) diff --git a/docs/api-reference/interfaces/SubscriptionToken.md b/docs/api-reference/interfaces/SubscriptionToken.md new file mode 100644 index 000000000..1de8a29fe --- /dev/null +++ b/docs/api-reference/interfaces/SubscriptionToken.md @@ -0,0 +1,30 @@ +[@nevermined-io/sdk](../code-reference.md) / SubscriptionToken + +# Interface: SubscriptionToken + +## Table of contents + +### Properties + +- [accessToken](SubscriptionToken.md#accesstoken) +- [neverminedProxyUri](SubscriptionToken.md#neverminedproxyuri) + +## Properties + +### accessToken + +• **accessToken**: `string` + +#### Defined in + +[src/services/node/NeverminedNode.ts:25](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L25) + +--- + +### neverminedProxyUri + +• **neverminedProxyUri**: `string` + +#### Defined in + +[src/services/node/NeverminedNode.ts:26](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/services/node/NeverminedNode.ts#L26) diff --git a/docs/api-reference/interfaces/TemplateMetadata.md b/docs/api-reference/interfaces/TemplateMetadata.md new file mode 100644 index 000000000..de2d4949c --- /dev/null +++ b/docs/api-reference/interfaces/TemplateMetadata.md @@ -0,0 +1,52 @@ +[@nevermined-io/sdk](../code-reference.md) / TemplateMetadata + +# Interface: TemplateMetadata + +## Table of contents + +### Properties + +- [blockNumberUpdated](TemplateMetadata.md#blocknumberupdated) +- [lastUpdatedBy](TemplateMetadata.md#lastupdatedby) +- [owner](TemplateMetadata.md#owner) +- [state](TemplateMetadata.md#state) + +## Properties + +### blockNumberUpdated + +• **blockNumberUpdated**: `number` + +#### Defined in + +[src/keeper/contracts/managers/TemplateStoreManager.ts:17](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/TemplateStoreManager.ts#L17) + +--- + +### lastUpdatedBy + +• **lastUpdatedBy**: `string` + +#### Defined in + +[src/keeper/contracts/managers/TemplateStoreManager.ts:16](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/TemplateStoreManager.ts#L16) + +--- + +### owner + +• **owner**: `string` + +#### Defined in + +[src/keeper/contracts/managers/TemplateStoreManager.ts:15](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/TemplateStoreManager.ts#L15) + +--- + +### state + +• **state**: [`TemplateState`](../enums/TemplateState.md) + +#### Defined in + +[src/keeper/contracts/managers/TemplateStoreManager.ts:14](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/managers/TemplateStoreManager.ts#L14) diff --git a/docs/api-reference/interfaces/TxParameters.md b/docs/api-reference/interfaces/TxParameters.md new file mode 100644 index 000000000..d566ff05c --- /dev/null +++ b/docs/api-reference/interfaces/TxParameters.md @@ -0,0 +1,132 @@ +[@nevermined-io/sdk](../code-reference.md) / TxParameters + +# Interface: TxParameters + +## Table of contents + +### Properties + +- [gasLimit](TxParameters.md#gaslimit) +- [gasMultiplier](TxParameters.md#gasmultiplier) +- [gasPrice](TxParameters.md#gasprice) +- [maxFeePerGas](TxParameters.md#maxfeepergas) +- [maxPriorityFeePerGas](TxParameters.md#maxpriorityfeepergas) +- [nonce](TxParameters.md#nonce) +- [progress](TxParameters.md#progress) +- [signer](TxParameters.md#signer) +- [value](TxParameters.md#value) +- [zeroDevSigner](TxParameters.md#zerodevsigner) + +## Properties + +### gasLimit + +• `Optional` **gasLimit**: `bigint` + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:16](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L16) + +--- + +### gasMultiplier + +• `Optional` **gasMultiplier**: `number` + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:17](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L17) + +--- + +### gasPrice + +• `Optional` **gasPrice**: `string` + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:18](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L18) + +--- + +### maxFeePerGas + +• `Optional` **maxFeePerGas**: `string` + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:20](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L20) + +--- + +### maxPriorityFeePerGas + +• `Optional` **maxPriorityFeePerGas**: `string` + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:19](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L19) + +--- + +### nonce + +• `Optional` **nonce**: `number` + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:23](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L23) + +--- + +### progress + +• `Optional` **progress**: (`data`: `any`) => `void` + +#### Type declaration + +▸ (`data`): `void` + +##### Parameters + +| Name | Type | +| :----- | :---- | +| `data` | `any` | + +##### Returns + +`void` + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:24](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L24) + +--- + +### signer + +• `Optional` **signer**: `Signer` + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:21](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L21) + +--- + +### value + +• `Optional` **value**: `string` + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:15](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L15) + +--- + +### zeroDevSigner + +• `Optional` **zeroDevSigner**: `ZeroDevAccountSigner`<`"ECDSA"`\> + +#### Defined in + +[src/keeper/contracts/ContractBase.ts:22](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/ContractBase.ts#L22) diff --git a/docs/api-reference/interfaces/TypedDataDomain.md b/docs/api-reference/interfaces/TypedDataDomain.md new file mode 100644 index 000000000..b516c7875 --- /dev/null +++ b/docs/api-reference/interfaces/TypedDataDomain.md @@ -0,0 +1,41 @@ +[@nevermined-io/sdk](../code-reference.md) / TypedDataDomain + +# Interface: TypedDataDomain + +## Table of contents + +### Properties + +- [chainId](TypedDataDomain.md#chainid) +- [name](TypedDataDomain.md#name) +- [version](TypedDataDomain.md#version) + +## Properties + +### chainId + +• **chainId**: `number` + +#### Defined in + +[src/nevermined/utils/JwtUtils.ts:16](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/JwtUtils.ts#L16) + +--- + +### name + +• **name**: `string` + +#### Defined in + +[src/nevermined/utils/JwtUtils.ts:14](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/JwtUtils.ts#L14) + +--- + +### version + +• **version**: `string` + +#### Defined in + +[src/nevermined/utils/JwtUtils.ts:15](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/JwtUtils.ts#L15) diff --git a/docs/api-reference/interfaces/TypedDataTypes.md b/docs/api-reference/interfaces/TypedDataTypes.md new file mode 100644 index 000000000..4c04c80a2 --- /dev/null +++ b/docs/api-reference/interfaces/TypedDataTypes.md @@ -0,0 +1,19 @@ +[@nevermined-io/sdk](../code-reference.md) / TypedDataTypes + +# Interface: TypedDataTypes + +## Table of contents + +### Properties + +- [Nevermined](TypedDataTypes.md#nevermined) + +## Properties + +### Nevermined + +• **Nevermined**: { `name`: `string` ; `type`: `string` }[] + +#### Defined in + +[src/nevermined/utils/JwtUtils.ts:20](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/nevermined/utils/JwtUtils.ts#L20) diff --git a/docs/api-reference/interfaces/UsedEvent.md b/docs/api-reference/interfaces/UsedEvent.md new file mode 100644 index 000000000..a68de7335 --- /dev/null +++ b/docs/api-reference/interfaces/UsedEvent.md @@ -0,0 +1,126 @@ +[@nevermined-io/sdk](../code-reference.md) / UsedEvent + +# Interface: UsedEvent + +## Hierarchy + +- [`ProvenanceBaseEvent`](ProvenanceBaseEvent.md) + + ↳ **`UsedEvent`** + +## Table of contents + +### Properties + +- [activityId](UsedEvent.md#activityid) +- [agentId](UsedEvent.md#agentid) +- [attributes](UsedEvent.md#attributes) +- [blockNumberUpdated](UsedEvent.md#blocknumberupdated) +- [did](UsedEvent.md#did) +- [event](UsedEvent.md#event) +- [method](UsedEvent.md#method) +- [provId](UsedEvent.md#provid) + +## Properties + +### activityId + +• **activityId**: `string` + +#### Inherited from + +[ProvenanceBaseEvent](ProvenanceBaseEvent.md).[activityId](ProvenanceBaseEvent.md#activityid) + +#### Defined in + +[src/keeper/contracts/Provenance.ts:55](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L55) + +--- + +### agentId + +• **agentId**: `string` + +#### Defined in + +[src/keeper/contracts/Provenance.ts:66](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L66) + +--- + +### attributes + +• `Optional` **attributes**: `string` + +#### Inherited from + +[ProvenanceBaseEvent](ProvenanceBaseEvent.md).[attributes](ProvenanceBaseEvent.md#attributes) + +#### Defined in + +[src/keeper/contracts/Provenance.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L57) + +--- + +### blockNumberUpdated + +• **blockNumberUpdated**: `number` + +#### Inherited from + +[ProvenanceBaseEvent](ProvenanceBaseEvent.md).[blockNumberUpdated](ProvenanceBaseEvent.md#blocknumberupdated) + +#### Defined in + +[src/keeper/contracts/Provenance.ts:58](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L58) + +--- + +### did + +• **did**: `string` + +#### Defined in + +[src/keeper/contracts/Provenance.ts:65](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L65) + +--- + +### event + +• **event**: `string` + +#### Inherited from + +[ProvenanceBaseEvent](ProvenanceBaseEvent.md).[event](ProvenanceBaseEvent.md#event) + +#### Defined in + +[src/keeper/contracts/Provenance.ts:53](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L53) + +--- + +### method + +• **method**: [`ProvenanceMethod`](../enums/ProvenanceMethod.md) + +#### Inherited from + +[ProvenanceBaseEvent](ProvenanceBaseEvent.md).[method](ProvenanceBaseEvent.md#method) + +#### Defined in + +[src/keeper/contracts/Provenance.ts:54](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L54) + +--- + +### provId + +• **provId**: `string` + +#### Inherited from + +[ProvenanceBaseEvent](ProvenanceBaseEvent.md).[provId](ProvenanceBaseEvent.md#provid) + +#### Defined in + +[src/keeper/contracts/Provenance.ts:56](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L56) diff --git a/docs/api-reference/interfaces/ValidationParams.md b/docs/api-reference/interfaces/ValidationParams.md new file mode 100644 index 000000000..38a702631 --- /dev/null +++ b/docs/api-reference/interfaces/ValidationParams.md @@ -0,0 +1,118 @@ +[@nevermined-io/sdk](../code-reference.md) / ValidationParams + +# Interface: ValidationParams + +## Table of contents + +### Properties + +- [agreement_id](ValidationParams.md#agreement_id) +- [babysig](ValidationParams.md#babysig) +- [buyer](ValidationParams.md#buyer) +- [consumer_address](ValidationParams.md#consumer_address) +- [did](ValidationParams.md#did) +- [duration](ValidationParams.md#duration) +- [expiration](ValidationParams.md#expiration) +- [nft_amount](ValidationParams.md#nft_amount) +- [nft_holder](ValidationParams.md#nft_holder) +- [service_index](ValidationParams.md#service_index) + +## Properties + +### agreement_id + +• **agreement_id**: `string` + +#### Defined in + +[src/ddo/types.ts:738](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L738) + +--- + +### babysig + +• `Optional` **babysig**: [`Babysig`](Babysig.md) + +#### Defined in + +[src/ddo/types.ts:743](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L743) + +--- + +### buyer + +• `Optional` **buyer**: `string` + +#### Defined in + +[src/ddo/types.ts:742](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L742) + +--- + +### consumer_address + +• `Optional` **consumer_address**: `string` + +#### Defined in + +[src/ddo/types.ts:741](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L741) + +--- + +### did + +• **did**: `string` + +#### Defined in + +[src/ddo/types.ts:739](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L739) + +--- + +### duration + +• `Optional` **duration**: `number` + +#### Defined in + +[src/ddo/types.ts:746](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L746) + +--- + +### expiration + +• `Optional` **expiration**: `number` + +#### Defined in + +[src/ddo/types.ts:747](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L747) + +--- + +### nft_amount + +• `Optional` **nft_amount**: `bigint` + +#### Defined in + +[src/ddo/types.ts:744](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L744) + +--- + +### nft_holder + +• `Optional` **nft_holder**: `string` + +#### Defined in + +[src/ddo/types.ts:745](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L745) + +--- + +### service_index + +• `Optional` **service_index**: `number` + +#### Defined in + +[src/ddo/types.ts:740](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L740) diff --git a/docs/api-reference/interfaces/ValuePair.md b/docs/api-reference/interfaces/ValuePair.md new file mode 100644 index 000000000..bc0ffffc0 --- /dev/null +++ b/docs/api-reference/interfaces/ValuePair.md @@ -0,0 +1,30 @@ +[@nevermined-io/sdk](../code-reference.md) / ValuePair + +# Interface: ValuePair + +## Table of contents + +### Properties + +- [type](ValuePair.md#type) +- [value](ValuePair.md#value) + +## Properties + +### type + +• **type**: `string` + +#### Defined in + +[src/models/types.ts:62](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/types.ts#L62) + +--- + +### value + +• **value**: `any` + +#### Defined in + +[src/models/types.ts:63](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/models/types.ts#L63) diff --git a/docs/api-reference/interfaces/WasAssociatedWithEvent.md b/docs/api-reference/interfaces/WasAssociatedWithEvent.md new file mode 100644 index 000000000..3dc91fcd2 --- /dev/null +++ b/docs/api-reference/interfaces/WasAssociatedWithEvent.md @@ -0,0 +1,126 @@ +[@nevermined-io/sdk](../code-reference.md) / WasAssociatedWithEvent + +# Interface: WasAssociatedWithEvent + +## Hierarchy + +- [`ProvenanceBaseEvent`](ProvenanceBaseEvent.md) + + ↳ **`WasAssociatedWithEvent`** + +## Table of contents + +### Properties + +- [activityId](WasAssociatedWithEvent.md#activityid) +- [agentId](WasAssociatedWithEvent.md#agentid) +- [attributes](WasAssociatedWithEvent.md#attributes) +- [blockNumberUpdated](WasAssociatedWithEvent.md#blocknumberupdated) +- [entityDid](WasAssociatedWithEvent.md#entitydid) +- [event](WasAssociatedWithEvent.md#event) +- [method](WasAssociatedWithEvent.md#method) +- [provId](WasAssociatedWithEvent.md#provid) + +## Properties + +### activityId + +• **activityId**: `string` + +#### Inherited from + +[ProvenanceBaseEvent](ProvenanceBaseEvent.md).[activityId](ProvenanceBaseEvent.md#activityid) + +#### Defined in + +[src/keeper/contracts/Provenance.ts:55](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L55) + +--- + +### agentId + +• **agentId**: `string` + +#### Defined in + +[src/keeper/contracts/Provenance.ts:75](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L75) + +--- + +### attributes + +• `Optional` **attributes**: `string` + +#### Inherited from + +[ProvenanceBaseEvent](ProvenanceBaseEvent.md).[attributes](ProvenanceBaseEvent.md#attributes) + +#### Defined in + +[src/keeper/contracts/Provenance.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L57) + +--- + +### blockNumberUpdated + +• **blockNumberUpdated**: `number` + +#### Inherited from + +[ProvenanceBaseEvent](ProvenanceBaseEvent.md).[blockNumberUpdated](ProvenanceBaseEvent.md#blocknumberupdated) + +#### Defined in + +[src/keeper/contracts/Provenance.ts:58](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L58) + +--- + +### entityDid + +• **entityDid**: `string` + +#### Defined in + +[src/keeper/contracts/Provenance.ts:74](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L74) + +--- + +### event + +• **event**: `string` + +#### Inherited from + +[ProvenanceBaseEvent](ProvenanceBaseEvent.md).[event](ProvenanceBaseEvent.md#event) + +#### Defined in + +[src/keeper/contracts/Provenance.ts:53](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L53) + +--- + +### method + +• **method**: [`ProvenanceMethod`](../enums/ProvenanceMethod.md) + +#### Inherited from + +[ProvenanceBaseEvent](ProvenanceBaseEvent.md).[method](ProvenanceBaseEvent.md#method) + +#### Defined in + +[src/keeper/contracts/Provenance.ts:54](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L54) + +--- + +### provId + +• **provId**: `string` + +#### Inherited from + +[ProvenanceBaseEvent](ProvenanceBaseEvent.md).[provId](ProvenanceBaseEvent.md#provid) + +#### Defined in + +[src/keeper/contracts/Provenance.ts:56](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L56) diff --git a/docs/api-reference/interfaces/WasDerivedFromEvent.md b/docs/api-reference/interfaces/WasDerivedFromEvent.md new file mode 100644 index 000000000..342b311f7 --- /dev/null +++ b/docs/api-reference/interfaces/WasDerivedFromEvent.md @@ -0,0 +1,137 @@ +[@nevermined-io/sdk](../code-reference.md) / WasDerivedFromEvent + +# Interface: WasDerivedFromEvent + +## Hierarchy + +- [`ProvenanceBaseEvent`](ProvenanceBaseEvent.md) + + ↳ **`WasDerivedFromEvent`** + +## Table of contents + +### Properties + +- [activityId](WasDerivedFromEvent.md#activityid) +- [agentId](WasDerivedFromEvent.md#agentid) +- [attributes](WasDerivedFromEvent.md#attributes) +- [blockNumberUpdated](WasDerivedFromEvent.md#blocknumberupdated) +- [event](WasDerivedFromEvent.md#event) +- [method](WasDerivedFromEvent.md#method) +- [newEntityDid](WasDerivedFromEvent.md#newentitydid) +- [provId](WasDerivedFromEvent.md#provid) +- [usedEntityDid](WasDerivedFromEvent.md#usedentitydid) + +## Properties + +### activityId + +• **activityId**: `string` + +#### Inherited from + +[ProvenanceBaseEvent](ProvenanceBaseEvent.md).[activityId](ProvenanceBaseEvent.md#activityid) + +#### Defined in + +[src/keeper/contracts/Provenance.ts:55](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L55) + +--- + +### agentId + +• **agentId**: `string` + +#### Defined in + +[src/keeper/contracts/Provenance.ts:71](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L71) + +--- + +### attributes + +• `Optional` **attributes**: `string` + +#### Inherited from + +[ProvenanceBaseEvent](ProvenanceBaseEvent.md).[attributes](ProvenanceBaseEvent.md#attributes) + +#### Defined in + +[src/keeper/contracts/Provenance.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L57) + +--- + +### blockNumberUpdated + +• **blockNumberUpdated**: `number` + +#### Inherited from + +[ProvenanceBaseEvent](ProvenanceBaseEvent.md).[blockNumberUpdated](ProvenanceBaseEvent.md#blocknumberupdated) + +#### Defined in + +[src/keeper/contracts/Provenance.ts:58](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L58) + +--- + +### event + +• **event**: `string` + +#### Inherited from + +[ProvenanceBaseEvent](ProvenanceBaseEvent.md).[event](ProvenanceBaseEvent.md#event) + +#### Defined in + +[src/keeper/contracts/Provenance.ts:53](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L53) + +--- + +### method + +• **method**: [`ProvenanceMethod`](../enums/ProvenanceMethod.md) + +#### Inherited from + +[ProvenanceBaseEvent](ProvenanceBaseEvent.md).[method](ProvenanceBaseEvent.md#method) + +#### Defined in + +[src/keeper/contracts/Provenance.ts:54](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L54) + +--- + +### newEntityDid + +• **newEntityDid**: `string` + +#### Defined in + +[src/keeper/contracts/Provenance.ts:69](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L69) + +--- + +### provId + +• **provId**: `string` + +#### Inherited from + +[ProvenanceBaseEvent](ProvenanceBaseEvent.md).[provId](ProvenanceBaseEvent.md#provid) + +#### Defined in + +[src/keeper/contracts/Provenance.ts:56](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L56) + +--- + +### usedEntityDid + +• **usedEntityDid**: `string` + +#### Defined in + +[src/keeper/contracts/Provenance.ts:70](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L70) diff --git a/docs/api-reference/interfaces/WasGeneratedByEvent.md b/docs/api-reference/interfaces/WasGeneratedByEvent.md new file mode 100644 index 000000000..3430dac8d --- /dev/null +++ b/docs/api-reference/interfaces/WasGeneratedByEvent.md @@ -0,0 +1,126 @@ +[@nevermined-io/sdk](../code-reference.md) / WasGeneratedByEvent + +# Interface: WasGeneratedByEvent + +## Hierarchy + +- [`ProvenanceBaseEvent`](ProvenanceBaseEvent.md) + + ↳ **`WasGeneratedByEvent`** + +## Table of contents + +### Properties + +- [activityId](WasGeneratedByEvent.md#activityid) +- [agentId](WasGeneratedByEvent.md#agentid) +- [attributes](WasGeneratedByEvent.md#attributes) +- [blockNumberUpdated](WasGeneratedByEvent.md#blocknumberupdated) +- [did](WasGeneratedByEvent.md#did) +- [event](WasGeneratedByEvent.md#event) +- [method](WasGeneratedByEvent.md#method) +- [provId](WasGeneratedByEvent.md#provid) + +## Properties + +### activityId + +• **activityId**: `string` + +#### Inherited from + +[ProvenanceBaseEvent](ProvenanceBaseEvent.md).[activityId](ProvenanceBaseEvent.md#activityid) + +#### Defined in + +[src/keeper/contracts/Provenance.ts:55](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L55) + +--- + +### agentId + +• **agentId**: `string` + +#### Defined in + +[src/keeper/contracts/Provenance.ts:62](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L62) + +--- + +### attributes + +• `Optional` **attributes**: `string` + +#### Inherited from + +[ProvenanceBaseEvent](ProvenanceBaseEvent.md).[attributes](ProvenanceBaseEvent.md#attributes) + +#### Defined in + +[src/keeper/contracts/Provenance.ts:57](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L57) + +--- + +### blockNumberUpdated + +• **blockNumberUpdated**: `number` + +#### Inherited from + +[ProvenanceBaseEvent](ProvenanceBaseEvent.md).[blockNumberUpdated](ProvenanceBaseEvent.md#blocknumberupdated) + +#### Defined in + +[src/keeper/contracts/Provenance.ts:58](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L58) + +--- + +### did + +• **did**: `string` + +#### Defined in + +[src/keeper/contracts/Provenance.ts:61](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L61) + +--- + +### event + +• **event**: `string` + +#### Inherited from + +[ProvenanceBaseEvent](ProvenanceBaseEvent.md).[event](ProvenanceBaseEvent.md#event) + +#### Defined in + +[src/keeper/contracts/Provenance.ts:53](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L53) + +--- + +### method + +• **method**: [`ProvenanceMethod`](../enums/ProvenanceMethod.md) + +#### Inherited from + +[ProvenanceBaseEvent](ProvenanceBaseEvent.md).[method](ProvenanceBaseEvent.md#method) + +#### Defined in + +[src/keeper/contracts/Provenance.ts:54](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L54) + +--- + +### provId + +• **provId**: `string` + +#### Inherited from + +[ProvenanceBaseEvent](ProvenanceBaseEvent.md).[provId](ProvenanceBaseEvent.md#provid) + +#### Defined in + +[src/keeper/contracts/Provenance.ts:56](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/keeper/contracts/Provenance.ts#L56) diff --git a/docs/api-reference/interfaces/WebService.md b/docs/api-reference/interfaces/WebService.md new file mode 100644 index 000000000..eb6c01e21 --- /dev/null +++ b/docs/api-reference/interfaces/WebService.md @@ -0,0 +1,65 @@ +[@nevermined-io/sdk](../code-reference.md) / WebService + +# Interface: WebService + +Interface describing an asset of type `service` + +## Table of contents + +### Properties + +- [encryptedAttributes](WebService.md#encryptedattributes) +- [endpoints](WebService.md#endpoints) +- [internalAttributes](WebService.md#internalattributes) +- [openEndpoints](WebService.md#openendpoints) +- [type](WebService.md#type) + +## Properties + +### encryptedAttributes + +• `Optional` **encryptedAttributes**: `string` + +#### Defined in + +[src/ddo/types.ts:194](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L194) + +--- + +### endpoints + +• `Optional` **endpoints**: { `[verb: string]`: `string`; }[] + +#### Defined in + +[src/ddo/types.ts:188](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L188) + +--- + +### internalAttributes + +• `Optional` **internalAttributes**: [`WebServiceInternalAttributes`](WebServiceInternalAttributes.md) + +#### Defined in + +[src/ddo/types.ts:192](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L192) + +--- + +### openEndpoints + +• `Optional` **openEndpoints**: `string`[] + +#### Defined in + +[src/ddo/types.ts:190](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L190) + +--- + +### type + +• `Optional` **type**: `"Other"` \| `"RESTful"` \| `"GrapQL"` \| `"RPC"` + +#### Defined in + +[src/ddo/types.ts:186](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L186) diff --git a/docs/api-reference/interfaces/WebServiceInternalAttributes.md b/docs/api-reference/interfaces/WebServiceInternalAttributes.md new file mode 100644 index 000000000..7bf0ebccc --- /dev/null +++ b/docs/api-reference/interfaces/WebServiceInternalAttributes.md @@ -0,0 +1,30 @@ +[@nevermined-io/sdk](../code-reference.md) / WebServiceInternalAttributes + +# Interface: WebServiceInternalAttributes + +## Table of contents + +### Properties + +- [authentication](WebServiceInternalAttributes.md#authentication) +- [headers](WebServiceInternalAttributes.md#headers) + +## Properties + +### authentication + +• `Optional` **authentication**: [`ResourceAuthentication`](ResourceAuthentication.md) + +#### Defined in + +[src/ddo/types.ts:198](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L198) + +--- + +### headers + +• `Optional` **headers**: { `[verb: string]`: `string`; }[] + +#### Defined in + +[src/ddo/types.ts:200](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L200) diff --git a/docs/api-reference/interfaces/Workflow.md b/docs/api-reference/interfaces/Workflow.md index 6a0eeddc2..2356b6c2f 100644 --- a/docs/api-reference/interfaces/Workflow.md +++ b/docs/api-reference/interfaces/Workflow.md @@ -6,14 +6,25 @@ ### Properties +- [coordinationType](Workflow.md#coordinationtype) - [stages](Workflow.md#stages) ## Properties +### coordinationType + +• **coordinationType**: `"argo"` \| `"fl-coordinator"` \| `"bacalhau"` + +#### Defined in + +[src/ddo/types.ts:67](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L67) + +--- + ### stages • **stages**: [`Stage`](Stage.md)[] #### Defined in -[src/ddo/MetaData.ts:36](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/ddo/MetaData.ts#L36) +[src/ddo/types.ts:68](https://github.com/nevermined-io/sdk-js/blob/bb26f8ab/src/ddo/types.ts#L68) diff --git a/docs/api-reference/interfaces/conditions.ConditionContext.md b/docs/api-reference/interfaces/conditions.ConditionContext.md deleted file mode 100644 index 1057d7421..000000000 --- a/docs/api-reference/interfaces/conditions.ConditionContext.md +++ /dev/null @@ -1,54 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [conditions](../modules/conditions.md) / ConditionContext - -# Interface: ConditionContext - -[conditions](../modules/conditions.md).ConditionContext - -## Table of contents - -### Properties - -- [creator](conditions.ConditionContext.md#creator) -- [ddo](conditions.ConditionContext.md#ddo) -- [rewards](conditions.ConditionContext.md#rewards) -- [service](conditions.ConditionContext.md#service) - -## Properties - -### creator - -• **creator**: `string` - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L23) - ---- - -### ddo - -• **ddo**: [`DDO`](../classes/DDO.md) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:20](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L20) - ---- - -### rewards - -• **rewards**: `default` - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:22](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L22) - ---- - -### service - -• **service**: `ServiceCommon` - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:21](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L21) diff --git a/docs/api-reference/interfaces/conditions.ConditionInstance.md b/docs/api-reference/interfaces/conditions.ConditionInstance.md deleted file mode 100644 index 36b446a4b..000000000 --- a/docs/api-reference/interfaces/conditions.ConditionInstance.md +++ /dev/null @@ -1,123 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [conditions](../modules/conditions.md) / ConditionInstance - -# Interface: ConditionInstance - -[conditions](../modules/conditions.md).ConditionInstance - -## Type parameters - -| Name | -| :------ | -| `Extra` | - -## Hierarchy - -- [`ConditionInstanceSmall`](conditions.ConditionInstanceSmall.md) - - ↳ **`ConditionInstance`** - -## Table of contents - -### Properties - -- [agreementId](conditions.ConditionInstance.md#agreementid) -- [condition](conditions.ConditionInstance.md#condition) -- [id](conditions.ConditionInstance.md#id) -- [list](conditions.ConditionInstance.md#list) -- [params](conditions.ConditionInstance.md#params) -- [seed](conditions.ConditionInstance.md#seed) - -## Properties - -### agreementId - -• **agreementId**: `string` - -#### Inherited from - -[ConditionInstanceSmall](conditions.ConditionInstanceSmall.md).[agreementId](conditions.ConditionInstanceSmall.md#agreementid) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L35) - ---- - -### condition - -• **condition**: `string` - -#### Inherited from - -[ConditionInstanceSmall](conditions.ConditionInstanceSmall.md).[condition](conditions.ConditionInstanceSmall.md#condition) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:36](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L36) - ---- - -### id - -• **id**: `string` - -#### Inherited from - -[ConditionInstanceSmall](conditions.ConditionInstanceSmall.md).[id](conditions.ConditionInstanceSmall.md#id) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:34](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L34) - ---- - -### list - -• **list**: `any`[] - -#### Inherited from - -[ConditionInstanceSmall](conditions.ConditionInstanceSmall.md).[list](conditions.ConditionInstanceSmall.md#list) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L32) - ---- - -### params - -• **params**: (`method`: [`ConditionMethod`](../modules/conditions.md#conditionmethod), `arg`: `Extra`) => `Promise`<`any`[]\> - -#### Type declaration - -▸ (`method`, `arg`): `Promise`<`any`[]\> - -##### Parameters - -| Name | Type | -| :------- | :------------------------------------------------------------ | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | -| `arg` | `Extra` | - -##### Returns - -`Promise`<`any`[]\> - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:40](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L40) - ---- - -### seed - -• **seed**: `string` - -#### Inherited from - -[ConditionInstanceSmall](conditions.ConditionInstanceSmall.md).[seed](conditions.ConditionInstanceSmall.md#seed) - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L33) diff --git a/docs/api-reference/interfaces/conditions.ConditionInstanceSmall.md b/docs/api-reference/interfaces/conditions.ConditionInstanceSmall.md deleted file mode 100644 index 3a4b6089c..000000000 --- a/docs/api-reference/interfaces/conditions.ConditionInstanceSmall.md +++ /dev/null @@ -1,71 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [conditions](../modules/conditions.md) / ConditionInstanceSmall - -# Interface: ConditionInstanceSmall - -[conditions](../modules/conditions.md).ConditionInstanceSmall - -## Hierarchy - -- **`ConditionInstanceSmall`** - - ↳ [`ConditionInstance`](conditions.ConditionInstance.md) - -## Table of contents - -### Properties - -- [agreementId](conditions.ConditionInstanceSmall.md#agreementid) -- [condition](conditions.ConditionInstanceSmall.md#condition) -- [id](conditions.ConditionInstanceSmall.md#id) -- [list](conditions.ConditionInstanceSmall.md#list) -- [seed](conditions.ConditionInstanceSmall.md#seed) - -## Properties - -### agreementId - -• **agreementId**: `string` - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:35](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L35) - ---- - -### condition - -• **condition**: `string` - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:36](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L36) - ---- - -### id - -• **id**: `string` - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:34](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L34) - ---- - -### list - -• **list**: `any`[] - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:32](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L32) - ---- - -### seed - -• **seed**: `string` - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:33](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L33) diff --git a/docs/api-reference/interfaces/conditions.ConditionParameters.md b/docs/api-reference/interfaces/conditions.ConditionParameters.md deleted file mode 100644 index 24d6ab507..000000000 --- a/docs/api-reference/interfaces/conditions.ConditionParameters.md +++ /dev/null @@ -1,53 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [conditions](../modules/conditions.md) / ConditionParameters - -# Interface: ConditionParameters - -[conditions](../modules/conditions.md).ConditionParameters - -## Type parameters - -| Name | -| :------ | -| `Extra` | - -## Table of contents - -### Properties - -- [list](conditions.ConditionParameters.md#list) -- [params](conditions.ConditionParameters.md#params) - -## Properties - -### list - -• **list**: `any`[] - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:27](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L27) - ---- - -### params - -• **params**: (`method`: [`ConditionMethod`](../modules/conditions.md#conditionmethod), `arg`: `Extra`) => `Promise`<`any`[]\> - -#### Type declaration - -▸ (`method`, `arg`): `Promise`<`any`[]\> - -##### Parameters - -| Name | Type | -| :------- | :------------------------------------------------------------ | -| `method` | [`ConditionMethod`](../modules/conditions.md#conditionmethod) | -| `arg` | `Extra` | - -##### Returns - -`Promise`<`any`[]\> - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:28](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L28) diff --git a/docs/api-reference/interfaces/events.ContractEventSubscription.md b/docs/api-reference/interfaces/events.ContractEventSubscription.md deleted file mode 100644 index 04ddda527..000000000 --- a/docs/api-reference/interfaces/events.ContractEventSubscription.md +++ /dev/null @@ -1,29 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [events](../modules/events.md) / ContractEventSubscription - -# Interface: ContractEventSubscription - -[events](../modules/events.md).ContractEventSubscription - -## Table of contents - -### Properties - -- [unsubscribe](events.ContractEventSubscription.md#unsubscribe) - -## Properties - -### unsubscribe - -• **unsubscribe**: () => `void` - -#### Type declaration - -▸ (): `void` - -##### Returns - -`void` - -#### Defined in - -[src/events/NeverminedEvent.ts:23](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L23) diff --git a/docs/api-reference/interfaces/events.EventOptions.md b/docs/api-reference/interfaces/events.EventOptions.md deleted file mode 100644 index 8874ac1d3..000000000 --- a/docs/api-reference/interfaces/events.EventOptions.md +++ /dev/null @@ -1,87 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [events](../modules/events.md) / EventOptions - -# Interface: EventOptions - -[events](../modules/events.md).EventOptions - -## Table of contents - -### Properties - -- [eventName](events.EventOptions.md#eventname) -- [filterJsonRpc](events.EventOptions.md#filterjsonrpc) -- [filterSubgraph](events.EventOptions.md#filtersubgraph) -- [fromBlock](events.EventOptions.md#fromblock) -- [methodName](events.EventOptions.md#methodname) -- [result](events.EventOptions.md#result) -- [toBlock](events.EventOptions.md#toblock) - -## Properties - -### eventName - -• `Optional` **eventName**: `string` - -#### Defined in - -[src/events/NeverminedEvent.ts:9](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L9) - ---- - -### filterJsonRpc - -• `Optional` **filterJsonRpc**: [`Filter`](events.Filter.md) - -#### Defined in - -[src/events/NeverminedEvent.ts:10](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L10) - ---- - -### filterSubgraph - -• `Optional` **filterSubgraph**: `Record`<`string`, `unknown`\> - -#### Defined in - -[src/events/NeverminedEvent.ts:11](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L11) - ---- - -### fromBlock - -• `Optional` **fromBlock**: `string` \| `number` - -#### Defined in - -[src/events/NeverminedEvent.ts:13](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L13) - ---- - -### methodName - -• `Optional` **methodName**: `string` - -#### Defined in - -[src/events/NeverminedEvent.ts:8](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L8) - ---- - -### result - -• `Optional` **result**: `Record`<`string`, `unknown`\> - -#### Defined in - -[src/events/NeverminedEvent.ts:12](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L12) - ---- - -### toBlock - -• `Optional` **toBlock**: `string` \| `number` - -#### Defined in - -[src/events/NeverminedEvent.ts:14](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L14) diff --git a/docs/api-reference/interfaces/events.Filter.md b/docs/api-reference/interfaces/events.Filter.md deleted file mode 100644 index 8d3e21f03..000000000 --- a/docs/api-reference/interfaces/events.Filter.md +++ /dev/null @@ -1,9 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [events](../modules/events.md) / Filter - -# Interface: Filter - -[events](../modules/events.md).Filter - -## Indexable - -▪ [key: `string`]: `number` \| `string` \| `string`[] \| `number`[] diff --git a/docs/api-reference/interfaces/templates.AgreementInstance.md b/docs/api-reference/interfaces/templates.AgreementInstance.md deleted file mode 100644 index f84c82e1f..000000000 --- a/docs/api-reference/interfaces/templates.AgreementInstance.md +++ /dev/null @@ -1,49 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [templates](../modules/templates.md) / AgreementInstance - -# Interface: AgreementInstance - -[templates](../modules/templates.md).AgreementInstance - -## Type parameters - -| Name | -| :------- | -| `Params` | - -## Table of contents - -### Properties - -- [agreementId](templates.AgreementInstance.md#agreementid) -- [instances](templates.AgreementInstance.md#instances) -- [list](templates.AgreementInstance.md#list) - -## Properties - -### agreementId - -• **agreementId**: `string` - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:50](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L50) - ---- - -### instances - -• **instances**: [`ConditionInstanceSmall`](conditions.ConditionInstanceSmall.md)[] - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:51](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L51) - ---- - -### list - -• **list**: `Params` - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:49](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L49) diff --git a/docs/api-reference/interfaces/templates.PaymentData.md b/docs/api-reference/interfaces/templates.PaymentData.md deleted file mode 100644 index c436484ee..000000000 --- a/docs/api-reference/interfaces/templates.PaymentData.md +++ /dev/null @@ -1,54 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [templates](../modules/templates.md) / PaymentData - -# Interface: PaymentData - -[templates](../modules/templates.md).PaymentData - -## Table of contents - -### Properties - -- [amounts](templates.PaymentData.md#amounts) -- [receivers](templates.PaymentData.md#receivers) -- [rewardAddress](templates.PaymentData.md#rewardaddress) -- [tokenAddress](templates.PaymentData.md#tokenaddress) - -## Properties - -### amounts - -• **amounts**: `default`[] - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:57](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L57) - ---- - -### receivers - -• **receivers**: `string`[] - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:58](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L58) - ---- - -### rewardAddress - -• **rewardAddress**: `string` - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:55](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L55) - ---- - -### tokenAddress - -• **tokenAddress**: `string` - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:56](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L56) diff --git a/docs/api-reference/modules/KeyTransfer.md b/docs/api-reference/modules/KeyTransfer.md deleted file mode 100644 index edf9aae46..000000000 --- a/docs/api-reference/modules/KeyTransfer.md +++ /dev/null @@ -1,14 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / KeyTransfer - -# Namespace: KeyTransfer - -## Table of contents - -### Classes - -- [BabyjubPublicKey](../classes/KeyTransfer.BabyjubPublicKey.md) -- [MimcCipher](../classes/KeyTransfer.MimcCipher.md) - -### Interfaces - -- [Babysig](../interfaces/KeyTransfer.Babysig.md) diff --git a/docs/api-reference/modules/conditions.md b/docs/api-reference/modules/conditions.md deleted file mode 100644 index 7eef3c0df..000000000 --- a/docs/api-reference/modules/conditions.md +++ /dev/null @@ -1,80 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / conditions - -# Namespace: conditions - -## Table of contents - -### References - -- [Condition](conditions.md#condition) -- [ConditionState](conditions.md#conditionstate) - -### Classes - -- [AaveBorrowCondition](../classes/conditions.AaveBorrowCondition.md) -- [AaveCollateralDepositCondition](../classes/conditions.AaveCollateralDepositCondition.md) -- [AaveCollateralWithdrawCondition](../classes/conditions.AaveCollateralWithdrawCondition.md) -- [AaveRepayCondition](../classes/conditions.AaveRepayCondition.md) -- [AccessCondition](../classes/conditions.AccessCondition.md) -- [ComputeExecutionCondition](../classes/conditions.ComputeExecutionCondition.md) -- [ConditionSmall](../classes/conditions.ConditionSmall.md) -- [ConsumerCondition](../classes/conditions.ConsumerCondition.md) -- [DistributeNFTCollateralCondition](../classes/conditions.DistributeNFTCollateralCondition.md) -- [EscrowPaymentCondition](../classes/conditions.EscrowPaymentCondition.md) -- [LockPaymentCondition](../classes/conditions.LockPaymentCondition.md) -- [NFT721HolderCondition](../classes/conditions.NFT721HolderCondition.md) -- [NFT721LockCondition](../classes/conditions.NFT721LockCondition.md) -- [NFTAccessCondition](../classes/conditions.NFTAccessCondition.md) -- [NFTHolderCondition](../classes/conditions.NFTHolderCondition.md) -- [NFTLockCondition](../classes/conditions.NFTLockCondition.md) -- [ProviderCondition](../classes/conditions.ProviderCondition.md) -- [TransferDIDOwnershipCondition](../classes/conditions.TransferDIDOwnershipCondition.md) -- [TransferNFT721Condition](../classes/conditions.TransferNFT721Condition.md) -- [TransferNFTCondition](../classes/conditions.TransferNFTCondition.md) - -### Interfaces - -- [ConditionContext](../interfaces/conditions.ConditionContext.md) -- [ConditionInstance](../interfaces/conditions.ConditionInstance.md) -- [ConditionInstanceSmall](../interfaces/conditions.ConditionInstanceSmall.md) -- [ConditionParameters](../interfaces/conditions.ConditionParameters.md) - -### Type Aliases - -- [ConditionMethod](conditions.md#conditionmethod) - -### Variables - -- [conditionStateNames](conditions.md#conditionstatenames) - -## References - -### Condition - -Re-exports [Condition](../classes/Condition.md) - ---- - -### ConditionState - -Re-exports [ConditionState](../enums/ConditionState.md) - -## Type Aliases - -### ConditionMethod - -Ƭ **ConditionMethod**: `"fulfill"` \| `"fulfillForDelegate"` - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:17](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L17) - -## Variables - -### conditionStateNames - -• `Const` **conditionStateNames**: `string`[] - -#### Defined in - -[src/keeper/contracts/conditions/Condition.abstract.ts:43](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/conditions/Condition.abstract.ts#L43) diff --git a/docs/api-reference/modules/events.md b/docs/api-reference/modules/events.md deleted file mode 100644 index 64d1fd870..000000000 --- a/docs/api-reference/modules/events.md +++ /dev/null @@ -1,33 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / events - -# Namespace: events - -## Table of contents - -### Classes - -- [ContractEvent](../classes/events.ContractEvent.md) -- [EventHandler](../classes/events.EventHandler.md) -- [NeverminedEvent](../classes/events.NeverminedEvent.md) -- [SubgraphEvent](../classes/events.SubgraphEvent.md) - -### Interfaces - -- [ContractEventSubscription](../interfaces/events.ContractEventSubscription.md) -- [EventEmitter](../interfaces/events.EventEmitter.md) -- [EventOptions](../interfaces/events.EventOptions.md) -- [Filter](../interfaces/events.Filter.md) - -### Type Aliases - -- [EventResult](events.md#eventresult) - -## Type Aliases - -### EventResult - -Ƭ **EventResult**: `Promise`<`any`[]\> - -#### Defined in - -[src/events/NeverminedEvent.ts:26](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/events/NeverminedEvent.ts#L26) diff --git a/docs/api-reference/modules/subgraphs.AaveBorrowCondition.md b/docs/api-reference/modules/subgraphs.AaveBorrowCondition.md deleted file mode 100644 index c5e225f32..000000000 --- a/docs/api-reference/modules/subgraphs.AaveBorrowCondition.md +++ /dev/null @@ -1,508 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / AaveBorrowCondition - -# Namespace: AaveBorrowCondition - -[subgraphs](subgraphs.md).AaveBorrowCondition - -## Table of contents - -### Type Aliases - -- [FulfilledArgs](subgraphs.AaveBorrowCondition.md#fulfilledargs) -- [FulfilledFields](subgraphs.AaveBorrowCondition.md#fulfilledfields) -- [FulfilledFilter](subgraphs.AaveBorrowCondition.md#fulfilledfilter) -- [FulfilledResult](subgraphs.AaveBorrowCondition.md#fulfilledresult) -- [InitializedArgs](subgraphs.AaveBorrowCondition.md#initializedargs) -- [InitializedFields](subgraphs.AaveBorrowCondition.md#initializedfields) -- [InitializedFilter](subgraphs.AaveBorrowCondition.md#initializedfilter) -- [InitializedResult](subgraphs.AaveBorrowCondition.md#initializedresult) -- [MultiQueryOptions](subgraphs.AaveBorrowCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.AaveBorrowCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.AaveBorrowCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.AaveBorrowCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.AaveBorrowCondition.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.AaveBorrowCondition.md#singlequeryoptions) - -### Functions - -- [getFulfilledById](subgraphs.AaveBorrowCondition.md#getfulfilledbyid) -- [getFulfilleds](subgraphs.AaveBorrowCondition.md#getfulfilleds) -- [getInitializedById](subgraphs.AaveBorrowCondition.md#getinitializedbyid) -- [getInitializeds](subgraphs.AaveBorrowCondition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.AaveBorrowCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.AaveBorrowCondition.md#getownershiptransferreds) - -## Type Aliases - -### FulfilledArgs - -Ƭ **FulfilledArgs**<`K`\>: { [Property in keyof Pick]: FulfilledFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.AaveBorrowCondition.md#fulfilledresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveBorrowCondition.d.ts:60 - ---- - -### FulfilledFields - -Ƭ **FulfilledFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------------- | :----- | -| `_agreementId` | `true` | -| `_conditionId` | `true` | -| `_did` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveBorrowCondition.d.ts:54 - ---- - -### FulfilledFilter - -Ƭ **FulfilledFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------------------- | :----------------- | -| `_agreementId?` | `string` \| `null` | -| `_agreementId_contains?` | `string` \| `null` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| `null` | -| `_agreementId_not_contains?` | `string` \| `null` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionId?` | `string` \| `null` | -| `_conditionId_contains?` | `string` \| `null` | -| `_conditionId_in?` | `string`[] | -| `_conditionId_not?` | `string` \| `null` | -| `_conditionId_not_contains?` | `string` \| `null` | -| `_conditionId_not_in?` | `string`[] | -| `_did?` | `string` \| `null` | -| `_did_contains?` | `string` \| `null` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| `null` | -| `_did_not_contains?` | `string` \| `null` | -| `_did_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveBorrowCondition.d.ts:20 - ---- - -### FulfilledResult - -Ƭ **FulfilledResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------------- | :------- | -| `_agreementId` | `string` | -| `_conditionId` | `string` | -| `_did` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveBorrowCondition.d.ts:48 - ---- - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.AaveBorrowCondition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveBorrowCondition.d.ts:91 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveBorrowCondition.d.ts:87 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveBorrowCondition.d.ts:65 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveBorrowCondition.d.ts:83 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveBorrowCondition.d.ts:9 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AaveBorrowCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveBorrowCondition.d.ts:128 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveBorrowCondition.d.ts:123 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveBorrowCondition.d.ts:96 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveBorrowCondition.d.ts:118 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveBorrowCondition.d.ts:1 - -## Functions - -### getFulfilledById - -▸ **getFulfilledById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.AaveBorrowCondition.md#fulfilledresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.AaveBorrowCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AaveBorrowCondition.md#singlequeryoptions) | -| `args` | [`FulfilledArgs`](subgraphs.AaveBorrowCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.AaveBorrowCondition.md#fulfilledresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveBorrowCondition.d.ts:63 - ---- - -### getFulfilleds - -▸ **getFulfilleds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.AaveBorrowCondition.md#fulfilledresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.AaveBorrowCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AaveBorrowCondition.md#multiqueryoptions)<[`FulfilledFilter`](subgraphs.AaveBorrowCondition.md#fulfilledfilter), [`FulfilledResult`](subgraphs.AaveBorrowCondition.md#fulfilledresult)\> | -| `args` | [`FulfilledArgs`](subgraphs.AaveBorrowCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.AaveBorrowCondition.md#fulfilledresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveBorrowCondition.d.ts:64 - ---- - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.AaveBorrowCondition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.AaveBorrowCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AaveBorrowCondition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.AaveBorrowCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.AaveBorrowCondition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveBorrowCondition.d.ts:94 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.AaveBorrowCondition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.AaveBorrowCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AaveBorrowCondition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.AaveBorrowCondition.md#initializedfilter), [`InitializedResult`](subgraphs.AaveBorrowCondition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.AaveBorrowCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.AaveBorrowCondition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveBorrowCondition.d.ts:95 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AaveBorrowCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AaveBorrowCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AaveBorrowCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.AaveBorrowCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AaveBorrowCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveBorrowCondition.d.ts:131 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AaveBorrowCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AaveBorrowCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AaveBorrowCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.AaveBorrowCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.AaveBorrowCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.AaveBorrowCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AaveBorrowCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveBorrowCondition.d.ts:132 diff --git a/docs/api-reference/modules/subgraphs.AaveCollateralDepositCondition.md b/docs/api-reference/modules/subgraphs.AaveCollateralDepositCondition.md deleted file mode 100644 index 5392d5e52..000000000 --- a/docs/api-reference/modules/subgraphs.AaveCollateralDepositCondition.md +++ /dev/null @@ -1,508 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / AaveCollateralDepositCondition - -# Namespace: AaveCollateralDepositCondition - -[subgraphs](subgraphs.md).AaveCollateralDepositCondition - -## Table of contents - -### Type Aliases - -- [FulfilledArgs](subgraphs.AaveCollateralDepositCondition.md#fulfilledargs) -- [FulfilledFields](subgraphs.AaveCollateralDepositCondition.md#fulfilledfields) -- [FulfilledFilter](subgraphs.AaveCollateralDepositCondition.md#fulfilledfilter) -- [FulfilledResult](subgraphs.AaveCollateralDepositCondition.md#fulfilledresult) -- [InitializedArgs](subgraphs.AaveCollateralDepositCondition.md#initializedargs) -- [InitializedFields](subgraphs.AaveCollateralDepositCondition.md#initializedfields) -- [InitializedFilter](subgraphs.AaveCollateralDepositCondition.md#initializedfilter) -- [InitializedResult](subgraphs.AaveCollateralDepositCondition.md#initializedresult) -- [MultiQueryOptions](subgraphs.AaveCollateralDepositCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.AaveCollateralDepositCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.AaveCollateralDepositCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.AaveCollateralDepositCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.AaveCollateralDepositCondition.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.AaveCollateralDepositCondition.md#singlequeryoptions) - -### Functions - -- [getFulfilledById](subgraphs.AaveCollateralDepositCondition.md#getfulfilledbyid) -- [getFulfilleds](subgraphs.AaveCollateralDepositCondition.md#getfulfilleds) -- [getInitializedById](subgraphs.AaveCollateralDepositCondition.md#getinitializedbyid) -- [getInitializeds](subgraphs.AaveCollateralDepositCondition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.AaveCollateralDepositCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.AaveCollateralDepositCondition.md#getownershiptransferreds) - -## Type Aliases - -### FulfilledArgs - -Ƭ **FulfilledArgs**<`K`\>: { [Property in keyof Pick]: FulfilledFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.AaveCollateralDepositCondition.md#fulfilledresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralDepositCondition.d.ts:60 - ---- - -### FulfilledFields - -Ƭ **FulfilledFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------------- | :----- | -| `_agreementId` | `true` | -| `_conditionId` | `true` | -| `_did` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralDepositCondition.d.ts:54 - ---- - -### FulfilledFilter - -Ƭ **FulfilledFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------------------- | :----------------- | -| `_agreementId?` | `string` \| `null` | -| `_agreementId_contains?` | `string` \| `null` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| `null` | -| `_agreementId_not_contains?` | `string` \| `null` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionId?` | `string` \| `null` | -| `_conditionId_contains?` | `string` \| `null` | -| `_conditionId_in?` | `string`[] | -| `_conditionId_not?` | `string` \| `null` | -| `_conditionId_not_contains?` | `string` \| `null` | -| `_conditionId_not_in?` | `string`[] | -| `_did?` | `string` \| `null` | -| `_did_contains?` | `string` \| `null` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| `null` | -| `_did_not_contains?` | `string` \| `null` | -| `_did_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralDepositCondition.d.ts:20 - ---- - -### FulfilledResult - -Ƭ **FulfilledResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------------- | :------- | -| `_agreementId` | `string` | -| `_conditionId` | `string` | -| `_did` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralDepositCondition.d.ts:48 - ---- - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.AaveCollateralDepositCondition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralDepositCondition.d.ts:91 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralDepositCondition.d.ts:87 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralDepositCondition.d.ts:65 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralDepositCondition.d.ts:83 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralDepositCondition.d.ts:9 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AaveCollateralDepositCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralDepositCondition.d.ts:128 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralDepositCondition.d.ts:123 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralDepositCondition.d.ts:96 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralDepositCondition.d.ts:118 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralDepositCondition.d.ts:1 - -## Functions - -### getFulfilledById - -▸ **getFulfilledById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.AaveCollateralDepositCondition.md#fulfilledresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.AaveCollateralDepositCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AaveCollateralDepositCondition.md#singlequeryoptions) | -| `args` | [`FulfilledArgs`](subgraphs.AaveCollateralDepositCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.AaveCollateralDepositCondition.md#fulfilledresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralDepositCondition.d.ts:63 - ---- - -### getFulfilleds - -▸ **getFulfilleds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.AaveCollateralDepositCondition.md#fulfilledresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.AaveCollateralDepositCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AaveCollateralDepositCondition.md#multiqueryoptions)<[`FulfilledFilter`](subgraphs.AaveCollateralDepositCondition.md#fulfilledfilter), [`FulfilledResult`](subgraphs.AaveCollateralDepositCondition.md#fulfilledresult)\> | -| `args` | [`FulfilledArgs`](subgraphs.AaveCollateralDepositCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.AaveCollateralDepositCondition.md#fulfilledresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralDepositCondition.d.ts:64 - ---- - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.AaveCollateralDepositCondition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.AaveCollateralDepositCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AaveCollateralDepositCondition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.AaveCollateralDepositCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.AaveCollateralDepositCondition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralDepositCondition.d.ts:94 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.AaveCollateralDepositCondition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.AaveCollateralDepositCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AaveCollateralDepositCondition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.AaveCollateralDepositCondition.md#initializedfilter), [`InitializedResult`](subgraphs.AaveCollateralDepositCondition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.AaveCollateralDepositCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.AaveCollateralDepositCondition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralDepositCondition.d.ts:95 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AaveCollateralDepositCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AaveCollateralDepositCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AaveCollateralDepositCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.AaveCollateralDepositCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AaveCollateralDepositCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralDepositCondition.d.ts:131 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AaveCollateralDepositCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AaveCollateralDepositCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AaveCollateralDepositCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.AaveCollateralDepositCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.AaveCollateralDepositCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.AaveCollateralDepositCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AaveCollateralDepositCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralDepositCondition.d.ts:132 diff --git a/docs/api-reference/modules/subgraphs.AaveCollateralWithdrawCondition.md b/docs/api-reference/modules/subgraphs.AaveCollateralWithdrawCondition.md deleted file mode 100644 index 07e215010..000000000 --- a/docs/api-reference/modules/subgraphs.AaveCollateralWithdrawCondition.md +++ /dev/null @@ -1,508 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / AaveCollateralWithdrawCondition - -# Namespace: AaveCollateralWithdrawCondition - -[subgraphs](subgraphs.md).AaveCollateralWithdrawCondition - -## Table of contents - -### Type Aliases - -- [FulfilledArgs](subgraphs.AaveCollateralWithdrawCondition.md#fulfilledargs) -- [FulfilledFields](subgraphs.AaveCollateralWithdrawCondition.md#fulfilledfields) -- [FulfilledFilter](subgraphs.AaveCollateralWithdrawCondition.md#fulfilledfilter) -- [FulfilledResult](subgraphs.AaveCollateralWithdrawCondition.md#fulfilledresult) -- [InitializedArgs](subgraphs.AaveCollateralWithdrawCondition.md#initializedargs) -- [InitializedFields](subgraphs.AaveCollateralWithdrawCondition.md#initializedfields) -- [InitializedFilter](subgraphs.AaveCollateralWithdrawCondition.md#initializedfilter) -- [InitializedResult](subgraphs.AaveCollateralWithdrawCondition.md#initializedresult) -- [MultiQueryOptions](subgraphs.AaveCollateralWithdrawCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.AaveCollateralWithdrawCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.AaveCollateralWithdrawCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.AaveCollateralWithdrawCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.AaveCollateralWithdrawCondition.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.AaveCollateralWithdrawCondition.md#singlequeryoptions) - -### Functions - -- [getFulfilledById](subgraphs.AaveCollateralWithdrawCondition.md#getfulfilledbyid) -- [getFulfilleds](subgraphs.AaveCollateralWithdrawCondition.md#getfulfilleds) -- [getInitializedById](subgraphs.AaveCollateralWithdrawCondition.md#getinitializedbyid) -- [getInitializeds](subgraphs.AaveCollateralWithdrawCondition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.AaveCollateralWithdrawCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.AaveCollateralWithdrawCondition.md#getownershiptransferreds) - -## Type Aliases - -### FulfilledArgs - -Ƭ **FulfilledArgs**<`K`\>: { [Property in keyof Pick]: FulfilledFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.AaveCollateralWithdrawCondition.md#fulfilledresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralWithdrawCondition.d.ts:60 - ---- - -### FulfilledFields - -Ƭ **FulfilledFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------------- | :----- | -| `_agreementId` | `true` | -| `_conditionId` | `true` | -| `_did` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralWithdrawCondition.d.ts:54 - ---- - -### FulfilledFilter - -Ƭ **FulfilledFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------------------- | :----------------- | -| `_agreementId?` | `string` \| `null` | -| `_agreementId_contains?` | `string` \| `null` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| `null` | -| `_agreementId_not_contains?` | `string` \| `null` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionId?` | `string` \| `null` | -| `_conditionId_contains?` | `string` \| `null` | -| `_conditionId_in?` | `string`[] | -| `_conditionId_not?` | `string` \| `null` | -| `_conditionId_not_contains?` | `string` \| `null` | -| `_conditionId_not_in?` | `string`[] | -| `_did?` | `string` \| `null` | -| `_did_contains?` | `string` \| `null` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| `null` | -| `_did_not_contains?` | `string` \| `null` | -| `_did_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralWithdrawCondition.d.ts:20 - ---- - -### FulfilledResult - -Ƭ **FulfilledResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------------- | :------- | -| `_agreementId` | `string` | -| `_conditionId` | `string` | -| `_did` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralWithdrawCondition.d.ts:48 - ---- - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.AaveCollateralWithdrawCondition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralWithdrawCondition.d.ts:91 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralWithdrawCondition.d.ts:87 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralWithdrawCondition.d.ts:65 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralWithdrawCondition.d.ts:83 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralWithdrawCondition.d.ts:9 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AaveCollateralWithdrawCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralWithdrawCondition.d.ts:128 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralWithdrawCondition.d.ts:123 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralWithdrawCondition.d.ts:96 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralWithdrawCondition.d.ts:118 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralWithdrawCondition.d.ts:1 - -## Functions - -### getFulfilledById - -▸ **getFulfilledById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.AaveCollateralWithdrawCondition.md#fulfilledresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.AaveCollateralWithdrawCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AaveCollateralWithdrawCondition.md#singlequeryoptions) | -| `args` | [`FulfilledArgs`](subgraphs.AaveCollateralWithdrawCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.AaveCollateralWithdrawCondition.md#fulfilledresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralWithdrawCondition.d.ts:63 - ---- - -### getFulfilleds - -▸ **getFulfilleds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.AaveCollateralWithdrawCondition.md#fulfilledresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.AaveCollateralWithdrawCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AaveCollateralWithdrawCondition.md#multiqueryoptions)<[`FulfilledFilter`](subgraphs.AaveCollateralWithdrawCondition.md#fulfilledfilter), [`FulfilledResult`](subgraphs.AaveCollateralWithdrawCondition.md#fulfilledresult)\> | -| `args` | [`FulfilledArgs`](subgraphs.AaveCollateralWithdrawCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.AaveCollateralWithdrawCondition.md#fulfilledresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralWithdrawCondition.d.ts:64 - ---- - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.AaveCollateralWithdrawCondition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.AaveCollateralWithdrawCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AaveCollateralWithdrawCondition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.AaveCollateralWithdrawCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.AaveCollateralWithdrawCondition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralWithdrawCondition.d.ts:94 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.AaveCollateralWithdrawCondition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.AaveCollateralWithdrawCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AaveCollateralWithdrawCondition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.AaveCollateralWithdrawCondition.md#initializedfilter), [`InitializedResult`](subgraphs.AaveCollateralWithdrawCondition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.AaveCollateralWithdrawCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.AaveCollateralWithdrawCondition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralWithdrawCondition.d.ts:95 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AaveCollateralWithdrawCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AaveCollateralWithdrawCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AaveCollateralWithdrawCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.AaveCollateralWithdrawCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AaveCollateralWithdrawCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralWithdrawCondition.d.ts:131 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AaveCollateralWithdrawCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AaveCollateralWithdrawCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AaveCollateralWithdrawCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.AaveCollateralWithdrawCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.AaveCollateralWithdrawCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.AaveCollateralWithdrawCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AaveCollateralWithdrawCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCollateralWithdrawCondition.d.ts:132 diff --git a/docs/api-reference/modules/subgraphs.AaveCreditTemplate.md b/docs/api-reference/modules/subgraphs.AaveCreditTemplate.md deleted file mode 100644 index 8d6be0d1d..000000000 --- a/docs/api-reference/modules/subgraphs.AaveCreditTemplate.md +++ /dev/null @@ -1,729 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / AaveCreditTemplate - -# Namespace: AaveCreditTemplate - -[subgraphs](subgraphs.md).AaveCreditTemplate - -## Table of contents - -### Type Aliases - -- [AgreementCreatedArgs](subgraphs.AaveCreditTemplate.md#agreementcreatedargs) -- [AgreementCreatedFields](subgraphs.AaveCreditTemplate.md#agreementcreatedfields) -- [AgreementCreatedFilter](subgraphs.AaveCreditTemplate.md#agreementcreatedfilter) -- [AgreementCreatedResult](subgraphs.AaveCreditTemplate.md#agreementcreatedresult) -- [InitializedArgs](subgraphs.AaveCreditTemplate.md#initializedargs) -- [InitializedFields](subgraphs.AaveCreditTemplate.md#initializedfields) -- [InitializedFilter](subgraphs.AaveCreditTemplate.md#initializedfilter) -- [InitializedResult](subgraphs.AaveCreditTemplate.md#initializedresult) -- [MultiQueryOptions](subgraphs.AaveCreditTemplate.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.AaveCreditTemplate.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.AaveCreditTemplate.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.AaveCreditTemplate.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.AaveCreditTemplate.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.AaveCreditTemplate.md#singlequeryoptions) -- [VaultCreatedArgs](subgraphs.AaveCreditTemplate.md#vaultcreatedargs) -- [VaultCreatedFields](subgraphs.AaveCreditTemplate.md#vaultcreatedfields) -- [VaultCreatedFilter](subgraphs.AaveCreditTemplate.md#vaultcreatedfilter) -- [VaultCreatedResult](subgraphs.AaveCreditTemplate.md#vaultcreatedresult) - -### Functions - -- [getAgreementCreatedById](subgraphs.AaveCreditTemplate.md#getagreementcreatedbyid) -- [getAgreementCreateds](subgraphs.AaveCreditTemplate.md#getagreementcreateds) -- [getInitializedById](subgraphs.AaveCreditTemplate.md#getinitializedbyid) -- [getInitializeds](subgraphs.AaveCreditTemplate.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.AaveCreditTemplate.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.AaveCreditTemplate.md#getownershiptransferreds) -- [getVaultCreatedById](subgraphs.AaveCreditTemplate.md#getvaultcreatedbyid) -- [getVaultCreateds](subgraphs.AaveCreditTemplate.md#getvaultcreateds) - -## Type Aliases - -### AgreementCreatedArgs - -Ƭ **AgreementCreatedArgs**<`K`\>: { [Property in keyof Pick]: AgreementCreatedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.AaveCreditTemplate.md#agreementcreatedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:117 - ---- - -### AgreementCreatedFields - -Ƭ **AgreementCreatedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :----- | -| `_accessConsumer` | `true` | -| `_accessProvider` | `true` | -| `_agreementId` | `true` | -| `_conditionIdSeeds` | `true` | -| `_conditionIds` | `true` | -| `_creator` | `true` | -| `_did` | `true` | -| `_idSeed` | `true` | -| `_timeLocks` | `true` | -| `_timeOuts` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:104 - ---- - -### AgreementCreatedFilter - -Ƭ **AgreementCreatedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------------------------------- | :----------------- | -| `_accessConsumer?` | `string` \| `null` | -| `_accessConsumer_contains?` | `string` \| `null` | -| `_accessConsumer_in?` | `string`[] | -| `_accessConsumer_not?` | `string` \| `null` | -| `_accessConsumer_not_contains?` | `string` \| `null` | -| `_accessConsumer_not_in?` | `string`[] | -| `_accessProvider?` | `string` \| `null` | -| `_accessProvider_contains?` | `string` \| `null` | -| `_accessProvider_in?` | `string`[] | -| `_accessProvider_not?` | `string` \| `null` | -| `_accessProvider_not_contains?` | `string` \| `null` | -| `_accessProvider_not_in?` | `string`[] | -| `_agreementId?` | `string` \| `null` | -| `_agreementId_contains?` | `string` \| `null` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| `null` | -| `_agreementId_not_contains?` | `string` \| `null` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionIdSeeds?` | `string`[] | -| `_conditionIdSeeds_contains?` | `string`[] | -| `_conditionIdSeeds_contains_nocase?` | `string`[] | -| `_conditionIdSeeds_not?` | `string`[] | -| `_conditionIdSeeds_not_contains?` | `string`[] | -| `_conditionIdSeeds_not_contains_nocase?` | `string`[] | -| `_conditionIds?` | `string`[] | -| `_conditionIds_contains?` | `string`[] | -| `_conditionIds_contains_nocase?` | `string`[] | -| `_conditionIds_not?` | `string`[] | -| `_conditionIds_not_contains?` | `string`[] | -| `_conditionIds_not_contains_nocase?` | `string`[] | -| `_creator?` | `string` \| `null` | -| `_creator_contains?` | `string` \| `null` | -| `_creator_in?` | `string`[] | -| `_creator_not?` | `string` \| `null` | -| `_creator_not_contains?` | `string` \| `null` | -| `_creator_not_in?` | `string`[] | -| `_did?` | `string` \| `null` | -| `_did_contains?` | `string` \| `null` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| `null` | -| `_did_not_contains?` | `string` \| `null` | -| `_did_not_in?` | `string`[] | -| `_idSeed?` | `string` \| `null` | -| `_idSeed_contains?` | `string` \| `null` | -| `_idSeed_in?` | `string`[] | -| `_idSeed_not?` | `string` \| `null` | -| `_idSeed_not_contains?` | `string` \| `null` | -| `_idSeed_not_in?` | `string`[] | -| `_timeLocks?` | `WeiSource`[] | -| `_timeLocks_contains?` | `WeiSource`[] | -| `_timeLocks_contains_nocase?` | `WeiSource`[] | -| `_timeLocks_not?` | `WeiSource`[] | -| `_timeLocks_not_contains?` | `WeiSource`[] | -| `_timeLocks_not_contains_nocase?` | `WeiSource`[] | -| `_timeOuts?` | `WeiSource`[] | -| `_timeOuts_contains?` | `WeiSource`[] | -| `_timeOuts_contains_nocase?` | `WeiSource`[] | -| `_timeOuts_not?` | `WeiSource`[] | -| `_timeOuts_not_contains?` | `WeiSource`[] | -| `_timeOuts_not_contains_nocase?` | `WeiSource`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:21 - ---- - -### AgreementCreatedResult - -Ƭ **AgreementCreatedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :--------------------- | -| `_accessConsumer` | `string` | -| `_accessProvider` | `string` | -| `_agreementId` | `string` | -| `_conditionIdSeeds` | (`string` \| `null`)[] | -| `_conditionIds` | (`string` \| `null`)[] | -| `_creator` | `string` | -| `_did` | `string` | -| `_idSeed` | `string` | -| `_timeLocks` | (`Wei` \| `null`)[] | -| `_timeOuts` | (`Wei` \| `null`)[] | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:91 - ---- - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.AaveCreditTemplate.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:148 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:144 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:122 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:140 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:10 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AaveCreditTemplate.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:185 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:180 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:153 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:175 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:2 - ---- - -### VaultCreatedArgs - -Ƭ **VaultCreatedArgs**<`K`\>: { [Property in keyof Pick]: VaultCreatedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------- | -| `K` | extends keyof [`VaultCreatedResult`](subgraphs.AaveCreditTemplate.md#vaultcreatedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:238 - ---- - -### VaultCreatedFields - -Ƭ **VaultCreatedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `_borrower` | `true` | -| `_creator` | `true` | -| `_lender` | `true` | -| `_vaultAddress` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:231 - ---- - -### VaultCreatedFilter - -Ƭ **VaultCreatedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `_borrower?` | `string` \| `null` | -| `_borrower_contains?` | `string` \| `null` | -| `_borrower_in?` | `string`[] | -| `_borrower_not?` | `string` \| `null` | -| `_borrower_not_contains?` | `string` \| `null` | -| `_borrower_not_in?` | `string`[] | -| `_creator?` | `string` \| `null` | -| `_creator_contains?` | `string` \| `null` | -| `_creator_in?` | `string`[] | -| `_creator_not?` | `string` \| `null` | -| `_creator_not_contains?` | `string` \| `null` | -| `_creator_not_in?` | `string`[] | -| `_lender?` | `string` \| `null` | -| `_lender_contains?` | `string` \| `null` | -| `_lender_in?` | `string`[] | -| `_lender_not?` | `string` \| `null` | -| `_lender_not_contains?` | `string` \| `null` | -| `_lender_not_in?` | `string`[] | -| `_vaultAddress?` | `string` \| `null` | -| `_vaultAddress_contains?` | `string` \| `null` | -| `_vaultAddress_in?` | `string`[] | -| `_vaultAddress_not?` | `string` \| `null` | -| `_vaultAddress_not_contains?` | `string` \| `null` | -| `_vaultAddress_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:190 - ---- - -### VaultCreatedResult - -Ƭ **VaultCreatedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `_borrower` | `string` | -| `_creator` | `string` | -| `_lender` | `string` | -| `_vaultAddress` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:224 - -## Functions - -### getAgreementCreatedById - -▸ **getAgreementCreatedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.AaveCreditTemplate.md#agreementcreatedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.AaveCreditTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AaveCreditTemplate.md#singlequeryoptions) | -| `args` | [`AgreementCreatedArgs`](subgraphs.AaveCreditTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.AaveCreditTemplate.md#agreementcreatedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:120 - ---- - -### getAgreementCreateds - -▸ **getAgreementCreateds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.AaveCreditTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.AaveCreditTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AaveCreditTemplate.md#multiqueryoptions)<[`AgreementCreatedFilter`](subgraphs.AaveCreditTemplate.md#agreementcreatedfilter), [`AgreementCreatedResult`](subgraphs.AaveCreditTemplate.md#agreementcreatedresult)\> | -| `args` | [`AgreementCreatedArgs`](subgraphs.AaveCreditTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.AaveCreditTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:121 - ---- - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.AaveCreditTemplate.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.AaveCreditTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AaveCreditTemplate.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.AaveCreditTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.AaveCreditTemplate.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:151 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.AaveCreditTemplate.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.AaveCreditTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AaveCreditTemplate.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.AaveCreditTemplate.md#initializedfilter), [`InitializedResult`](subgraphs.AaveCreditTemplate.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.AaveCreditTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.AaveCreditTemplate.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:152 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AaveCreditTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AaveCreditTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AaveCreditTemplate.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.AaveCreditTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AaveCreditTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:188 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AaveCreditTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AaveCreditTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AaveCreditTemplate.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.AaveCreditTemplate.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.AaveCreditTemplate.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.AaveCreditTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AaveCreditTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:189 - ---- - -### getVaultCreatedById - -▸ **getVaultCreatedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`VaultCreatedResult`](subgraphs.AaveCreditTemplate.md#vaultcreatedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------- | -| `K` | extends keyof [`VaultCreatedResult`](subgraphs.AaveCreditTemplate.md#vaultcreatedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AaveCreditTemplate.md#singlequeryoptions) | -| `args` | [`VaultCreatedArgs`](subgraphs.AaveCreditTemplate.md#vaultcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`VaultCreatedResult`](subgraphs.AaveCreditTemplate.md#vaultcreatedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:241 - ---- - -### getVaultCreateds - -▸ **getVaultCreateds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`VaultCreatedResult`](subgraphs.AaveCreditTemplate.md#vaultcreatedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------- | -| `K` | extends keyof [`VaultCreatedResult`](subgraphs.AaveCreditTemplate.md#vaultcreatedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AaveCreditTemplate.md#multiqueryoptions)<[`VaultCreatedFilter`](subgraphs.AaveCreditTemplate.md#vaultcreatedfilter), [`VaultCreatedResult`](subgraphs.AaveCreditTemplate.md#vaultcreatedresult)\> | -| `args` | [`VaultCreatedArgs`](subgraphs.AaveCreditTemplate.md#vaultcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`VaultCreatedResult`](subgraphs.AaveCreditTemplate.md#vaultcreatedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveCreditTemplate.d.ts:242 diff --git a/docs/api-reference/modules/subgraphs.AaveRepayCondition.md b/docs/api-reference/modules/subgraphs.AaveRepayCondition.md deleted file mode 100644 index 486c76ed9..000000000 --- a/docs/api-reference/modules/subgraphs.AaveRepayCondition.md +++ /dev/null @@ -1,508 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / AaveRepayCondition - -# Namespace: AaveRepayCondition - -[subgraphs](subgraphs.md).AaveRepayCondition - -## Table of contents - -### Type Aliases - -- [FulfilledArgs](subgraphs.AaveRepayCondition.md#fulfilledargs) -- [FulfilledFields](subgraphs.AaveRepayCondition.md#fulfilledfields) -- [FulfilledFilter](subgraphs.AaveRepayCondition.md#fulfilledfilter) -- [FulfilledResult](subgraphs.AaveRepayCondition.md#fulfilledresult) -- [InitializedArgs](subgraphs.AaveRepayCondition.md#initializedargs) -- [InitializedFields](subgraphs.AaveRepayCondition.md#initializedfields) -- [InitializedFilter](subgraphs.AaveRepayCondition.md#initializedfilter) -- [InitializedResult](subgraphs.AaveRepayCondition.md#initializedresult) -- [MultiQueryOptions](subgraphs.AaveRepayCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.AaveRepayCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.AaveRepayCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.AaveRepayCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.AaveRepayCondition.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.AaveRepayCondition.md#singlequeryoptions) - -### Functions - -- [getFulfilledById](subgraphs.AaveRepayCondition.md#getfulfilledbyid) -- [getFulfilleds](subgraphs.AaveRepayCondition.md#getfulfilleds) -- [getInitializedById](subgraphs.AaveRepayCondition.md#getinitializedbyid) -- [getInitializeds](subgraphs.AaveRepayCondition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.AaveRepayCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.AaveRepayCondition.md#getownershiptransferreds) - -## Type Aliases - -### FulfilledArgs - -Ƭ **FulfilledArgs**<`K`\>: { [Property in keyof Pick]: FulfilledFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.AaveRepayCondition.md#fulfilledresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveRepayCondition.d.ts:60 - ---- - -### FulfilledFields - -Ƭ **FulfilledFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------------- | :----- | -| `_agreementId` | `true` | -| `_conditionId` | `true` | -| `_did` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveRepayCondition.d.ts:54 - ---- - -### FulfilledFilter - -Ƭ **FulfilledFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------------------- | :----------------- | -| `_agreementId?` | `string` \| `null` | -| `_agreementId_contains?` | `string` \| `null` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| `null` | -| `_agreementId_not_contains?` | `string` \| `null` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionId?` | `string` \| `null` | -| `_conditionId_contains?` | `string` \| `null` | -| `_conditionId_in?` | `string`[] | -| `_conditionId_not?` | `string` \| `null` | -| `_conditionId_not_contains?` | `string` \| `null` | -| `_conditionId_not_in?` | `string`[] | -| `_did?` | `string` \| `null` | -| `_did_contains?` | `string` \| `null` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| `null` | -| `_did_not_contains?` | `string` \| `null` | -| `_did_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveRepayCondition.d.ts:20 - ---- - -### FulfilledResult - -Ƭ **FulfilledResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------------- | :------- | -| `_agreementId` | `string` | -| `_conditionId` | `string` | -| `_did` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveRepayCondition.d.ts:48 - ---- - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.AaveRepayCondition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveRepayCondition.d.ts:91 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveRepayCondition.d.ts:87 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveRepayCondition.d.ts:65 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveRepayCondition.d.ts:83 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveRepayCondition.d.ts:9 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AaveRepayCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveRepayCondition.d.ts:128 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveRepayCondition.d.ts:123 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveRepayCondition.d.ts:96 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveRepayCondition.d.ts:118 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveRepayCondition.d.ts:1 - -## Functions - -### getFulfilledById - -▸ **getFulfilledById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.AaveRepayCondition.md#fulfilledresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.AaveRepayCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AaveRepayCondition.md#singlequeryoptions) | -| `args` | [`FulfilledArgs`](subgraphs.AaveRepayCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.AaveRepayCondition.md#fulfilledresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveRepayCondition.d.ts:63 - ---- - -### getFulfilleds - -▸ **getFulfilleds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.AaveRepayCondition.md#fulfilledresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.AaveRepayCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AaveRepayCondition.md#multiqueryoptions)<[`FulfilledFilter`](subgraphs.AaveRepayCondition.md#fulfilledfilter), [`FulfilledResult`](subgraphs.AaveRepayCondition.md#fulfilledresult)\> | -| `args` | [`FulfilledArgs`](subgraphs.AaveRepayCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.AaveRepayCondition.md#fulfilledresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveRepayCondition.d.ts:64 - ---- - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.AaveRepayCondition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.AaveRepayCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AaveRepayCondition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.AaveRepayCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.AaveRepayCondition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveRepayCondition.d.ts:94 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.AaveRepayCondition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.AaveRepayCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AaveRepayCondition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.AaveRepayCondition.md#initializedfilter), [`InitializedResult`](subgraphs.AaveRepayCondition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.AaveRepayCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.AaveRepayCondition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveRepayCondition.d.ts:95 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AaveRepayCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AaveRepayCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AaveRepayCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.AaveRepayCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AaveRepayCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveRepayCondition.d.ts:131 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AaveRepayCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AaveRepayCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AaveRepayCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.AaveRepayCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.AaveRepayCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.AaveRepayCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AaveRepayCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AaveRepayCondition.d.ts:132 diff --git a/docs/api-reference/modules/subgraphs.AccessCondition.md b/docs/api-reference/modules/subgraphs.AccessCondition.md deleted file mode 100644 index 7e63779eb..000000000 --- a/docs/api-reference/modules/subgraphs.AccessCondition.md +++ /dev/null @@ -1,516 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / AccessCondition - -# Namespace: AccessCondition - -[subgraphs](subgraphs.md).AccessCondition - -## Table of contents - -### Type Aliases - -- [FulfilledArgs](subgraphs.AccessCondition.md#fulfilledargs) -- [FulfilledFields](subgraphs.AccessCondition.md#fulfilledfields) -- [FulfilledFilter](subgraphs.AccessCondition.md#fulfilledfilter) -- [FulfilledResult](subgraphs.AccessCondition.md#fulfilledresult) -- [InitializedArgs](subgraphs.AccessCondition.md#initializedargs) -- [InitializedFields](subgraphs.AccessCondition.md#initializedfields) -- [InitializedFilter](subgraphs.AccessCondition.md#initializedfilter) -- [InitializedResult](subgraphs.AccessCondition.md#initializedresult) -- [MultiQueryOptions](subgraphs.AccessCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.AccessCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.AccessCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.AccessCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.AccessCondition.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.AccessCondition.md#singlequeryoptions) - -### Functions - -- [getFulfilledById](subgraphs.AccessCondition.md#getfulfilledbyid) -- [getFulfilleds](subgraphs.AccessCondition.md#getfulfilleds) -- [getInitializedById](subgraphs.AccessCondition.md#getinitializedbyid) -- [getInitializeds](subgraphs.AccessCondition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.AccessCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.AccessCondition.md#getownershiptransferreds) - -## Type Aliases - -### FulfilledArgs - -Ƭ **FulfilledArgs**<`K`\>: { [Property in keyof Pick]: FulfilledFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.AccessCondition.md#fulfilledresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessCondition.d.ts:68 - ---- - -### FulfilledFields - -Ƭ **FulfilledFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------------- | :----- | -| `_agreementId` | `true` | -| `_conditionId` | `true` | -| `_documentId` | `true` | -| `_grantee` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessCondition.d.ts:61 - ---- - -### FulfilledFilter - -Ƭ **FulfilledFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------------------- | :----------------- | -| `_agreementId?` | `string` \| `null` | -| `_agreementId_contains?` | `string` \| `null` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| `null` | -| `_agreementId_not_contains?` | `string` \| `null` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionId?` | `string` \| `null` | -| `_conditionId_contains?` | `string` \| `null` | -| `_conditionId_in?` | `string`[] | -| `_conditionId_not?` | `string` \| `null` | -| `_conditionId_not_contains?` | `string` \| `null` | -| `_conditionId_not_in?` | `string`[] | -| `_documentId?` | `string` \| `null` | -| `_documentId_contains?` | `string` \| `null` | -| `_documentId_in?` | `string`[] | -| `_documentId_not?` | `string` \| `null` | -| `_documentId_not_contains?` | `string` \| `null` | -| `_documentId_not_in?` | `string`[] | -| `_grantee?` | `string` \| `null` | -| `_grantee_contains?` | `string` \| `null` | -| `_grantee_in?` | `string`[] | -| `_grantee_not?` | `string` \| `null` | -| `_grantee_not_contains?` | `string` \| `null` | -| `_grantee_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessCondition.d.ts:20 - ---- - -### FulfilledResult - -Ƭ **FulfilledResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------------- | :------- | -| `_agreementId` | `string` | -| `_conditionId` | `string` | -| `_documentId` | `string` | -| `_grantee` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessCondition.d.ts:54 - ---- - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.AccessCondition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessCondition.d.ts:99 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessCondition.d.ts:95 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessCondition.d.ts:73 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessCondition.d.ts:91 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessCondition.d.ts:9 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AccessCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessCondition.d.ts:136 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessCondition.d.ts:131 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessCondition.d.ts:104 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessCondition.d.ts:126 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessCondition.d.ts:1 - -## Functions - -### getFulfilledById - -▸ **getFulfilledById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.AccessCondition.md#fulfilledresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.AccessCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AccessCondition.md#singlequeryoptions) | -| `args` | [`FulfilledArgs`](subgraphs.AccessCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.AccessCondition.md#fulfilledresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessCondition.d.ts:71 - ---- - -### getFulfilleds - -▸ **getFulfilleds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.AccessCondition.md#fulfilledresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.AccessCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AccessCondition.md#multiqueryoptions)<[`FulfilledFilter`](subgraphs.AccessCondition.md#fulfilledfilter), [`FulfilledResult`](subgraphs.AccessCondition.md#fulfilledresult)\> | -| `args` | [`FulfilledArgs`](subgraphs.AccessCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.AccessCondition.md#fulfilledresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessCondition.d.ts:72 - ---- - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.AccessCondition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.AccessCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AccessCondition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.AccessCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.AccessCondition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessCondition.d.ts:102 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.AccessCondition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.AccessCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AccessCondition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.AccessCondition.md#initializedfilter), [`InitializedResult`](subgraphs.AccessCondition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.AccessCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.AccessCondition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessCondition.d.ts:103 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AccessCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AccessCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AccessCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.AccessCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AccessCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessCondition.d.ts:139 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AccessCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AccessCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AccessCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.AccessCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.AccessCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.AccessCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AccessCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessCondition.d.ts:140 diff --git a/docs/api-reference/modules/subgraphs.AccessProofCondition.md b/docs/api-reference/modules/subgraphs.AccessProofCondition.md deleted file mode 100644 index 2a180d7b7..000000000 --- a/docs/api-reference/modules/subgraphs.AccessProofCondition.md +++ /dev/null @@ -1,542 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / AccessProofCondition - -# Namespace: AccessProofCondition - -[subgraphs](subgraphs.md).AccessProofCondition - -## Table of contents - -### Type Aliases - -- [FulfilledArgs](subgraphs.AccessProofCondition.md#fulfilledargs) -- [FulfilledFields](subgraphs.AccessProofCondition.md#fulfilledfields) -- [FulfilledFilter](subgraphs.AccessProofCondition.md#fulfilledfilter) -- [FulfilledResult](subgraphs.AccessProofCondition.md#fulfilledresult) -- [InitializedArgs](subgraphs.AccessProofCondition.md#initializedargs) -- [InitializedFields](subgraphs.AccessProofCondition.md#initializedfields) -- [InitializedFilter](subgraphs.AccessProofCondition.md#initializedfilter) -- [InitializedResult](subgraphs.AccessProofCondition.md#initializedresult) -- [MultiQueryOptions](subgraphs.AccessProofCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.AccessProofCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.AccessProofCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.AccessProofCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.AccessProofCondition.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.AccessProofCondition.md#singlequeryoptions) - -### Functions - -- [getFulfilledById](subgraphs.AccessProofCondition.md#getfulfilledbyid) -- [getFulfilleds](subgraphs.AccessProofCondition.md#getfulfilleds) -- [getInitializedById](subgraphs.AccessProofCondition.md#getinitializedbyid) -- [getInitializeds](subgraphs.AccessProofCondition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.AccessProofCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.AccessProofCondition.md#getownershiptransferreds) - -## Type Aliases - -### FulfilledArgs - -Ƭ **FulfilledArgs**<`K`\>: { [Property in keyof Pick]: FulfilledFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.AccessProofCondition.md#fulfilledresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofCondition.d.ts:95 - ---- - -### FulfilledFields - -Ƭ **FulfilledFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------------- | :----- | -| `_agreementId` | `true` | -| `_buyer` | `true` | -| `_cipher` | `true` | -| `_conditionId` | `true` | -| `_origHash` | `true` | -| `_proof` | `true` | -| `_provider` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofCondition.d.ts:85 - ---- - -### FulfilledFilter - -Ƭ **FulfilledFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------------------- | :-------------------- | -| `_agreementId?` | `string` \| `null` | -| `_agreementId_contains?` | `string` \| `null` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| `null` | -| `_agreementId_not_contains?` | `string` \| `null` | -| `_agreementId_not_in?` | `string`[] | -| `_buyer?` | `WeiSource`[] | -| `_buyer_contains?` | `WeiSource`[] | -| `_buyer_contains_nocase?` | `WeiSource`[] | -| `_buyer_not?` | `WeiSource`[] | -| `_buyer_not_contains?` | `WeiSource`[] | -| `_buyer_not_contains_nocase?` | `WeiSource`[] | -| `_cipher?` | `WeiSource`[] | -| `_cipher_contains?` | `WeiSource`[] | -| `_cipher_contains_nocase?` | `WeiSource`[] | -| `_cipher_not?` | `WeiSource`[] | -| `_cipher_not_contains?` | `WeiSource`[] | -| `_cipher_not_contains_nocase?` | `WeiSource`[] | -| `_conditionId?` | `string` \| `null` | -| `_conditionId_contains?` | `string` \| `null` | -| `_conditionId_in?` | `string`[] | -| `_conditionId_not?` | `string` \| `null` | -| `_conditionId_not_contains?` | `string` \| `null` | -| `_conditionId_not_in?` | `string`[] | -| `_origHash?` | `WeiSource` \| `null` | -| `_origHash_gt?` | `WeiSource` \| `null` | -| `_origHash_gte?` | `WeiSource` \| `null` | -| `_origHash_in?` | `WeiSource`[] | -| `_origHash_lt?` | `WeiSource` \| `null` | -| `_origHash_lte?` | `WeiSource` \| `null` | -| `_origHash_not?` | `WeiSource` \| `null` | -| `_origHash_not_in?` | `WeiSource`[] | -| `_proof?` | `string` \| `null` | -| `_proof_contains?` | `string` \| `null` | -| `_proof_in?` | `string`[] | -| `_proof_not?` | `string` \| `null` | -| `_proof_not_contains?` | `string` \| `null` | -| `_proof_not_in?` | `string`[] | -| `_provider?` | `WeiSource`[] | -| `_provider_contains?` | `WeiSource`[] | -| `_provider_contains_nocase?` | `WeiSource`[] | -| `_provider_not?` | `WeiSource`[] | -| `_provider_not_contains?` | `WeiSource`[] | -| `_provider_not_contains_nocase?` | `WeiSource`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofCondition.d.ts:21 - ---- - -### FulfilledResult - -Ƭ **FulfilledResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------------- | :------------------ | -| `_agreementId` | `string` | -| `_buyer` | (`Wei` \| `null`)[] | -| `_cipher` | (`Wei` \| `null`)[] | -| `_conditionId` | `string` | -| `_origHash` | `Wei` | -| `_proof` | `string` | -| `_provider` | (`Wei` \| `null`)[] | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofCondition.d.ts:75 - ---- - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.AccessProofCondition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofCondition.d.ts:126 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofCondition.d.ts:122 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofCondition.d.ts:100 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofCondition.d.ts:118 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofCondition.d.ts:10 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AccessProofCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofCondition.d.ts:163 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofCondition.d.ts:158 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofCondition.d.ts:131 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofCondition.d.ts:153 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofCondition.d.ts:2 - -## Functions - -### getFulfilledById - -▸ **getFulfilledById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.AccessProofCondition.md#fulfilledresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.AccessProofCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AccessProofCondition.md#singlequeryoptions) | -| `args` | [`FulfilledArgs`](subgraphs.AccessProofCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.AccessProofCondition.md#fulfilledresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofCondition.d.ts:98 - ---- - -### getFulfilleds - -▸ **getFulfilleds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.AccessProofCondition.md#fulfilledresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.AccessProofCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AccessProofCondition.md#multiqueryoptions)<[`FulfilledFilter`](subgraphs.AccessProofCondition.md#fulfilledfilter), [`FulfilledResult`](subgraphs.AccessProofCondition.md#fulfilledresult)\> | -| `args` | [`FulfilledArgs`](subgraphs.AccessProofCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.AccessProofCondition.md#fulfilledresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofCondition.d.ts:99 - ---- - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.AccessProofCondition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.AccessProofCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AccessProofCondition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.AccessProofCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.AccessProofCondition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofCondition.d.ts:129 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.AccessProofCondition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.AccessProofCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AccessProofCondition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.AccessProofCondition.md#initializedfilter), [`InitializedResult`](subgraphs.AccessProofCondition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.AccessProofCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.AccessProofCondition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofCondition.d.ts:130 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AccessProofCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AccessProofCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AccessProofCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.AccessProofCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AccessProofCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofCondition.d.ts:166 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AccessProofCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AccessProofCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AccessProofCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.AccessProofCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.AccessProofCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.AccessProofCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AccessProofCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofCondition.d.ts:167 diff --git a/docs/api-reference/modules/subgraphs.AccessProofTemplate.md b/docs/api-reference/modules/subgraphs.AccessProofTemplate.md deleted file mode 100644 index 3efc89981..000000000 --- a/docs/api-reference/modules/subgraphs.AccessProofTemplate.md +++ /dev/null @@ -1,564 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / AccessProofTemplate - -# Namespace: AccessProofTemplate - -[subgraphs](subgraphs.md).AccessProofTemplate - -## Table of contents - -### Type Aliases - -- [AgreementCreatedArgs](subgraphs.AccessProofTemplate.md#agreementcreatedargs) -- [AgreementCreatedFields](subgraphs.AccessProofTemplate.md#agreementcreatedfields) -- [AgreementCreatedFilter](subgraphs.AccessProofTemplate.md#agreementcreatedfilter) -- [AgreementCreatedResult](subgraphs.AccessProofTemplate.md#agreementcreatedresult) -- [InitializedArgs](subgraphs.AccessProofTemplate.md#initializedargs) -- [InitializedFields](subgraphs.AccessProofTemplate.md#initializedfields) -- [InitializedFilter](subgraphs.AccessProofTemplate.md#initializedfilter) -- [InitializedResult](subgraphs.AccessProofTemplate.md#initializedresult) -- [MultiQueryOptions](subgraphs.AccessProofTemplate.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.AccessProofTemplate.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.AccessProofTemplate.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.AccessProofTemplate.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.AccessProofTemplate.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.AccessProofTemplate.md#singlequeryoptions) - -### Functions - -- [getAgreementCreatedById](subgraphs.AccessProofTemplate.md#getagreementcreatedbyid) -- [getAgreementCreateds](subgraphs.AccessProofTemplate.md#getagreementcreateds) -- [getInitializedById](subgraphs.AccessProofTemplate.md#getinitializedbyid) -- [getInitializeds](subgraphs.AccessProofTemplate.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.AccessProofTemplate.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.AccessProofTemplate.md#getownershiptransferreds) - -## Type Aliases - -### AgreementCreatedArgs - -Ƭ **AgreementCreatedArgs**<`K`\>: { [Property in keyof Pick]: AgreementCreatedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.AccessProofTemplate.md#agreementcreatedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofTemplate.d.ts:117 - ---- - -### AgreementCreatedFields - -Ƭ **AgreementCreatedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :----- | -| `_accessConsumer` | `true` | -| `_accessProvider` | `true` | -| `_agreementId` | `true` | -| `_conditionIdSeeds` | `true` | -| `_conditionIds` | `true` | -| `_creator` | `true` | -| `_did` | `true` | -| `_idSeed` | `true` | -| `_timeLocks` | `true` | -| `_timeOuts` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofTemplate.d.ts:104 - ---- - -### AgreementCreatedFilter - -Ƭ **AgreementCreatedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------------------------------- | :----------------- | -| `_accessConsumer?` | `string` \| `null` | -| `_accessConsumer_contains?` | `string` \| `null` | -| `_accessConsumer_in?` | `string`[] | -| `_accessConsumer_not?` | `string` \| `null` | -| `_accessConsumer_not_contains?` | `string` \| `null` | -| `_accessConsumer_not_in?` | `string`[] | -| `_accessProvider?` | `string` \| `null` | -| `_accessProvider_contains?` | `string` \| `null` | -| `_accessProvider_in?` | `string`[] | -| `_accessProvider_not?` | `string` \| `null` | -| `_accessProvider_not_contains?` | `string` \| `null` | -| `_accessProvider_not_in?` | `string`[] | -| `_agreementId?` | `string` \| `null` | -| `_agreementId_contains?` | `string` \| `null` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| `null` | -| `_agreementId_not_contains?` | `string` \| `null` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionIdSeeds?` | `string`[] | -| `_conditionIdSeeds_contains?` | `string`[] | -| `_conditionIdSeeds_contains_nocase?` | `string`[] | -| `_conditionIdSeeds_not?` | `string`[] | -| `_conditionIdSeeds_not_contains?` | `string`[] | -| `_conditionIdSeeds_not_contains_nocase?` | `string`[] | -| `_conditionIds?` | `string`[] | -| `_conditionIds_contains?` | `string`[] | -| `_conditionIds_contains_nocase?` | `string`[] | -| `_conditionIds_not?` | `string`[] | -| `_conditionIds_not_contains?` | `string`[] | -| `_conditionIds_not_contains_nocase?` | `string`[] | -| `_creator?` | `string` \| `null` | -| `_creator_contains?` | `string` \| `null` | -| `_creator_in?` | `string`[] | -| `_creator_not?` | `string` \| `null` | -| `_creator_not_contains?` | `string` \| `null` | -| `_creator_not_in?` | `string`[] | -| `_did?` | `string` \| `null` | -| `_did_contains?` | `string` \| `null` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| `null` | -| `_did_not_contains?` | `string` \| `null` | -| `_did_not_in?` | `string`[] | -| `_idSeed?` | `string` \| `null` | -| `_idSeed_contains?` | `string` \| `null` | -| `_idSeed_in?` | `string`[] | -| `_idSeed_not?` | `string` \| `null` | -| `_idSeed_not_contains?` | `string` \| `null` | -| `_idSeed_not_in?` | `string`[] | -| `_timeLocks?` | `WeiSource`[] | -| `_timeLocks_contains?` | `WeiSource`[] | -| `_timeLocks_contains_nocase?` | `WeiSource`[] | -| `_timeLocks_not?` | `WeiSource`[] | -| `_timeLocks_not_contains?` | `WeiSource`[] | -| `_timeLocks_not_contains_nocase?` | `WeiSource`[] | -| `_timeOuts?` | `WeiSource`[] | -| `_timeOuts_contains?` | `WeiSource`[] | -| `_timeOuts_contains_nocase?` | `WeiSource`[] | -| `_timeOuts_not?` | `WeiSource`[] | -| `_timeOuts_not_contains?` | `WeiSource`[] | -| `_timeOuts_not_contains_nocase?` | `WeiSource`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofTemplate.d.ts:21 - ---- - -### AgreementCreatedResult - -Ƭ **AgreementCreatedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :--------------------- | -| `_accessConsumer` | `string` | -| `_accessProvider` | `string` | -| `_agreementId` | `string` | -| `_conditionIdSeeds` | (`string` \| `null`)[] | -| `_conditionIds` | (`string` \| `null`)[] | -| `_creator` | `string` | -| `_did` | `string` | -| `_idSeed` | `string` | -| `_timeLocks` | (`Wei` \| `null`)[] | -| `_timeOuts` | (`Wei` \| `null`)[] | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofTemplate.d.ts:91 - ---- - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.AccessProofTemplate.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofTemplate.d.ts:148 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofTemplate.d.ts:144 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofTemplate.d.ts:122 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofTemplate.d.ts:140 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofTemplate.d.ts:10 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AccessProofTemplate.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofTemplate.d.ts:185 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofTemplate.d.ts:180 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofTemplate.d.ts:153 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofTemplate.d.ts:175 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofTemplate.d.ts:2 - -## Functions - -### getAgreementCreatedById - -▸ **getAgreementCreatedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.AccessProofTemplate.md#agreementcreatedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.AccessProofTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AccessProofTemplate.md#singlequeryoptions) | -| `args` | [`AgreementCreatedArgs`](subgraphs.AccessProofTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.AccessProofTemplate.md#agreementcreatedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofTemplate.d.ts:120 - ---- - -### getAgreementCreateds - -▸ **getAgreementCreateds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.AccessProofTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.AccessProofTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AccessProofTemplate.md#multiqueryoptions)<[`AgreementCreatedFilter`](subgraphs.AccessProofTemplate.md#agreementcreatedfilter), [`AgreementCreatedResult`](subgraphs.AccessProofTemplate.md#agreementcreatedresult)\> | -| `args` | [`AgreementCreatedArgs`](subgraphs.AccessProofTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.AccessProofTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofTemplate.d.ts:121 - ---- - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.AccessProofTemplate.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.AccessProofTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AccessProofTemplate.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.AccessProofTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.AccessProofTemplate.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofTemplate.d.ts:151 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.AccessProofTemplate.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.AccessProofTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AccessProofTemplate.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.AccessProofTemplate.md#initializedfilter), [`InitializedResult`](subgraphs.AccessProofTemplate.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.AccessProofTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.AccessProofTemplate.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofTemplate.d.ts:152 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AccessProofTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AccessProofTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AccessProofTemplate.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.AccessProofTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AccessProofTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofTemplate.d.ts:188 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AccessProofTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AccessProofTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AccessProofTemplate.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.AccessProofTemplate.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.AccessProofTemplate.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.AccessProofTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AccessProofTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessProofTemplate.d.ts:189 diff --git a/docs/api-reference/modules/subgraphs.AccessTemplate.md b/docs/api-reference/modules/subgraphs.AccessTemplate.md deleted file mode 100644 index 6a99eca81..000000000 --- a/docs/api-reference/modules/subgraphs.AccessTemplate.md +++ /dev/null @@ -1,564 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / AccessTemplate - -# Namespace: AccessTemplate - -[subgraphs](subgraphs.md).AccessTemplate - -## Table of contents - -### Type Aliases - -- [AgreementCreatedArgs](subgraphs.AccessTemplate.md#agreementcreatedargs) -- [AgreementCreatedFields](subgraphs.AccessTemplate.md#agreementcreatedfields) -- [AgreementCreatedFilter](subgraphs.AccessTemplate.md#agreementcreatedfilter) -- [AgreementCreatedResult](subgraphs.AccessTemplate.md#agreementcreatedresult) -- [InitializedArgs](subgraphs.AccessTemplate.md#initializedargs) -- [InitializedFields](subgraphs.AccessTemplate.md#initializedfields) -- [InitializedFilter](subgraphs.AccessTemplate.md#initializedfilter) -- [InitializedResult](subgraphs.AccessTemplate.md#initializedresult) -- [MultiQueryOptions](subgraphs.AccessTemplate.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.AccessTemplate.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.AccessTemplate.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.AccessTemplate.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.AccessTemplate.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.AccessTemplate.md#singlequeryoptions) - -### Functions - -- [getAgreementCreatedById](subgraphs.AccessTemplate.md#getagreementcreatedbyid) -- [getAgreementCreateds](subgraphs.AccessTemplate.md#getagreementcreateds) -- [getInitializedById](subgraphs.AccessTemplate.md#getinitializedbyid) -- [getInitializeds](subgraphs.AccessTemplate.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.AccessTemplate.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.AccessTemplate.md#getownershiptransferreds) - -## Type Aliases - -### AgreementCreatedArgs - -Ƭ **AgreementCreatedArgs**<`K`\>: { [Property in keyof Pick]: AgreementCreatedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.AccessTemplate.md#agreementcreatedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessTemplate.d.ts:117 - ---- - -### AgreementCreatedFields - -Ƭ **AgreementCreatedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :----- | -| `_accessConsumer` | `true` | -| `_accessProvider` | `true` | -| `_agreementId` | `true` | -| `_conditionIdSeeds` | `true` | -| `_conditionIds` | `true` | -| `_creator` | `true` | -| `_did` | `true` | -| `_idSeed` | `true` | -| `_timeLocks` | `true` | -| `_timeOuts` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessTemplate.d.ts:104 - ---- - -### AgreementCreatedFilter - -Ƭ **AgreementCreatedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------------------------------- | :----------------- | -| `_accessConsumer?` | `string` \| `null` | -| `_accessConsumer_contains?` | `string` \| `null` | -| `_accessConsumer_in?` | `string`[] | -| `_accessConsumer_not?` | `string` \| `null` | -| `_accessConsumer_not_contains?` | `string` \| `null` | -| `_accessConsumer_not_in?` | `string`[] | -| `_accessProvider?` | `string` \| `null` | -| `_accessProvider_contains?` | `string` \| `null` | -| `_accessProvider_in?` | `string`[] | -| `_accessProvider_not?` | `string` \| `null` | -| `_accessProvider_not_contains?` | `string` \| `null` | -| `_accessProvider_not_in?` | `string`[] | -| `_agreementId?` | `string` \| `null` | -| `_agreementId_contains?` | `string` \| `null` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| `null` | -| `_agreementId_not_contains?` | `string` \| `null` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionIdSeeds?` | `string`[] | -| `_conditionIdSeeds_contains?` | `string`[] | -| `_conditionIdSeeds_contains_nocase?` | `string`[] | -| `_conditionIdSeeds_not?` | `string`[] | -| `_conditionIdSeeds_not_contains?` | `string`[] | -| `_conditionIdSeeds_not_contains_nocase?` | `string`[] | -| `_conditionIds?` | `string`[] | -| `_conditionIds_contains?` | `string`[] | -| `_conditionIds_contains_nocase?` | `string`[] | -| `_conditionIds_not?` | `string`[] | -| `_conditionIds_not_contains?` | `string`[] | -| `_conditionIds_not_contains_nocase?` | `string`[] | -| `_creator?` | `string` \| `null` | -| `_creator_contains?` | `string` \| `null` | -| `_creator_in?` | `string`[] | -| `_creator_not?` | `string` \| `null` | -| `_creator_not_contains?` | `string` \| `null` | -| `_creator_not_in?` | `string`[] | -| `_did?` | `string` \| `null` | -| `_did_contains?` | `string` \| `null` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| `null` | -| `_did_not_contains?` | `string` \| `null` | -| `_did_not_in?` | `string`[] | -| `_idSeed?` | `string` \| `null` | -| `_idSeed_contains?` | `string` \| `null` | -| `_idSeed_in?` | `string`[] | -| `_idSeed_not?` | `string` \| `null` | -| `_idSeed_not_contains?` | `string` \| `null` | -| `_idSeed_not_in?` | `string`[] | -| `_timeLocks?` | `WeiSource`[] | -| `_timeLocks_contains?` | `WeiSource`[] | -| `_timeLocks_contains_nocase?` | `WeiSource`[] | -| `_timeLocks_not?` | `WeiSource`[] | -| `_timeLocks_not_contains?` | `WeiSource`[] | -| `_timeLocks_not_contains_nocase?` | `WeiSource`[] | -| `_timeOuts?` | `WeiSource`[] | -| `_timeOuts_contains?` | `WeiSource`[] | -| `_timeOuts_contains_nocase?` | `WeiSource`[] | -| `_timeOuts_not?` | `WeiSource`[] | -| `_timeOuts_not_contains?` | `WeiSource`[] | -| `_timeOuts_not_contains_nocase?` | `WeiSource`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessTemplate.d.ts:21 - ---- - -### AgreementCreatedResult - -Ƭ **AgreementCreatedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :--------------------- | -| `_accessConsumer` | `string` | -| `_accessProvider` | `string` | -| `_agreementId` | `string` | -| `_conditionIdSeeds` | (`string` \| `null`)[] | -| `_conditionIds` | (`string` \| `null`)[] | -| `_creator` | `string` | -| `_did` | `string` | -| `_idSeed` | `string` | -| `_timeLocks` | (`Wei` \| `null`)[] | -| `_timeOuts` | (`Wei` \| `null`)[] | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessTemplate.d.ts:91 - ---- - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.AccessTemplate.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessTemplate.d.ts:148 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessTemplate.d.ts:144 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessTemplate.d.ts:122 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessTemplate.d.ts:140 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessTemplate.d.ts:10 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AccessTemplate.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessTemplate.d.ts:185 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessTemplate.d.ts:180 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessTemplate.d.ts:153 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessTemplate.d.ts:175 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessTemplate.d.ts:2 - -## Functions - -### getAgreementCreatedById - -▸ **getAgreementCreatedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.AccessTemplate.md#agreementcreatedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.AccessTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AccessTemplate.md#singlequeryoptions) | -| `args` | [`AgreementCreatedArgs`](subgraphs.AccessTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.AccessTemplate.md#agreementcreatedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessTemplate.d.ts:120 - ---- - -### getAgreementCreateds - -▸ **getAgreementCreateds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.AccessTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.AccessTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AccessTemplate.md#multiqueryoptions)<[`AgreementCreatedFilter`](subgraphs.AccessTemplate.md#agreementcreatedfilter), [`AgreementCreatedResult`](subgraphs.AccessTemplate.md#agreementcreatedresult)\> | -| `args` | [`AgreementCreatedArgs`](subgraphs.AccessTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.AccessTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessTemplate.d.ts:121 - ---- - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.AccessTemplate.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.AccessTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AccessTemplate.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.AccessTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.AccessTemplate.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessTemplate.d.ts:151 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.AccessTemplate.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.AccessTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AccessTemplate.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.AccessTemplate.md#initializedfilter), [`InitializedResult`](subgraphs.AccessTemplate.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.AccessTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.AccessTemplate.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessTemplate.d.ts:152 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AccessTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AccessTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AccessTemplate.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.AccessTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AccessTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessTemplate.d.ts:188 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AccessTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AccessTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AccessTemplate.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.AccessTemplate.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.AccessTemplate.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.AccessTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AccessTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AccessTemplate.d.ts:189 diff --git a/docs/api-reference/modules/subgraphs.AgreementStoreManager.md b/docs/api-reference/modules/subgraphs.AgreementStoreManager.md deleted file mode 100644 index dc7c3d0b3..000000000 --- a/docs/api-reference/modules/subgraphs.AgreementStoreManager.md +++ /dev/null @@ -1,822 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / AgreementStoreManager - -# Namespace: AgreementStoreManager - -[subgraphs](subgraphs.md).AgreementStoreManager - -## Table of contents - -### Type Aliases - -- [InitializedArgs](subgraphs.AgreementStoreManager.md#initializedargs) -- [InitializedFields](subgraphs.AgreementStoreManager.md#initializedfields) -- [InitializedFilter](subgraphs.AgreementStoreManager.md#initializedfilter) -- [InitializedResult](subgraphs.AgreementStoreManager.md#initializedresult) -- [MultiQueryOptions](subgraphs.AgreementStoreManager.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.AgreementStoreManager.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.AgreementStoreManager.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.AgreementStoreManager.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.AgreementStoreManager.md#ownershiptransferredresult) -- [RoleAdminChangedArgs](subgraphs.AgreementStoreManager.md#roleadminchangedargs) -- [RoleAdminChangedFields](subgraphs.AgreementStoreManager.md#roleadminchangedfields) -- [RoleAdminChangedFilter](subgraphs.AgreementStoreManager.md#roleadminchangedfilter) -- [RoleAdminChangedResult](subgraphs.AgreementStoreManager.md#roleadminchangedresult) -- [RoleGrantedArgs](subgraphs.AgreementStoreManager.md#rolegrantedargs) -- [RoleGrantedFields](subgraphs.AgreementStoreManager.md#rolegrantedfields) -- [RoleGrantedFilter](subgraphs.AgreementStoreManager.md#rolegrantedfilter) -- [RoleGrantedResult](subgraphs.AgreementStoreManager.md#rolegrantedresult) -- [RoleRevokedArgs](subgraphs.AgreementStoreManager.md#rolerevokedargs) -- [RoleRevokedFields](subgraphs.AgreementStoreManager.md#rolerevokedfields) -- [RoleRevokedFilter](subgraphs.AgreementStoreManager.md#rolerevokedfilter) -- [RoleRevokedResult](subgraphs.AgreementStoreManager.md#rolerevokedresult) -- [SingleQueryOptions](subgraphs.AgreementStoreManager.md#singlequeryoptions) - -### Functions - -- [getInitializedById](subgraphs.AgreementStoreManager.md#getinitializedbyid) -- [getInitializeds](subgraphs.AgreementStoreManager.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.AgreementStoreManager.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.AgreementStoreManager.md#getownershiptransferreds) -- [getRoleAdminChangedById](subgraphs.AgreementStoreManager.md#getroleadminchangedbyid) -- [getRoleAdminChangeds](subgraphs.AgreementStoreManager.md#getroleadminchangeds) -- [getRoleGrantedById](subgraphs.AgreementStoreManager.md#getrolegrantedbyid) -- [getRoleGranteds](subgraphs.AgreementStoreManager.md#getrolegranteds) -- [getRoleRevokedById](subgraphs.AgreementStoreManager.md#getrolerevokedbyid) -- [getRoleRevokeds](subgraphs.AgreementStoreManager.md#getrolerevokeds) - -## Type Aliases - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.AgreementStoreManager.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:46 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:42 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:20 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:38 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:9 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AgreementStoreManager.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:83 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:78 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:51 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:73 - ---- - -### RoleAdminChangedArgs - -Ƭ **RoleAdminChangedArgs**<`K`\>: { [Property in keyof Pick]: RoleAdminChangedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.AgreementStoreManager.md#roleadminchangedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:128 - ---- - -### RoleAdminChangedFields - -Ƭ **RoleAdminChangedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :----- | -| `id` | `true` | -| `newAdminRole` | `true` | -| `previousAdminRole` | `true` | -| `role` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:122 - ---- - -### RoleAdminChangedFilter - -Ƭ **RoleAdminChangedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newAdminRole?` | `string` \| `null` | -| `newAdminRole_contains?` | `string` \| `null` | -| `newAdminRole_in?` | `string`[] | -| `newAdminRole_not?` | `string` \| `null` | -| `newAdminRole_not_contains?` | `string` \| `null` | -| `newAdminRole_not_in?` | `string`[] | -| `previousAdminRole?` | `string` \| `null` | -| `previousAdminRole_contains?` | `string` \| `null` | -| `previousAdminRole_in?` | `string`[] | -| `previousAdminRole_not?` | `string` \| `null` | -| `previousAdminRole_not_contains?` | `string` \| `null` | -| `previousAdminRole_not_in?` | `string`[] | -| `role?` | `string` \| `null` | -| `role_contains?` | `string` \| `null` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| `null` | -| `role_not_contains?` | `string` \| `null` | -| `role_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:88 - ---- - -### RoleAdminChangedResult - -Ƭ **RoleAdminChangedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :------- | -| `id` | `string` | -| `newAdminRole` | `string` | -| `previousAdminRole` | `string` | -| `role` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:116 - ---- - -### RoleGrantedArgs - -Ƭ **RoleGrantedArgs**<`K`\>: { [Property in keyof Pick]: RoleGrantedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.AgreementStoreManager.md#rolegrantedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:173 - ---- - -### RoleGrantedFields - -Ƭ **RoleGrantedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `account` | `true` | -| `id` | `true` | -| `role` | `true` | -| `sender` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:167 - ---- - -### RoleGrantedFilter - -Ƭ **RoleGrantedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------- | :----------------- | -| `account?` | `string` \| `null` | -| `account_contains?` | `string` \| `null` | -| `account_in?` | `string`[] | -| `account_not?` | `string` \| `null` | -| `account_not_contains?` | `string` \| `null` | -| `account_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `role?` | `string` \| `null` | -| `role_contains?` | `string` \| `null` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| `null` | -| `role_not_contains?` | `string` \| `null` | -| `role_not_in?` | `string`[] | -| `sender?` | `string` \| `null` | -| `sender_contains?` | `string` \| `null` | -| `sender_in?` | `string`[] | -| `sender_not?` | `string` \| `null` | -| `sender_not_contains?` | `string` \| `null` | -| `sender_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:133 - ---- - -### RoleGrantedResult - -Ƭ **RoleGrantedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `account` | `string` | -| `id` | `string` | -| `role` | `string` | -| `sender` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:161 - ---- - -### RoleRevokedArgs - -Ƭ **RoleRevokedArgs**<`K`\>: { [Property in keyof Pick]: RoleRevokedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.AgreementStoreManager.md#rolerevokedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:218 - ---- - -### RoleRevokedFields - -Ƭ **RoleRevokedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `account` | `true` | -| `id` | `true` | -| `role` | `true` | -| `sender` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:212 - ---- - -### RoleRevokedFilter - -Ƭ **RoleRevokedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------- | :----------------- | -| `account?` | `string` \| `null` | -| `account_contains?` | `string` \| `null` | -| `account_in?` | `string`[] | -| `account_not?` | `string` \| `null` | -| `account_not_contains?` | `string` \| `null` | -| `account_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `role?` | `string` \| `null` | -| `role_contains?` | `string` \| `null` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| `null` | -| `role_not_contains?` | `string` \| `null` | -| `role_not_in?` | `string`[] | -| `sender?` | `string` \| `null` | -| `sender_contains?` | `string` \| `null` | -| `sender_in?` | `string`[] | -| `sender_not?` | `string` \| `null` | -| `sender_not_contains?` | `string` \| `null` | -| `sender_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:178 - ---- - -### RoleRevokedResult - -Ƭ **RoleRevokedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `account` | `string` | -| `id` | `string` | -| `role` | `string` | -| `sender` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:206 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:1 - -## Functions - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.AgreementStoreManager.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.AgreementStoreManager.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AgreementStoreManager.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.AgreementStoreManager.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.AgreementStoreManager.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:49 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.AgreementStoreManager.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.AgreementStoreManager.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AgreementStoreManager.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.AgreementStoreManager.md#initializedfilter), [`InitializedResult`](subgraphs.AgreementStoreManager.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.AgreementStoreManager.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.AgreementStoreManager.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:50 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AgreementStoreManager.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AgreementStoreManager.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AgreementStoreManager.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.AgreementStoreManager.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AgreementStoreManager.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:86 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AgreementStoreManager.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.AgreementStoreManager.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AgreementStoreManager.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.AgreementStoreManager.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.AgreementStoreManager.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.AgreementStoreManager.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.AgreementStoreManager.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:87 - ---- - -### getRoleAdminChangedById - -▸ **getRoleAdminChangedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.AgreementStoreManager.md#roleadminchangedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.AgreementStoreManager.md#roleadminchangedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AgreementStoreManager.md#singlequeryoptions) | -| `args` | [`RoleAdminChangedArgs`](subgraphs.AgreementStoreManager.md#roleadminchangedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.AgreementStoreManager.md#roleadminchangedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:131 - ---- - -### getRoleAdminChangeds - -▸ **getRoleAdminChangeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.AgreementStoreManager.md#roleadminchangedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.AgreementStoreManager.md#roleadminchangedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AgreementStoreManager.md#multiqueryoptions)<[`RoleAdminChangedFilter`](subgraphs.AgreementStoreManager.md#roleadminchangedfilter), [`RoleAdminChangedResult`](subgraphs.AgreementStoreManager.md#roleadminchangedresult)\> | -| `args` | [`RoleAdminChangedArgs`](subgraphs.AgreementStoreManager.md#roleadminchangedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.AgreementStoreManager.md#roleadminchangedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:132 - ---- - -### getRoleGrantedById - -▸ **getRoleGrantedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.AgreementStoreManager.md#rolegrantedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.AgreementStoreManager.md#rolegrantedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AgreementStoreManager.md#singlequeryoptions) | -| `args` | [`RoleGrantedArgs`](subgraphs.AgreementStoreManager.md#rolegrantedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.AgreementStoreManager.md#rolegrantedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:176 - ---- - -### getRoleGranteds - -▸ **getRoleGranteds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.AgreementStoreManager.md#rolegrantedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.AgreementStoreManager.md#rolegrantedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AgreementStoreManager.md#multiqueryoptions)<[`RoleGrantedFilter`](subgraphs.AgreementStoreManager.md#rolegrantedfilter), [`RoleGrantedResult`](subgraphs.AgreementStoreManager.md#rolegrantedresult)\> | -| `args` | [`RoleGrantedArgs`](subgraphs.AgreementStoreManager.md#rolegrantedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.AgreementStoreManager.md#rolegrantedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:177 - ---- - -### getRoleRevokedById - -▸ **getRoleRevokedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.AgreementStoreManager.md#rolerevokedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.AgreementStoreManager.md#rolerevokedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.AgreementStoreManager.md#singlequeryoptions) | -| `args` | [`RoleRevokedArgs`](subgraphs.AgreementStoreManager.md#rolerevokedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.AgreementStoreManager.md#rolerevokedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:221 - ---- - -### getRoleRevokeds - -▸ **getRoleRevokeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.AgreementStoreManager.md#rolerevokedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.AgreementStoreManager.md#rolerevokedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.AgreementStoreManager.md#multiqueryoptions)<[`RoleRevokedFilter`](subgraphs.AgreementStoreManager.md#rolerevokedfilter), [`RoleRevokedResult`](subgraphs.AgreementStoreManager.md#rolerevokedresult)\> | -| `args` | [`RoleRevokedArgs`](subgraphs.AgreementStoreManager.md#rolerevokedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.AgreementStoreManager.md#rolerevokedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/AgreementStoreManager.d.ts:222 diff --git a/docs/api-reference/modules/subgraphs.ComputeExecutionCondition.md b/docs/api-reference/modules/subgraphs.ComputeExecutionCondition.md deleted file mode 100644 index e89a0b1d9..000000000 --- a/docs/api-reference/modules/subgraphs.ComputeExecutionCondition.md +++ /dev/null @@ -1,516 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / ComputeExecutionCondition - -# Namespace: ComputeExecutionCondition - -[subgraphs](subgraphs.md).ComputeExecutionCondition - -## Table of contents - -### Type Aliases - -- [FulfilledArgs](subgraphs.ComputeExecutionCondition.md#fulfilledargs) -- [FulfilledFields](subgraphs.ComputeExecutionCondition.md#fulfilledfields) -- [FulfilledFilter](subgraphs.ComputeExecutionCondition.md#fulfilledfilter) -- [FulfilledResult](subgraphs.ComputeExecutionCondition.md#fulfilledresult) -- [InitializedArgs](subgraphs.ComputeExecutionCondition.md#initializedargs) -- [InitializedFields](subgraphs.ComputeExecutionCondition.md#initializedfields) -- [InitializedFilter](subgraphs.ComputeExecutionCondition.md#initializedfilter) -- [InitializedResult](subgraphs.ComputeExecutionCondition.md#initializedresult) -- [MultiQueryOptions](subgraphs.ComputeExecutionCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.ComputeExecutionCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.ComputeExecutionCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.ComputeExecutionCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.ComputeExecutionCondition.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.ComputeExecutionCondition.md#singlequeryoptions) - -### Functions - -- [getFulfilledById](subgraphs.ComputeExecutionCondition.md#getfulfilledbyid) -- [getFulfilleds](subgraphs.ComputeExecutionCondition.md#getfulfilleds) -- [getInitializedById](subgraphs.ComputeExecutionCondition.md#getinitializedbyid) -- [getInitializeds](subgraphs.ComputeExecutionCondition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.ComputeExecutionCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.ComputeExecutionCondition.md#getownershiptransferreds) - -## Type Aliases - -### FulfilledArgs - -Ƭ **FulfilledArgs**<`K`\>: { [Property in keyof Pick]: FulfilledFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.ComputeExecutionCondition.md#fulfilledresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ComputeExecutionCondition.d.ts:68 - ---- - -### FulfilledFields - -Ƭ **FulfilledFields**: `Object` - -#### Type declaration - -| Name | Type | -| :----------------- | :----- | -| `_agreementId` | `true` | -| `_computeConsumer` | `true` | -| `_conditionId` | `true` | -| `_did` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ComputeExecutionCondition.d.ts:61 - ---- - -### FulfilledFilter - -Ƭ **FulfilledFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------------------- | :----------------- | -| `_agreementId?` | `string` \| `null` | -| `_agreementId_contains?` | `string` \| `null` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| `null` | -| `_agreementId_not_contains?` | `string` \| `null` | -| `_agreementId_not_in?` | `string`[] | -| `_computeConsumer?` | `string` \| `null` | -| `_computeConsumer_contains?` | `string` \| `null` | -| `_computeConsumer_in?` | `string`[] | -| `_computeConsumer_not?` | `string` \| `null` | -| `_computeConsumer_not_contains?` | `string` \| `null` | -| `_computeConsumer_not_in?` | `string`[] | -| `_conditionId?` | `string` \| `null` | -| `_conditionId_contains?` | `string` \| `null` | -| `_conditionId_in?` | `string`[] | -| `_conditionId_not?` | `string` \| `null` | -| `_conditionId_not_contains?` | `string` \| `null` | -| `_conditionId_not_in?` | `string`[] | -| `_did?` | `string` \| `null` | -| `_did_contains?` | `string` \| `null` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| `null` | -| `_did_not_contains?` | `string` \| `null` | -| `_did_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ComputeExecutionCondition.d.ts:20 - ---- - -### FulfilledResult - -Ƭ **FulfilledResult**: `Object` - -#### Type declaration - -| Name | Type | -| :----------------- | :------- | -| `_agreementId` | `string` | -| `_computeConsumer` | `string` | -| `_conditionId` | `string` | -| `_did` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ComputeExecutionCondition.d.ts:54 - ---- - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.ComputeExecutionCondition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ComputeExecutionCondition.d.ts:99 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ComputeExecutionCondition.d.ts:95 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ComputeExecutionCondition.d.ts:73 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ComputeExecutionCondition.d.ts:91 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ComputeExecutionCondition.d.ts:9 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.ComputeExecutionCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ComputeExecutionCondition.d.ts:136 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ComputeExecutionCondition.d.ts:131 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ComputeExecutionCondition.d.ts:104 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ComputeExecutionCondition.d.ts:126 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ComputeExecutionCondition.d.ts:1 - -## Functions - -### getFulfilledById - -▸ **getFulfilledById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.ComputeExecutionCondition.md#fulfilledresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.ComputeExecutionCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.ComputeExecutionCondition.md#singlequeryoptions) | -| `args` | [`FulfilledArgs`](subgraphs.ComputeExecutionCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.ComputeExecutionCondition.md#fulfilledresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ComputeExecutionCondition.d.ts:71 - ---- - -### getFulfilleds - -▸ **getFulfilleds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.ComputeExecutionCondition.md#fulfilledresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.ComputeExecutionCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.ComputeExecutionCondition.md#multiqueryoptions)<[`FulfilledFilter`](subgraphs.ComputeExecutionCondition.md#fulfilledfilter), [`FulfilledResult`](subgraphs.ComputeExecutionCondition.md#fulfilledresult)\> | -| `args` | [`FulfilledArgs`](subgraphs.ComputeExecutionCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.ComputeExecutionCondition.md#fulfilledresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ComputeExecutionCondition.d.ts:72 - ---- - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.ComputeExecutionCondition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.ComputeExecutionCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.ComputeExecutionCondition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.ComputeExecutionCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.ComputeExecutionCondition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ComputeExecutionCondition.d.ts:102 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.ComputeExecutionCondition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.ComputeExecutionCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.ComputeExecutionCondition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.ComputeExecutionCondition.md#initializedfilter), [`InitializedResult`](subgraphs.ComputeExecutionCondition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.ComputeExecutionCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.ComputeExecutionCondition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ComputeExecutionCondition.d.ts:103 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.ComputeExecutionCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.ComputeExecutionCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.ComputeExecutionCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.ComputeExecutionCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.ComputeExecutionCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ComputeExecutionCondition.d.ts:139 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.ComputeExecutionCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.ComputeExecutionCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.ComputeExecutionCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.ComputeExecutionCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.ComputeExecutionCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.ComputeExecutionCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.ComputeExecutionCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ComputeExecutionCondition.d.ts:140 diff --git a/docs/api-reference/modules/subgraphs.ConditionStoreManager.md b/docs/api-reference/modules/subgraphs.ConditionStoreManager.md deleted file mode 100644 index aa496786a..000000000 --- a/docs/api-reference/modules/subgraphs.ConditionStoreManager.md +++ /dev/null @@ -1,1130 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / ConditionStoreManager - -# Namespace: ConditionStoreManager - -[subgraphs](subgraphs.md).ConditionStoreManager - -## Table of contents - -### Type Aliases - -- [ConditionCreatedArgs](subgraphs.ConditionStoreManager.md#conditioncreatedargs) -- [ConditionCreatedFields](subgraphs.ConditionStoreManager.md#conditioncreatedfields) -- [ConditionCreatedFilter](subgraphs.ConditionStoreManager.md#conditioncreatedfilter) -- [ConditionCreatedResult](subgraphs.ConditionStoreManager.md#conditioncreatedresult) -- [ConditionUpdatedArgs](subgraphs.ConditionStoreManager.md#conditionupdatedargs) -- [ConditionUpdatedFields](subgraphs.ConditionStoreManager.md#conditionupdatedfields) -- [ConditionUpdatedFilter](subgraphs.ConditionStoreManager.md#conditionupdatedfilter) -- [ConditionUpdatedResult](subgraphs.ConditionStoreManager.md#conditionupdatedresult) -- [InitializedArgs](subgraphs.ConditionStoreManager.md#initializedargs) -- [InitializedFields](subgraphs.ConditionStoreManager.md#initializedfields) -- [InitializedFilter](subgraphs.ConditionStoreManager.md#initializedfilter) -- [InitializedResult](subgraphs.ConditionStoreManager.md#initializedresult) -- [MultiQueryOptions](subgraphs.ConditionStoreManager.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.ConditionStoreManager.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.ConditionStoreManager.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.ConditionStoreManager.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.ConditionStoreManager.md#ownershiptransferredresult) -- [RoleAdminChangedArgs](subgraphs.ConditionStoreManager.md#roleadminchangedargs) -- [RoleAdminChangedFields](subgraphs.ConditionStoreManager.md#roleadminchangedfields) -- [RoleAdminChangedFilter](subgraphs.ConditionStoreManager.md#roleadminchangedfilter) -- [RoleAdminChangedResult](subgraphs.ConditionStoreManager.md#roleadminchangedresult) -- [RoleGrantedArgs](subgraphs.ConditionStoreManager.md#rolegrantedargs) -- [RoleGrantedFields](subgraphs.ConditionStoreManager.md#rolegrantedfields) -- [RoleGrantedFilter](subgraphs.ConditionStoreManager.md#rolegrantedfilter) -- [RoleGrantedResult](subgraphs.ConditionStoreManager.md#rolegrantedresult) -- [RoleRevokedArgs](subgraphs.ConditionStoreManager.md#rolerevokedargs) -- [RoleRevokedFields](subgraphs.ConditionStoreManager.md#rolerevokedfields) -- [RoleRevokedFilter](subgraphs.ConditionStoreManager.md#rolerevokedfilter) -- [RoleRevokedResult](subgraphs.ConditionStoreManager.md#rolerevokedresult) -- [SingleQueryOptions](subgraphs.ConditionStoreManager.md#singlequeryoptions) - -### Functions - -- [getConditionCreatedById](subgraphs.ConditionStoreManager.md#getconditioncreatedbyid) -- [getConditionCreateds](subgraphs.ConditionStoreManager.md#getconditioncreateds) -- [getConditionUpdatedById](subgraphs.ConditionStoreManager.md#getconditionupdatedbyid) -- [getConditionUpdateds](subgraphs.ConditionStoreManager.md#getconditionupdateds) -- [getInitializedById](subgraphs.ConditionStoreManager.md#getinitializedbyid) -- [getInitializeds](subgraphs.ConditionStoreManager.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.ConditionStoreManager.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.ConditionStoreManager.md#getownershiptransferreds) -- [getRoleAdminChangedById](subgraphs.ConditionStoreManager.md#getroleadminchangedbyid) -- [getRoleAdminChangeds](subgraphs.ConditionStoreManager.md#getroleadminchangeds) -- [getRoleGrantedById](subgraphs.ConditionStoreManager.md#getrolegrantedbyid) -- [getRoleGranteds](subgraphs.ConditionStoreManager.md#getrolegranteds) -- [getRoleRevokedById](subgraphs.ConditionStoreManager.md#getrolerevokedbyid) -- [getRoleRevokeds](subgraphs.ConditionStoreManager.md#getrolerevokeds) - -## Type Aliases - -### ConditionCreatedArgs - -Ƭ **ConditionCreatedArgs**<`K`\>: { [Property in keyof Pick]: ConditionCreatedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`ConditionCreatedResult`](subgraphs.ConditionStoreManager.md#conditioncreatedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:52 - ---- - -### ConditionCreatedFields - -Ƭ **ConditionCreatedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :--------- | :----- | -| `_typeRef` | `true` | -| `_who` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:47 - ---- - -### ConditionCreatedFilter - -Ƭ **ConditionCreatedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :----------------------- | :----------------- | -| `_typeRef?` | `string` \| `null` | -| `_typeRef_contains?` | `string` \| `null` | -| `_typeRef_in?` | `string`[] | -| `_typeRef_not?` | `string` \| `null` | -| `_typeRef_not_contains?` | `string` \| `null` | -| `_typeRef_not_in?` | `string`[] | -| `_who?` | `string` \| `null` | -| `_who_contains?` | `string` \| `null` | -| `_who_in?` | `string`[] | -| `_who_not?` | `string` \| `null` | -| `_who_not_contains?` | `string` \| `null` | -| `_who_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:20 - ---- - -### ConditionCreatedResult - -Ƭ **ConditionCreatedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :--------- | :------- | -| `_typeRef` | `string` | -| `_who` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:42 - ---- - -### ConditionUpdatedArgs - -Ƭ **ConditionUpdatedArgs**<`K`\>: { [Property in keyof Pick]: ConditionUpdatedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`ConditionUpdatedResult`](subgraphs.ConditionStoreManager.md#conditionupdatedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:99 - ---- - -### ConditionUpdatedFields - -Ƭ **ConditionUpdatedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :--------- | :----- | -| `_state` | `true` | -| `_typeRef` | `true` | -| `_who` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:93 - ---- - -### ConditionUpdatedFilter - -Ƭ **ConditionUpdatedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :----------------------- | :----------------- | -| `_state?` | `number` \| `null` | -| `_state_gt?` | `number` \| `null` | -| `_state_gte?` | `number` \| `null` | -| `_state_in?` | `number`[] | -| `_state_lt?` | `number` \| `null` | -| `_state_lte?` | `number` \| `null` | -| `_state_not?` | `number` \| `null` | -| `_state_not_in?` | `number`[] | -| `_typeRef?` | `string` \| `null` | -| `_typeRef_contains?` | `string` \| `null` | -| `_typeRef_in?` | `string`[] | -| `_typeRef_not?` | `string` \| `null` | -| `_typeRef_not_contains?` | `string` \| `null` | -| `_typeRef_not_in?` | `string`[] | -| `_who?` | `string` \| `null` | -| `_who_contains?` | `string` \| `null` | -| `_who_in?` | `string`[] | -| `_who_not?` | `string` \| `null` | -| `_who_not_contains?` | `string` \| `null` | -| `_who_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:57 - ---- - -### ConditionUpdatedResult - -Ƭ **ConditionUpdatedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :--------- | :------- | -| `_state` | `number` | -| `_typeRef` | `string` | -| `_who` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:87 - ---- - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.ConditionStoreManager.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:130 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:126 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:104 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:122 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:9 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.ConditionStoreManager.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:167 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:162 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:135 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:157 - ---- - -### RoleAdminChangedArgs - -Ƭ **RoleAdminChangedArgs**<`K`\>: { [Property in keyof Pick]: RoleAdminChangedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.ConditionStoreManager.md#roleadminchangedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:212 - ---- - -### RoleAdminChangedFields - -Ƭ **RoleAdminChangedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :----- | -| `id` | `true` | -| `newAdminRole` | `true` | -| `previousAdminRole` | `true` | -| `role` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:206 - ---- - -### RoleAdminChangedFilter - -Ƭ **RoleAdminChangedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newAdminRole?` | `string` \| `null` | -| `newAdminRole_contains?` | `string` \| `null` | -| `newAdminRole_in?` | `string`[] | -| `newAdminRole_not?` | `string` \| `null` | -| `newAdminRole_not_contains?` | `string` \| `null` | -| `newAdminRole_not_in?` | `string`[] | -| `previousAdminRole?` | `string` \| `null` | -| `previousAdminRole_contains?` | `string` \| `null` | -| `previousAdminRole_in?` | `string`[] | -| `previousAdminRole_not?` | `string` \| `null` | -| `previousAdminRole_not_contains?` | `string` \| `null` | -| `previousAdminRole_not_in?` | `string`[] | -| `role?` | `string` \| `null` | -| `role_contains?` | `string` \| `null` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| `null` | -| `role_not_contains?` | `string` \| `null` | -| `role_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:172 - ---- - -### RoleAdminChangedResult - -Ƭ **RoleAdminChangedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :------- | -| `id` | `string` | -| `newAdminRole` | `string` | -| `previousAdminRole` | `string` | -| `role` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:200 - ---- - -### RoleGrantedArgs - -Ƭ **RoleGrantedArgs**<`K`\>: { [Property in keyof Pick]: RoleGrantedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.ConditionStoreManager.md#rolegrantedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:257 - ---- - -### RoleGrantedFields - -Ƭ **RoleGrantedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `account` | `true` | -| `id` | `true` | -| `role` | `true` | -| `sender` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:251 - ---- - -### RoleGrantedFilter - -Ƭ **RoleGrantedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------- | :----------------- | -| `account?` | `string` \| `null` | -| `account_contains?` | `string` \| `null` | -| `account_in?` | `string`[] | -| `account_not?` | `string` \| `null` | -| `account_not_contains?` | `string` \| `null` | -| `account_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `role?` | `string` \| `null` | -| `role_contains?` | `string` \| `null` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| `null` | -| `role_not_contains?` | `string` \| `null` | -| `role_not_in?` | `string`[] | -| `sender?` | `string` \| `null` | -| `sender_contains?` | `string` \| `null` | -| `sender_in?` | `string`[] | -| `sender_not?` | `string` \| `null` | -| `sender_not_contains?` | `string` \| `null` | -| `sender_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:217 - ---- - -### RoleGrantedResult - -Ƭ **RoleGrantedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `account` | `string` | -| `id` | `string` | -| `role` | `string` | -| `sender` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:245 - ---- - -### RoleRevokedArgs - -Ƭ **RoleRevokedArgs**<`K`\>: { [Property in keyof Pick]: RoleRevokedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.ConditionStoreManager.md#rolerevokedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:302 - ---- - -### RoleRevokedFields - -Ƭ **RoleRevokedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `account` | `true` | -| `id` | `true` | -| `role` | `true` | -| `sender` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:296 - ---- - -### RoleRevokedFilter - -Ƭ **RoleRevokedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------- | :----------------- | -| `account?` | `string` \| `null` | -| `account_contains?` | `string` \| `null` | -| `account_in?` | `string`[] | -| `account_not?` | `string` \| `null` | -| `account_not_contains?` | `string` \| `null` | -| `account_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `role?` | `string` \| `null` | -| `role_contains?` | `string` \| `null` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| `null` | -| `role_not_contains?` | `string` \| `null` | -| `role_not_in?` | `string`[] | -| `sender?` | `string` \| `null` | -| `sender_contains?` | `string` \| `null` | -| `sender_in?` | `string`[] | -| `sender_not?` | `string` \| `null` | -| `sender_not_contains?` | `string` \| `null` | -| `sender_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:262 - ---- - -### RoleRevokedResult - -Ƭ **RoleRevokedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `account` | `string` | -| `id` | `string` | -| `role` | `string` | -| `sender` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:290 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:1 - -## Functions - -### getConditionCreatedById - -▸ **getConditionCreatedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ConditionCreatedResult`](subgraphs.ConditionStoreManager.md#conditioncreatedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`ConditionCreatedResult`](subgraphs.ConditionStoreManager.md#conditioncreatedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.ConditionStoreManager.md#singlequeryoptions) | -| `args` | [`ConditionCreatedArgs`](subgraphs.ConditionStoreManager.md#conditioncreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ConditionCreatedResult`](subgraphs.ConditionStoreManager.md#conditioncreatedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:55 - ---- - -### getConditionCreateds - -▸ **getConditionCreateds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ConditionCreatedResult`](subgraphs.ConditionStoreManager.md#conditioncreatedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`ConditionCreatedResult`](subgraphs.ConditionStoreManager.md#conditioncreatedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.ConditionStoreManager.md#multiqueryoptions)<[`ConditionCreatedFilter`](subgraphs.ConditionStoreManager.md#conditioncreatedfilter), [`ConditionCreatedResult`](subgraphs.ConditionStoreManager.md#conditioncreatedresult)\> | -| `args` | [`ConditionCreatedArgs`](subgraphs.ConditionStoreManager.md#conditioncreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ConditionCreatedResult`](subgraphs.ConditionStoreManager.md#conditioncreatedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:56 - ---- - -### getConditionUpdatedById - -▸ **getConditionUpdatedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ConditionUpdatedResult`](subgraphs.ConditionStoreManager.md#conditionupdatedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`ConditionUpdatedResult`](subgraphs.ConditionStoreManager.md#conditionupdatedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.ConditionStoreManager.md#singlequeryoptions) | -| `args` | [`ConditionUpdatedArgs`](subgraphs.ConditionStoreManager.md#conditionupdatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ConditionUpdatedResult`](subgraphs.ConditionStoreManager.md#conditionupdatedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:102 - ---- - -### getConditionUpdateds - -▸ **getConditionUpdateds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ConditionUpdatedResult`](subgraphs.ConditionStoreManager.md#conditionupdatedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`ConditionUpdatedResult`](subgraphs.ConditionStoreManager.md#conditionupdatedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.ConditionStoreManager.md#multiqueryoptions)<[`ConditionUpdatedFilter`](subgraphs.ConditionStoreManager.md#conditionupdatedfilter), [`ConditionUpdatedResult`](subgraphs.ConditionStoreManager.md#conditionupdatedresult)\> | -| `args` | [`ConditionUpdatedArgs`](subgraphs.ConditionStoreManager.md#conditionupdatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ConditionUpdatedResult`](subgraphs.ConditionStoreManager.md#conditionupdatedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:103 - ---- - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.ConditionStoreManager.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.ConditionStoreManager.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.ConditionStoreManager.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.ConditionStoreManager.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.ConditionStoreManager.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:133 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.ConditionStoreManager.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.ConditionStoreManager.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.ConditionStoreManager.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.ConditionStoreManager.md#initializedfilter), [`InitializedResult`](subgraphs.ConditionStoreManager.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.ConditionStoreManager.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.ConditionStoreManager.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:134 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.ConditionStoreManager.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.ConditionStoreManager.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.ConditionStoreManager.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.ConditionStoreManager.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.ConditionStoreManager.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:170 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.ConditionStoreManager.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.ConditionStoreManager.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.ConditionStoreManager.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.ConditionStoreManager.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.ConditionStoreManager.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.ConditionStoreManager.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.ConditionStoreManager.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:171 - ---- - -### getRoleAdminChangedById - -▸ **getRoleAdminChangedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.ConditionStoreManager.md#roleadminchangedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.ConditionStoreManager.md#roleadminchangedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.ConditionStoreManager.md#singlequeryoptions) | -| `args` | [`RoleAdminChangedArgs`](subgraphs.ConditionStoreManager.md#roleadminchangedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.ConditionStoreManager.md#roleadminchangedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:215 - ---- - -### getRoleAdminChangeds - -▸ **getRoleAdminChangeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.ConditionStoreManager.md#roleadminchangedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.ConditionStoreManager.md#roleadminchangedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.ConditionStoreManager.md#multiqueryoptions)<[`RoleAdminChangedFilter`](subgraphs.ConditionStoreManager.md#roleadminchangedfilter), [`RoleAdminChangedResult`](subgraphs.ConditionStoreManager.md#roleadminchangedresult)\> | -| `args` | [`RoleAdminChangedArgs`](subgraphs.ConditionStoreManager.md#roleadminchangedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.ConditionStoreManager.md#roleadminchangedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:216 - ---- - -### getRoleGrantedById - -▸ **getRoleGrantedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.ConditionStoreManager.md#rolegrantedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.ConditionStoreManager.md#rolegrantedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.ConditionStoreManager.md#singlequeryoptions) | -| `args` | [`RoleGrantedArgs`](subgraphs.ConditionStoreManager.md#rolegrantedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.ConditionStoreManager.md#rolegrantedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:260 - ---- - -### getRoleGranteds - -▸ **getRoleGranteds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.ConditionStoreManager.md#rolegrantedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.ConditionStoreManager.md#rolegrantedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.ConditionStoreManager.md#multiqueryoptions)<[`RoleGrantedFilter`](subgraphs.ConditionStoreManager.md#rolegrantedfilter), [`RoleGrantedResult`](subgraphs.ConditionStoreManager.md#rolegrantedresult)\> | -| `args` | [`RoleGrantedArgs`](subgraphs.ConditionStoreManager.md#rolegrantedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.ConditionStoreManager.md#rolegrantedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:261 - ---- - -### getRoleRevokedById - -▸ **getRoleRevokedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.ConditionStoreManager.md#rolerevokedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.ConditionStoreManager.md#rolerevokedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.ConditionStoreManager.md#singlequeryoptions) | -| `args` | [`RoleRevokedArgs`](subgraphs.ConditionStoreManager.md#rolerevokedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.ConditionStoreManager.md#rolerevokedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:305 - ---- - -### getRoleRevokeds - -▸ **getRoleRevokeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.ConditionStoreManager.md#rolerevokedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.ConditionStoreManager.md#rolerevokedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.ConditionStoreManager.md#multiqueryoptions)<[`RoleRevokedFilter`](subgraphs.ConditionStoreManager.md#rolerevokedfilter), [`RoleRevokedResult`](subgraphs.ConditionStoreManager.md#rolerevokedresult)\> | -| `args` | [`RoleRevokedArgs`](subgraphs.ConditionStoreManager.md#rolerevokedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.ConditionStoreManager.md#rolerevokedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ConditionStoreManager.d.ts:306 diff --git a/docs/api-reference/modules/subgraphs.DIDRegistry.md b/docs/api-reference/modules/subgraphs.DIDRegistry.md deleted file mode 100644 index bd61feda9..000000000 --- a/docs/api-reference/modules/subgraphs.DIDRegistry.md +++ /dev/null @@ -1,3149 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / DIDRegistry - -# Namespace: DIDRegistry - -[subgraphs](subgraphs.md).DIDRegistry - -## Table of contents - -### Type Aliases - -- [ActedOnBehalfArgs](subgraphs.DIDRegistry.md#actedonbehalfargs) -- [ActedOnBehalfFields](subgraphs.DIDRegistry.md#actedonbehalffields) -- [ActedOnBehalfFilter](subgraphs.DIDRegistry.md#actedonbehalffilter) -- [ActedOnBehalfResult](subgraphs.DIDRegistry.md#actedonbehalfresult) -- [DIDAttributeRegisteredArgs](subgraphs.DIDRegistry.md#didattributeregisteredargs) -- [DIDAttributeRegisteredFields](subgraphs.DIDRegistry.md#didattributeregisteredfields) -- [DIDAttributeRegisteredFilter](subgraphs.DIDRegistry.md#didattributeregisteredfilter) -- [DIDAttributeRegisteredResult](subgraphs.DIDRegistry.md#didattributeregisteredresult) -- [DIDOwnershipTransferredArgs](subgraphs.DIDRegistry.md#didownershiptransferredargs) -- [DIDOwnershipTransferredFields](subgraphs.DIDRegistry.md#didownershiptransferredfields) -- [DIDOwnershipTransferredFilter](subgraphs.DIDRegistry.md#didownershiptransferredfilter) -- [DIDOwnershipTransferredResult](subgraphs.DIDRegistry.md#didownershiptransferredresult) -- [DIDPermissionGrantedArgs](subgraphs.DIDRegistry.md#didpermissiongrantedargs) -- [DIDPermissionGrantedFields](subgraphs.DIDRegistry.md#didpermissiongrantedfields) -- [DIDPermissionGrantedFilter](subgraphs.DIDRegistry.md#didpermissiongrantedfilter) -- [DIDPermissionGrantedResult](subgraphs.DIDRegistry.md#didpermissiongrantedresult) -- [DIDPermissionRevokedArgs](subgraphs.DIDRegistry.md#didpermissionrevokedargs) -- [DIDPermissionRevokedFields](subgraphs.DIDRegistry.md#didpermissionrevokedfields) -- [DIDPermissionRevokedFilter](subgraphs.DIDRegistry.md#didpermissionrevokedfilter) -- [DIDPermissionRevokedResult](subgraphs.DIDRegistry.md#didpermissionrevokedresult) -- [DIDProvenanceDelegateAddedArgs](subgraphs.DIDRegistry.md#didprovenancedelegateaddedargs) -- [DIDProvenanceDelegateAddedFields](subgraphs.DIDRegistry.md#didprovenancedelegateaddedfields) -- [DIDProvenanceDelegateAddedFilter](subgraphs.DIDRegistry.md#didprovenancedelegateaddedfilter) -- [DIDProvenanceDelegateAddedResult](subgraphs.DIDRegistry.md#didprovenancedelegateaddedresult) -- [DIDProvenanceDelegateRemovedArgs](subgraphs.DIDRegistry.md#didprovenancedelegateremovedargs) -- [DIDProvenanceDelegateRemovedFields](subgraphs.DIDRegistry.md#didprovenancedelegateremovedfields) -- [DIDProvenanceDelegateRemovedFilter](subgraphs.DIDRegistry.md#didprovenancedelegateremovedfilter) -- [DIDProvenanceDelegateRemovedResult](subgraphs.DIDRegistry.md#didprovenancedelegateremovedresult) -- [DIDProviderAddedArgs](subgraphs.DIDRegistry.md#didprovideraddedargs) -- [DIDProviderAddedFields](subgraphs.DIDRegistry.md#didprovideraddedfields) -- [DIDProviderAddedFilter](subgraphs.DIDRegistry.md#didprovideraddedfilter) -- [DIDProviderAddedResult](subgraphs.DIDRegistry.md#didprovideraddedresult) -- [DIDProviderRemovedArgs](subgraphs.DIDRegistry.md#didproviderremovedargs) -- [DIDProviderRemovedFields](subgraphs.DIDRegistry.md#didproviderremovedfields) -- [DIDProviderRemovedFilter](subgraphs.DIDRegistry.md#didproviderremovedfilter) -- [DIDProviderRemovedResult](subgraphs.DIDRegistry.md#didproviderremovedresult) -- [DIDRoyaltiesAddedArgs](subgraphs.DIDRegistry.md#didroyaltiesaddedargs) -- [DIDRoyaltiesAddedFields](subgraphs.DIDRegistry.md#didroyaltiesaddedfields) -- [DIDRoyaltiesAddedFilter](subgraphs.DIDRegistry.md#didroyaltiesaddedfilter) -- [DIDRoyaltiesAddedResult](subgraphs.DIDRegistry.md#didroyaltiesaddedresult) -- [DIDRoyaltyRecipientChangedArgs](subgraphs.DIDRegistry.md#didroyaltyrecipientchangedargs) -- [DIDRoyaltyRecipientChangedFields](subgraphs.DIDRegistry.md#didroyaltyrecipientchangedfields) -- [DIDRoyaltyRecipientChangedFilter](subgraphs.DIDRegistry.md#didroyaltyrecipientchangedfilter) -- [DIDRoyaltyRecipientChangedResult](subgraphs.DIDRegistry.md#didroyaltyrecipientchangedresult) -- [InitializedArgs](subgraphs.DIDRegistry.md#initializedargs) -- [InitializedFields](subgraphs.DIDRegistry.md#initializedfields) -- [InitializedFilter](subgraphs.DIDRegistry.md#initializedfilter) -- [InitializedResult](subgraphs.DIDRegistry.md#initializedresult) -- [MultiQueryOptions](subgraphs.DIDRegistry.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.DIDRegistry.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.DIDRegistry.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.DIDRegistry.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.DIDRegistry.md#ownershiptransferredresult) -- [ProvenanceAttributeRegisteredArgs](subgraphs.DIDRegistry.md#provenanceattributeregisteredargs) -- [ProvenanceAttributeRegisteredFields](subgraphs.DIDRegistry.md#provenanceattributeregisteredfields) -- [ProvenanceAttributeRegisteredFilter](subgraphs.DIDRegistry.md#provenanceattributeregisteredfilter) -- [ProvenanceAttributeRegisteredResult](subgraphs.DIDRegistry.md#provenanceattributeregisteredresult) -- [SingleQueryOptions](subgraphs.DIDRegistry.md#singlequeryoptions) -- [UsedArgs](subgraphs.DIDRegistry.md#usedargs) -- [UsedFields](subgraphs.DIDRegistry.md#usedfields) -- [UsedFilter](subgraphs.DIDRegistry.md#usedfilter) -- [UsedResult](subgraphs.DIDRegistry.md#usedresult) -- [WasAssociatedWithArgs](subgraphs.DIDRegistry.md#wasassociatedwithargs) -- [WasAssociatedWithFields](subgraphs.DIDRegistry.md#wasassociatedwithfields) -- [WasAssociatedWithFilter](subgraphs.DIDRegistry.md#wasassociatedwithfilter) -- [WasAssociatedWithResult](subgraphs.DIDRegistry.md#wasassociatedwithresult) -- [WasDerivedFromArgs](subgraphs.DIDRegistry.md#wasderivedfromargs) -- [WasDerivedFromFields](subgraphs.DIDRegistry.md#wasderivedfromfields) -- [WasDerivedFromFilter](subgraphs.DIDRegistry.md#wasderivedfromfilter) -- [WasDerivedFromResult](subgraphs.DIDRegistry.md#wasderivedfromresult) -- [WasGeneratedByArgs](subgraphs.DIDRegistry.md#wasgeneratedbyargs) -- [WasGeneratedByFields](subgraphs.DIDRegistry.md#wasgeneratedbyfields) -- [WasGeneratedByFilter](subgraphs.DIDRegistry.md#wasgeneratedbyfilter) -- [WasGeneratedByResult](subgraphs.DIDRegistry.md#wasgeneratedbyresult) - -### Functions - -- [getActedOnBehalfById](subgraphs.DIDRegistry.md#getactedonbehalfbyid) -- [getActedOnBehalfs](subgraphs.DIDRegistry.md#getactedonbehalfs) -- [getDIDAttributeRegisteredById](subgraphs.DIDRegistry.md#getdidattributeregisteredbyid) -- [getDIDAttributeRegistereds](subgraphs.DIDRegistry.md#getdidattributeregistereds) -- [getDIDOwnershipTransferredById](subgraphs.DIDRegistry.md#getdidownershiptransferredbyid) -- [getDIDOwnershipTransferreds](subgraphs.DIDRegistry.md#getdidownershiptransferreds) -- [getDIDPermissionGrantedById](subgraphs.DIDRegistry.md#getdidpermissiongrantedbyid) -- [getDIDPermissionGranteds](subgraphs.DIDRegistry.md#getdidpermissiongranteds) -- [getDIDPermissionRevokedById](subgraphs.DIDRegistry.md#getdidpermissionrevokedbyid) -- [getDIDPermissionRevokeds](subgraphs.DIDRegistry.md#getdidpermissionrevokeds) -- [getDIDProvenanceDelegateAddedById](subgraphs.DIDRegistry.md#getdidprovenancedelegateaddedbyid) -- [getDIDProvenanceDelegateAddeds](subgraphs.DIDRegistry.md#getdidprovenancedelegateaddeds) -- [getDIDProvenanceDelegateRemovedById](subgraphs.DIDRegistry.md#getdidprovenancedelegateremovedbyid) -- [getDIDProvenanceDelegateRemoveds](subgraphs.DIDRegistry.md#getdidprovenancedelegateremoveds) -- [getDIDProviderAddedById](subgraphs.DIDRegistry.md#getdidprovideraddedbyid) -- [getDIDProviderAddeds](subgraphs.DIDRegistry.md#getdidprovideraddeds) -- [getDIDProviderRemovedById](subgraphs.DIDRegistry.md#getdidproviderremovedbyid) -- [getDIDProviderRemoveds](subgraphs.DIDRegistry.md#getdidproviderremoveds) -- [getDIDRoyaltiesAddedById](subgraphs.DIDRegistry.md#getdidroyaltiesaddedbyid) -- [getDIDRoyaltiesAddeds](subgraphs.DIDRegistry.md#getdidroyaltiesaddeds) -- [getDIDRoyaltyRecipientChangedById](subgraphs.DIDRegistry.md#getdidroyaltyrecipientchangedbyid) -- [getDIDRoyaltyRecipientChangeds](subgraphs.DIDRegistry.md#getdidroyaltyrecipientchangeds) -- [getInitializedById](subgraphs.DIDRegistry.md#getinitializedbyid) -- [getInitializeds](subgraphs.DIDRegistry.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.DIDRegistry.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.DIDRegistry.md#getownershiptransferreds) -- [getProvenanceAttributeRegisteredById](subgraphs.DIDRegistry.md#getprovenanceattributeregisteredbyid) -- [getProvenanceAttributeRegistereds](subgraphs.DIDRegistry.md#getprovenanceattributeregistereds) -- [getUsedById](subgraphs.DIDRegistry.md#getusedbyid) -- [getUseds](subgraphs.DIDRegistry.md#getuseds) -- [getWasAssociatedWithById](subgraphs.DIDRegistry.md#getwasassociatedwithbyid) -- [getWasAssociatedWiths](subgraphs.DIDRegistry.md#getwasassociatedwiths) -- [getWasDerivedFromById](subgraphs.DIDRegistry.md#getwasderivedfrombyid) -- [getWasDerivedFroms](subgraphs.DIDRegistry.md#getwasderivedfroms) -- [getWasGeneratedByById](subgraphs.DIDRegistry.md#getwasgeneratedbybyid) -- [getWasGeneratedBys](subgraphs.DIDRegistry.md#getwasgeneratedbys) - -## Type Aliases - -### ActedOnBehalfArgs - -Ƭ **ActedOnBehalfArgs**<`K`\>: { [Property in keyof Pick]: ActedOnBehalfFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------- | -| `K` | extends keyof [`ActedOnBehalfResult`](subgraphs.DIDRegistry.md#actedonbehalfresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:109 - ---- - -### ActedOnBehalfFields - -Ƭ **ActedOnBehalfFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------- | :----- | -| `_activityId` | `true` | -| `_attributes` | `true` | -| `_blockNumberUpdated` | `true` | -| `_delegateAgentId` | `true` | -| `_entityDid` | `true` | -| `_responsibleAgentId` | `true` | -| `id` | `true` | -| `provId` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:99 - ---- - -### ActedOnBehalfFilter - -Ƭ **ActedOnBehalfFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------------------------ | :-------------------- | -| `_activityId?` | `string` \| `null` | -| `_activityId_contains?` | `string` \| `null` | -| `_activityId_in?` | `string`[] | -| `_activityId_not?` | `string` \| `null` | -| `_activityId_not_contains?` | `string` \| `null` | -| `_activityId_not_in?` | `string`[] | -| `_attributes?` | `string` \| `null` | -| `_attributes_contains?` | `string` \| `null` | -| `_attributes_contains_nocase?` | `string` \| `null` | -| `_attributes_ends_with?` | `string` \| `null` | -| `_attributes_ends_with_nocase?` | `string` \| `null` | -| `_attributes_gt?` | `string` \| `null` | -| `_attributes_gte?` | `string` \| `null` | -| `_attributes_in?` | `string`[] | -| `_attributes_lt?` | `string` \| `null` | -| `_attributes_lte?` | `string` \| `null` | -| `_attributes_not?` | `string` \| `null` | -| `_attributes_not_contains?` | `string` \| `null` | -| `_attributes_not_contains_nocase?` | `string` \| `null` | -| `_attributes_not_ends_with?` | `string` \| `null` | -| `_attributes_not_ends_with_nocase?` | `string` \| `null` | -| `_attributes_not_in?` | `string`[] | -| `_attributes_not_starts_with?` | `string` \| `null` | -| `_attributes_not_starts_with_nocase?` | `string` \| `null` | -| `_attributes_starts_with?` | `string` \| `null` | -| `_attributes_starts_with_nocase?` | `string` \| `null` | -| `_blockNumberUpdated?` | `WeiSource` \| `null` | -| `_blockNumberUpdated_gt?` | `WeiSource` \| `null` | -| `_blockNumberUpdated_gte?` | `WeiSource` \| `null` | -| `_blockNumberUpdated_in?` | `WeiSource`[] | -| `_blockNumberUpdated_lt?` | `WeiSource` \| `null` | -| `_blockNumberUpdated_lte?` | `WeiSource` \| `null` | -| `_blockNumberUpdated_not?` | `WeiSource` \| `null` | -| `_blockNumberUpdated_not_in?` | `WeiSource`[] | -| `_delegateAgentId?` | `string` \| `null` | -| `_delegateAgentId_contains?` | `string` \| `null` | -| `_delegateAgentId_in?` | `string`[] | -| `_delegateAgentId_not?` | `string` \| `null` | -| `_delegateAgentId_not_contains?` | `string` \| `null` | -| `_delegateAgentId_not_in?` | `string`[] | -| `_entityDid?` | `string` \| `null` | -| `_entityDid_contains?` | `string` \| `null` | -| `_entityDid_in?` | `string`[] | -| `_entityDid_not?` | `string` \| `null` | -| `_entityDid_not_contains?` | `string` \| `null` | -| `_entityDid_not_in?` | `string`[] | -| `_responsibleAgentId?` | `string` \| `null` | -| `_responsibleAgentId_contains?` | `string` \| `null` | -| `_responsibleAgentId_in?` | `string`[] | -| `_responsibleAgentId_not?` | `string` \| `null` | -| `_responsibleAgentId_not_contains?` | `string` \| `null` | -| `_responsibleAgentId_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `provId?` | `string` \| `null` | -| `provId_contains?` | `string` \| `null` | -| `provId_in?` | `string`[] | -| `provId_not?` | `string` \| `null` | -| `provId_not_contains?` | `string` \| `null` | -| `provId_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:21 - ---- - -### ActedOnBehalfResult - -Ƭ **ActedOnBehalfResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------- | :------- | -| `_activityId` | `string` | -| `_attributes` | `string` | -| `_blockNumberUpdated` | `Wei` | -| `_delegateAgentId` | `string` | -| `_entityDid` | `string` | -| `_responsibleAgentId` | `string` | -| `id` | `string` | -| `provId` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:89 - ---- - -### DIDAttributeRegisteredArgs - -Ƭ **DIDAttributeRegisteredArgs**<`K`\>: { [Property in keyof Pick]: DIDAttributeRegisteredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`DIDAttributeRegisteredResult`](subgraphs.DIDRegistry.md#didattributeregisteredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:194 - ---- - -### DIDAttributeRegisteredFields - -Ƭ **DIDAttributeRegisteredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------- | :----- | -| `_blockNumberUpdated` | `true` | -| `_checksum` | `true` | -| `_did` | `true` | -| `_lastUpdatedBy` | `true` | -| `_owner` | `true` | -| `_value` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:185 - ---- - -### DIDAttributeRegisteredFilter - -Ƭ **DIDAttributeRegisteredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------------------- | :-------------------- | -| `_blockNumberUpdated?` | `WeiSource` \| `null` | -| `_blockNumberUpdated_gt?` | `WeiSource` \| `null` | -| `_blockNumberUpdated_gte?` | `WeiSource` \| `null` | -| `_blockNumberUpdated_in?` | `WeiSource`[] | -| `_blockNumberUpdated_lt?` | `WeiSource` \| `null` | -| `_blockNumberUpdated_lte?` | `WeiSource` \| `null` | -| `_blockNumberUpdated_not?` | `WeiSource` \| `null` | -| `_blockNumberUpdated_not_in?` | `WeiSource`[] | -| `_checksum?` | `string` \| `null` | -| `_checksum_contains?` | `string` \| `null` | -| `_checksum_in?` | `string`[] | -| `_checksum_not?` | `string` \| `null` | -| `_checksum_not_contains?` | `string` \| `null` | -| `_checksum_not_in?` | `string`[] | -| `_did?` | `string` \| `null` | -| `_did_contains?` | `string` \| `null` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| `null` | -| `_did_not_contains?` | `string` \| `null` | -| `_did_not_in?` | `string`[] | -| `_lastUpdatedBy?` | `string` \| `null` | -| `_lastUpdatedBy_contains?` | `string` \| `null` | -| `_lastUpdatedBy_in?` | `string`[] | -| `_lastUpdatedBy_not?` | `string` \| `null` | -| `_lastUpdatedBy_not_contains?` | `string` \| `null` | -| `_lastUpdatedBy_not_in?` | `string`[] | -| `_owner?` | `string` \| `null` | -| `_owner_contains?` | `string` \| `null` | -| `_owner_in?` | `string`[] | -| `_owner_not?` | `string` \| `null` | -| `_owner_not_contains?` | `string` \| `null` | -| `_owner_not_in?` | `string`[] | -| `_value?` | `string` \| `null` | -| `_value_contains?` | `string` \| `null` | -| `_value_contains_nocase?` | `string` \| `null` | -| `_value_ends_with?` | `string` \| `null` | -| `_value_ends_with_nocase?` | `string` \| `null` | -| `_value_gt?` | `string` \| `null` | -| `_value_gte?` | `string` \| `null` | -| `_value_in?` | `string`[] | -| `_value_lt?` | `string` \| `null` | -| `_value_lte?` | `string` \| `null` | -| `_value_not?` | `string` \| `null` | -| `_value_not_contains?` | `string` \| `null` | -| `_value_not_contains_nocase?` | `string` \| `null` | -| `_value_not_ends_with?` | `string` \| `null` | -| `_value_not_ends_with_nocase?` | `string` \| `null` | -| `_value_not_in?` | `string`[] | -| `_value_not_starts_with?` | `string` \| `null` | -| `_value_not_starts_with_nocase?` | `string` \| `null` | -| `_value_starts_with?` | `string` \| `null` | -| `_value_starts_with_nocase?` | `string` \| `null` | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:114 - ---- - -### DIDAttributeRegisteredResult - -Ƭ **DIDAttributeRegisteredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------- | :------- | -| `_blockNumberUpdated` | `Wei` | -| `_checksum` | `string` | -| `_did` | `string` | -| `_lastUpdatedBy` | `string` | -| `_owner` | `string` | -| `_value` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:176 - ---- - -### DIDOwnershipTransferredArgs - -Ƭ **DIDOwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: DIDOwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`DIDOwnershipTransferredResult`](subgraphs.DIDRegistry.md#didownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:239 - ---- - -### DIDOwnershipTransferredFields - -Ƭ **DIDOwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------- | :----- | -| `_did` | `true` | -| `_newOwner` | `true` | -| `_previousOwner` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:233 - ---- - -### DIDOwnershipTransferredFilter - -Ƭ **DIDOwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :----------------------------- | :----------------- | -| `_did?` | `string` \| `null` | -| `_did_contains?` | `string` \| `null` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| `null` | -| `_did_not_contains?` | `string` \| `null` | -| `_did_not_in?` | `string`[] | -| `_newOwner?` | `string` \| `null` | -| `_newOwner_contains?` | `string` \| `null` | -| `_newOwner_in?` | `string`[] | -| `_newOwner_not?` | `string` \| `null` | -| `_newOwner_not_contains?` | `string` \| `null` | -| `_newOwner_not_in?` | `string`[] | -| `_previousOwner?` | `string` \| `null` | -| `_previousOwner_contains?` | `string` \| `null` | -| `_previousOwner_in?` | `string`[] | -| `_previousOwner_not?` | `string` \| `null` | -| `_previousOwner_not_contains?` | `string` \| `null` | -| `_previousOwner_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:199 - ---- - -### DIDOwnershipTransferredResult - -Ƭ **DIDOwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------- | :------- | -| `_did` | `string` | -| `_newOwner` | `string` | -| `_previousOwner` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:227 - ---- - -### DIDPermissionGrantedArgs - -Ƭ **DIDPermissionGrantedArgs**<`K`\>: { [Property in keyof Pick]: DIDPermissionGrantedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`DIDPermissionGrantedResult`](subgraphs.DIDRegistry.md#didpermissiongrantedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:284 - ---- - -### DIDPermissionGrantedFields - -Ƭ **DIDPermissionGrantedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :--------- | :----- | -| `_did` | `true` | -| `_grantee` | `true` | -| `_owner` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:278 - ---- - -### DIDPermissionGrantedFilter - -Ƭ **DIDPermissionGrantedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :----------------------- | :----------------- | -| `_did?` | `string` \| `null` | -| `_did_contains?` | `string` \| `null` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| `null` | -| `_did_not_contains?` | `string` \| `null` | -| `_did_not_in?` | `string`[] | -| `_grantee?` | `string` \| `null` | -| `_grantee_contains?` | `string` \| `null` | -| `_grantee_in?` | `string`[] | -| `_grantee_not?` | `string` \| `null` | -| `_grantee_not_contains?` | `string` \| `null` | -| `_grantee_not_in?` | `string`[] | -| `_owner?` | `string` \| `null` | -| `_owner_contains?` | `string` \| `null` | -| `_owner_in?` | `string`[] | -| `_owner_not?` | `string` \| `null` | -| `_owner_not_contains?` | `string` \| `null` | -| `_owner_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:244 - ---- - -### DIDPermissionGrantedResult - -Ƭ **DIDPermissionGrantedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :--------- | :------- | -| `_did` | `string` | -| `_grantee` | `string` | -| `_owner` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:272 - ---- - -### DIDPermissionRevokedArgs - -Ƭ **DIDPermissionRevokedArgs**<`K`\>: { [Property in keyof Pick]: DIDPermissionRevokedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`DIDPermissionRevokedResult`](subgraphs.DIDRegistry.md#didpermissionrevokedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:329 - ---- - -### DIDPermissionRevokedFields - -Ƭ **DIDPermissionRevokedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :--------- | :----- | -| `_did` | `true` | -| `_grantee` | `true` | -| `_owner` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:323 - ---- - -### DIDPermissionRevokedFilter - -Ƭ **DIDPermissionRevokedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :----------------------- | :----------------- | -| `_did?` | `string` \| `null` | -| `_did_contains?` | `string` \| `null` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| `null` | -| `_did_not_contains?` | `string` \| `null` | -| `_did_not_in?` | `string`[] | -| `_grantee?` | `string` \| `null` | -| `_grantee_contains?` | `string` \| `null` | -| `_grantee_in?` | `string`[] | -| `_grantee_not?` | `string` \| `null` | -| `_grantee_not_contains?` | `string` \| `null` | -| `_grantee_not_in?` | `string`[] | -| `_owner?` | `string` \| `null` | -| `_owner_contains?` | `string` \| `null` | -| `_owner_in?` | `string`[] | -| `_owner_not?` | `string` \| `null` | -| `_owner_not_contains?` | `string` \| `null` | -| `_owner_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:289 - ---- - -### DIDPermissionRevokedResult - -Ƭ **DIDPermissionRevokedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :--------- | :------- | -| `_did` | `string` | -| `_grantee` | `string` | -| `_owner` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:317 - ---- - -### DIDProvenanceDelegateAddedArgs - -Ƭ **DIDProvenanceDelegateAddedArgs**<`K`\>: { [Property in keyof Pick]: DIDProvenanceDelegateAddedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`DIDProvenanceDelegateAddedResult`](subgraphs.DIDRegistry.md#didprovenancedelegateaddedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:366 - ---- - -### DIDProvenanceDelegateAddedFields - -Ƭ **DIDProvenanceDelegateAddedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :---------- | :----- | -| `_delegate` | `true` | -| `_did` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:361 - ---- - -### DIDProvenanceDelegateAddedFilter - -Ƭ **DIDProvenanceDelegateAddedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------------ | :----------------- | -| `_delegate?` | `string` \| `null` | -| `_delegate_contains?` | `string` \| `null` | -| `_delegate_in?` | `string`[] | -| `_delegate_not?` | `string` \| `null` | -| `_delegate_not_contains?` | `string` \| `null` | -| `_delegate_not_in?` | `string`[] | -| `_did?` | `string` \| `null` | -| `_did_contains?` | `string` \| `null` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| `null` | -| `_did_not_contains?` | `string` \| `null` | -| `_did_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:334 - ---- - -### DIDProvenanceDelegateAddedResult - -Ƭ **DIDProvenanceDelegateAddedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :---------- | :------- | -| `_delegate` | `string` | -| `_did` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:356 - ---- - -### DIDProvenanceDelegateRemovedArgs - -Ƭ **DIDProvenanceDelegateRemovedArgs**<`K`\>: { [Property in keyof Pick]: DIDProvenanceDelegateRemovedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`DIDProvenanceDelegateRemovedResult`](subgraphs.DIDRegistry.md#didprovenancedelegateremovedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:409 - ---- - -### DIDProvenanceDelegateRemovedFields - -Ƭ **DIDProvenanceDelegateRemovedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :---------- | :----- | -| `_delegate` | `true` | -| `_did` | `true` | -| `id` | `true` | -| `state` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:403 - ---- - -### DIDProvenanceDelegateRemovedFilter - -Ƭ **DIDProvenanceDelegateRemovedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------------ | :------------------ | -| `_delegate?` | `string` \| `null` | -| `_delegate_contains?` | `string` \| `null` | -| `_delegate_in?` | `string`[] | -| `_delegate_not?` | `string` \| `null` | -| `_delegate_not_contains?` | `string` \| `null` | -| `_delegate_not_in?` | `string`[] | -| `_did?` | `string` \| `null` | -| `_did_contains?` | `string` \| `null` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| `null` | -| `_did_not_contains?` | `string` \| `null` | -| `_did_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `state?` | `boolean` \| `null` | -| `state_in?` | `boolean`[] | -| `state_not?` | `boolean` \| `null` | -| `state_not_in?` | `boolean`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:371 - ---- - -### DIDProvenanceDelegateRemovedResult - -Ƭ **DIDProvenanceDelegateRemovedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :---------- | :-------- | -| `_delegate` | `string` | -| `_did` | `string` | -| `id` | `string` | -| `state` | `boolean` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:397 - ---- - -### DIDProviderAddedArgs - -Ƭ **DIDProviderAddedArgs**<`K`\>: { [Property in keyof Pick]: DIDProviderAddedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------- | -| `K` | extends keyof [`DIDProviderAddedResult`](subgraphs.DIDRegistry.md#didprovideraddedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:446 - ---- - -### DIDProviderAddedFields - -Ƭ **DIDProviderAddedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :---------- | :----- | -| `_did` | `true` | -| `_provider` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:441 - ---- - -### DIDProviderAddedFilter - -Ƭ **DIDProviderAddedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------------ | :----------------- | -| `_did?` | `string` \| `null` | -| `_did_contains?` | `string` \| `null` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| `null` | -| `_did_not_contains?` | `string` \| `null` | -| `_did_not_in?` | `string`[] | -| `_provider?` | `string` \| `null` | -| `_provider_contains?` | `string` \| `null` | -| `_provider_in?` | `string`[] | -| `_provider_not?` | `string` \| `null` | -| `_provider_not_contains?` | `string` \| `null` | -| `_provider_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:414 - ---- - -### DIDProviderAddedResult - -Ƭ **DIDProviderAddedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :---------- | :------- | -| `_did` | `string` | -| `_provider` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:436 - ---- - -### DIDProviderRemovedArgs - -Ƭ **DIDProviderRemovedArgs**<`K`\>: { [Property in keyof Pick]: DIDProviderRemovedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`DIDProviderRemovedResult`](subgraphs.DIDRegistry.md#didproviderremovedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:489 - ---- - -### DIDProviderRemovedFields - -Ƭ **DIDProviderRemovedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :---------- | :----- | -| `_did` | `true` | -| `_provider` | `true` | -| `id` | `true` | -| `state` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:483 - ---- - -### DIDProviderRemovedFilter - -Ƭ **DIDProviderRemovedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------------ | :------------------ | -| `_did?` | `string` \| `null` | -| `_did_contains?` | `string` \| `null` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| `null` | -| `_did_not_contains?` | `string` \| `null` | -| `_did_not_in?` | `string`[] | -| `_provider?` | `string` \| `null` | -| `_provider_contains?` | `string` \| `null` | -| `_provider_in?` | `string`[] | -| `_provider_not?` | `string` \| `null` | -| `_provider_not_contains?` | `string` \| `null` | -| `_provider_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `state?` | `boolean` \| `null` | -| `state_in?` | `boolean`[] | -| `state_not?` | `boolean` \| `null` | -| `state_not_in?` | `boolean`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:451 - ---- - -### DIDProviderRemovedResult - -Ƭ **DIDProviderRemovedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :---------- | :-------- | -| `_did` | `string` | -| `_provider` | `string` | -| `id` | `string` | -| `state` | `boolean` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:477 - ---- - -### DIDRoyaltiesAddedArgs - -Ƭ **DIDRoyaltiesAddedArgs**<`K`\>: { [Property in keyof Pick]: DIDRoyaltiesAddedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`DIDRoyaltiesAddedResult`](subgraphs.DIDRegistry.md#didroyaltiesaddedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:526 - ---- - -### DIDRoyaltiesAddedFields - -Ƭ **DIDRoyaltiesAddedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :----- | :----- | -| `addr` | `true` | -| `did` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:521 - ---- - -### DIDRoyaltiesAddedFilter - -Ƭ **DIDRoyaltiesAddedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------- | :----------------- | -| `addr?` | `string` \| `null` | -| `addr_contains?` | `string` \| `null` | -| `addr_in?` | `string`[] | -| `addr_not?` | `string` \| `null` | -| `addr_not_contains?` | `string` \| `null` | -| `addr_not_in?` | `string`[] | -| `did?` | `string` \| `null` | -| `did_contains?` | `string` \| `null` | -| `did_in?` | `string`[] | -| `did_not?` | `string` \| `null` | -| `did_not_contains?` | `string` \| `null` | -| `did_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:494 - ---- - -### DIDRoyaltiesAddedResult - -Ƭ **DIDRoyaltiesAddedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :----- | :------- | -| `addr` | `string` | -| `did` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:516 - ---- - -### DIDRoyaltyRecipientChangedArgs - -Ƭ **DIDRoyaltyRecipientChangedArgs**<`K`\>: { [Property in keyof Pick]: DIDRoyaltyRecipientChangedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`DIDRoyaltyRecipientChangedResult`](subgraphs.DIDRegistry.md#didroyaltyrecipientchangedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:563 - ---- - -### DIDRoyaltyRecipientChangedFields - -Ƭ **DIDRoyaltyRecipientChangedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :----- | :----- | -| `addr` | `true` | -| `did` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:558 - ---- - -### DIDRoyaltyRecipientChangedFilter - -Ƭ **DIDRoyaltyRecipientChangedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------- | :----------------- | -| `addr?` | `string` \| `null` | -| `addr_contains?` | `string` \| `null` | -| `addr_in?` | `string`[] | -| `addr_not?` | `string` \| `null` | -| `addr_not_contains?` | `string` \| `null` | -| `addr_not_in?` | `string`[] | -| `did?` | `string` \| `null` | -| `did_contains?` | `string` \| `null` | -| `did_in?` | `string`[] | -| `did_not?` | `string` \| `null` | -| `did_not_contains?` | `string` \| `null` | -| `did_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:531 - ---- - -### DIDRoyaltyRecipientChangedResult - -Ƭ **DIDRoyaltyRecipientChangedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :----- | :------- | -| `addr` | `string` | -| `did` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:553 - ---- - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.DIDRegistry.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:594 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:590 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:568 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:586 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:10 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.DIDRegistry.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:631 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:626 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:599 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:621 - ---- - -### ProvenanceAttributeRegisteredArgs - -Ƭ **ProvenanceAttributeRegisteredArgs**<`K`\>: { [Property in keyof Pick]: ProvenanceAttributeRegisteredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`ProvenanceAttributeRegisteredResult`](subgraphs.DIDRegistry.md#provenanceattributeregisteredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:742 - ---- - -### ProvenanceAttributeRegisteredFields - -Ƭ **ProvenanceAttributeRegisteredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------- | :----- | -| `_activityId` | `true` | -| `_agentId` | `true` | -| `_agentInvolvedId` | `true` | -| `_attributes` | `true` | -| `_blockNumberUpdated` | `true` | -| `_did` | `true` | -| `_method` | `true` | -| `_relatedDid` | `true` | -| `id` | `true` | -| `provId` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:730 - ---- - -### ProvenanceAttributeRegisteredFilter - -Ƭ **ProvenanceAttributeRegisteredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------------------------ | :-------------------- | -| `_activityId?` | `string` \| `null` | -| `_activityId_contains?` | `string` \| `null` | -| `_activityId_in?` | `string`[] | -| `_activityId_not?` | `string` \| `null` | -| `_activityId_not_contains?` | `string` \| `null` | -| `_activityId_not_in?` | `string`[] | -| `_agentId?` | `string` \| `null` | -| `_agentId_contains?` | `string` \| `null` | -| `_agentId_in?` | `string`[] | -| `_agentId_not?` | `string` \| `null` | -| `_agentId_not_contains?` | `string` \| `null` | -| `_agentId_not_in?` | `string`[] | -| `_agentInvolvedId?` | `string` \| `null` | -| `_agentInvolvedId_contains?` | `string` \| `null` | -| `_agentInvolvedId_in?` | `string`[] | -| `_agentInvolvedId_not?` | `string` \| `null` | -| `_agentInvolvedId_not_contains?` | `string` \| `null` | -| `_agentInvolvedId_not_in?` | `string`[] | -| `_attributes?` | `string` \| `null` | -| `_attributes_contains?` | `string` \| `null` | -| `_attributes_contains_nocase?` | `string` \| `null` | -| `_attributes_ends_with?` | `string` \| `null` | -| `_attributes_ends_with_nocase?` | `string` \| `null` | -| `_attributes_gt?` | `string` \| `null` | -| `_attributes_gte?` | `string` \| `null` | -| `_attributes_in?` | `string`[] | -| `_attributes_lt?` | `string` \| `null` | -| `_attributes_lte?` | `string` \| `null` | -| `_attributes_not?` | `string` \| `null` | -| `_attributes_not_contains?` | `string` \| `null` | -| `_attributes_not_contains_nocase?` | `string` \| `null` | -| `_attributes_not_ends_with?` | `string` \| `null` | -| `_attributes_not_ends_with_nocase?` | `string` \| `null` | -| `_attributes_not_in?` | `string`[] | -| `_attributes_not_starts_with?` | `string` \| `null` | -| `_attributes_not_starts_with_nocase?` | `string` \| `null` | -| `_attributes_starts_with?` | `string` \| `null` | -| `_attributes_starts_with_nocase?` | `string` \| `null` | -| `_blockNumberUpdated?` | `WeiSource` \| `null` | -| `_blockNumberUpdated_gt?` | `WeiSource` \| `null` | -| `_blockNumberUpdated_gte?` | `WeiSource` \| `null` | -| `_blockNumberUpdated_in?` | `WeiSource`[] | -| `_blockNumberUpdated_lt?` | `WeiSource` \| `null` | -| `_blockNumberUpdated_lte?` | `WeiSource` \| `null` | -| `_blockNumberUpdated_not?` | `WeiSource` \| `null` | -| `_blockNumberUpdated_not_in?` | `WeiSource`[] | -| `_did?` | `string` \| `null` | -| `_did_contains?` | `string` \| `null` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| `null` | -| `_did_not_contains?` | `string` \| `null` | -| `_did_not_in?` | `string`[] | -| `_method?` | `number` \| `null` | -| `_method_gt?` | `number` \| `null` | -| `_method_gte?` | `number` \| `null` | -| `_method_in?` | `number`[] | -| `_method_lt?` | `number` \| `null` | -| `_method_lte?` | `number` \| `null` | -| `_method_not?` | `number` \| `null` | -| `_method_not_in?` | `number`[] | -| `_relatedDid?` | `string` \| `null` | -| `_relatedDid_contains?` | `string` \| `null` | -| `_relatedDid_in?` | `string`[] | -| `_relatedDid_not?` | `string` \| `null` | -| `_relatedDid_not_contains?` | `string` \| `null` | -| `_relatedDid_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `provId?` | `string` \| `null` | -| `provId_contains?` | `string` \| `null` | -| `provId_in?` | `string`[] | -| `provId_not?` | `string` \| `null` | -| `provId_not_contains?` | `string` \| `null` | -| `provId_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:636 - ---- - -### ProvenanceAttributeRegisteredResult - -Ƭ **ProvenanceAttributeRegisteredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------- | :------- | -| `_activityId` | `string` | -| `_agentId` | `string` | -| `_agentInvolvedId` | `string` | -| `_attributes` | `string` | -| `_blockNumberUpdated` | `Wei` | -| `_did` | `string` | -| `_method` | `number` | -| `_relatedDid` | `string` | -| `id` | `string` | -| `provId` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:718 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:2 - ---- - -### UsedArgs - -Ƭ **UsedArgs**<`K`\>: { [Property in keyof Pick]: UsedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------- | -| `K` | extends keyof [`UsedResult`](subgraphs.DIDRegistry.md#usedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:827 - ---- - -### UsedFields - -Ƭ **UsedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------- | :----- | -| `_activityId` | `true` | -| `_agentId` | `true` | -| `_attributes` | `true` | -| `_blockNumberUpdated` | `true` | -| `_did` | `true` | -| `id` | `true` | -| `provId` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:818 - ---- - -### UsedFilter - -Ƭ **UsedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------------------------ | :-------------------- | -| `_activityId?` | `string` \| `null` | -| `_activityId_contains?` | `string` \| `null` | -| `_activityId_in?` | `string`[] | -| `_activityId_not?` | `string` \| `null` | -| `_activityId_not_contains?` | `string` \| `null` | -| `_activityId_not_in?` | `string`[] | -| `_agentId?` | `string` \| `null` | -| `_agentId_contains?` | `string` \| `null` | -| `_agentId_in?` | `string`[] | -| `_agentId_not?` | `string` \| `null` | -| `_agentId_not_contains?` | `string` \| `null` | -| `_agentId_not_in?` | `string`[] | -| `_attributes?` | `string` \| `null` | -| `_attributes_contains?` | `string` \| `null` | -| `_attributes_contains_nocase?` | `string` \| `null` | -| `_attributes_ends_with?` | `string` \| `null` | -| `_attributes_ends_with_nocase?` | `string` \| `null` | -| `_attributes_gt?` | `string` \| `null` | -| `_attributes_gte?` | `string` \| `null` | -| `_attributes_in?` | `string`[] | -| `_attributes_lt?` | `string` \| `null` | -| `_attributes_lte?` | `string` \| `null` | -| `_attributes_not?` | `string` \| `null` | -| `_attributes_not_contains?` | `string` \| `null` | -| `_attributes_not_contains_nocase?` | `string` \| `null` | -| `_attributes_not_ends_with?` | `string` \| `null` | -| `_attributes_not_ends_with_nocase?` | `string` \| `null` | -| `_attributes_not_in?` | `string`[] | -| `_attributes_not_starts_with?` | `string` \| `null` | -| `_attributes_not_starts_with_nocase?` | `string` \| `null` | -| `_attributes_starts_with?` | `string` \| `null` | -| `_attributes_starts_with_nocase?` | `string` \| `null` | -| `_blockNumberUpdated?` | `WeiSource` \| `null` | -| `_blockNumberUpdated_gt?` | `WeiSource` \| `null` | -| `_blockNumberUpdated_gte?` | `WeiSource` \| `null` | -| `_blockNumberUpdated_in?` | `WeiSource`[] | -| `_blockNumberUpdated_lt?` | `WeiSource` \| `null` | -| `_blockNumberUpdated_lte?` | `WeiSource` \| `null` | -| `_blockNumberUpdated_not?` | `WeiSource` \| `null` | -| `_blockNumberUpdated_not_in?` | `WeiSource`[] | -| `_did?` | `string` \| `null` | -| `_did_contains?` | `string` \| `null` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| `null` | -| `_did_not_contains?` | `string` \| `null` | -| `_did_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `provId?` | `string` \| `null` | -| `provId_contains?` | `string` \| `null` | -| `provId_in?` | `string`[] | -| `provId_not?` | `string` \| `null` | -| `provId_not_contains?` | `string` \| `null` | -| `provId_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:747 - ---- - -### UsedResult - -Ƭ **UsedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------- | :------- | -| `_activityId` | `string` | -| `_agentId` | `string` | -| `_attributes` | `string` | -| `_blockNumberUpdated` | `Wei` | -| `_did` | `string` | -| `id` | `string` | -| `provId` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:809 - ---- - -### WasAssociatedWithArgs - -Ƭ **WasAssociatedWithArgs**<`K`\>: { [Property in keyof Pick]: WasAssociatedWithFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`WasAssociatedWithResult`](subgraphs.DIDRegistry.md#wasassociatedwithresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:912 - ---- - -### WasAssociatedWithFields - -Ƭ **WasAssociatedWithFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------- | :----- | -| `_activityId` | `true` | -| `_agentId` | `true` | -| `_attributes` | `true` | -| `_blockNumberUpdated` | `true` | -| `_entityDid` | `true` | -| `id` | `true` | -| `provId` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:903 - ---- - -### WasAssociatedWithFilter - -Ƭ **WasAssociatedWithFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------------------------ | :-------------------- | -| `_activityId?` | `string` \| `null` | -| `_activityId_contains?` | `string` \| `null` | -| `_activityId_in?` | `string`[] | -| `_activityId_not?` | `string` \| `null` | -| `_activityId_not_contains?` | `string` \| `null` | -| `_activityId_not_in?` | `string`[] | -| `_agentId?` | `string` \| `null` | -| `_agentId_contains?` | `string` \| `null` | -| `_agentId_in?` | `string`[] | -| `_agentId_not?` | `string` \| `null` | -| `_agentId_not_contains?` | `string` \| `null` | -| `_agentId_not_in?` | `string`[] | -| `_attributes?` | `string` \| `null` | -| `_attributes_contains?` | `string` \| `null` | -| `_attributes_contains_nocase?` | `string` \| `null` | -| `_attributes_ends_with?` | `string` \| `null` | -| `_attributes_ends_with_nocase?` | `string` \| `null` | -| `_attributes_gt?` | `string` \| `null` | -| `_attributes_gte?` | `string` \| `null` | -| `_attributes_in?` | `string`[] | -| `_attributes_lt?` | `string` \| `null` | -| `_attributes_lte?` | `string` \| `null` | -| `_attributes_not?` | `string` \| `null` | -| `_attributes_not_contains?` | `string` \| `null` | -| `_attributes_not_contains_nocase?` | `string` \| `null` | -| `_attributes_not_ends_with?` | `string` \| `null` | -| `_attributes_not_ends_with_nocase?` | `string` \| `null` | -| `_attributes_not_in?` | `string`[] | -| `_attributes_not_starts_with?` | `string` \| `null` | -| `_attributes_not_starts_with_nocase?` | `string` \| `null` | -| `_attributes_starts_with?` | `string` \| `null` | -| `_attributes_starts_with_nocase?` | `string` \| `null` | -| `_blockNumberUpdated?` | `WeiSource` \| `null` | -| `_blockNumberUpdated_gt?` | `WeiSource` \| `null` | -| `_blockNumberUpdated_gte?` | `WeiSource` \| `null` | -| `_blockNumberUpdated_in?` | `WeiSource`[] | -| `_blockNumberUpdated_lt?` | `WeiSource` \| `null` | -| `_blockNumberUpdated_lte?` | `WeiSource` \| `null` | -| `_blockNumberUpdated_not?` | `WeiSource` \| `null` | -| `_blockNumberUpdated_not_in?` | `WeiSource`[] | -| `_entityDid?` | `string` \| `null` | -| `_entityDid_contains?` | `string` \| `null` | -| `_entityDid_in?` | `string`[] | -| `_entityDid_not?` | `string` \| `null` | -| `_entityDid_not_contains?` | `string` \| `null` | -| `_entityDid_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `provId?` | `string` \| `null` | -| `provId_contains?` | `string` \| `null` | -| `provId_in?` | `string`[] | -| `provId_not?` | `string` \| `null` | -| `provId_not_contains?` | `string` \| `null` | -| `provId_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:832 - ---- - -### WasAssociatedWithResult - -Ƭ **WasAssociatedWithResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------- | :------- | -| `_activityId` | `string` | -| `_agentId` | `string` | -| `_attributes` | `string` | -| `_blockNumberUpdated` | `Wei` | -| `_entityDid` | `string` | -| `id` | `string` | -| `provId` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:894 - ---- - -### WasDerivedFromArgs - -Ƭ **WasDerivedFromArgs**<`K`\>: { [Property in keyof Pick]: WasDerivedFromFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------ | -| `K` | extends keyof [`WasDerivedFromResult`](subgraphs.DIDRegistry.md#wasderivedfromresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:1005 - ---- - -### WasDerivedFromFields - -Ƭ **WasDerivedFromFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------- | :----- | -| `_activityId` | `true` | -| `_agentId` | `true` | -| `_attributes` | `true` | -| `_blockNumberUpdated` | `true` | -| `_newEntityDid` | `true` | -| `_usedEntityDid` | `true` | -| `id` | `true` | -| `provId` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:995 - ---- - -### WasDerivedFromFilter - -Ƭ **WasDerivedFromFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------------------------ | :-------------------- | -| `_activityId?` | `string` \| `null` | -| `_activityId_contains?` | `string` \| `null` | -| `_activityId_in?` | `string`[] | -| `_activityId_not?` | `string` \| `null` | -| `_activityId_not_contains?` | `string` \| `null` | -| `_activityId_not_in?` | `string`[] | -| `_agentId?` | `string` \| `null` | -| `_agentId_contains?` | `string` \| `null` | -| `_agentId_in?` | `string`[] | -| `_agentId_not?` | `string` \| `null` | -| `_agentId_not_contains?` | `string` \| `null` | -| `_agentId_not_in?` | `string`[] | -| `_attributes?` | `string` \| `null` | -| `_attributes_contains?` | `string` \| `null` | -| `_attributes_contains_nocase?` | `string` \| `null` | -| `_attributes_ends_with?` | `string` \| `null` | -| `_attributes_ends_with_nocase?` | `string` \| `null` | -| `_attributes_gt?` | `string` \| `null` | -| `_attributes_gte?` | `string` \| `null` | -| `_attributes_in?` | `string`[] | -| `_attributes_lt?` | `string` \| `null` | -| `_attributes_lte?` | `string` \| `null` | -| `_attributes_not?` | `string` \| `null` | -| `_attributes_not_contains?` | `string` \| `null` | -| `_attributes_not_contains_nocase?` | `string` \| `null` | -| `_attributes_not_ends_with?` | `string` \| `null` | -| `_attributes_not_ends_with_nocase?` | `string` \| `null` | -| `_attributes_not_in?` | `string`[] | -| `_attributes_not_starts_with?` | `string` \| `null` | -| `_attributes_not_starts_with_nocase?` | `string` \| `null` | -| `_attributes_starts_with?` | `string` \| `null` | -| `_attributes_starts_with_nocase?` | `string` \| `null` | -| `_blockNumberUpdated?` | `WeiSource` \| `null` | -| `_blockNumberUpdated_gt?` | `WeiSource` \| `null` | -| `_blockNumberUpdated_gte?` | `WeiSource` \| `null` | -| `_blockNumberUpdated_in?` | `WeiSource`[] | -| `_blockNumberUpdated_lt?` | `WeiSource` \| `null` | -| `_blockNumberUpdated_lte?` | `WeiSource` \| `null` | -| `_blockNumberUpdated_not?` | `WeiSource` \| `null` | -| `_blockNumberUpdated_not_in?` | `WeiSource`[] | -| `_newEntityDid?` | `string` \| `null` | -| `_newEntityDid_contains?` | `string` \| `null` | -| `_newEntityDid_in?` | `string`[] | -| `_newEntityDid_not?` | `string` \| `null` | -| `_newEntityDid_not_contains?` | `string` \| `null` | -| `_newEntityDid_not_in?` | `string`[] | -| `_usedEntityDid?` | `string` \| `null` | -| `_usedEntityDid_contains?` | `string` \| `null` | -| `_usedEntityDid_in?` | `string`[] | -| `_usedEntityDid_not?` | `string` \| `null` | -| `_usedEntityDid_not_contains?` | `string` \| `null` | -| `_usedEntityDid_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `provId?` | `string` \| `null` | -| `provId_contains?` | `string` \| `null` | -| `provId_in?` | `string`[] | -| `provId_not?` | `string` \| `null` | -| `provId_not_contains?` | `string` \| `null` | -| `provId_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:917 - ---- - -### WasDerivedFromResult - -Ƭ **WasDerivedFromResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------- | :------- | -| `_activityId` | `string` | -| `_agentId` | `string` | -| `_attributes` | `string` | -| `_blockNumberUpdated` | `Wei` | -| `_newEntityDid` | `string` | -| `_usedEntityDid` | `string` | -| `id` | `string` | -| `provId` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:985 - ---- - -### WasGeneratedByArgs - -Ƭ **WasGeneratedByArgs**<`K`\>: { [Property in keyof Pick]: WasGeneratedByFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------ | -| `K` | extends keyof [`WasGeneratedByResult`](subgraphs.DIDRegistry.md#wasgeneratedbyresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:1090 - ---- - -### WasGeneratedByFields - -Ƭ **WasGeneratedByFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------- | :----- | -| `_activityId` | `true` | -| `_agentId` | `true` | -| `_attributes` | `true` | -| `_blockNumberUpdated` | `true` | -| `_did` | `true` | -| `id` | `true` | -| `provId` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:1081 - ---- - -### WasGeneratedByFilter - -Ƭ **WasGeneratedByFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------------------------ | :-------------------- | -| `_activityId?` | `string` \| `null` | -| `_activityId_contains?` | `string` \| `null` | -| `_activityId_in?` | `string`[] | -| `_activityId_not?` | `string` \| `null` | -| `_activityId_not_contains?` | `string` \| `null` | -| `_activityId_not_in?` | `string`[] | -| `_agentId?` | `string` \| `null` | -| `_agentId_contains?` | `string` \| `null` | -| `_agentId_in?` | `string`[] | -| `_agentId_not?` | `string` \| `null` | -| `_agentId_not_contains?` | `string` \| `null` | -| `_agentId_not_in?` | `string`[] | -| `_attributes?` | `string` \| `null` | -| `_attributes_contains?` | `string` \| `null` | -| `_attributes_contains_nocase?` | `string` \| `null` | -| `_attributes_ends_with?` | `string` \| `null` | -| `_attributes_ends_with_nocase?` | `string` \| `null` | -| `_attributes_gt?` | `string` \| `null` | -| `_attributes_gte?` | `string` \| `null` | -| `_attributes_in?` | `string`[] | -| `_attributes_lt?` | `string` \| `null` | -| `_attributes_lte?` | `string` \| `null` | -| `_attributes_not?` | `string` \| `null` | -| `_attributes_not_contains?` | `string` \| `null` | -| `_attributes_not_contains_nocase?` | `string` \| `null` | -| `_attributes_not_ends_with?` | `string` \| `null` | -| `_attributes_not_ends_with_nocase?` | `string` \| `null` | -| `_attributes_not_in?` | `string`[] | -| `_attributes_not_starts_with?` | `string` \| `null` | -| `_attributes_not_starts_with_nocase?` | `string` \| `null` | -| `_attributes_starts_with?` | `string` \| `null` | -| `_attributes_starts_with_nocase?` | `string` \| `null` | -| `_blockNumberUpdated?` | `WeiSource` \| `null` | -| `_blockNumberUpdated_gt?` | `WeiSource` \| `null` | -| `_blockNumberUpdated_gte?` | `WeiSource` \| `null` | -| `_blockNumberUpdated_in?` | `WeiSource`[] | -| `_blockNumberUpdated_lt?` | `WeiSource` \| `null` | -| `_blockNumberUpdated_lte?` | `WeiSource` \| `null` | -| `_blockNumberUpdated_not?` | `WeiSource` \| `null` | -| `_blockNumberUpdated_not_in?` | `WeiSource`[] | -| `_did?` | `string` \| `null` | -| `_did_contains?` | `string` \| `null` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| `null` | -| `_did_not_contains?` | `string` \| `null` | -| `_did_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `provId?` | `string` \| `null` | -| `provId_contains?` | `string` \| `null` | -| `provId_in?` | `string`[] | -| `provId_not?` | `string` \| `null` | -| `provId_not_contains?` | `string` \| `null` | -| `provId_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:1010 - ---- - -### WasGeneratedByResult - -Ƭ **WasGeneratedByResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------- | :------- | -| `_activityId` | `string` | -| `_agentId` | `string` | -| `_attributes` | `string` | -| `_blockNumberUpdated` | `Wei` | -| `_did` | `string` | -| `id` | `string` | -| `provId` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:1072 - -## Functions - -### getActedOnBehalfById - -▸ **getActedOnBehalfById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ActedOnBehalfResult`](subgraphs.DIDRegistry.md#actedonbehalfresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------- | -| `K` | extends keyof [`ActedOnBehalfResult`](subgraphs.DIDRegistry.md#actedonbehalfresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DIDRegistry.md#singlequeryoptions) | -| `args` | [`ActedOnBehalfArgs`](subgraphs.DIDRegistry.md#actedonbehalfargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ActedOnBehalfResult`](subgraphs.DIDRegistry.md#actedonbehalfresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:112 - ---- - -### getActedOnBehalfs - -▸ **getActedOnBehalfs**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ActedOnBehalfResult`](subgraphs.DIDRegistry.md#actedonbehalfresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------- | -| `K` | extends keyof [`ActedOnBehalfResult`](subgraphs.DIDRegistry.md#actedonbehalfresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DIDRegistry.md#multiqueryoptions)<[`ActedOnBehalfFilter`](subgraphs.DIDRegistry.md#actedonbehalffilter), [`ActedOnBehalfResult`](subgraphs.DIDRegistry.md#actedonbehalfresult)\> | -| `args` | [`ActedOnBehalfArgs`](subgraphs.DIDRegistry.md#actedonbehalfargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ActedOnBehalfResult`](subgraphs.DIDRegistry.md#actedonbehalfresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:113 - ---- - -### getDIDAttributeRegisteredById - -▸ **getDIDAttributeRegisteredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`DIDAttributeRegisteredResult`](subgraphs.DIDRegistry.md#didattributeregisteredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`DIDAttributeRegisteredResult`](subgraphs.DIDRegistry.md#didattributeregisteredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DIDRegistry.md#singlequeryoptions) | -| `args` | [`DIDAttributeRegisteredArgs`](subgraphs.DIDRegistry.md#didattributeregisteredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`DIDAttributeRegisteredResult`](subgraphs.DIDRegistry.md#didattributeregisteredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:197 - ---- - -### getDIDAttributeRegistereds - -▸ **getDIDAttributeRegistereds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`DIDAttributeRegisteredResult`](subgraphs.DIDRegistry.md#didattributeregisteredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`DIDAttributeRegisteredResult`](subgraphs.DIDRegistry.md#didattributeregisteredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DIDRegistry.md#multiqueryoptions)<[`DIDAttributeRegisteredFilter`](subgraphs.DIDRegistry.md#didattributeregisteredfilter), [`DIDAttributeRegisteredResult`](subgraphs.DIDRegistry.md#didattributeregisteredresult)\> | -| `args` | [`DIDAttributeRegisteredArgs`](subgraphs.DIDRegistry.md#didattributeregisteredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`DIDAttributeRegisteredResult`](subgraphs.DIDRegistry.md#didattributeregisteredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:198 - ---- - -### getDIDOwnershipTransferredById - -▸ **getDIDOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`DIDOwnershipTransferredResult`](subgraphs.DIDRegistry.md#didownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`DIDOwnershipTransferredResult`](subgraphs.DIDRegistry.md#didownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DIDRegistry.md#singlequeryoptions) | -| `args` | [`DIDOwnershipTransferredArgs`](subgraphs.DIDRegistry.md#didownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`DIDOwnershipTransferredResult`](subgraphs.DIDRegistry.md#didownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:242 - ---- - -### getDIDOwnershipTransferreds - -▸ **getDIDOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`DIDOwnershipTransferredResult`](subgraphs.DIDRegistry.md#didownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`DIDOwnershipTransferredResult`](subgraphs.DIDRegistry.md#didownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DIDRegistry.md#multiqueryoptions)<[`DIDOwnershipTransferredFilter`](subgraphs.DIDRegistry.md#didownershiptransferredfilter), [`DIDOwnershipTransferredResult`](subgraphs.DIDRegistry.md#didownershiptransferredresult)\> | -| `args` | [`DIDOwnershipTransferredArgs`](subgraphs.DIDRegistry.md#didownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`DIDOwnershipTransferredResult`](subgraphs.DIDRegistry.md#didownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:243 - ---- - -### getDIDPermissionGrantedById - -▸ **getDIDPermissionGrantedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`DIDPermissionGrantedResult`](subgraphs.DIDRegistry.md#didpermissiongrantedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`DIDPermissionGrantedResult`](subgraphs.DIDRegistry.md#didpermissiongrantedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DIDRegistry.md#singlequeryoptions) | -| `args` | [`DIDPermissionGrantedArgs`](subgraphs.DIDRegistry.md#didpermissiongrantedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`DIDPermissionGrantedResult`](subgraphs.DIDRegistry.md#didpermissiongrantedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:287 - ---- - -### getDIDPermissionGranteds - -▸ **getDIDPermissionGranteds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`DIDPermissionGrantedResult`](subgraphs.DIDRegistry.md#didpermissiongrantedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`DIDPermissionGrantedResult`](subgraphs.DIDRegistry.md#didpermissiongrantedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DIDRegistry.md#multiqueryoptions)<[`DIDPermissionGrantedFilter`](subgraphs.DIDRegistry.md#didpermissiongrantedfilter), [`DIDPermissionGrantedResult`](subgraphs.DIDRegistry.md#didpermissiongrantedresult)\> | -| `args` | [`DIDPermissionGrantedArgs`](subgraphs.DIDRegistry.md#didpermissiongrantedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`DIDPermissionGrantedResult`](subgraphs.DIDRegistry.md#didpermissiongrantedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:288 - ---- - -### getDIDPermissionRevokedById - -▸ **getDIDPermissionRevokedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`DIDPermissionRevokedResult`](subgraphs.DIDRegistry.md#didpermissionrevokedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`DIDPermissionRevokedResult`](subgraphs.DIDRegistry.md#didpermissionrevokedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DIDRegistry.md#singlequeryoptions) | -| `args` | [`DIDPermissionRevokedArgs`](subgraphs.DIDRegistry.md#didpermissionrevokedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`DIDPermissionRevokedResult`](subgraphs.DIDRegistry.md#didpermissionrevokedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:332 - ---- - -### getDIDPermissionRevokeds - -▸ **getDIDPermissionRevokeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`DIDPermissionRevokedResult`](subgraphs.DIDRegistry.md#didpermissionrevokedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`DIDPermissionRevokedResult`](subgraphs.DIDRegistry.md#didpermissionrevokedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DIDRegistry.md#multiqueryoptions)<[`DIDPermissionRevokedFilter`](subgraphs.DIDRegistry.md#didpermissionrevokedfilter), [`DIDPermissionRevokedResult`](subgraphs.DIDRegistry.md#didpermissionrevokedresult)\> | -| `args` | [`DIDPermissionRevokedArgs`](subgraphs.DIDRegistry.md#didpermissionrevokedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`DIDPermissionRevokedResult`](subgraphs.DIDRegistry.md#didpermissionrevokedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:333 - ---- - -### getDIDProvenanceDelegateAddedById - -▸ **getDIDProvenanceDelegateAddedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`DIDProvenanceDelegateAddedResult`](subgraphs.DIDRegistry.md#didprovenancedelegateaddedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`DIDProvenanceDelegateAddedResult`](subgraphs.DIDRegistry.md#didprovenancedelegateaddedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DIDRegistry.md#singlequeryoptions) | -| `args` | [`DIDProvenanceDelegateAddedArgs`](subgraphs.DIDRegistry.md#didprovenancedelegateaddedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`DIDProvenanceDelegateAddedResult`](subgraphs.DIDRegistry.md#didprovenancedelegateaddedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:369 - ---- - -### getDIDProvenanceDelegateAddeds - -▸ **getDIDProvenanceDelegateAddeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`DIDProvenanceDelegateAddedResult`](subgraphs.DIDRegistry.md#didprovenancedelegateaddedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`DIDProvenanceDelegateAddedResult`](subgraphs.DIDRegistry.md#didprovenancedelegateaddedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DIDRegistry.md#multiqueryoptions)<[`DIDProvenanceDelegateAddedFilter`](subgraphs.DIDRegistry.md#didprovenancedelegateaddedfilter), [`DIDProvenanceDelegateAddedResult`](subgraphs.DIDRegistry.md#didprovenancedelegateaddedresult)\> | -| `args` | [`DIDProvenanceDelegateAddedArgs`](subgraphs.DIDRegistry.md#didprovenancedelegateaddedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`DIDProvenanceDelegateAddedResult`](subgraphs.DIDRegistry.md#didprovenancedelegateaddedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:370 - ---- - -### getDIDProvenanceDelegateRemovedById - -▸ **getDIDProvenanceDelegateRemovedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`DIDProvenanceDelegateRemovedResult`](subgraphs.DIDRegistry.md#didprovenancedelegateremovedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`DIDProvenanceDelegateRemovedResult`](subgraphs.DIDRegistry.md#didprovenancedelegateremovedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DIDRegistry.md#singlequeryoptions) | -| `args` | [`DIDProvenanceDelegateRemovedArgs`](subgraphs.DIDRegistry.md#didprovenancedelegateremovedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`DIDProvenanceDelegateRemovedResult`](subgraphs.DIDRegistry.md#didprovenancedelegateremovedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:412 - ---- - -### getDIDProvenanceDelegateRemoveds - -▸ **getDIDProvenanceDelegateRemoveds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`DIDProvenanceDelegateRemovedResult`](subgraphs.DIDRegistry.md#didprovenancedelegateremovedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`DIDProvenanceDelegateRemovedResult`](subgraphs.DIDRegistry.md#didprovenancedelegateremovedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DIDRegistry.md#multiqueryoptions)<[`DIDProvenanceDelegateRemovedFilter`](subgraphs.DIDRegistry.md#didprovenancedelegateremovedfilter), [`DIDProvenanceDelegateRemovedResult`](subgraphs.DIDRegistry.md#didprovenancedelegateremovedresult)\> | -| `args` | [`DIDProvenanceDelegateRemovedArgs`](subgraphs.DIDRegistry.md#didprovenancedelegateremovedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`DIDProvenanceDelegateRemovedResult`](subgraphs.DIDRegistry.md#didprovenancedelegateremovedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:413 - ---- - -### getDIDProviderAddedById - -▸ **getDIDProviderAddedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`DIDProviderAddedResult`](subgraphs.DIDRegistry.md#didprovideraddedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------- | -| `K` | extends keyof [`DIDProviderAddedResult`](subgraphs.DIDRegistry.md#didprovideraddedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DIDRegistry.md#singlequeryoptions) | -| `args` | [`DIDProviderAddedArgs`](subgraphs.DIDRegistry.md#didprovideraddedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`DIDProviderAddedResult`](subgraphs.DIDRegistry.md#didprovideraddedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:449 - ---- - -### getDIDProviderAddeds - -▸ **getDIDProviderAddeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`DIDProviderAddedResult`](subgraphs.DIDRegistry.md#didprovideraddedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------- | -| `K` | extends keyof [`DIDProviderAddedResult`](subgraphs.DIDRegistry.md#didprovideraddedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DIDRegistry.md#multiqueryoptions)<[`DIDProviderAddedFilter`](subgraphs.DIDRegistry.md#didprovideraddedfilter), [`DIDProviderAddedResult`](subgraphs.DIDRegistry.md#didprovideraddedresult)\> | -| `args` | [`DIDProviderAddedArgs`](subgraphs.DIDRegistry.md#didprovideraddedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`DIDProviderAddedResult`](subgraphs.DIDRegistry.md#didprovideraddedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:450 - ---- - -### getDIDProviderRemovedById - -▸ **getDIDProviderRemovedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`DIDProviderRemovedResult`](subgraphs.DIDRegistry.md#didproviderremovedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`DIDProviderRemovedResult`](subgraphs.DIDRegistry.md#didproviderremovedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DIDRegistry.md#singlequeryoptions) | -| `args` | [`DIDProviderRemovedArgs`](subgraphs.DIDRegistry.md#didproviderremovedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`DIDProviderRemovedResult`](subgraphs.DIDRegistry.md#didproviderremovedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:492 - ---- - -### getDIDProviderRemoveds - -▸ **getDIDProviderRemoveds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`DIDProviderRemovedResult`](subgraphs.DIDRegistry.md#didproviderremovedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`DIDProviderRemovedResult`](subgraphs.DIDRegistry.md#didproviderremovedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DIDRegistry.md#multiqueryoptions)<[`DIDProviderRemovedFilter`](subgraphs.DIDRegistry.md#didproviderremovedfilter), [`DIDProviderRemovedResult`](subgraphs.DIDRegistry.md#didproviderremovedresult)\> | -| `args` | [`DIDProviderRemovedArgs`](subgraphs.DIDRegistry.md#didproviderremovedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`DIDProviderRemovedResult`](subgraphs.DIDRegistry.md#didproviderremovedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:493 - ---- - -### getDIDRoyaltiesAddedById - -▸ **getDIDRoyaltiesAddedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`DIDRoyaltiesAddedResult`](subgraphs.DIDRegistry.md#didroyaltiesaddedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`DIDRoyaltiesAddedResult`](subgraphs.DIDRegistry.md#didroyaltiesaddedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DIDRegistry.md#singlequeryoptions) | -| `args` | [`DIDRoyaltiesAddedArgs`](subgraphs.DIDRegistry.md#didroyaltiesaddedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`DIDRoyaltiesAddedResult`](subgraphs.DIDRegistry.md#didroyaltiesaddedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:529 - ---- - -### getDIDRoyaltiesAddeds - -▸ **getDIDRoyaltiesAddeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`DIDRoyaltiesAddedResult`](subgraphs.DIDRegistry.md#didroyaltiesaddedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`DIDRoyaltiesAddedResult`](subgraphs.DIDRegistry.md#didroyaltiesaddedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DIDRegistry.md#multiqueryoptions)<[`DIDRoyaltiesAddedFilter`](subgraphs.DIDRegistry.md#didroyaltiesaddedfilter), [`DIDRoyaltiesAddedResult`](subgraphs.DIDRegistry.md#didroyaltiesaddedresult)\> | -| `args` | [`DIDRoyaltiesAddedArgs`](subgraphs.DIDRegistry.md#didroyaltiesaddedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`DIDRoyaltiesAddedResult`](subgraphs.DIDRegistry.md#didroyaltiesaddedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:530 - ---- - -### getDIDRoyaltyRecipientChangedById - -▸ **getDIDRoyaltyRecipientChangedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`DIDRoyaltyRecipientChangedResult`](subgraphs.DIDRegistry.md#didroyaltyrecipientchangedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`DIDRoyaltyRecipientChangedResult`](subgraphs.DIDRegistry.md#didroyaltyrecipientchangedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DIDRegistry.md#singlequeryoptions) | -| `args` | [`DIDRoyaltyRecipientChangedArgs`](subgraphs.DIDRegistry.md#didroyaltyrecipientchangedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`DIDRoyaltyRecipientChangedResult`](subgraphs.DIDRegistry.md#didroyaltyrecipientchangedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:566 - ---- - -### getDIDRoyaltyRecipientChangeds - -▸ **getDIDRoyaltyRecipientChangeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`DIDRoyaltyRecipientChangedResult`](subgraphs.DIDRegistry.md#didroyaltyrecipientchangedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`DIDRoyaltyRecipientChangedResult`](subgraphs.DIDRegistry.md#didroyaltyrecipientchangedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DIDRegistry.md#multiqueryoptions)<[`DIDRoyaltyRecipientChangedFilter`](subgraphs.DIDRegistry.md#didroyaltyrecipientchangedfilter), [`DIDRoyaltyRecipientChangedResult`](subgraphs.DIDRegistry.md#didroyaltyrecipientchangedresult)\> | -| `args` | [`DIDRoyaltyRecipientChangedArgs`](subgraphs.DIDRegistry.md#didroyaltyrecipientchangedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`DIDRoyaltyRecipientChangedResult`](subgraphs.DIDRegistry.md#didroyaltyrecipientchangedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:567 - ---- - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.DIDRegistry.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.DIDRegistry.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DIDRegistry.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.DIDRegistry.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.DIDRegistry.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:597 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.DIDRegistry.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.DIDRegistry.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DIDRegistry.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.DIDRegistry.md#initializedfilter), [`InitializedResult`](subgraphs.DIDRegistry.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.DIDRegistry.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.DIDRegistry.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:598 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.DIDRegistry.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.DIDRegistry.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DIDRegistry.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.DIDRegistry.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.DIDRegistry.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:634 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.DIDRegistry.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.DIDRegistry.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DIDRegistry.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.DIDRegistry.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.DIDRegistry.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.DIDRegistry.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.DIDRegistry.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:635 - ---- - -### getProvenanceAttributeRegisteredById - -▸ **getProvenanceAttributeRegisteredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ProvenanceAttributeRegisteredResult`](subgraphs.DIDRegistry.md#provenanceattributeregisteredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`ProvenanceAttributeRegisteredResult`](subgraphs.DIDRegistry.md#provenanceattributeregisteredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DIDRegistry.md#singlequeryoptions) | -| `args` | [`ProvenanceAttributeRegisteredArgs`](subgraphs.DIDRegistry.md#provenanceattributeregisteredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ProvenanceAttributeRegisteredResult`](subgraphs.DIDRegistry.md#provenanceattributeregisteredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:745 - ---- - -### getProvenanceAttributeRegistereds - -▸ **getProvenanceAttributeRegistereds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ProvenanceAttributeRegisteredResult`](subgraphs.DIDRegistry.md#provenanceattributeregisteredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`ProvenanceAttributeRegisteredResult`](subgraphs.DIDRegistry.md#provenanceattributeregisteredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DIDRegistry.md#multiqueryoptions)<[`ProvenanceAttributeRegisteredFilter`](subgraphs.DIDRegistry.md#provenanceattributeregisteredfilter), [`ProvenanceAttributeRegisteredResult`](subgraphs.DIDRegistry.md#provenanceattributeregisteredresult)\> | -| `args` | [`ProvenanceAttributeRegisteredArgs`](subgraphs.DIDRegistry.md#provenanceattributeregisteredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ProvenanceAttributeRegisteredResult`](subgraphs.DIDRegistry.md#provenanceattributeregisteredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:746 - ---- - -### getUsedById - -▸ **getUsedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`UsedResult`](subgraphs.DIDRegistry.md#usedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------- | -| `K` | extends keyof [`UsedResult`](subgraphs.DIDRegistry.md#usedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DIDRegistry.md#singlequeryoptions) | -| `args` | [`UsedArgs`](subgraphs.DIDRegistry.md#usedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`UsedResult`](subgraphs.DIDRegistry.md#usedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:830 - ---- - -### getUseds - -▸ **getUseds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`UsedResult`](subgraphs.DIDRegistry.md#usedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------- | -| `K` | extends keyof [`UsedResult`](subgraphs.DIDRegistry.md#usedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DIDRegistry.md#multiqueryoptions)<[`UsedFilter`](subgraphs.DIDRegistry.md#usedfilter), [`UsedResult`](subgraphs.DIDRegistry.md#usedresult)\> | -| `args` | [`UsedArgs`](subgraphs.DIDRegistry.md#usedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`UsedResult`](subgraphs.DIDRegistry.md#usedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:831 - ---- - -### getWasAssociatedWithById - -▸ **getWasAssociatedWithById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`WasAssociatedWithResult`](subgraphs.DIDRegistry.md#wasassociatedwithresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`WasAssociatedWithResult`](subgraphs.DIDRegistry.md#wasassociatedwithresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DIDRegistry.md#singlequeryoptions) | -| `args` | [`WasAssociatedWithArgs`](subgraphs.DIDRegistry.md#wasassociatedwithargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`WasAssociatedWithResult`](subgraphs.DIDRegistry.md#wasassociatedwithresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:915 - ---- - -### getWasAssociatedWiths - -▸ **getWasAssociatedWiths**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`WasAssociatedWithResult`](subgraphs.DIDRegistry.md#wasassociatedwithresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`WasAssociatedWithResult`](subgraphs.DIDRegistry.md#wasassociatedwithresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DIDRegistry.md#multiqueryoptions)<[`WasAssociatedWithFilter`](subgraphs.DIDRegistry.md#wasassociatedwithfilter), [`WasAssociatedWithResult`](subgraphs.DIDRegistry.md#wasassociatedwithresult)\> | -| `args` | [`WasAssociatedWithArgs`](subgraphs.DIDRegistry.md#wasassociatedwithargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`WasAssociatedWithResult`](subgraphs.DIDRegistry.md#wasassociatedwithresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:916 - ---- - -### getWasDerivedFromById - -▸ **getWasDerivedFromById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`WasDerivedFromResult`](subgraphs.DIDRegistry.md#wasderivedfromresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------ | -| `K` | extends keyof [`WasDerivedFromResult`](subgraphs.DIDRegistry.md#wasderivedfromresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DIDRegistry.md#singlequeryoptions) | -| `args` | [`WasDerivedFromArgs`](subgraphs.DIDRegistry.md#wasderivedfromargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`WasDerivedFromResult`](subgraphs.DIDRegistry.md#wasderivedfromresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:1008 - ---- - -### getWasDerivedFroms - -▸ **getWasDerivedFroms**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`WasDerivedFromResult`](subgraphs.DIDRegistry.md#wasderivedfromresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------ | -| `K` | extends keyof [`WasDerivedFromResult`](subgraphs.DIDRegistry.md#wasderivedfromresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DIDRegistry.md#multiqueryoptions)<[`WasDerivedFromFilter`](subgraphs.DIDRegistry.md#wasderivedfromfilter), [`WasDerivedFromResult`](subgraphs.DIDRegistry.md#wasderivedfromresult)\> | -| `args` | [`WasDerivedFromArgs`](subgraphs.DIDRegistry.md#wasderivedfromargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`WasDerivedFromResult`](subgraphs.DIDRegistry.md#wasderivedfromresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:1009 - ---- - -### getWasGeneratedByById - -▸ **getWasGeneratedByById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`WasGeneratedByResult`](subgraphs.DIDRegistry.md#wasgeneratedbyresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------ | -| `K` | extends keyof [`WasGeneratedByResult`](subgraphs.DIDRegistry.md#wasgeneratedbyresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DIDRegistry.md#singlequeryoptions) | -| `args` | [`WasGeneratedByArgs`](subgraphs.DIDRegistry.md#wasgeneratedbyargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`WasGeneratedByResult`](subgraphs.DIDRegistry.md#wasgeneratedbyresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:1093 - ---- - -### getWasGeneratedBys - -▸ **getWasGeneratedBys**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`WasGeneratedByResult`](subgraphs.DIDRegistry.md#wasgeneratedbyresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------ | -| `K` | extends keyof [`WasGeneratedByResult`](subgraphs.DIDRegistry.md#wasgeneratedbyresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DIDRegistry.md#multiqueryoptions)<[`WasGeneratedByFilter`](subgraphs.DIDRegistry.md#wasgeneratedbyfilter), [`WasGeneratedByResult`](subgraphs.DIDRegistry.md#wasgeneratedbyresult)\> | -| `args` | [`WasGeneratedByArgs`](subgraphs.DIDRegistry.md#wasgeneratedbyargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`WasGeneratedByResult`](subgraphs.DIDRegistry.md#wasgeneratedbyresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDRegistry.d.ts:1094 diff --git a/docs/api-reference/modules/subgraphs.DIDSalesTemplate.md b/docs/api-reference/modules/subgraphs.DIDSalesTemplate.md deleted file mode 100644 index 9359399b9..000000000 --- a/docs/api-reference/modules/subgraphs.DIDSalesTemplate.md +++ /dev/null @@ -1,564 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / DIDSalesTemplate - -# Namespace: DIDSalesTemplate - -[subgraphs](subgraphs.md).DIDSalesTemplate - -## Table of contents - -### Type Aliases - -- [AgreementCreatedArgs](subgraphs.DIDSalesTemplate.md#agreementcreatedargs) -- [AgreementCreatedFields](subgraphs.DIDSalesTemplate.md#agreementcreatedfields) -- [AgreementCreatedFilter](subgraphs.DIDSalesTemplate.md#agreementcreatedfilter) -- [AgreementCreatedResult](subgraphs.DIDSalesTemplate.md#agreementcreatedresult) -- [InitializedArgs](subgraphs.DIDSalesTemplate.md#initializedargs) -- [InitializedFields](subgraphs.DIDSalesTemplate.md#initializedfields) -- [InitializedFilter](subgraphs.DIDSalesTemplate.md#initializedfilter) -- [InitializedResult](subgraphs.DIDSalesTemplate.md#initializedresult) -- [MultiQueryOptions](subgraphs.DIDSalesTemplate.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.DIDSalesTemplate.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.DIDSalesTemplate.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.DIDSalesTemplate.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.DIDSalesTemplate.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.DIDSalesTemplate.md#singlequeryoptions) - -### Functions - -- [getAgreementCreatedById](subgraphs.DIDSalesTemplate.md#getagreementcreatedbyid) -- [getAgreementCreateds](subgraphs.DIDSalesTemplate.md#getagreementcreateds) -- [getInitializedById](subgraphs.DIDSalesTemplate.md#getinitializedbyid) -- [getInitializeds](subgraphs.DIDSalesTemplate.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.DIDSalesTemplate.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.DIDSalesTemplate.md#getownershiptransferreds) - -## Type Aliases - -### AgreementCreatedArgs - -Ƭ **AgreementCreatedArgs**<`K`\>: { [Property in keyof Pick]: AgreementCreatedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.DIDSalesTemplate.md#agreementcreatedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDSalesTemplate.d.ts:117 - ---- - -### AgreementCreatedFields - -Ƭ **AgreementCreatedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :----- | -| `_accessConsumer` | `true` | -| `_accessProvider` | `true` | -| `_agreementId` | `true` | -| `_conditionIdSeeds` | `true` | -| `_conditionIds` | `true` | -| `_creator` | `true` | -| `_did` | `true` | -| `_idSeed` | `true` | -| `_timeLocks` | `true` | -| `_timeOuts` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDSalesTemplate.d.ts:104 - ---- - -### AgreementCreatedFilter - -Ƭ **AgreementCreatedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------------------------------- | :----------------- | -| `_accessConsumer?` | `string` \| `null` | -| `_accessConsumer_contains?` | `string` \| `null` | -| `_accessConsumer_in?` | `string`[] | -| `_accessConsumer_not?` | `string` \| `null` | -| `_accessConsumer_not_contains?` | `string` \| `null` | -| `_accessConsumer_not_in?` | `string`[] | -| `_accessProvider?` | `string` \| `null` | -| `_accessProvider_contains?` | `string` \| `null` | -| `_accessProvider_in?` | `string`[] | -| `_accessProvider_not?` | `string` \| `null` | -| `_accessProvider_not_contains?` | `string` \| `null` | -| `_accessProvider_not_in?` | `string`[] | -| `_agreementId?` | `string` \| `null` | -| `_agreementId_contains?` | `string` \| `null` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| `null` | -| `_agreementId_not_contains?` | `string` \| `null` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionIdSeeds?` | `string`[] | -| `_conditionIdSeeds_contains?` | `string`[] | -| `_conditionIdSeeds_contains_nocase?` | `string`[] | -| `_conditionIdSeeds_not?` | `string`[] | -| `_conditionIdSeeds_not_contains?` | `string`[] | -| `_conditionIdSeeds_not_contains_nocase?` | `string`[] | -| `_conditionIds?` | `string`[] | -| `_conditionIds_contains?` | `string`[] | -| `_conditionIds_contains_nocase?` | `string`[] | -| `_conditionIds_not?` | `string`[] | -| `_conditionIds_not_contains?` | `string`[] | -| `_conditionIds_not_contains_nocase?` | `string`[] | -| `_creator?` | `string` \| `null` | -| `_creator_contains?` | `string` \| `null` | -| `_creator_in?` | `string`[] | -| `_creator_not?` | `string` \| `null` | -| `_creator_not_contains?` | `string` \| `null` | -| `_creator_not_in?` | `string`[] | -| `_did?` | `string` \| `null` | -| `_did_contains?` | `string` \| `null` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| `null` | -| `_did_not_contains?` | `string` \| `null` | -| `_did_not_in?` | `string`[] | -| `_idSeed?` | `string` \| `null` | -| `_idSeed_contains?` | `string` \| `null` | -| `_idSeed_in?` | `string`[] | -| `_idSeed_not?` | `string` \| `null` | -| `_idSeed_not_contains?` | `string` \| `null` | -| `_idSeed_not_in?` | `string`[] | -| `_timeLocks?` | `WeiSource`[] | -| `_timeLocks_contains?` | `WeiSource`[] | -| `_timeLocks_contains_nocase?` | `WeiSource`[] | -| `_timeLocks_not?` | `WeiSource`[] | -| `_timeLocks_not_contains?` | `WeiSource`[] | -| `_timeLocks_not_contains_nocase?` | `WeiSource`[] | -| `_timeOuts?` | `WeiSource`[] | -| `_timeOuts_contains?` | `WeiSource`[] | -| `_timeOuts_contains_nocase?` | `WeiSource`[] | -| `_timeOuts_not?` | `WeiSource`[] | -| `_timeOuts_not_contains?` | `WeiSource`[] | -| `_timeOuts_not_contains_nocase?` | `WeiSource`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDSalesTemplate.d.ts:21 - ---- - -### AgreementCreatedResult - -Ƭ **AgreementCreatedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :--------------------- | -| `_accessConsumer` | `string` | -| `_accessProvider` | `string` | -| `_agreementId` | `string` | -| `_conditionIdSeeds` | (`string` \| `null`)[] | -| `_conditionIds` | (`string` \| `null`)[] | -| `_creator` | `string` | -| `_did` | `string` | -| `_idSeed` | `string` | -| `_timeLocks` | (`Wei` \| `null`)[] | -| `_timeOuts` | (`Wei` \| `null`)[] | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDSalesTemplate.d.ts:91 - ---- - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.DIDSalesTemplate.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDSalesTemplate.d.ts:148 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDSalesTemplate.d.ts:144 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDSalesTemplate.d.ts:122 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDSalesTemplate.d.ts:140 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDSalesTemplate.d.ts:10 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.DIDSalesTemplate.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDSalesTemplate.d.ts:185 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDSalesTemplate.d.ts:180 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDSalesTemplate.d.ts:153 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDSalesTemplate.d.ts:175 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDSalesTemplate.d.ts:2 - -## Functions - -### getAgreementCreatedById - -▸ **getAgreementCreatedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.DIDSalesTemplate.md#agreementcreatedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.DIDSalesTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DIDSalesTemplate.md#singlequeryoptions) | -| `args` | [`AgreementCreatedArgs`](subgraphs.DIDSalesTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.DIDSalesTemplate.md#agreementcreatedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDSalesTemplate.d.ts:120 - ---- - -### getAgreementCreateds - -▸ **getAgreementCreateds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.DIDSalesTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.DIDSalesTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DIDSalesTemplate.md#multiqueryoptions)<[`AgreementCreatedFilter`](subgraphs.DIDSalesTemplate.md#agreementcreatedfilter), [`AgreementCreatedResult`](subgraphs.DIDSalesTemplate.md#agreementcreatedresult)\> | -| `args` | [`AgreementCreatedArgs`](subgraphs.DIDSalesTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.DIDSalesTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDSalesTemplate.d.ts:121 - ---- - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.DIDSalesTemplate.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.DIDSalesTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DIDSalesTemplate.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.DIDSalesTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.DIDSalesTemplate.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDSalesTemplate.d.ts:151 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.DIDSalesTemplate.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.DIDSalesTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DIDSalesTemplate.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.DIDSalesTemplate.md#initializedfilter), [`InitializedResult`](subgraphs.DIDSalesTemplate.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.DIDSalesTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.DIDSalesTemplate.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDSalesTemplate.d.ts:152 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.DIDSalesTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.DIDSalesTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DIDSalesTemplate.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.DIDSalesTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.DIDSalesTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDSalesTemplate.d.ts:188 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.DIDSalesTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.DIDSalesTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DIDSalesTemplate.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.DIDSalesTemplate.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.DIDSalesTemplate.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.DIDSalesTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.DIDSalesTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DIDSalesTemplate.d.ts:189 diff --git a/docs/api-reference/modules/subgraphs.Dispenser.md b/docs/api-reference/modules/subgraphs.Dispenser.md deleted file mode 100644 index 559e2a022..000000000 --- a/docs/api-reference/modules/subgraphs.Dispenser.md +++ /dev/null @@ -1,663 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / Dispenser - -# Namespace: Dispenser - -[subgraphs](subgraphs.md).Dispenser - -## Table of contents - -### Type Aliases - -- [InitializedArgs](subgraphs.Dispenser.md#initializedargs) -- [InitializedFields](subgraphs.Dispenser.md#initializedfields) -- [InitializedFilter](subgraphs.Dispenser.md#initializedfilter) -- [InitializedResult](subgraphs.Dispenser.md#initializedresult) -- [MultiQueryOptions](subgraphs.Dispenser.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.Dispenser.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.Dispenser.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.Dispenser.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.Dispenser.md#ownershiptransferredresult) -- [RequestFrequencyExceededArgs](subgraphs.Dispenser.md#requestfrequencyexceededargs) -- [RequestFrequencyExceededFields](subgraphs.Dispenser.md#requestfrequencyexceededfields) -- [RequestFrequencyExceededFilter](subgraphs.Dispenser.md#requestfrequencyexceededfilter) -- [RequestFrequencyExceededResult](subgraphs.Dispenser.md#requestfrequencyexceededresult) -- [RequestLimitExceededArgs](subgraphs.Dispenser.md#requestlimitexceededargs) -- [RequestLimitExceededFields](subgraphs.Dispenser.md#requestlimitexceededfields) -- [RequestLimitExceededFilter](subgraphs.Dispenser.md#requestlimitexceededfilter) -- [RequestLimitExceededResult](subgraphs.Dispenser.md#requestlimitexceededresult) -- [SingleQueryOptions](subgraphs.Dispenser.md#singlequeryoptions) - -### Functions - -- [getInitializedById](subgraphs.Dispenser.md#getinitializedbyid) -- [getInitializeds](subgraphs.Dispenser.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.Dispenser.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.Dispenser.md#getownershiptransferreds) -- [getRequestFrequencyExceededById](subgraphs.Dispenser.md#getrequestfrequencyexceededbyid) -- [getRequestFrequencyExceededs](subgraphs.Dispenser.md#getrequestfrequencyexceededs) -- [getRequestLimitExceededById](subgraphs.Dispenser.md#getrequestlimitexceededbyid) -- [getRequestLimitExceededs](subgraphs.Dispenser.md#getrequestlimitexceededs) - -## Type Aliases - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.Dispenser.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:47 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:43 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:21 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:39 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:10 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.Dispenser.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:84 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:79 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:52 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:74 - ---- - -### RequestFrequencyExceededArgs - -Ƭ **RequestFrequencyExceededArgs**<`K`\>: { [Property in keyof Pick]: RequestFrequencyExceededFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`RequestFrequencyExceededResult`](subgraphs.Dispenser.md#requestfrequencyexceededresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:123 - ---- - -### RequestFrequencyExceededFields - -Ƭ **RequestFrequencyExceededFields**: `Object` - -#### Type declaration - -| Name | Type | -| :---------- | :----- | -| `id` | `true` | -| `minPeriod` | `true` | -| `requester` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:118 - ---- - -### RequestFrequencyExceededFilter - -Ƭ **RequestFrequencyExceededFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------------ | :-------------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `minPeriod?` | `WeiSource` \| `null` | -| `minPeriod_gt?` | `WeiSource` \| `null` | -| `minPeriod_gte?` | `WeiSource` \| `null` | -| `minPeriod_in?` | `WeiSource`[] | -| `minPeriod_lt?` | `WeiSource` \| `null` | -| `minPeriod_lte?` | `WeiSource` \| `null` | -| `minPeriod_not?` | `WeiSource` \| `null` | -| `minPeriod_not_in?` | `WeiSource`[] | -| `requester?` | `string` \| `null` | -| `requester_contains?` | `string` \| `null` | -| `requester_in?` | `string`[] | -| `requester_not?` | `string` \| `null` | -| `requester_not_contains?` | `string` \| `null` | -| `requester_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:89 - ---- - -### RequestFrequencyExceededResult - -Ƭ **RequestFrequencyExceededResult**: `Object` - -#### Type declaration - -| Name | Type | -| :---------- | :------- | -| `id` | `string` | -| `minPeriod` | `Wei` | -| `requester` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:113 - ---- - -### RequestLimitExceededArgs - -Ƭ **RequestLimitExceededArgs**<`K`\>: { [Property in keyof Pick]: RequestLimitExceededFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RequestLimitExceededResult`](subgraphs.Dispenser.md#requestlimitexceededresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:172 - ---- - -### RequestLimitExceededFields - -Ƭ **RequestLimitExceededFields**: `Object` - -#### Type declaration - -| Name | Type | -| :---------- | :----- | -| `amount` | `true` | -| `id` | `true` | -| `maxAmount` | `true` | -| `requester` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:166 - ---- - -### RequestLimitExceededFilter - -Ƭ **RequestLimitExceededFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------------ | :-------------------- | -| `amount?` | `WeiSource` \| `null` | -| `amount_gt?` | `WeiSource` \| `null` | -| `amount_gte?` | `WeiSource` \| `null` | -| `amount_in?` | `WeiSource`[] | -| `amount_lt?` | `WeiSource` \| `null` | -| `amount_lte?` | `WeiSource` \| `null` | -| `amount_not?` | `WeiSource` \| `null` | -| `amount_not_in?` | `WeiSource`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `maxAmount?` | `WeiSource` \| `null` | -| `maxAmount_gt?` | `WeiSource` \| `null` | -| `maxAmount_gte?` | `WeiSource` \| `null` | -| `maxAmount_in?` | `WeiSource`[] | -| `maxAmount_lt?` | `WeiSource` \| `null` | -| `maxAmount_lte?` | `WeiSource` \| `null` | -| `maxAmount_not?` | `WeiSource` \| `null` | -| `maxAmount_not_in?` | `WeiSource`[] | -| `requester?` | `string` \| `null` | -| `requester_contains?` | `string` \| `null` | -| `requester_in?` | `string`[] | -| `requester_not?` | `string` \| `null` | -| `requester_not_contains?` | `string` \| `null` | -| `requester_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:128 - ---- - -### RequestLimitExceededResult - -Ƭ **RequestLimitExceededResult**: `Object` - -#### Type declaration - -| Name | Type | -| :---------- | :------- | -| `amount` | `Wei` | -| `id` | `string` | -| `maxAmount` | `Wei` | -| `requester` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:160 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:2 - -## Functions - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.Dispenser.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.Dispenser.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.Dispenser.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.Dispenser.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.Dispenser.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:50 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.Dispenser.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.Dispenser.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.Dispenser.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.Dispenser.md#initializedfilter), [`InitializedResult`](subgraphs.Dispenser.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.Dispenser.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.Dispenser.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:51 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.Dispenser.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.Dispenser.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.Dispenser.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.Dispenser.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.Dispenser.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:87 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.Dispenser.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.Dispenser.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.Dispenser.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.Dispenser.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.Dispenser.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.Dispenser.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.Dispenser.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:88 - ---- - -### getRequestFrequencyExceededById - -▸ **getRequestFrequencyExceededById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RequestFrequencyExceededResult`](subgraphs.Dispenser.md#requestfrequencyexceededresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`RequestFrequencyExceededResult`](subgraphs.Dispenser.md#requestfrequencyexceededresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.Dispenser.md#singlequeryoptions) | -| `args` | [`RequestFrequencyExceededArgs`](subgraphs.Dispenser.md#requestfrequencyexceededargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RequestFrequencyExceededResult`](subgraphs.Dispenser.md#requestfrequencyexceededresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:126 - ---- - -### getRequestFrequencyExceededs - -▸ **getRequestFrequencyExceededs**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RequestFrequencyExceededResult`](subgraphs.Dispenser.md#requestfrequencyexceededresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`RequestFrequencyExceededResult`](subgraphs.Dispenser.md#requestfrequencyexceededresult) | - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.Dispenser.md#multiqueryoptions)<[`RequestFrequencyExceededFilter`](subgraphs.Dispenser.md#requestfrequencyexceededfilter), [`RequestFrequencyExceededResult`](subgraphs.Dispenser.md#requestfrequencyexceededresult)\> | -| `args` | [`RequestFrequencyExceededArgs`](subgraphs.Dispenser.md#requestfrequencyexceededargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RequestFrequencyExceededResult`](subgraphs.Dispenser.md#requestfrequencyexceededresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:127 - ---- - -### getRequestLimitExceededById - -▸ **getRequestLimitExceededById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RequestLimitExceededResult`](subgraphs.Dispenser.md#requestlimitexceededresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RequestLimitExceededResult`](subgraphs.Dispenser.md#requestlimitexceededresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.Dispenser.md#singlequeryoptions) | -| `args` | [`RequestLimitExceededArgs`](subgraphs.Dispenser.md#requestlimitexceededargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RequestLimitExceededResult`](subgraphs.Dispenser.md#requestlimitexceededresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:175 - ---- - -### getRequestLimitExceededs - -▸ **getRequestLimitExceededs**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RequestLimitExceededResult`](subgraphs.Dispenser.md#requestlimitexceededresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RequestLimitExceededResult`](subgraphs.Dispenser.md#requestlimitexceededresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.Dispenser.md#multiqueryoptions)<[`RequestLimitExceededFilter`](subgraphs.Dispenser.md#requestlimitexceededfilter), [`RequestLimitExceededResult`](subgraphs.Dispenser.md#requestlimitexceededresult)\> | -| `args` | [`RequestLimitExceededArgs`](subgraphs.Dispenser.md#requestlimitexceededargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RequestLimitExceededResult`](subgraphs.Dispenser.md#requestlimitexceededresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/Dispenser.d.ts:176 diff --git a/docs/api-reference/modules/subgraphs.DistributeNFTCollateralCondition.md b/docs/api-reference/modules/subgraphs.DistributeNFTCollateralCondition.md deleted file mode 100644 index 996cd0296..000000000 --- a/docs/api-reference/modules/subgraphs.DistributeNFTCollateralCondition.md +++ /dev/null @@ -1,381 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / DistributeNFTCollateralCondition - -# Namespace: DistributeNFTCollateralCondition - -[subgraphs](subgraphs.md).DistributeNFTCollateralCondition - -## Table of contents - -### Type Aliases - -- [FulfilledArgs](subgraphs.DistributeNFTCollateralCondition.md#fulfilledargs) -- [FulfilledFields](subgraphs.DistributeNFTCollateralCondition.md#fulfilledfields) -- [FulfilledFilter](subgraphs.DistributeNFTCollateralCondition.md#fulfilledfilter) -- [FulfilledResult](subgraphs.DistributeNFTCollateralCondition.md#fulfilledresult) -- [MultiQueryOptions](subgraphs.DistributeNFTCollateralCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.DistributeNFTCollateralCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.DistributeNFTCollateralCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.DistributeNFTCollateralCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.DistributeNFTCollateralCondition.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.DistributeNFTCollateralCondition.md#singlequeryoptions) - -### Functions - -- [getFulfilledById](subgraphs.DistributeNFTCollateralCondition.md#getfulfilledbyid) -- [getFulfilleds](subgraphs.DistributeNFTCollateralCondition.md#getfulfilleds) -- [getOwnershipTransferredById](subgraphs.DistributeNFTCollateralCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.DistributeNFTCollateralCondition.md#getownershiptransferreds) - -## Type Aliases - -### FulfilledArgs - -Ƭ **FulfilledArgs**<`K`\>: { [Property in keyof Pick]: FulfilledFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.DistributeNFTCollateralCondition.md#fulfilledresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DistributeNFTCollateralCondition.d.ts:76 - ---- - -### FulfilledFields - -Ƭ **FulfilledFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------------- | :----- | -| `_agreementId` | `true` | -| `_conditionId` | `true` | -| `_contract` | `true` | -| `_did` | `true` | -| `_receiver` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DistributeNFTCollateralCondition.d.ts:68 - ---- - -### FulfilledFilter - -Ƭ **FulfilledFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------------------- | :----------------- | -| `_agreementId?` | `string` \| `null` | -| `_agreementId_contains?` | `string` \| `null` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| `null` | -| `_agreementId_not_contains?` | `string` \| `null` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionId?` | `string` \| `null` | -| `_conditionId_contains?` | `string` \| `null` | -| `_conditionId_in?` | `string`[] | -| `_conditionId_not?` | `string` \| `null` | -| `_conditionId_not_contains?` | `string` \| `null` | -| `_conditionId_not_in?` | `string`[] | -| `_contract?` | `string` \| `null` | -| `_contract_contains?` | `string` \| `null` | -| `_contract_in?` | `string`[] | -| `_contract_not?` | `string` \| `null` | -| `_contract_not_contains?` | `string` \| `null` | -| `_contract_not_in?` | `string`[] | -| `_did?` | `string` \| `null` | -| `_did_contains?` | `string` \| `null` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| `null` | -| `_did_not_contains?` | `string` \| `null` | -| `_did_not_in?` | `string`[] | -| `_receiver?` | `string` \| `null` | -| `_receiver_contains?` | `string` \| `null` | -| `_receiver_in?` | `string`[] | -| `_receiver_not?` | `string` \| `null` | -| `_receiver_not_contains?` | `string` \| `null` | -| `_receiver_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DistributeNFTCollateralCondition.d.ts:20 - ---- - -### FulfilledResult - -Ƭ **FulfilledResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------------- | :------- | -| `_agreementId` | `string` | -| `_conditionId` | `string` | -| `_contract` | `string` | -| `_did` | `string` | -| `_receiver` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DistributeNFTCollateralCondition.d.ts:60 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DistributeNFTCollateralCondition.d.ts:9 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.DistributeNFTCollateralCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DistributeNFTCollateralCondition.d.ts:113 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DistributeNFTCollateralCondition.d.ts:108 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DistributeNFTCollateralCondition.d.ts:81 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DistributeNFTCollateralCondition.d.ts:103 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DistributeNFTCollateralCondition.d.ts:1 - -## Functions - -### getFulfilledById - -▸ **getFulfilledById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.DistributeNFTCollateralCondition.md#fulfilledresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.DistributeNFTCollateralCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DistributeNFTCollateralCondition.md#singlequeryoptions) | -| `args` | [`FulfilledArgs`](subgraphs.DistributeNFTCollateralCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.DistributeNFTCollateralCondition.md#fulfilledresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DistributeNFTCollateralCondition.d.ts:79 - ---- - -### getFulfilleds - -▸ **getFulfilleds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.DistributeNFTCollateralCondition.md#fulfilledresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.DistributeNFTCollateralCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DistributeNFTCollateralCondition.md#multiqueryoptions)<[`FulfilledFilter`](subgraphs.DistributeNFTCollateralCondition.md#fulfilledfilter), [`FulfilledResult`](subgraphs.DistributeNFTCollateralCondition.md#fulfilledresult)\> | -| `args` | [`FulfilledArgs`](subgraphs.DistributeNFTCollateralCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.DistributeNFTCollateralCondition.md#fulfilledresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DistributeNFTCollateralCondition.d.ts:80 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.DistributeNFTCollateralCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.DistributeNFTCollateralCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.DistributeNFTCollateralCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.DistributeNFTCollateralCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.DistributeNFTCollateralCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DistributeNFTCollateralCondition.d.ts:116 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.DistributeNFTCollateralCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.DistributeNFTCollateralCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.DistributeNFTCollateralCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.DistributeNFTCollateralCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.DistributeNFTCollateralCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.DistributeNFTCollateralCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.DistributeNFTCollateralCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/DistributeNFTCollateralCondition.d.ts:117 diff --git a/docs/api-reference/modules/subgraphs.EscrowComputeExecutionTemplate.md b/docs/api-reference/modules/subgraphs.EscrowComputeExecutionTemplate.md deleted file mode 100644 index eb2641cf1..000000000 --- a/docs/api-reference/modules/subgraphs.EscrowComputeExecutionTemplate.md +++ /dev/null @@ -1,564 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / EscrowComputeExecutionTemplate - -# Namespace: EscrowComputeExecutionTemplate - -[subgraphs](subgraphs.md).EscrowComputeExecutionTemplate - -## Table of contents - -### Type Aliases - -- [AgreementCreatedArgs](subgraphs.EscrowComputeExecutionTemplate.md#agreementcreatedargs) -- [AgreementCreatedFields](subgraphs.EscrowComputeExecutionTemplate.md#agreementcreatedfields) -- [AgreementCreatedFilter](subgraphs.EscrowComputeExecutionTemplate.md#agreementcreatedfilter) -- [AgreementCreatedResult](subgraphs.EscrowComputeExecutionTemplate.md#agreementcreatedresult) -- [InitializedArgs](subgraphs.EscrowComputeExecutionTemplate.md#initializedargs) -- [InitializedFields](subgraphs.EscrowComputeExecutionTemplate.md#initializedfields) -- [InitializedFilter](subgraphs.EscrowComputeExecutionTemplate.md#initializedfilter) -- [InitializedResult](subgraphs.EscrowComputeExecutionTemplate.md#initializedresult) -- [MultiQueryOptions](subgraphs.EscrowComputeExecutionTemplate.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.EscrowComputeExecutionTemplate.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.EscrowComputeExecutionTemplate.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.EscrowComputeExecutionTemplate.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.EscrowComputeExecutionTemplate.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.EscrowComputeExecutionTemplate.md#singlequeryoptions) - -### Functions - -- [getAgreementCreatedById](subgraphs.EscrowComputeExecutionTemplate.md#getagreementcreatedbyid) -- [getAgreementCreateds](subgraphs.EscrowComputeExecutionTemplate.md#getagreementcreateds) -- [getInitializedById](subgraphs.EscrowComputeExecutionTemplate.md#getinitializedbyid) -- [getInitializeds](subgraphs.EscrowComputeExecutionTemplate.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.EscrowComputeExecutionTemplate.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.EscrowComputeExecutionTemplate.md#getownershiptransferreds) - -## Type Aliases - -### AgreementCreatedArgs - -Ƭ **AgreementCreatedArgs**<`K`\>: { [Property in keyof Pick]: AgreementCreatedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.EscrowComputeExecutionTemplate.md#agreementcreatedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowComputeExecutionTemplate.d.ts:117 - ---- - -### AgreementCreatedFields - -Ƭ **AgreementCreatedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :----- | -| `_accessConsumer` | `true` | -| `_accessProvider` | `true` | -| `_agreementId` | `true` | -| `_conditionIdSeeds` | `true` | -| `_conditionIds` | `true` | -| `_creator` | `true` | -| `_did` | `true` | -| `_idSeed` | `true` | -| `_timeLocks` | `true` | -| `_timeOuts` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowComputeExecutionTemplate.d.ts:104 - ---- - -### AgreementCreatedFilter - -Ƭ **AgreementCreatedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------------------------------- | :----------------- | -| `_accessConsumer?` | `string` \| `null` | -| `_accessConsumer_contains?` | `string` \| `null` | -| `_accessConsumer_in?` | `string`[] | -| `_accessConsumer_not?` | `string` \| `null` | -| `_accessConsumer_not_contains?` | `string` \| `null` | -| `_accessConsumer_not_in?` | `string`[] | -| `_accessProvider?` | `string` \| `null` | -| `_accessProvider_contains?` | `string` \| `null` | -| `_accessProvider_in?` | `string`[] | -| `_accessProvider_not?` | `string` \| `null` | -| `_accessProvider_not_contains?` | `string` \| `null` | -| `_accessProvider_not_in?` | `string`[] | -| `_agreementId?` | `string` \| `null` | -| `_agreementId_contains?` | `string` \| `null` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| `null` | -| `_agreementId_not_contains?` | `string` \| `null` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionIdSeeds?` | `string`[] | -| `_conditionIdSeeds_contains?` | `string`[] | -| `_conditionIdSeeds_contains_nocase?` | `string`[] | -| `_conditionIdSeeds_not?` | `string`[] | -| `_conditionIdSeeds_not_contains?` | `string`[] | -| `_conditionIdSeeds_not_contains_nocase?` | `string`[] | -| `_conditionIds?` | `string`[] | -| `_conditionIds_contains?` | `string`[] | -| `_conditionIds_contains_nocase?` | `string`[] | -| `_conditionIds_not?` | `string`[] | -| `_conditionIds_not_contains?` | `string`[] | -| `_conditionIds_not_contains_nocase?` | `string`[] | -| `_creator?` | `string` \| `null` | -| `_creator_contains?` | `string` \| `null` | -| `_creator_in?` | `string`[] | -| `_creator_not?` | `string` \| `null` | -| `_creator_not_contains?` | `string` \| `null` | -| `_creator_not_in?` | `string`[] | -| `_did?` | `string` \| `null` | -| `_did_contains?` | `string` \| `null` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| `null` | -| `_did_not_contains?` | `string` \| `null` | -| `_did_not_in?` | `string`[] | -| `_idSeed?` | `string` \| `null` | -| `_idSeed_contains?` | `string` \| `null` | -| `_idSeed_in?` | `string`[] | -| `_idSeed_not?` | `string` \| `null` | -| `_idSeed_not_contains?` | `string` \| `null` | -| `_idSeed_not_in?` | `string`[] | -| `_timeLocks?` | `WeiSource`[] | -| `_timeLocks_contains?` | `WeiSource`[] | -| `_timeLocks_contains_nocase?` | `WeiSource`[] | -| `_timeLocks_not?` | `WeiSource`[] | -| `_timeLocks_not_contains?` | `WeiSource`[] | -| `_timeLocks_not_contains_nocase?` | `WeiSource`[] | -| `_timeOuts?` | `WeiSource`[] | -| `_timeOuts_contains?` | `WeiSource`[] | -| `_timeOuts_contains_nocase?` | `WeiSource`[] | -| `_timeOuts_not?` | `WeiSource`[] | -| `_timeOuts_not_contains?` | `WeiSource`[] | -| `_timeOuts_not_contains_nocase?` | `WeiSource`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowComputeExecutionTemplate.d.ts:21 - ---- - -### AgreementCreatedResult - -Ƭ **AgreementCreatedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :--------------------- | -| `_accessConsumer` | `string` | -| `_accessProvider` | `string` | -| `_agreementId` | `string` | -| `_conditionIdSeeds` | (`string` \| `null`)[] | -| `_conditionIds` | (`string` \| `null`)[] | -| `_creator` | `string` | -| `_did` | `string` | -| `_idSeed` | `string` | -| `_timeLocks` | (`Wei` \| `null`)[] | -| `_timeOuts` | (`Wei` \| `null`)[] | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowComputeExecutionTemplate.d.ts:91 - ---- - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.EscrowComputeExecutionTemplate.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowComputeExecutionTemplate.d.ts:148 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowComputeExecutionTemplate.d.ts:144 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowComputeExecutionTemplate.d.ts:122 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowComputeExecutionTemplate.d.ts:140 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowComputeExecutionTemplate.d.ts:10 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.EscrowComputeExecutionTemplate.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowComputeExecutionTemplate.d.ts:185 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowComputeExecutionTemplate.d.ts:180 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowComputeExecutionTemplate.d.ts:153 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowComputeExecutionTemplate.d.ts:175 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowComputeExecutionTemplate.d.ts:2 - -## Functions - -### getAgreementCreatedById - -▸ **getAgreementCreatedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.EscrowComputeExecutionTemplate.md#agreementcreatedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.EscrowComputeExecutionTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.EscrowComputeExecutionTemplate.md#singlequeryoptions) | -| `args` | [`AgreementCreatedArgs`](subgraphs.EscrowComputeExecutionTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.EscrowComputeExecutionTemplate.md#agreementcreatedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowComputeExecutionTemplate.d.ts:120 - ---- - -### getAgreementCreateds - -▸ **getAgreementCreateds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.EscrowComputeExecutionTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.EscrowComputeExecutionTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.EscrowComputeExecutionTemplate.md#multiqueryoptions)<[`AgreementCreatedFilter`](subgraphs.EscrowComputeExecutionTemplate.md#agreementcreatedfilter), [`AgreementCreatedResult`](subgraphs.EscrowComputeExecutionTemplate.md#agreementcreatedresult)\> | -| `args` | [`AgreementCreatedArgs`](subgraphs.EscrowComputeExecutionTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.EscrowComputeExecutionTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowComputeExecutionTemplate.d.ts:121 - ---- - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.EscrowComputeExecutionTemplate.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.EscrowComputeExecutionTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.EscrowComputeExecutionTemplate.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.EscrowComputeExecutionTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.EscrowComputeExecutionTemplate.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowComputeExecutionTemplate.d.ts:151 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.EscrowComputeExecutionTemplate.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.EscrowComputeExecutionTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.EscrowComputeExecutionTemplate.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.EscrowComputeExecutionTemplate.md#initializedfilter), [`InitializedResult`](subgraphs.EscrowComputeExecutionTemplate.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.EscrowComputeExecutionTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.EscrowComputeExecutionTemplate.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowComputeExecutionTemplate.d.ts:152 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.EscrowComputeExecutionTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.EscrowComputeExecutionTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.EscrowComputeExecutionTemplate.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.EscrowComputeExecutionTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.EscrowComputeExecutionTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowComputeExecutionTemplate.d.ts:188 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.EscrowComputeExecutionTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.EscrowComputeExecutionTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.EscrowComputeExecutionTemplate.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.EscrowComputeExecutionTemplate.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.EscrowComputeExecutionTemplate.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.EscrowComputeExecutionTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.EscrowComputeExecutionTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowComputeExecutionTemplate.d.ts:189 diff --git a/docs/api-reference/modules/subgraphs.EscrowPaymentCondition.md b/docs/api-reference/modules/subgraphs.EscrowPaymentCondition.md deleted file mode 100644 index 1d64095e6..000000000 --- a/docs/api-reference/modules/subgraphs.EscrowPaymentCondition.md +++ /dev/null @@ -1,675 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / EscrowPaymentCondition - -# Namespace: EscrowPaymentCondition - -[subgraphs](subgraphs.md).EscrowPaymentCondition - -## Table of contents - -### Type Aliases - -- [FulfilledArgs](subgraphs.EscrowPaymentCondition.md#fulfilledargs) -- [FulfilledFields](subgraphs.EscrowPaymentCondition.md#fulfilledfields) -- [FulfilledFilter](subgraphs.EscrowPaymentCondition.md#fulfilledfilter) -- [FulfilledResult](subgraphs.EscrowPaymentCondition.md#fulfilledresult) -- [InitializedArgs](subgraphs.EscrowPaymentCondition.md#initializedargs) -- [InitializedFields](subgraphs.EscrowPaymentCondition.md#initializedfields) -- [InitializedFilter](subgraphs.EscrowPaymentCondition.md#initializedfilter) -- [InitializedResult](subgraphs.EscrowPaymentCondition.md#initializedresult) -- [MultiQueryOptions](subgraphs.EscrowPaymentCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.EscrowPaymentCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.EscrowPaymentCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.EscrowPaymentCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.EscrowPaymentCondition.md#ownershiptransferredresult) -- [ReceivedArgs](subgraphs.EscrowPaymentCondition.md#receivedargs) -- [ReceivedFields](subgraphs.EscrowPaymentCondition.md#receivedfields) -- [ReceivedFilter](subgraphs.EscrowPaymentCondition.md#receivedfilter) -- [ReceivedResult](subgraphs.EscrowPaymentCondition.md#receivedresult) -- [SingleQueryOptions](subgraphs.EscrowPaymentCondition.md#singlequeryoptions) - -### Functions - -- [getFulfilledById](subgraphs.EscrowPaymentCondition.md#getfulfilledbyid) -- [getFulfilleds](subgraphs.EscrowPaymentCondition.md#getfulfilleds) -- [getInitializedById](subgraphs.EscrowPaymentCondition.md#getinitializedbyid) -- [getInitializeds](subgraphs.EscrowPaymentCondition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.EscrowPaymentCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.EscrowPaymentCondition.md#getownershiptransferreds) -- [getReceivedById](subgraphs.EscrowPaymentCondition.md#getreceivedbyid) -- [getReceiveds](subgraphs.EscrowPaymentCondition.md#getreceiveds) - -## Type Aliases - -### FulfilledArgs - -Ƭ **FulfilledArgs**<`K`\>: { [Property in keyof Pick]: FulfilledFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.EscrowPaymentCondition.md#fulfilledresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:77 - ---- - -### FulfilledFields - -Ƭ **FulfilledFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `_agreementId` | `true` | -| `_amounts` | `true` | -| `_conditionId` | `true` | -| `_receivers` | `true` | -| `_tokenAddress` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:69 - ---- - -### FulfilledFilter - -Ƭ **FulfilledFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------------------- | :----------------- | -| `_agreementId?` | `string` \| `null` | -| `_agreementId_contains?` | `string` \| `null` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| `null` | -| `_agreementId_not_contains?` | `string` \| `null` | -| `_agreementId_not_in?` | `string`[] | -| `_amounts?` | `WeiSource`[] | -| `_amounts_contains?` | `WeiSource`[] | -| `_amounts_contains_nocase?` | `WeiSource`[] | -| `_amounts_not?` | `WeiSource`[] | -| `_amounts_not_contains?` | `WeiSource`[] | -| `_amounts_not_contains_nocase?` | `WeiSource`[] | -| `_conditionId?` | `string` \| `null` | -| `_conditionId_contains?` | `string` \| `null` | -| `_conditionId_in?` | `string`[] | -| `_conditionId_not?` | `string` \| `null` | -| `_conditionId_not_contains?` | `string` \| `null` | -| `_conditionId_not_in?` | `string`[] | -| `_receivers?` | `string`[] | -| `_receivers_contains?` | `string`[] | -| `_receivers_contains_nocase?` | `string`[] | -| `_receivers_not?` | `string`[] | -| `_receivers_not_contains?` | `string`[] | -| `_receivers_not_contains_nocase?` | `string`[] | -| `_tokenAddress?` | `string` \| `null` | -| `_tokenAddress_contains?` | `string` \| `null` | -| `_tokenAddress_in?` | `string`[] | -| `_tokenAddress_not?` | `string` \| `null` | -| `_tokenAddress_not_contains?` | `string` \| `null` | -| `_tokenAddress_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:21 - ---- - -### FulfilledResult - -Ƭ **FulfilledResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :--------------------- | -| `_agreementId` | `string` | -| `_amounts` | (`Wei` \| `null`)[] | -| `_conditionId` | `string` | -| `_receivers` | (`string` \| `null`)[] | -| `_tokenAddress` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:61 - ---- - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.EscrowPaymentCondition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:108 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:104 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:82 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:100 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:10 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.EscrowPaymentCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:145 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:140 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:113 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:135 - ---- - -### ReceivedArgs - -Ƭ **ReceivedArgs**<`K`\>: { [Property in keyof Pick]: ReceivedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------- | -| `K` | extends keyof [`ReceivedResult`](subgraphs.EscrowPaymentCondition.md#receivedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:184 - ---- - -### ReceivedFields - -Ƭ **ReceivedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :----- | -| `_from` | `true` | -| `_value` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:179 - ---- - -### ReceivedFilter - -Ƭ **ReceivedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------- | :-------------------- | -| `_from?` | `string` \| `null` | -| `_from_contains?` | `string` \| `null` | -| `_from_in?` | `string`[] | -| `_from_not?` | `string` \| `null` | -| `_from_not_contains?` | `string` \| `null` | -| `_from_not_in?` | `string`[] | -| `_value?` | `WeiSource` \| `null` | -| `_value_gt?` | `WeiSource` \| `null` | -| `_value_gte?` | `WeiSource` \| `null` | -| `_value_in?` | `WeiSource`[] | -| `_value_lt?` | `WeiSource` \| `null` | -| `_value_lte?` | `WeiSource` \| `null` | -| `_value_not?` | `WeiSource` \| `null` | -| `_value_not_in?` | `WeiSource`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:150 - ---- - -### ReceivedResult - -Ƭ **ReceivedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :------- | -| `_from` | `string` | -| `_value` | `Wei` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:174 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:2 - -## Functions - -### getFulfilledById - -▸ **getFulfilledById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.EscrowPaymentCondition.md#fulfilledresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.EscrowPaymentCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.EscrowPaymentCondition.md#singlequeryoptions) | -| `args` | [`FulfilledArgs`](subgraphs.EscrowPaymentCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.EscrowPaymentCondition.md#fulfilledresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:80 - ---- - -### getFulfilleds - -▸ **getFulfilleds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.EscrowPaymentCondition.md#fulfilledresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.EscrowPaymentCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.EscrowPaymentCondition.md#multiqueryoptions)<[`FulfilledFilter`](subgraphs.EscrowPaymentCondition.md#fulfilledfilter), [`FulfilledResult`](subgraphs.EscrowPaymentCondition.md#fulfilledresult)\> | -| `args` | [`FulfilledArgs`](subgraphs.EscrowPaymentCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.EscrowPaymentCondition.md#fulfilledresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:81 - ---- - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.EscrowPaymentCondition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.EscrowPaymentCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.EscrowPaymentCondition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.EscrowPaymentCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.EscrowPaymentCondition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:111 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.EscrowPaymentCondition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.EscrowPaymentCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.EscrowPaymentCondition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.EscrowPaymentCondition.md#initializedfilter), [`InitializedResult`](subgraphs.EscrowPaymentCondition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.EscrowPaymentCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.EscrowPaymentCondition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:112 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.EscrowPaymentCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.EscrowPaymentCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.EscrowPaymentCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.EscrowPaymentCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.EscrowPaymentCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:148 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.EscrowPaymentCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.EscrowPaymentCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.EscrowPaymentCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.EscrowPaymentCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.EscrowPaymentCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.EscrowPaymentCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.EscrowPaymentCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:149 - ---- - -### getReceivedById - -▸ **getReceivedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ReceivedResult`](subgraphs.EscrowPaymentCondition.md#receivedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------- | -| `K` | extends keyof [`ReceivedResult`](subgraphs.EscrowPaymentCondition.md#receivedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.EscrowPaymentCondition.md#singlequeryoptions) | -| `args` | [`ReceivedArgs`](subgraphs.EscrowPaymentCondition.md#receivedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ReceivedResult`](subgraphs.EscrowPaymentCondition.md#receivedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:187 - ---- - -### getReceiveds - -▸ **getReceiveds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ReceivedResult`](subgraphs.EscrowPaymentCondition.md#receivedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------- | -| `K` | extends keyof [`ReceivedResult`](subgraphs.EscrowPaymentCondition.md#receivedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.EscrowPaymentCondition.md#multiqueryoptions)<[`ReceivedFilter`](subgraphs.EscrowPaymentCondition.md#receivedfilter), [`ReceivedResult`](subgraphs.EscrowPaymentCondition.md#receivedresult)\> | -| `args` | [`ReceivedArgs`](subgraphs.EscrowPaymentCondition.md#receivedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ReceivedResult`](subgraphs.EscrowPaymentCondition.md#receivedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/EscrowPaymentCondition.d.ts:188 diff --git a/docs/api-reference/modules/subgraphs.HashLockCondition.md b/docs/api-reference/modules/subgraphs.HashLockCondition.md deleted file mode 100644 index a51f21d19..000000000 --- a/docs/api-reference/modules/subgraphs.HashLockCondition.md +++ /dev/null @@ -1,351 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / HashLockCondition - -# Namespace: HashLockCondition - -[subgraphs](subgraphs.md).HashLockCondition - -## Table of contents - -### Type Aliases - -- [InitializedArgs](subgraphs.HashLockCondition.md#initializedargs) -- [InitializedFields](subgraphs.HashLockCondition.md#initializedfields) -- [InitializedFilter](subgraphs.HashLockCondition.md#initializedfilter) -- [InitializedResult](subgraphs.HashLockCondition.md#initializedresult) -- [MultiQueryOptions](subgraphs.HashLockCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.HashLockCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.HashLockCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.HashLockCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.HashLockCondition.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.HashLockCondition.md#singlequeryoptions) - -### Functions - -- [getInitializedById](subgraphs.HashLockCondition.md#getinitializedbyid) -- [getInitializeds](subgraphs.HashLockCondition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.HashLockCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.HashLockCondition.md#getownershiptransferreds) - -## Type Aliases - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.HashLockCondition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/HashLockCondition.d.ts:46 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/HashLockCondition.d.ts:42 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/HashLockCondition.d.ts:20 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/HashLockCondition.d.ts:38 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/HashLockCondition.d.ts:9 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.HashLockCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/HashLockCondition.d.ts:83 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/HashLockCondition.d.ts:78 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/HashLockCondition.d.ts:51 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/HashLockCondition.d.ts:73 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/HashLockCondition.d.ts:1 - -## Functions - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.HashLockCondition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.HashLockCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.HashLockCondition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.HashLockCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.HashLockCondition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/HashLockCondition.d.ts:49 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.HashLockCondition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.HashLockCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.HashLockCondition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.HashLockCondition.md#initializedfilter), [`InitializedResult`](subgraphs.HashLockCondition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.HashLockCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.HashLockCondition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/HashLockCondition.d.ts:50 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.HashLockCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.HashLockCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.HashLockCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.HashLockCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.HashLockCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/HashLockCondition.d.ts:86 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.HashLockCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.HashLockCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.HashLockCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.HashLockCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.HashLockCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.HashLockCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.HashLockCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/HashLockCondition.d.ts:87 diff --git a/docs/api-reference/modules/subgraphs.LockPaymentCondition.md b/docs/api-reference/modules/subgraphs.LockPaymentCondition.md deleted file mode 100644 index 372d4a27b..000000000 --- a/docs/api-reference/modules/subgraphs.LockPaymentCondition.md +++ /dev/null @@ -1,1011 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / LockPaymentCondition - -# Namespace: LockPaymentCondition - -[subgraphs](subgraphs.md).LockPaymentCondition - -## Table of contents - -### Type Aliases - -- [FulfilledArgs](subgraphs.LockPaymentCondition.md#fulfilledargs) -- [FulfilledFields](subgraphs.LockPaymentCondition.md#fulfilledfields) -- [FulfilledFilter](subgraphs.LockPaymentCondition.md#fulfilledfilter) -- [FulfilledResult](subgraphs.LockPaymentCondition.md#fulfilledresult) -- [InitializedArgs](subgraphs.LockPaymentCondition.md#initializedargs) -- [InitializedFields](subgraphs.LockPaymentCondition.md#initializedfields) -- [InitializedFilter](subgraphs.LockPaymentCondition.md#initializedfilter) -- [InitializedResult](subgraphs.LockPaymentCondition.md#initializedresult) -- [MultiQueryOptions](subgraphs.LockPaymentCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.LockPaymentCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.LockPaymentCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.LockPaymentCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.LockPaymentCondition.md#ownershiptransferredresult) -- [RoleAdminChangedArgs](subgraphs.LockPaymentCondition.md#roleadminchangedargs) -- [RoleAdminChangedFields](subgraphs.LockPaymentCondition.md#roleadminchangedfields) -- [RoleAdminChangedFilter](subgraphs.LockPaymentCondition.md#roleadminchangedfilter) -- [RoleAdminChangedResult](subgraphs.LockPaymentCondition.md#roleadminchangedresult) -- [RoleGrantedArgs](subgraphs.LockPaymentCondition.md#rolegrantedargs) -- [RoleGrantedFields](subgraphs.LockPaymentCondition.md#rolegrantedfields) -- [RoleGrantedFilter](subgraphs.LockPaymentCondition.md#rolegrantedfilter) -- [RoleGrantedResult](subgraphs.LockPaymentCondition.md#rolegrantedresult) -- [RoleRevokedArgs](subgraphs.LockPaymentCondition.md#rolerevokedargs) -- [RoleRevokedFields](subgraphs.LockPaymentCondition.md#rolerevokedfields) -- [RoleRevokedFilter](subgraphs.LockPaymentCondition.md#rolerevokedfilter) -- [RoleRevokedResult](subgraphs.LockPaymentCondition.md#rolerevokedresult) -- [SingleQueryOptions](subgraphs.LockPaymentCondition.md#singlequeryoptions) - -### Functions - -- [getFulfilledById](subgraphs.LockPaymentCondition.md#getfulfilledbyid) -- [getFulfilleds](subgraphs.LockPaymentCondition.md#getfulfilleds) -- [getInitializedById](subgraphs.LockPaymentCondition.md#getinitializedbyid) -- [getInitializeds](subgraphs.LockPaymentCondition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.LockPaymentCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.LockPaymentCondition.md#getownershiptransferreds) -- [getRoleAdminChangedById](subgraphs.LockPaymentCondition.md#getroleadminchangedbyid) -- [getRoleAdminChangeds](subgraphs.LockPaymentCondition.md#getroleadminchangeds) -- [getRoleGrantedById](subgraphs.LockPaymentCondition.md#getrolegrantedbyid) -- [getRoleGranteds](subgraphs.LockPaymentCondition.md#getrolegranteds) -- [getRoleRevokedById](subgraphs.LockPaymentCondition.md#getrolerevokedbyid) -- [getRoleRevokeds](subgraphs.LockPaymentCondition.md#getrolerevokeds) - -## Type Aliases - -### FulfilledArgs - -Ƭ **FulfilledArgs**<`K`\>: { [Property in keyof Pick]: FulfilledFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.LockPaymentCondition.md#fulfilledresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:93 - ---- - -### FulfilledFields - -Ƭ **FulfilledFields**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------- | :----- | -| `_agreementId` | `true` | -| `_amounts` | `true` | -| `_conditionId` | `true` | -| `_did` | `true` | -| `_receivers` | `true` | -| `_rewardAddress` | `true` | -| `_tokenAddress` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:83 - ---- - -### FulfilledFilter - -Ƭ **FulfilledFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------------------- | :----------------- | -| `_agreementId?` | `string` \| `null` | -| `_agreementId_contains?` | `string` \| `null` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| `null` | -| `_agreementId_not_contains?` | `string` \| `null` | -| `_agreementId_not_in?` | `string`[] | -| `_amounts?` | `WeiSource`[] | -| `_amounts_contains?` | `WeiSource`[] | -| `_amounts_contains_nocase?` | `WeiSource`[] | -| `_amounts_not?` | `WeiSource`[] | -| `_amounts_not_contains?` | `WeiSource`[] | -| `_amounts_not_contains_nocase?` | `WeiSource`[] | -| `_conditionId?` | `string` \| `null` | -| `_conditionId_contains?` | `string` \| `null` | -| `_conditionId_in?` | `string`[] | -| `_conditionId_not?` | `string` \| `null` | -| `_conditionId_not_contains?` | `string` \| `null` | -| `_conditionId_not_in?` | `string`[] | -| `_did?` | `string` \| `null` | -| `_did_contains?` | `string` \| `null` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| `null` | -| `_did_not_contains?` | `string` \| `null` | -| `_did_not_in?` | `string`[] | -| `_receivers?` | `string`[] | -| `_receivers_contains?` | `string`[] | -| `_receivers_contains_nocase?` | `string`[] | -| `_receivers_not?` | `string`[] | -| `_receivers_not_contains?` | `string`[] | -| `_receivers_not_contains_nocase?` | `string`[] | -| `_rewardAddress?` | `string` \| `null` | -| `_rewardAddress_contains?` | `string` \| `null` | -| `_rewardAddress_in?` | `string`[] | -| `_rewardAddress_not?` | `string` \| `null` | -| `_rewardAddress_not_contains?` | `string` \| `null` | -| `_rewardAddress_not_in?` | `string`[] | -| `_tokenAddress?` | `string` \| `null` | -| `_tokenAddress_contains?` | `string` \| `null` | -| `_tokenAddress_in?` | `string`[] | -| `_tokenAddress_not?` | `string` \| `null` | -| `_tokenAddress_not_contains?` | `string` \| `null` | -| `_tokenAddress_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:21 - ---- - -### FulfilledResult - -Ƭ **FulfilledResult**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------- | :--------------------- | -| `_agreementId` | `string` | -| `_amounts` | (`Wei` \| `null`)[] | -| `_conditionId` | `string` | -| `_did` | `string` | -| `_receivers` | (`string` \| `null`)[] | -| `_rewardAddress` | `string` | -| `_tokenAddress` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:73 - ---- - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.LockPaymentCondition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:124 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:120 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:98 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:116 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:10 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.LockPaymentCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:161 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:156 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:129 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:151 - ---- - -### RoleAdminChangedArgs - -Ƭ **RoleAdminChangedArgs**<`K`\>: { [Property in keyof Pick]: RoleAdminChangedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.LockPaymentCondition.md#roleadminchangedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:206 - ---- - -### RoleAdminChangedFields - -Ƭ **RoleAdminChangedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :----- | -| `id` | `true` | -| `newAdminRole` | `true` | -| `previousAdminRole` | `true` | -| `role` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:200 - ---- - -### RoleAdminChangedFilter - -Ƭ **RoleAdminChangedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newAdminRole?` | `string` \| `null` | -| `newAdminRole_contains?` | `string` \| `null` | -| `newAdminRole_in?` | `string`[] | -| `newAdminRole_not?` | `string` \| `null` | -| `newAdminRole_not_contains?` | `string` \| `null` | -| `newAdminRole_not_in?` | `string`[] | -| `previousAdminRole?` | `string` \| `null` | -| `previousAdminRole_contains?` | `string` \| `null` | -| `previousAdminRole_in?` | `string`[] | -| `previousAdminRole_not?` | `string` \| `null` | -| `previousAdminRole_not_contains?` | `string` \| `null` | -| `previousAdminRole_not_in?` | `string`[] | -| `role?` | `string` \| `null` | -| `role_contains?` | `string` \| `null` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| `null` | -| `role_not_contains?` | `string` \| `null` | -| `role_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:166 - ---- - -### RoleAdminChangedResult - -Ƭ **RoleAdminChangedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :------- | -| `id` | `string` | -| `newAdminRole` | `string` | -| `previousAdminRole` | `string` | -| `role` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:194 - ---- - -### RoleGrantedArgs - -Ƭ **RoleGrantedArgs**<`K`\>: { [Property in keyof Pick]: RoleGrantedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.LockPaymentCondition.md#rolegrantedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:251 - ---- - -### RoleGrantedFields - -Ƭ **RoleGrantedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `account` | `true` | -| `id` | `true` | -| `role` | `true` | -| `sender` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:245 - ---- - -### RoleGrantedFilter - -Ƭ **RoleGrantedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------- | :----------------- | -| `account?` | `string` \| `null` | -| `account_contains?` | `string` \| `null` | -| `account_in?` | `string`[] | -| `account_not?` | `string` \| `null` | -| `account_not_contains?` | `string` \| `null` | -| `account_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `role?` | `string` \| `null` | -| `role_contains?` | `string` \| `null` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| `null` | -| `role_not_contains?` | `string` \| `null` | -| `role_not_in?` | `string`[] | -| `sender?` | `string` \| `null` | -| `sender_contains?` | `string` \| `null` | -| `sender_in?` | `string`[] | -| `sender_not?` | `string` \| `null` | -| `sender_not_contains?` | `string` \| `null` | -| `sender_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:211 - ---- - -### RoleGrantedResult - -Ƭ **RoleGrantedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `account` | `string` | -| `id` | `string` | -| `role` | `string` | -| `sender` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:239 - ---- - -### RoleRevokedArgs - -Ƭ **RoleRevokedArgs**<`K`\>: { [Property in keyof Pick]: RoleRevokedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.LockPaymentCondition.md#rolerevokedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:296 - ---- - -### RoleRevokedFields - -Ƭ **RoleRevokedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `account` | `true` | -| `id` | `true` | -| `role` | `true` | -| `sender` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:290 - ---- - -### RoleRevokedFilter - -Ƭ **RoleRevokedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------- | :----------------- | -| `account?` | `string` \| `null` | -| `account_contains?` | `string` \| `null` | -| `account_in?` | `string`[] | -| `account_not?` | `string` \| `null` | -| `account_not_contains?` | `string` \| `null` | -| `account_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `role?` | `string` \| `null` | -| `role_contains?` | `string` \| `null` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| `null` | -| `role_not_contains?` | `string` \| `null` | -| `role_not_in?` | `string`[] | -| `sender?` | `string` \| `null` | -| `sender_contains?` | `string` \| `null` | -| `sender_in?` | `string`[] | -| `sender_not?` | `string` \| `null` | -| `sender_not_contains?` | `string` \| `null` | -| `sender_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:256 - ---- - -### RoleRevokedResult - -Ƭ **RoleRevokedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `account` | `string` | -| `id` | `string` | -| `role` | `string` | -| `sender` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:284 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:2 - -## Functions - -### getFulfilledById - -▸ **getFulfilledById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.LockPaymentCondition.md#fulfilledresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.LockPaymentCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.LockPaymentCondition.md#singlequeryoptions) | -| `args` | [`FulfilledArgs`](subgraphs.LockPaymentCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.LockPaymentCondition.md#fulfilledresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:96 - ---- - -### getFulfilleds - -▸ **getFulfilleds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.LockPaymentCondition.md#fulfilledresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.LockPaymentCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.LockPaymentCondition.md#multiqueryoptions)<[`FulfilledFilter`](subgraphs.LockPaymentCondition.md#fulfilledfilter), [`FulfilledResult`](subgraphs.LockPaymentCondition.md#fulfilledresult)\> | -| `args` | [`FulfilledArgs`](subgraphs.LockPaymentCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.LockPaymentCondition.md#fulfilledresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:97 - ---- - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.LockPaymentCondition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.LockPaymentCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.LockPaymentCondition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.LockPaymentCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.LockPaymentCondition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:127 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.LockPaymentCondition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.LockPaymentCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.LockPaymentCondition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.LockPaymentCondition.md#initializedfilter), [`InitializedResult`](subgraphs.LockPaymentCondition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.LockPaymentCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.LockPaymentCondition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:128 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.LockPaymentCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.LockPaymentCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.LockPaymentCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.LockPaymentCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.LockPaymentCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:164 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.LockPaymentCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.LockPaymentCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.LockPaymentCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.LockPaymentCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.LockPaymentCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.LockPaymentCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.LockPaymentCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:165 - ---- - -### getRoleAdminChangedById - -▸ **getRoleAdminChangedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.LockPaymentCondition.md#roleadminchangedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.LockPaymentCondition.md#roleadminchangedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.LockPaymentCondition.md#singlequeryoptions) | -| `args` | [`RoleAdminChangedArgs`](subgraphs.LockPaymentCondition.md#roleadminchangedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.LockPaymentCondition.md#roleadminchangedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:209 - ---- - -### getRoleAdminChangeds - -▸ **getRoleAdminChangeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.LockPaymentCondition.md#roleadminchangedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.LockPaymentCondition.md#roleadminchangedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.LockPaymentCondition.md#multiqueryoptions)<[`RoleAdminChangedFilter`](subgraphs.LockPaymentCondition.md#roleadminchangedfilter), [`RoleAdminChangedResult`](subgraphs.LockPaymentCondition.md#roleadminchangedresult)\> | -| `args` | [`RoleAdminChangedArgs`](subgraphs.LockPaymentCondition.md#roleadminchangedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.LockPaymentCondition.md#roleadminchangedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:210 - ---- - -### getRoleGrantedById - -▸ **getRoleGrantedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.LockPaymentCondition.md#rolegrantedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.LockPaymentCondition.md#rolegrantedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.LockPaymentCondition.md#singlequeryoptions) | -| `args` | [`RoleGrantedArgs`](subgraphs.LockPaymentCondition.md#rolegrantedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.LockPaymentCondition.md#rolegrantedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:254 - ---- - -### getRoleGranteds - -▸ **getRoleGranteds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.LockPaymentCondition.md#rolegrantedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.LockPaymentCondition.md#rolegrantedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.LockPaymentCondition.md#multiqueryoptions)<[`RoleGrantedFilter`](subgraphs.LockPaymentCondition.md#rolegrantedfilter), [`RoleGrantedResult`](subgraphs.LockPaymentCondition.md#rolegrantedresult)\> | -| `args` | [`RoleGrantedArgs`](subgraphs.LockPaymentCondition.md#rolegrantedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.LockPaymentCondition.md#rolegrantedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:255 - ---- - -### getRoleRevokedById - -▸ **getRoleRevokedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.LockPaymentCondition.md#rolerevokedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.LockPaymentCondition.md#rolerevokedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.LockPaymentCondition.md#singlequeryoptions) | -| `args` | [`RoleRevokedArgs`](subgraphs.LockPaymentCondition.md#rolerevokedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.LockPaymentCondition.md#rolerevokedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:299 - ---- - -### getRoleRevokeds - -▸ **getRoleRevokeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.LockPaymentCondition.md#rolerevokedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.LockPaymentCondition.md#rolerevokedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.LockPaymentCondition.md#multiqueryoptions)<[`RoleRevokedFilter`](subgraphs.LockPaymentCondition.md#rolerevokedfilter), [`RoleRevokedResult`](subgraphs.LockPaymentCondition.md#rolerevokedresult)\> | -| `args` | [`RoleRevokedArgs`](subgraphs.LockPaymentCondition.md#rolerevokedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.LockPaymentCondition.md#rolerevokedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/LockPaymentCondition.d.ts:300 diff --git a/docs/api-reference/modules/subgraphs.NFT721AccessProofTemplate.md b/docs/api-reference/modules/subgraphs.NFT721AccessProofTemplate.md deleted file mode 100644 index ac5e1645b..000000000 --- a/docs/api-reference/modules/subgraphs.NFT721AccessProofTemplate.md +++ /dev/null @@ -1,564 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / NFT721AccessProofTemplate - -# Namespace: NFT721AccessProofTemplate - -[subgraphs](subgraphs.md).NFT721AccessProofTemplate - -## Table of contents - -### Type Aliases - -- [AgreementCreatedArgs](subgraphs.NFT721AccessProofTemplate.md#agreementcreatedargs) -- [AgreementCreatedFields](subgraphs.NFT721AccessProofTemplate.md#agreementcreatedfields) -- [AgreementCreatedFilter](subgraphs.NFT721AccessProofTemplate.md#agreementcreatedfilter) -- [AgreementCreatedResult](subgraphs.NFT721AccessProofTemplate.md#agreementcreatedresult) -- [InitializedArgs](subgraphs.NFT721AccessProofTemplate.md#initializedargs) -- [InitializedFields](subgraphs.NFT721AccessProofTemplate.md#initializedfields) -- [InitializedFilter](subgraphs.NFT721AccessProofTemplate.md#initializedfilter) -- [InitializedResult](subgraphs.NFT721AccessProofTemplate.md#initializedresult) -- [MultiQueryOptions](subgraphs.NFT721AccessProofTemplate.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.NFT721AccessProofTemplate.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.NFT721AccessProofTemplate.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.NFT721AccessProofTemplate.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.NFT721AccessProofTemplate.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.NFT721AccessProofTemplate.md#singlequeryoptions) - -### Functions - -- [getAgreementCreatedById](subgraphs.NFT721AccessProofTemplate.md#getagreementcreatedbyid) -- [getAgreementCreateds](subgraphs.NFT721AccessProofTemplate.md#getagreementcreateds) -- [getInitializedById](subgraphs.NFT721AccessProofTemplate.md#getinitializedbyid) -- [getInitializeds](subgraphs.NFT721AccessProofTemplate.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.NFT721AccessProofTemplate.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.NFT721AccessProofTemplate.md#getownershiptransferreds) - -## Type Aliases - -### AgreementCreatedArgs - -Ƭ **AgreementCreatedArgs**<`K`\>: { [Property in keyof Pick]: AgreementCreatedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFT721AccessProofTemplate.md#agreementcreatedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessProofTemplate.d.ts:117 - ---- - -### AgreementCreatedFields - -Ƭ **AgreementCreatedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :----- | -| `_accessConsumer` | `true` | -| `_accessProvider` | `true` | -| `_agreementId` | `true` | -| `_conditionIdSeeds` | `true` | -| `_conditionIds` | `true` | -| `_creator` | `true` | -| `_did` | `true` | -| `_idSeed` | `true` | -| `_timeLocks` | `true` | -| `_timeOuts` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessProofTemplate.d.ts:104 - ---- - -### AgreementCreatedFilter - -Ƭ **AgreementCreatedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------------------------------- | :----------------- | -| `_accessConsumer?` | `string` \| `null` | -| `_accessConsumer_contains?` | `string` \| `null` | -| `_accessConsumer_in?` | `string`[] | -| `_accessConsumer_not?` | `string` \| `null` | -| `_accessConsumer_not_contains?` | `string` \| `null` | -| `_accessConsumer_not_in?` | `string`[] | -| `_accessProvider?` | `string` \| `null` | -| `_accessProvider_contains?` | `string` \| `null` | -| `_accessProvider_in?` | `string`[] | -| `_accessProvider_not?` | `string` \| `null` | -| `_accessProvider_not_contains?` | `string` \| `null` | -| `_accessProvider_not_in?` | `string`[] | -| `_agreementId?` | `string` \| `null` | -| `_agreementId_contains?` | `string` \| `null` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| `null` | -| `_agreementId_not_contains?` | `string` \| `null` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionIdSeeds?` | `string`[] | -| `_conditionIdSeeds_contains?` | `string`[] | -| `_conditionIdSeeds_contains_nocase?` | `string`[] | -| `_conditionIdSeeds_not?` | `string`[] | -| `_conditionIdSeeds_not_contains?` | `string`[] | -| `_conditionIdSeeds_not_contains_nocase?` | `string`[] | -| `_conditionIds?` | `string`[] | -| `_conditionIds_contains?` | `string`[] | -| `_conditionIds_contains_nocase?` | `string`[] | -| `_conditionIds_not?` | `string`[] | -| `_conditionIds_not_contains?` | `string`[] | -| `_conditionIds_not_contains_nocase?` | `string`[] | -| `_creator?` | `string` \| `null` | -| `_creator_contains?` | `string` \| `null` | -| `_creator_in?` | `string`[] | -| `_creator_not?` | `string` \| `null` | -| `_creator_not_contains?` | `string` \| `null` | -| `_creator_not_in?` | `string`[] | -| `_did?` | `string` \| `null` | -| `_did_contains?` | `string` \| `null` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| `null` | -| `_did_not_contains?` | `string` \| `null` | -| `_did_not_in?` | `string`[] | -| `_idSeed?` | `string` \| `null` | -| `_idSeed_contains?` | `string` \| `null` | -| `_idSeed_in?` | `string`[] | -| `_idSeed_not?` | `string` \| `null` | -| `_idSeed_not_contains?` | `string` \| `null` | -| `_idSeed_not_in?` | `string`[] | -| `_timeLocks?` | `WeiSource`[] | -| `_timeLocks_contains?` | `WeiSource`[] | -| `_timeLocks_contains_nocase?` | `WeiSource`[] | -| `_timeLocks_not?` | `WeiSource`[] | -| `_timeLocks_not_contains?` | `WeiSource`[] | -| `_timeLocks_not_contains_nocase?` | `WeiSource`[] | -| `_timeOuts?` | `WeiSource`[] | -| `_timeOuts_contains?` | `WeiSource`[] | -| `_timeOuts_contains_nocase?` | `WeiSource`[] | -| `_timeOuts_not?` | `WeiSource`[] | -| `_timeOuts_not_contains?` | `WeiSource`[] | -| `_timeOuts_not_contains_nocase?` | `WeiSource`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessProofTemplate.d.ts:21 - ---- - -### AgreementCreatedResult - -Ƭ **AgreementCreatedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :--------------------- | -| `_accessConsumer` | `string` | -| `_accessProvider` | `string` | -| `_agreementId` | `string` | -| `_conditionIdSeeds` | (`string` \| `null`)[] | -| `_conditionIds` | (`string` \| `null`)[] | -| `_creator` | `string` | -| `_did` | `string` | -| `_idSeed` | `string` | -| `_timeLocks` | (`Wei` \| `null`)[] | -| `_timeOuts` | (`Wei` \| `null`)[] | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessProofTemplate.d.ts:91 - ---- - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721AccessProofTemplate.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessProofTemplate.d.ts:148 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessProofTemplate.d.ts:144 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessProofTemplate.d.ts:122 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessProofTemplate.d.ts:140 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessProofTemplate.d.ts:10 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721AccessProofTemplate.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessProofTemplate.d.ts:185 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessProofTemplate.d.ts:180 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessProofTemplate.d.ts:153 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessProofTemplate.d.ts:175 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessProofTemplate.d.ts:2 - -## Functions - -### getAgreementCreatedById - -▸ **getAgreementCreatedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFT721AccessProofTemplate.md#agreementcreatedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFT721AccessProofTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721AccessProofTemplate.md#singlequeryoptions) | -| `args` | [`AgreementCreatedArgs`](subgraphs.NFT721AccessProofTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFT721AccessProofTemplate.md#agreementcreatedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessProofTemplate.d.ts:120 - ---- - -### getAgreementCreateds - -▸ **getAgreementCreateds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFT721AccessProofTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFT721AccessProofTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721AccessProofTemplate.md#multiqueryoptions)<[`AgreementCreatedFilter`](subgraphs.NFT721AccessProofTemplate.md#agreementcreatedfilter), [`AgreementCreatedResult`](subgraphs.NFT721AccessProofTemplate.md#agreementcreatedresult)\> | -| `args` | [`AgreementCreatedArgs`](subgraphs.NFT721AccessProofTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFT721AccessProofTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessProofTemplate.d.ts:121 - ---- - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721AccessProofTemplate.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721AccessProofTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721AccessProofTemplate.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.NFT721AccessProofTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721AccessProofTemplate.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessProofTemplate.d.ts:151 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721AccessProofTemplate.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721AccessProofTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721AccessProofTemplate.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.NFT721AccessProofTemplate.md#initializedfilter), [`InitializedResult`](subgraphs.NFT721AccessProofTemplate.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.NFT721AccessProofTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721AccessProofTemplate.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessProofTemplate.d.ts:152 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721AccessProofTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721AccessProofTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721AccessProofTemplate.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFT721AccessProofTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721AccessProofTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessProofTemplate.d.ts:188 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721AccessProofTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721AccessProofTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721AccessProofTemplate.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.NFT721AccessProofTemplate.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.NFT721AccessProofTemplate.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFT721AccessProofTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721AccessProofTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessProofTemplate.d.ts:189 diff --git a/docs/api-reference/modules/subgraphs.NFT721AccessSwapTemplate.md b/docs/api-reference/modules/subgraphs.NFT721AccessSwapTemplate.md deleted file mode 100644 index 7e8044d1d..000000000 --- a/docs/api-reference/modules/subgraphs.NFT721AccessSwapTemplate.md +++ /dev/null @@ -1,564 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / NFT721AccessSwapTemplate - -# Namespace: NFT721AccessSwapTemplate - -[subgraphs](subgraphs.md).NFT721AccessSwapTemplate - -## Table of contents - -### Type Aliases - -- [AgreementCreatedArgs](subgraphs.NFT721AccessSwapTemplate.md#agreementcreatedargs) -- [AgreementCreatedFields](subgraphs.NFT721AccessSwapTemplate.md#agreementcreatedfields) -- [AgreementCreatedFilter](subgraphs.NFT721AccessSwapTemplate.md#agreementcreatedfilter) -- [AgreementCreatedResult](subgraphs.NFT721AccessSwapTemplate.md#agreementcreatedresult) -- [InitializedArgs](subgraphs.NFT721AccessSwapTemplate.md#initializedargs) -- [InitializedFields](subgraphs.NFT721AccessSwapTemplate.md#initializedfields) -- [InitializedFilter](subgraphs.NFT721AccessSwapTemplate.md#initializedfilter) -- [InitializedResult](subgraphs.NFT721AccessSwapTemplate.md#initializedresult) -- [MultiQueryOptions](subgraphs.NFT721AccessSwapTemplate.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.NFT721AccessSwapTemplate.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.NFT721AccessSwapTemplate.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.NFT721AccessSwapTemplate.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.NFT721AccessSwapTemplate.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.NFT721AccessSwapTemplate.md#singlequeryoptions) - -### Functions - -- [getAgreementCreatedById](subgraphs.NFT721AccessSwapTemplate.md#getagreementcreatedbyid) -- [getAgreementCreateds](subgraphs.NFT721AccessSwapTemplate.md#getagreementcreateds) -- [getInitializedById](subgraphs.NFT721AccessSwapTemplate.md#getinitializedbyid) -- [getInitializeds](subgraphs.NFT721AccessSwapTemplate.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.NFT721AccessSwapTemplate.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.NFT721AccessSwapTemplate.md#getownershiptransferreds) - -## Type Aliases - -### AgreementCreatedArgs - -Ƭ **AgreementCreatedArgs**<`K`\>: { [Property in keyof Pick]: AgreementCreatedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFT721AccessSwapTemplate.md#agreementcreatedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessSwapTemplate.d.ts:117 - ---- - -### AgreementCreatedFields - -Ƭ **AgreementCreatedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :----- | -| `_accessConsumer` | `true` | -| `_accessProvider` | `true` | -| `_agreementId` | `true` | -| `_conditionIdSeeds` | `true` | -| `_conditionIds` | `true` | -| `_creator` | `true` | -| `_did` | `true` | -| `_idSeed` | `true` | -| `_timeLocks` | `true` | -| `_timeOuts` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessSwapTemplate.d.ts:104 - ---- - -### AgreementCreatedFilter - -Ƭ **AgreementCreatedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------------------------------- | :----------------- | -| `_accessConsumer?` | `string` \| `null` | -| `_accessConsumer_contains?` | `string` \| `null` | -| `_accessConsumer_in?` | `string`[] | -| `_accessConsumer_not?` | `string` \| `null` | -| `_accessConsumer_not_contains?` | `string` \| `null` | -| `_accessConsumer_not_in?` | `string`[] | -| `_accessProvider?` | `string` \| `null` | -| `_accessProvider_contains?` | `string` \| `null` | -| `_accessProvider_in?` | `string`[] | -| `_accessProvider_not?` | `string` \| `null` | -| `_accessProvider_not_contains?` | `string` \| `null` | -| `_accessProvider_not_in?` | `string`[] | -| `_agreementId?` | `string` \| `null` | -| `_agreementId_contains?` | `string` \| `null` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| `null` | -| `_agreementId_not_contains?` | `string` \| `null` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionIdSeeds?` | `string`[] | -| `_conditionIdSeeds_contains?` | `string`[] | -| `_conditionIdSeeds_contains_nocase?` | `string`[] | -| `_conditionIdSeeds_not?` | `string`[] | -| `_conditionIdSeeds_not_contains?` | `string`[] | -| `_conditionIdSeeds_not_contains_nocase?` | `string`[] | -| `_conditionIds?` | `string`[] | -| `_conditionIds_contains?` | `string`[] | -| `_conditionIds_contains_nocase?` | `string`[] | -| `_conditionIds_not?` | `string`[] | -| `_conditionIds_not_contains?` | `string`[] | -| `_conditionIds_not_contains_nocase?` | `string`[] | -| `_creator?` | `string` \| `null` | -| `_creator_contains?` | `string` \| `null` | -| `_creator_in?` | `string`[] | -| `_creator_not?` | `string` \| `null` | -| `_creator_not_contains?` | `string` \| `null` | -| `_creator_not_in?` | `string`[] | -| `_did?` | `string` \| `null` | -| `_did_contains?` | `string` \| `null` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| `null` | -| `_did_not_contains?` | `string` \| `null` | -| `_did_not_in?` | `string`[] | -| `_idSeed?` | `string` \| `null` | -| `_idSeed_contains?` | `string` \| `null` | -| `_idSeed_in?` | `string`[] | -| `_idSeed_not?` | `string` \| `null` | -| `_idSeed_not_contains?` | `string` \| `null` | -| `_idSeed_not_in?` | `string`[] | -| `_timeLocks?` | `WeiSource`[] | -| `_timeLocks_contains?` | `WeiSource`[] | -| `_timeLocks_contains_nocase?` | `WeiSource`[] | -| `_timeLocks_not?` | `WeiSource`[] | -| `_timeLocks_not_contains?` | `WeiSource`[] | -| `_timeLocks_not_contains_nocase?` | `WeiSource`[] | -| `_timeOuts?` | `WeiSource`[] | -| `_timeOuts_contains?` | `WeiSource`[] | -| `_timeOuts_contains_nocase?` | `WeiSource`[] | -| `_timeOuts_not?` | `WeiSource`[] | -| `_timeOuts_not_contains?` | `WeiSource`[] | -| `_timeOuts_not_contains_nocase?` | `WeiSource`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessSwapTemplate.d.ts:21 - ---- - -### AgreementCreatedResult - -Ƭ **AgreementCreatedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :--------------------- | -| `_accessConsumer` | `string` | -| `_accessProvider` | `string` | -| `_agreementId` | `string` | -| `_conditionIdSeeds` | (`string` \| `null`)[] | -| `_conditionIds` | (`string` \| `null`)[] | -| `_creator` | `string` | -| `_did` | `string` | -| `_idSeed` | `string` | -| `_timeLocks` | (`Wei` \| `null`)[] | -| `_timeOuts` | (`Wei` \| `null`)[] | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessSwapTemplate.d.ts:91 - ---- - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721AccessSwapTemplate.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessSwapTemplate.d.ts:148 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessSwapTemplate.d.ts:144 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessSwapTemplate.d.ts:122 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessSwapTemplate.d.ts:140 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessSwapTemplate.d.ts:10 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721AccessSwapTemplate.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessSwapTemplate.d.ts:185 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessSwapTemplate.d.ts:180 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessSwapTemplate.d.ts:153 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessSwapTemplate.d.ts:175 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessSwapTemplate.d.ts:2 - -## Functions - -### getAgreementCreatedById - -▸ **getAgreementCreatedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFT721AccessSwapTemplate.md#agreementcreatedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFT721AccessSwapTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721AccessSwapTemplate.md#singlequeryoptions) | -| `args` | [`AgreementCreatedArgs`](subgraphs.NFT721AccessSwapTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFT721AccessSwapTemplate.md#agreementcreatedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessSwapTemplate.d.ts:120 - ---- - -### getAgreementCreateds - -▸ **getAgreementCreateds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFT721AccessSwapTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFT721AccessSwapTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721AccessSwapTemplate.md#multiqueryoptions)<[`AgreementCreatedFilter`](subgraphs.NFT721AccessSwapTemplate.md#agreementcreatedfilter), [`AgreementCreatedResult`](subgraphs.NFT721AccessSwapTemplate.md#agreementcreatedresult)\> | -| `args` | [`AgreementCreatedArgs`](subgraphs.NFT721AccessSwapTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFT721AccessSwapTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessSwapTemplate.d.ts:121 - ---- - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721AccessSwapTemplate.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721AccessSwapTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721AccessSwapTemplate.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.NFT721AccessSwapTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721AccessSwapTemplate.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessSwapTemplate.d.ts:151 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721AccessSwapTemplate.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721AccessSwapTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721AccessSwapTemplate.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.NFT721AccessSwapTemplate.md#initializedfilter), [`InitializedResult`](subgraphs.NFT721AccessSwapTemplate.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.NFT721AccessSwapTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721AccessSwapTemplate.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessSwapTemplate.d.ts:152 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721AccessSwapTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721AccessSwapTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721AccessSwapTemplate.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFT721AccessSwapTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721AccessSwapTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessSwapTemplate.d.ts:188 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721AccessSwapTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721AccessSwapTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721AccessSwapTemplate.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.NFT721AccessSwapTemplate.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.NFT721AccessSwapTemplate.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFT721AccessSwapTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721AccessSwapTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessSwapTemplate.d.ts:189 diff --git a/docs/api-reference/modules/subgraphs.NFT721AccessTemplate.md b/docs/api-reference/modules/subgraphs.NFT721AccessTemplate.md deleted file mode 100644 index 5006d3837..000000000 --- a/docs/api-reference/modules/subgraphs.NFT721AccessTemplate.md +++ /dev/null @@ -1,564 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / NFT721AccessTemplate - -# Namespace: NFT721AccessTemplate - -[subgraphs](subgraphs.md).NFT721AccessTemplate - -## Table of contents - -### Type Aliases - -- [AgreementCreatedArgs](subgraphs.NFT721AccessTemplate.md#agreementcreatedargs) -- [AgreementCreatedFields](subgraphs.NFT721AccessTemplate.md#agreementcreatedfields) -- [AgreementCreatedFilter](subgraphs.NFT721AccessTemplate.md#agreementcreatedfilter) -- [AgreementCreatedResult](subgraphs.NFT721AccessTemplate.md#agreementcreatedresult) -- [InitializedArgs](subgraphs.NFT721AccessTemplate.md#initializedargs) -- [InitializedFields](subgraphs.NFT721AccessTemplate.md#initializedfields) -- [InitializedFilter](subgraphs.NFT721AccessTemplate.md#initializedfilter) -- [InitializedResult](subgraphs.NFT721AccessTemplate.md#initializedresult) -- [MultiQueryOptions](subgraphs.NFT721AccessTemplate.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.NFT721AccessTemplate.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.NFT721AccessTemplate.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.NFT721AccessTemplate.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.NFT721AccessTemplate.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.NFT721AccessTemplate.md#singlequeryoptions) - -### Functions - -- [getAgreementCreatedById](subgraphs.NFT721AccessTemplate.md#getagreementcreatedbyid) -- [getAgreementCreateds](subgraphs.NFT721AccessTemplate.md#getagreementcreateds) -- [getInitializedById](subgraphs.NFT721AccessTemplate.md#getinitializedbyid) -- [getInitializeds](subgraphs.NFT721AccessTemplate.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.NFT721AccessTemplate.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.NFT721AccessTemplate.md#getownershiptransferreds) - -## Type Aliases - -### AgreementCreatedArgs - -Ƭ **AgreementCreatedArgs**<`K`\>: { [Property in keyof Pick]: AgreementCreatedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFT721AccessTemplate.md#agreementcreatedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessTemplate.d.ts:117 - ---- - -### AgreementCreatedFields - -Ƭ **AgreementCreatedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :----- | -| `_accessConsumer` | `true` | -| `_accessProvider` | `true` | -| `_agreementId` | `true` | -| `_conditionIdSeeds` | `true` | -| `_conditionIds` | `true` | -| `_creator` | `true` | -| `_did` | `true` | -| `_idSeed` | `true` | -| `_timeLocks` | `true` | -| `_timeOuts` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessTemplate.d.ts:104 - ---- - -### AgreementCreatedFilter - -Ƭ **AgreementCreatedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------------------------------- | :----------------- | -| `_accessConsumer?` | `string` \| `null` | -| `_accessConsumer_contains?` | `string` \| `null` | -| `_accessConsumer_in?` | `string`[] | -| `_accessConsumer_not?` | `string` \| `null` | -| `_accessConsumer_not_contains?` | `string` \| `null` | -| `_accessConsumer_not_in?` | `string`[] | -| `_accessProvider?` | `string` \| `null` | -| `_accessProvider_contains?` | `string` \| `null` | -| `_accessProvider_in?` | `string`[] | -| `_accessProvider_not?` | `string` \| `null` | -| `_accessProvider_not_contains?` | `string` \| `null` | -| `_accessProvider_not_in?` | `string`[] | -| `_agreementId?` | `string` \| `null` | -| `_agreementId_contains?` | `string` \| `null` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| `null` | -| `_agreementId_not_contains?` | `string` \| `null` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionIdSeeds?` | `string`[] | -| `_conditionIdSeeds_contains?` | `string`[] | -| `_conditionIdSeeds_contains_nocase?` | `string`[] | -| `_conditionIdSeeds_not?` | `string`[] | -| `_conditionIdSeeds_not_contains?` | `string`[] | -| `_conditionIdSeeds_not_contains_nocase?` | `string`[] | -| `_conditionIds?` | `string`[] | -| `_conditionIds_contains?` | `string`[] | -| `_conditionIds_contains_nocase?` | `string`[] | -| `_conditionIds_not?` | `string`[] | -| `_conditionIds_not_contains?` | `string`[] | -| `_conditionIds_not_contains_nocase?` | `string`[] | -| `_creator?` | `string` \| `null` | -| `_creator_contains?` | `string` \| `null` | -| `_creator_in?` | `string`[] | -| `_creator_not?` | `string` \| `null` | -| `_creator_not_contains?` | `string` \| `null` | -| `_creator_not_in?` | `string`[] | -| `_did?` | `string` \| `null` | -| `_did_contains?` | `string` \| `null` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| `null` | -| `_did_not_contains?` | `string` \| `null` | -| `_did_not_in?` | `string`[] | -| `_idSeed?` | `string` \| `null` | -| `_idSeed_contains?` | `string` \| `null` | -| `_idSeed_in?` | `string`[] | -| `_idSeed_not?` | `string` \| `null` | -| `_idSeed_not_contains?` | `string` \| `null` | -| `_idSeed_not_in?` | `string`[] | -| `_timeLocks?` | `WeiSource`[] | -| `_timeLocks_contains?` | `WeiSource`[] | -| `_timeLocks_contains_nocase?` | `WeiSource`[] | -| `_timeLocks_not?` | `WeiSource`[] | -| `_timeLocks_not_contains?` | `WeiSource`[] | -| `_timeLocks_not_contains_nocase?` | `WeiSource`[] | -| `_timeOuts?` | `WeiSource`[] | -| `_timeOuts_contains?` | `WeiSource`[] | -| `_timeOuts_contains_nocase?` | `WeiSource`[] | -| `_timeOuts_not?` | `WeiSource`[] | -| `_timeOuts_not_contains?` | `WeiSource`[] | -| `_timeOuts_not_contains_nocase?` | `WeiSource`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessTemplate.d.ts:21 - ---- - -### AgreementCreatedResult - -Ƭ **AgreementCreatedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :--------------------- | -| `_accessConsumer` | `string` | -| `_accessProvider` | `string` | -| `_agreementId` | `string` | -| `_conditionIdSeeds` | (`string` \| `null`)[] | -| `_conditionIds` | (`string` \| `null`)[] | -| `_creator` | `string` | -| `_did` | `string` | -| `_idSeed` | `string` | -| `_timeLocks` | (`Wei` \| `null`)[] | -| `_timeOuts` | (`Wei` \| `null`)[] | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessTemplate.d.ts:91 - ---- - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721AccessTemplate.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessTemplate.d.ts:148 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessTemplate.d.ts:144 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessTemplate.d.ts:122 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessTemplate.d.ts:140 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessTemplate.d.ts:10 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721AccessTemplate.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessTemplate.d.ts:185 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessTemplate.d.ts:180 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessTemplate.d.ts:153 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessTemplate.d.ts:175 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessTemplate.d.ts:2 - -## Functions - -### getAgreementCreatedById - -▸ **getAgreementCreatedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFT721AccessTemplate.md#agreementcreatedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFT721AccessTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721AccessTemplate.md#singlequeryoptions) | -| `args` | [`AgreementCreatedArgs`](subgraphs.NFT721AccessTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFT721AccessTemplate.md#agreementcreatedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessTemplate.d.ts:120 - ---- - -### getAgreementCreateds - -▸ **getAgreementCreateds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFT721AccessTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFT721AccessTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721AccessTemplate.md#multiqueryoptions)<[`AgreementCreatedFilter`](subgraphs.NFT721AccessTemplate.md#agreementcreatedfilter), [`AgreementCreatedResult`](subgraphs.NFT721AccessTemplate.md#agreementcreatedresult)\> | -| `args` | [`AgreementCreatedArgs`](subgraphs.NFT721AccessTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFT721AccessTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessTemplate.d.ts:121 - ---- - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721AccessTemplate.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721AccessTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721AccessTemplate.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.NFT721AccessTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721AccessTemplate.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessTemplate.d.ts:151 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721AccessTemplate.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721AccessTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721AccessTemplate.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.NFT721AccessTemplate.md#initializedfilter), [`InitializedResult`](subgraphs.NFT721AccessTemplate.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.NFT721AccessTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721AccessTemplate.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessTemplate.d.ts:152 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721AccessTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721AccessTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721AccessTemplate.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFT721AccessTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721AccessTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessTemplate.d.ts:188 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721AccessTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721AccessTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721AccessTemplate.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.NFT721AccessTemplate.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.NFT721AccessTemplate.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFT721AccessTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721AccessTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721AccessTemplate.d.ts:189 diff --git a/docs/api-reference/modules/subgraphs.NFT721EscrowPaymentCondition.md b/docs/api-reference/modules/subgraphs.NFT721EscrowPaymentCondition.md deleted file mode 100644 index 714e90a41..000000000 --- a/docs/api-reference/modules/subgraphs.NFT721EscrowPaymentCondition.md +++ /dev/null @@ -1,685 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / NFT721EscrowPaymentCondition - -# Namespace: NFT721EscrowPaymentCondition - -[subgraphs](subgraphs.md).NFT721EscrowPaymentCondition - -## Table of contents - -### Type Aliases - -- [FulfilledArgs](subgraphs.NFT721EscrowPaymentCondition.md#fulfilledargs) -- [FulfilledFields](subgraphs.NFT721EscrowPaymentCondition.md#fulfilledfields) -- [FulfilledFilter](subgraphs.NFT721EscrowPaymentCondition.md#fulfilledfilter) -- [FulfilledResult](subgraphs.NFT721EscrowPaymentCondition.md#fulfilledresult) -- [InitializedArgs](subgraphs.NFT721EscrowPaymentCondition.md#initializedargs) -- [InitializedFields](subgraphs.NFT721EscrowPaymentCondition.md#initializedfields) -- [InitializedFilter](subgraphs.NFT721EscrowPaymentCondition.md#initializedfilter) -- [InitializedResult](subgraphs.NFT721EscrowPaymentCondition.md#initializedresult) -- [MultiQueryOptions](subgraphs.NFT721EscrowPaymentCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.NFT721EscrowPaymentCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.NFT721EscrowPaymentCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.NFT721EscrowPaymentCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.NFT721EscrowPaymentCondition.md#ownershiptransferredresult) -- [ReceivedArgs](subgraphs.NFT721EscrowPaymentCondition.md#receivedargs) -- [ReceivedFields](subgraphs.NFT721EscrowPaymentCondition.md#receivedfields) -- [ReceivedFilter](subgraphs.NFT721EscrowPaymentCondition.md#receivedfilter) -- [ReceivedResult](subgraphs.NFT721EscrowPaymentCondition.md#receivedresult) -- [SingleQueryOptions](subgraphs.NFT721EscrowPaymentCondition.md#singlequeryoptions) - -### Functions - -- [getFulfilledById](subgraphs.NFT721EscrowPaymentCondition.md#getfulfilledbyid) -- [getFulfilleds](subgraphs.NFT721EscrowPaymentCondition.md#getfulfilleds) -- [getInitializedById](subgraphs.NFT721EscrowPaymentCondition.md#getinitializedbyid) -- [getInitializeds](subgraphs.NFT721EscrowPaymentCondition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.NFT721EscrowPaymentCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.NFT721EscrowPaymentCondition.md#getownershiptransferreds) -- [getReceivedById](subgraphs.NFT721EscrowPaymentCondition.md#getreceivedbyid) -- [getReceiveds](subgraphs.NFT721EscrowPaymentCondition.md#getreceiveds) - -## Type Aliases - -### FulfilledArgs - -Ƭ **FulfilledArgs**<`K`\>: { [Property in keyof Pick]: FulfilledFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.NFT721EscrowPaymentCondition.md#fulfilledresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:87 - ---- - -### FulfilledFields - -Ƭ **FulfilledFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `_agreementId` | `true` | -| `_amounts` | `true` | -| `_conditionId` | `true` | -| `_did` | `true` | -| `_receivers` | `true` | -| `_tokenAddress` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:78 - ---- - -### FulfilledFilter - -Ƭ **FulfilledFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :-------------------- | -| `_agreementId?` | `string` \| `null` | -| `_agreementId_contains?` | `string` \| `null` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| `null` | -| `_agreementId_not_contains?` | `string` \| `null` | -| `_agreementId_not_in?` | `string`[] | -| `_amounts?` | `WeiSource` \| `null` | -| `_amounts_gt?` | `WeiSource` \| `null` | -| `_amounts_gte?` | `WeiSource` \| `null` | -| `_amounts_in?` | `WeiSource`[] | -| `_amounts_lt?` | `WeiSource` \| `null` | -| `_amounts_lte?` | `WeiSource` \| `null` | -| `_amounts_not?` | `WeiSource` \| `null` | -| `_amounts_not_in?` | `WeiSource`[] | -| `_conditionId?` | `string` \| `null` | -| `_conditionId_contains?` | `string` \| `null` | -| `_conditionId_in?` | `string`[] | -| `_conditionId_not?` | `string` \| `null` | -| `_conditionId_not_contains?` | `string` \| `null` | -| `_conditionId_not_in?` | `string`[] | -| `_did?` | `string` \| `null` | -| `_did_contains?` | `string` \| `null` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| `null` | -| `_did_not_contains?` | `string` \| `null` | -| `_did_not_in?` | `string`[] | -| `_receivers?` | `string` \| `null` | -| `_receivers_contains?` | `string` \| `null` | -| `_receivers_in?` | `string`[] | -| `_receivers_not?` | `string` \| `null` | -| `_receivers_not_contains?` | `string` \| `null` | -| `_receivers_not_in?` | `string`[] | -| `_tokenAddress?` | `string` \| `null` | -| `_tokenAddress_contains?` | `string` \| `null` | -| `_tokenAddress_in?` | `string`[] | -| `_tokenAddress_not?` | `string` \| `null` | -| `_tokenAddress_not_contains?` | `string` \| `null` | -| `_tokenAddress_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:21 - ---- - -### FulfilledResult - -Ƭ **FulfilledResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `_agreementId` | `string` | -| `_amounts` | `Wei` | -| `_conditionId` | `string` | -| `_did` | `string` | -| `_receivers` | `string` | -| `_tokenAddress` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:69 - ---- - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721EscrowPaymentCondition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:118 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:114 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:92 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:110 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:10 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721EscrowPaymentCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:155 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:150 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:123 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:145 - ---- - -### ReceivedArgs - -Ƭ **ReceivedArgs**<`K`\>: { [Property in keyof Pick]: ReceivedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------- | -| `K` | extends keyof [`ReceivedResult`](subgraphs.NFT721EscrowPaymentCondition.md#receivedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:194 - ---- - -### ReceivedFields - -Ƭ **ReceivedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :----- | -| `_from` | `true` | -| `_value` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:189 - ---- - -### ReceivedFilter - -Ƭ **ReceivedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------- | :-------------------- | -| `_from?` | `string` \| `null` | -| `_from_contains?` | `string` \| `null` | -| `_from_in?` | `string`[] | -| `_from_not?` | `string` \| `null` | -| `_from_not_contains?` | `string` \| `null` | -| `_from_not_in?` | `string`[] | -| `_value?` | `WeiSource` \| `null` | -| `_value_gt?` | `WeiSource` \| `null` | -| `_value_gte?` | `WeiSource` \| `null` | -| `_value_in?` | `WeiSource`[] | -| `_value_lt?` | `WeiSource` \| `null` | -| `_value_lte?` | `WeiSource` \| `null` | -| `_value_not?` | `WeiSource` \| `null` | -| `_value_not_in?` | `WeiSource`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:160 - ---- - -### ReceivedResult - -Ƭ **ReceivedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :------- | -| `_from` | `string` | -| `_value` | `Wei` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:184 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:2 - -## Functions - -### getFulfilledById - -▸ **getFulfilledById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFT721EscrowPaymentCondition.md#fulfilledresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.NFT721EscrowPaymentCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721EscrowPaymentCondition.md#singlequeryoptions) | -| `args` | [`FulfilledArgs`](subgraphs.NFT721EscrowPaymentCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFT721EscrowPaymentCondition.md#fulfilledresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:90 - ---- - -### getFulfilleds - -▸ **getFulfilleds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFT721EscrowPaymentCondition.md#fulfilledresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.NFT721EscrowPaymentCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721EscrowPaymentCondition.md#multiqueryoptions)<[`FulfilledFilter`](subgraphs.NFT721EscrowPaymentCondition.md#fulfilledfilter), [`FulfilledResult`](subgraphs.NFT721EscrowPaymentCondition.md#fulfilledresult)\> | -| `args` | [`FulfilledArgs`](subgraphs.NFT721EscrowPaymentCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFT721EscrowPaymentCondition.md#fulfilledresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:91 - ---- - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721EscrowPaymentCondition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721EscrowPaymentCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721EscrowPaymentCondition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.NFT721EscrowPaymentCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721EscrowPaymentCondition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:121 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721EscrowPaymentCondition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721EscrowPaymentCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721EscrowPaymentCondition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.NFT721EscrowPaymentCondition.md#initializedfilter), [`InitializedResult`](subgraphs.NFT721EscrowPaymentCondition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.NFT721EscrowPaymentCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721EscrowPaymentCondition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:122 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721EscrowPaymentCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721EscrowPaymentCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721EscrowPaymentCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFT721EscrowPaymentCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721EscrowPaymentCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:158 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721EscrowPaymentCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721EscrowPaymentCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721EscrowPaymentCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.NFT721EscrowPaymentCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.NFT721EscrowPaymentCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFT721EscrowPaymentCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721EscrowPaymentCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:159 - ---- - -### getReceivedById - -▸ **getReceivedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ReceivedResult`](subgraphs.NFT721EscrowPaymentCondition.md#receivedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------- | -| `K` | extends keyof [`ReceivedResult`](subgraphs.NFT721EscrowPaymentCondition.md#receivedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721EscrowPaymentCondition.md#singlequeryoptions) | -| `args` | [`ReceivedArgs`](subgraphs.NFT721EscrowPaymentCondition.md#receivedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ReceivedResult`](subgraphs.NFT721EscrowPaymentCondition.md#receivedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:197 - ---- - -### getReceiveds - -▸ **getReceiveds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ReceivedResult`](subgraphs.NFT721EscrowPaymentCondition.md#receivedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------- | -| `K` | extends keyof [`ReceivedResult`](subgraphs.NFT721EscrowPaymentCondition.md#receivedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721EscrowPaymentCondition.md#multiqueryoptions)<[`ReceivedFilter`](subgraphs.NFT721EscrowPaymentCondition.md#receivedfilter), [`ReceivedResult`](subgraphs.NFT721EscrowPaymentCondition.md#receivedresult)\> | -| `args` | [`ReceivedArgs`](subgraphs.NFT721EscrowPaymentCondition.md#receivedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ReceivedResult`](subgraphs.NFT721EscrowPaymentCondition.md#receivedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721EscrowPaymentCondition.d.ts:198 diff --git a/docs/api-reference/modules/subgraphs.NFT721HolderCondition.md b/docs/api-reference/modules/subgraphs.NFT721HolderCondition.md deleted file mode 100644 index 3ba9c095d..000000000 --- a/docs/api-reference/modules/subgraphs.NFT721HolderCondition.md +++ /dev/null @@ -1,526 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / NFT721HolderCondition - -# Namespace: NFT721HolderCondition - -[subgraphs](subgraphs.md).NFT721HolderCondition - -## Table of contents - -### Type Aliases - -- [FulfilledArgs](subgraphs.NFT721HolderCondition.md#fulfilledargs) -- [FulfilledFields](subgraphs.NFT721HolderCondition.md#fulfilledfields) -- [FulfilledFilter](subgraphs.NFT721HolderCondition.md#fulfilledfilter) -- [FulfilledResult](subgraphs.NFT721HolderCondition.md#fulfilledresult) -- [InitializedArgs](subgraphs.NFT721HolderCondition.md#initializedargs) -- [InitializedFields](subgraphs.NFT721HolderCondition.md#initializedfields) -- [InitializedFilter](subgraphs.NFT721HolderCondition.md#initializedfilter) -- [InitializedResult](subgraphs.NFT721HolderCondition.md#initializedresult) -- [MultiQueryOptions](subgraphs.NFT721HolderCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.NFT721HolderCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.NFT721HolderCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.NFT721HolderCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.NFT721HolderCondition.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.NFT721HolderCondition.md#singlequeryoptions) - -### Functions - -- [getFulfilledById](subgraphs.NFT721HolderCondition.md#getfulfilledbyid) -- [getFulfilleds](subgraphs.NFT721HolderCondition.md#getfulfilleds) -- [getInitializedById](subgraphs.NFT721HolderCondition.md#getinitializedbyid) -- [getInitializeds](subgraphs.NFT721HolderCondition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.NFT721HolderCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.NFT721HolderCondition.md#getownershiptransferreds) - -## Type Aliases - -### FulfilledArgs - -Ƭ **FulfilledArgs**<`K`\>: { [Property in keyof Pick]: FulfilledFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.NFT721HolderCondition.md#fulfilledresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721HolderCondition.d.ts:79 - ---- - -### FulfilledFields - -Ƭ **FulfilledFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------------- | :----- | -| `_address` | `true` | -| `_agreementId` | `true` | -| `_amount` | `true` | -| `_conditionId` | `true` | -| `_did` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721HolderCondition.d.ts:71 - ---- - -### FulfilledFilter - -Ƭ **FulfilledFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------------------- | :-------------------- | -| `_address?` | `string` \| `null` | -| `_address_contains?` | `string` \| `null` | -| `_address_in?` | `string`[] | -| `_address_not?` | `string` \| `null` | -| `_address_not_contains?` | `string` \| `null` | -| `_address_not_in?` | `string`[] | -| `_agreementId?` | `string` \| `null` | -| `_agreementId_contains?` | `string` \| `null` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| `null` | -| `_agreementId_not_contains?` | `string` \| `null` | -| `_agreementId_not_in?` | `string`[] | -| `_amount?` | `WeiSource` \| `null` | -| `_amount_gt?` | `WeiSource` \| `null` | -| `_amount_gte?` | `WeiSource` \| `null` | -| `_amount_in?` | `WeiSource`[] | -| `_amount_lt?` | `WeiSource` \| `null` | -| `_amount_lte?` | `WeiSource` \| `null` | -| `_amount_not?` | `WeiSource` \| `null` | -| `_amount_not_in?` | `WeiSource`[] | -| `_conditionId?` | `string` \| `null` | -| `_conditionId_contains?` | `string` \| `null` | -| `_conditionId_in?` | `string`[] | -| `_conditionId_not?` | `string` \| `null` | -| `_conditionId_not_contains?` | `string` \| `null` | -| `_conditionId_not_in?` | `string`[] | -| `_did?` | `string` \| `null` | -| `_did_contains?` | `string` \| `null` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| `null` | -| `_did_not_contains?` | `string` \| `null` | -| `_did_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721HolderCondition.d.ts:21 - ---- - -### FulfilledResult - -Ƭ **FulfilledResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------------- | :------- | -| `_address` | `string` | -| `_agreementId` | `string` | -| `_amount` | `Wei` | -| `_conditionId` | `string` | -| `_did` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721HolderCondition.d.ts:63 - ---- - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721HolderCondition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721HolderCondition.d.ts:110 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721HolderCondition.d.ts:106 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721HolderCondition.d.ts:84 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721HolderCondition.d.ts:102 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721HolderCondition.d.ts:10 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721HolderCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721HolderCondition.d.ts:147 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721HolderCondition.d.ts:142 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721HolderCondition.d.ts:115 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721HolderCondition.d.ts:137 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721HolderCondition.d.ts:2 - -## Functions - -### getFulfilledById - -▸ **getFulfilledById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFT721HolderCondition.md#fulfilledresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.NFT721HolderCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721HolderCondition.md#singlequeryoptions) | -| `args` | [`FulfilledArgs`](subgraphs.NFT721HolderCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFT721HolderCondition.md#fulfilledresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721HolderCondition.d.ts:82 - ---- - -### getFulfilleds - -▸ **getFulfilleds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFT721HolderCondition.md#fulfilledresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------ | -| `K` | extends keyof [`FulfilledResult`](subgraphs.NFT721HolderCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721HolderCondition.md#multiqueryoptions)<[`FulfilledFilter`](subgraphs.NFT721HolderCondition.md#fulfilledfilter), [`FulfilledResult`](subgraphs.NFT721HolderCondition.md#fulfilledresult)\> | -| `args` | [`FulfilledArgs`](subgraphs.NFT721HolderCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFT721HolderCondition.md#fulfilledresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721HolderCondition.d.ts:83 - ---- - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721HolderCondition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721HolderCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721HolderCondition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.NFT721HolderCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721HolderCondition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721HolderCondition.d.ts:113 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721HolderCondition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721HolderCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721HolderCondition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.NFT721HolderCondition.md#initializedfilter), [`InitializedResult`](subgraphs.NFT721HolderCondition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.NFT721HolderCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721HolderCondition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721HolderCondition.d.ts:114 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721HolderCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721HolderCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721HolderCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFT721HolderCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721HolderCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721HolderCondition.d.ts:150 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721HolderCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721HolderCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721HolderCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.NFT721HolderCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.NFT721HolderCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFT721HolderCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721HolderCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721HolderCondition.d.ts:151 diff --git a/docs/api-reference/modules/subgraphs.NFT721LockCondition.md b/docs/api-reference/modules/subgraphs.NFT721LockCondition.md deleted file mode 100644 index 66a0c72f9..000000000 --- a/docs/api-reference/modules/subgraphs.NFT721LockCondition.md +++ /dev/null @@ -1,391 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / NFT721LockCondition - -# Namespace: NFT721LockCondition - -[subgraphs](subgraphs.md).NFT721LockCondition - -## Table of contents - -### Type Aliases - -- [FulfilledArgs](subgraphs.NFT721LockCondition.md#fulfilledargs) -- [FulfilledFields](subgraphs.NFT721LockCondition.md#fulfilledfields) -- [FulfilledFilter](subgraphs.NFT721LockCondition.md#fulfilledfilter) -- [FulfilledResult](subgraphs.NFT721LockCondition.md#fulfilledresult) -- [MultiQueryOptions](subgraphs.NFT721LockCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.NFT721LockCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.NFT721LockCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.NFT721LockCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.NFT721LockCondition.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.NFT721LockCondition.md#singlequeryoptions) - -### Functions - -- [getFulfilledById](subgraphs.NFT721LockCondition.md#getfulfilledbyid) -- [getFulfilleds](subgraphs.NFT721LockCondition.md#getfulfilleds) -- [getOwnershipTransferredById](subgraphs.NFT721LockCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.NFT721LockCondition.md#getownershiptransferreds) - -## Type Aliases - -### FulfilledArgs - -Ƭ **FulfilledArgs**<`K`\>: { [Property in keyof Pick]: FulfilledFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.NFT721LockCondition.md#fulfilledresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721LockCondition.d.ts:87 - ---- - -### FulfilledFields - -Ƭ **FulfilledFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------- | :----- | -| `_agreementId` | `true` | -| `_amount` | `true` | -| `_conditionId` | `true` | -| `_did` | `true` | -| `_lockAddress` | `true` | -| `_nftContractAddress` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721LockCondition.d.ts:78 - ---- - -### FulfilledFilter - -Ƭ **FulfilledFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------------- | :-------------------- | -| `_agreementId?` | `string` \| `null` | -| `_agreementId_contains?` | `string` \| `null` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| `null` | -| `_agreementId_not_contains?` | `string` \| `null` | -| `_agreementId_not_in?` | `string`[] | -| `_amount?` | `WeiSource` \| `null` | -| `_amount_gt?` | `WeiSource` \| `null` | -| `_amount_gte?` | `WeiSource` \| `null` | -| `_amount_in?` | `WeiSource`[] | -| `_amount_lt?` | `WeiSource` \| `null` | -| `_amount_lte?` | `WeiSource` \| `null` | -| `_amount_not?` | `WeiSource` \| `null` | -| `_amount_not_in?` | `WeiSource`[] | -| `_conditionId?` | `string` \| `null` | -| `_conditionId_contains?` | `string` \| `null` | -| `_conditionId_in?` | `string`[] | -| `_conditionId_not?` | `string` \| `null` | -| `_conditionId_not_contains?` | `string` \| `null` | -| `_conditionId_not_in?` | `string`[] | -| `_did?` | `string` \| `null` | -| `_did_contains?` | `string` \| `null` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| `null` | -| `_did_not_contains?` | `string` \| `null` | -| `_did_not_in?` | `string`[] | -| `_lockAddress?` | `string` \| `null` | -| `_lockAddress_contains?` | `string` \| `null` | -| `_lockAddress_in?` | `string`[] | -| `_lockAddress_not?` | `string` \| `null` | -| `_lockAddress_not_contains?` | `string` \| `null` | -| `_lockAddress_not_in?` | `string`[] | -| `_nftContractAddress?` | `string` \| `null` | -| `_nftContractAddress_contains?` | `string` \| `null` | -| `_nftContractAddress_in?` | `string`[] | -| `_nftContractAddress_not?` | `string` \| `null` | -| `_nftContractAddress_not_contains?` | `string` \| `null` | -| `_nftContractAddress_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721LockCondition.d.ts:21 - ---- - -### FulfilledResult - -Ƭ **FulfilledResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------- | :------- | -| `_agreementId` | `string` | -| `_amount` | `Wei` | -| `_conditionId` | `string` | -| `_did` | `string` | -| `_lockAddress` | `string` | -| `_nftContractAddress` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721LockCondition.d.ts:69 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721LockCondition.d.ts:10 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721LockCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721LockCondition.d.ts:124 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721LockCondition.d.ts:119 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721LockCondition.d.ts:92 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721LockCondition.d.ts:114 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721LockCondition.d.ts:2 - -## Functions - -### getFulfilledById - -▸ **getFulfilledById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFT721LockCondition.md#fulfilledresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.NFT721LockCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721LockCondition.md#singlequeryoptions) | -| `args` | [`FulfilledArgs`](subgraphs.NFT721LockCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFT721LockCondition.md#fulfilledresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721LockCondition.d.ts:90 - ---- - -### getFulfilleds - -▸ **getFulfilleds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFT721LockCondition.md#fulfilledresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.NFT721LockCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721LockCondition.md#multiqueryoptions)<[`FulfilledFilter`](subgraphs.NFT721LockCondition.md#fulfilledfilter), [`FulfilledResult`](subgraphs.NFT721LockCondition.md#fulfilledresult)\> | -| `args` | [`FulfilledArgs`](subgraphs.NFT721LockCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFT721LockCondition.md#fulfilledresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721LockCondition.d.ts:91 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721LockCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721LockCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721LockCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFT721LockCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721LockCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721LockCondition.d.ts:127 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721LockCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721LockCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721LockCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.NFT721LockCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.NFT721LockCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFT721LockCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721LockCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721LockCondition.d.ts:128 diff --git a/docs/api-reference/modules/subgraphs.NFT721SalesTemplate.md b/docs/api-reference/modules/subgraphs.NFT721SalesTemplate.md deleted file mode 100644 index 1ad99e421..000000000 --- a/docs/api-reference/modules/subgraphs.NFT721SalesTemplate.md +++ /dev/null @@ -1,564 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / NFT721SalesTemplate - -# Namespace: NFT721SalesTemplate - -[subgraphs](subgraphs.md).NFT721SalesTemplate - -## Table of contents - -### Type Aliases - -- [AgreementCreatedArgs](subgraphs.NFT721SalesTemplate.md#agreementcreatedargs) -- [AgreementCreatedFields](subgraphs.NFT721SalesTemplate.md#agreementcreatedfields) -- [AgreementCreatedFilter](subgraphs.NFT721SalesTemplate.md#agreementcreatedfilter) -- [AgreementCreatedResult](subgraphs.NFT721SalesTemplate.md#agreementcreatedresult) -- [InitializedArgs](subgraphs.NFT721SalesTemplate.md#initializedargs) -- [InitializedFields](subgraphs.NFT721SalesTemplate.md#initializedfields) -- [InitializedFilter](subgraphs.NFT721SalesTemplate.md#initializedfilter) -- [InitializedResult](subgraphs.NFT721SalesTemplate.md#initializedresult) -- [MultiQueryOptions](subgraphs.NFT721SalesTemplate.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.NFT721SalesTemplate.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.NFT721SalesTemplate.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.NFT721SalesTemplate.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.NFT721SalesTemplate.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.NFT721SalesTemplate.md#singlequeryoptions) - -### Functions - -- [getAgreementCreatedById](subgraphs.NFT721SalesTemplate.md#getagreementcreatedbyid) -- [getAgreementCreateds](subgraphs.NFT721SalesTemplate.md#getagreementcreateds) -- [getInitializedById](subgraphs.NFT721SalesTemplate.md#getinitializedbyid) -- [getInitializeds](subgraphs.NFT721SalesTemplate.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.NFT721SalesTemplate.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.NFT721SalesTemplate.md#getownershiptransferreds) - -## Type Aliases - -### AgreementCreatedArgs - -Ƭ **AgreementCreatedArgs**<`K`\>: { [Property in keyof Pick]: AgreementCreatedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFT721SalesTemplate.md#agreementcreatedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesTemplate.d.ts:117 - ---- - -### AgreementCreatedFields - -Ƭ **AgreementCreatedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :----- | -| `_accessConsumer` | `true` | -| `_accessProvider` | `true` | -| `_agreementId` | `true` | -| `_conditionIdSeeds` | `true` | -| `_conditionIds` | `true` | -| `_creator` | `true` | -| `_did` | `true` | -| `_idSeed` | `true` | -| `_timeLocks` | `true` | -| `_timeOuts` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesTemplate.d.ts:104 - ---- - -### AgreementCreatedFilter - -Ƭ **AgreementCreatedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------------------------------- | :----------------- | -| `_accessConsumer?` | `string` \| `null` | -| `_accessConsumer_contains?` | `string` \| `null` | -| `_accessConsumer_in?` | `string`[] | -| `_accessConsumer_not?` | `string` \| `null` | -| `_accessConsumer_not_contains?` | `string` \| `null` | -| `_accessConsumer_not_in?` | `string`[] | -| `_accessProvider?` | `string` \| `null` | -| `_accessProvider_contains?` | `string` \| `null` | -| `_accessProvider_in?` | `string`[] | -| `_accessProvider_not?` | `string` \| `null` | -| `_accessProvider_not_contains?` | `string` \| `null` | -| `_accessProvider_not_in?` | `string`[] | -| `_agreementId?` | `string` \| `null` | -| `_agreementId_contains?` | `string` \| `null` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| `null` | -| `_agreementId_not_contains?` | `string` \| `null` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionIdSeeds?` | `string`[] | -| `_conditionIdSeeds_contains?` | `string`[] | -| `_conditionIdSeeds_contains_nocase?` | `string`[] | -| `_conditionIdSeeds_not?` | `string`[] | -| `_conditionIdSeeds_not_contains?` | `string`[] | -| `_conditionIdSeeds_not_contains_nocase?` | `string`[] | -| `_conditionIds?` | `string`[] | -| `_conditionIds_contains?` | `string`[] | -| `_conditionIds_contains_nocase?` | `string`[] | -| `_conditionIds_not?` | `string`[] | -| `_conditionIds_not_contains?` | `string`[] | -| `_conditionIds_not_contains_nocase?` | `string`[] | -| `_creator?` | `string` \| `null` | -| `_creator_contains?` | `string` \| `null` | -| `_creator_in?` | `string`[] | -| `_creator_not?` | `string` \| `null` | -| `_creator_not_contains?` | `string` \| `null` | -| `_creator_not_in?` | `string`[] | -| `_did?` | `string` \| `null` | -| `_did_contains?` | `string` \| `null` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| `null` | -| `_did_not_contains?` | `string` \| `null` | -| `_did_not_in?` | `string`[] | -| `_idSeed?` | `string` \| `null` | -| `_idSeed_contains?` | `string` \| `null` | -| `_idSeed_in?` | `string`[] | -| `_idSeed_not?` | `string` \| `null` | -| `_idSeed_not_contains?` | `string` \| `null` | -| `_idSeed_not_in?` | `string`[] | -| `_timeLocks?` | `WeiSource`[] | -| `_timeLocks_contains?` | `WeiSource`[] | -| `_timeLocks_contains_nocase?` | `WeiSource`[] | -| `_timeLocks_not?` | `WeiSource`[] | -| `_timeLocks_not_contains?` | `WeiSource`[] | -| `_timeLocks_not_contains_nocase?` | `WeiSource`[] | -| `_timeOuts?` | `WeiSource`[] | -| `_timeOuts_contains?` | `WeiSource`[] | -| `_timeOuts_contains_nocase?` | `WeiSource`[] | -| `_timeOuts_not?` | `WeiSource`[] | -| `_timeOuts_not_contains?` | `WeiSource`[] | -| `_timeOuts_not_contains_nocase?` | `WeiSource`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesTemplate.d.ts:21 - ---- - -### AgreementCreatedResult - -Ƭ **AgreementCreatedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :--------------------- | -| `_accessConsumer` | `string` | -| `_accessProvider` | `string` | -| `_agreementId` | `string` | -| `_conditionIdSeeds` | (`string` \| `null`)[] | -| `_conditionIds` | (`string` \| `null`)[] | -| `_creator` | `string` | -| `_did` | `string` | -| `_idSeed` | `string` | -| `_timeLocks` | (`Wei` \| `null`)[] | -| `_timeOuts` | (`Wei` \| `null`)[] | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesTemplate.d.ts:91 - ---- - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721SalesTemplate.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesTemplate.d.ts:148 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesTemplate.d.ts:144 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesTemplate.d.ts:122 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesTemplate.d.ts:140 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesTemplate.d.ts:10 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721SalesTemplate.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesTemplate.d.ts:185 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesTemplate.d.ts:180 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesTemplate.d.ts:153 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesTemplate.d.ts:175 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesTemplate.d.ts:2 - -## Functions - -### getAgreementCreatedById - -▸ **getAgreementCreatedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFT721SalesTemplate.md#agreementcreatedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFT721SalesTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721SalesTemplate.md#singlequeryoptions) | -| `args` | [`AgreementCreatedArgs`](subgraphs.NFT721SalesTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFT721SalesTemplate.md#agreementcreatedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesTemplate.d.ts:120 - ---- - -### getAgreementCreateds - -▸ **getAgreementCreateds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFT721SalesTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFT721SalesTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721SalesTemplate.md#multiqueryoptions)<[`AgreementCreatedFilter`](subgraphs.NFT721SalesTemplate.md#agreementcreatedfilter), [`AgreementCreatedResult`](subgraphs.NFT721SalesTemplate.md#agreementcreatedresult)\> | -| `args` | [`AgreementCreatedArgs`](subgraphs.NFT721SalesTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFT721SalesTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesTemplate.d.ts:121 - ---- - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721SalesTemplate.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721SalesTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721SalesTemplate.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.NFT721SalesTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721SalesTemplate.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesTemplate.d.ts:151 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721SalesTemplate.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721SalesTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721SalesTemplate.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.NFT721SalesTemplate.md#initializedfilter), [`InitializedResult`](subgraphs.NFT721SalesTemplate.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.NFT721SalesTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721SalesTemplate.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesTemplate.d.ts:152 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721SalesTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721SalesTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721SalesTemplate.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFT721SalesTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721SalesTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesTemplate.d.ts:188 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721SalesTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721SalesTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721SalesTemplate.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.NFT721SalesTemplate.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.NFT721SalesTemplate.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFT721SalesTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721SalesTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesTemplate.d.ts:189 diff --git a/docs/api-reference/modules/subgraphs.NFT721SalesWithAccessTemplate.md b/docs/api-reference/modules/subgraphs.NFT721SalesWithAccessTemplate.md deleted file mode 100644 index 9ccdb5471..000000000 --- a/docs/api-reference/modules/subgraphs.NFT721SalesWithAccessTemplate.md +++ /dev/null @@ -1,564 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / NFT721SalesWithAccessTemplate - -# Namespace: NFT721SalesWithAccessTemplate - -[subgraphs](subgraphs.md).NFT721SalesWithAccessTemplate - -## Table of contents - -### Type Aliases - -- [AgreementCreatedArgs](subgraphs.NFT721SalesWithAccessTemplate.md#agreementcreatedargs) -- [AgreementCreatedFields](subgraphs.NFT721SalesWithAccessTemplate.md#agreementcreatedfields) -- [AgreementCreatedFilter](subgraphs.NFT721SalesWithAccessTemplate.md#agreementcreatedfilter) -- [AgreementCreatedResult](subgraphs.NFT721SalesWithAccessTemplate.md#agreementcreatedresult) -- [InitializedArgs](subgraphs.NFT721SalesWithAccessTemplate.md#initializedargs) -- [InitializedFields](subgraphs.NFT721SalesWithAccessTemplate.md#initializedfields) -- [InitializedFilter](subgraphs.NFT721SalesWithAccessTemplate.md#initializedfilter) -- [InitializedResult](subgraphs.NFT721SalesWithAccessTemplate.md#initializedresult) -- [MultiQueryOptions](subgraphs.NFT721SalesWithAccessTemplate.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.NFT721SalesWithAccessTemplate.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.NFT721SalesWithAccessTemplate.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.NFT721SalesWithAccessTemplate.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.NFT721SalesWithAccessTemplate.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.NFT721SalesWithAccessTemplate.md#singlequeryoptions) - -### Functions - -- [getAgreementCreatedById](subgraphs.NFT721SalesWithAccessTemplate.md#getagreementcreatedbyid) -- [getAgreementCreateds](subgraphs.NFT721SalesWithAccessTemplate.md#getagreementcreateds) -- [getInitializedById](subgraphs.NFT721SalesWithAccessTemplate.md#getinitializedbyid) -- [getInitializeds](subgraphs.NFT721SalesWithAccessTemplate.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.NFT721SalesWithAccessTemplate.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.NFT721SalesWithAccessTemplate.md#getownershiptransferreds) - -## Type Aliases - -### AgreementCreatedArgs - -Ƭ **AgreementCreatedArgs**<`K`\>: { [Property in keyof Pick]: AgreementCreatedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFT721SalesWithAccessTemplate.md#agreementcreatedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesWithAccessTemplate.d.ts:117 - ---- - -### AgreementCreatedFields - -Ƭ **AgreementCreatedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :----- | -| `_accessConsumer` | `true` | -| `_accessProvider` | `true` | -| `_agreementId` | `true` | -| `_conditionIdSeeds` | `true` | -| `_conditionIds` | `true` | -| `_creator` | `true` | -| `_did` | `true` | -| `_idSeed` | `true` | -| `_timeLocks` | `true` | -| `_timeOuts` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesWithAccessTemplate.d.ts:104 - ---- - -### AgreementCreatedFilter - -Ƭ **AgreementCreatedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------------------------------- | :----------------- | -| `_accessConsumer?` | `string` \| `null` | -| `_accessConsumer_contains?` | `string` \| `null` | -| `_accessConsumer_in?` | `string`[] | -| `_accessConsumer_not?` | `string` \| `null` | -| `_accessConsumer_not_contains?` | `string` \| `null` | -| `_accessConsumer_not_in?` | `string`[] | -| `_accessProvider?` | `string` \| `null` | -| `_accessProvider_contains?` | `string` \| `null` | -| `_accessProvider_in?` | `string`[] | -| `_accessProvider_not?` | `string` \| `null` | -| `_accessProvider_not_contains?` | `string` \| `null` | -| `_accessProvider_not_in?` | `string`[] | -| `_agreementId?` | `string` \| `null` | -| `_agreementId_contains?` | `string` \| `null` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| `null` | -| `_agreementId_not_contains?` | `string` \| `null` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionIdSeeds?` | `string`[] | -| `_conditionIdSeeds_contains?` | `string`[] | -| `_conditionIdSeeds_contains_nocase?` | `string`[] | -| `_conditionIdSeeds_not?` | `string`[] | -| `_conditionIdSeeds_not_contains?` | `string`[] | -| `_conditionIdSeeds_not_contains_nocase?` | `string`[] | -| `_conditionIds?` | `string`[] | -| `_conditionIds_contains?` | `string`[] | -| `_conditionIds_contains_nocase?` | `string`[] | -| `_conditionIds_not?` | `string`[] | -| `_conditionIds_not_contains?` | `string`[] | -| `_conditionIds_not_contains_nocase?` | `string`[] | -| `_creator?` | `string` \| `null` | -| `_creator_contains?` | `string` \| `null` | -| `_creator_in?` | `string`[] | -| `_creator_not?` | `string` \| `null` | -| `_creator_not_contains?` | `string` \| `null` | -| `_creator_not_in?` | `string`[] | -| `_did?` | `string` \| `null` | -| `_did_contains?` | `string` \| `null` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| `null` | -| `_did_not_contains?` | `string` \| `null` | -| `_did_not_in?` | `string`[] | -| `_idSeed?` | `string` \| `null` | -| `_idSeed_contains?` | `string` \| `null` | -| `_idSeed_in?` | `string`[] | -| `_idSeed_not?` | `string` \| `null` | -| `_idSeed_not_contains?` | `string` \| `null` | -| `_idSeed_not_in?` | `string`[] | -| `_timeLocks?` | `WeiSource`[] | -| `_timeLocks_contains?` | `WeiSource`[] | -| `_timeLocks_contains_nocase?` | `WeiSource`[] | -| `_timeLocks_not?` | `WeiSource`[] | -| `_timeLocks_not_contains?` | `WeiSource`[] | -| `_timeLocks_not_contains_nocase?` | `WeiSource`[] | -| `_timeOuts?` | `WeiSource`[] | -| `_timeOuts_contains?` | `WeiSource`[] | -| `_timeOuts_contains_nocase?` | `WeiSource`[] | -| `_timeOuts_not?` | `WeiSource`[] | -| `_timeOuts_not_contains?` | `WeiSource`[] | -| `_timeOuts_not_contains_nocase?` | `WeiSource`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesWithAccessTemplate.d.ts:21 - ---- - -### AgreementCreatedResult - -Ƭ **AgreementCreatedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :--------------------- | -| `_accessConsumer` | `string` | -| `_accessProvider` | `string` | -| `_agreementId` | `string` | -| `_conditionIdSeeds` | (`string` \| `null`)[] | -| `_conditionIds` | (`string` \| `null`)[] | -| `_creator` | `string` | -| `_did` | `string` | -| `_idSeed` | `string` | -| `_timeLocks` | (`Wei` \| `null`)[] | -| `_timeOuts` | (`Wei` \| `null`)[] | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesWithAccessTemplate.d.ts:91 - ---- - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721SalesWithAccessTemplate.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesWithAccessTemplate.d.ts:148 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesWithAccessTemplate.d.ts:144 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesWithAccessTemplate.d.ts:122 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesWithAccessTemplate.d.ts:140 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesWithAccessTemplate.d.ts:10 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721SalesWithAccessTemplate.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesWithAccessTemplate.d.ts:185 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesWithAccessTemplate.d.ts:180 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesWithAccessTemplate.d.ts:153 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesWithAccessTemplate.d.ts:175 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesWithAccessTemplate.d.ts:2 - -## Functions - -### getAgreementCreatedById - -▸ **getAgreementCreatedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFT721SalesWithAccessTemplate.md#agreementcreatedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFT721SalesWithAccessTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721SalesWithAccessTemplate.md#singlequeryoptions) | -| `args` | [`AgreementCreatedArgs`](subgraphs.NFT721SalesWithAccessTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFT721SalesWithAccessTemplate.md#agreementcreatedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesWithAccessTemplate.d.ts:120 - ---- - -### getAgreementCreateds - -▸ **getAgreementCreateds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFT721SalesWithAccessTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFT721SalesWithAccessTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721SalesWithAccessTemplate.md#multiqueryoptions)<[`AgreementCreatedFilter`](subgraphs.NFT721SalesWithAccessTemplate.md#agreementcreatedfilter), [`AgreementCreatedResult`](subgraphs.NFT721SalesWithAccessTemplate.md#agreementcreatedresult)\> | -| `args` | [`AgreementCreatedArgs`](subgraphs.NFT721SalesWithAccessTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFT721SalesWithAccessTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesWithAccessTemplate.d.ts:121 - ---- - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721SalesWithAccessTemplate.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721SalesWithAccessTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721SalesWithAccessTemplate.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.NFT721SalesWithAccessTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721SalesWithAccessTemplate.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesWithAccessTemplate.d.ts:151 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721SalesWithAccessTemplate.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721SalesWithAccessTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721SalesWithAccessTemplate.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.NFT721SalesWithAccessTemplate.md#initializedfilter), [`InitializedResult`](subgraphs.NFT721SalesWithAccessTemplate.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.NFT721SalesWithAccessTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721SalesWithAccessTemplate.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesWithAccessTemplate.d.ts:152 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721SalesWithAccessTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721SalesWithAccessTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721SalesWithAccessTemplate.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFT721SalesWithAccessTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721SalesWithAccessTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesWithAccessTemplate.d.ts:188 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721SalesWithAccessTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721SalesWithAccessTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721SalesWithAccessTemplate.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.NFT721SalesWithAccessTemplate.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.NFT721SalesWithAccessTemplate.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFT721SalesWithAccessTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721SalesWithAccessTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721SalesWithAccessTemplate.d.ts:189 diff --git a/docs/api-reference/modules/subgraphs.NFT721Upgradeable.md b/docs/api-reference/modules/subgraphs.NFT721Upgradeable.md deleted file mode 100644 index 9e3eccb57..000000000 --- a/docs/api-reference/modules/subgraphs.NFT721Upgradeable.md +++ /dev/null @@ -1,1450 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / NFT721Upgradeable - -# Namespace: NFT721Upgradeable - -[subgraphs](subgraphs.md).NFT721Upgradeable - -## Table of contents - -### Type Aliases - -- [ApprovalArgs](subgraphs.NFT721Upgradeable.md#approvalargs) -- [ApprovalFields](subgraphs.NFT721Upgradeable.md#approvalfields) -- [ApprovalFilter](subgraphs.NFT721Upgradeable.md#approvalfilter) -- [ApprovalForAllArgs](subgraphs.NFT721Upgradeable.md#approvalforallargs) -- [ApprovalForAllFields](subgraphs.NFT721Upgradeable.md#approvalforallfields) -- [ApprovalForAllFilter](subgraphs.NFT721Upgradeable.md#approvalforallfilter) -- [ApprovalForAllResult](subgraphs.NFT721Upgradeable.md#approvalforallresult) -- [ApprovalResult](subgraphs.NFT721Upgradeable.md#approvalresult) -- [InitializedArgs](subgraphs.NFT721Upgradeable.md#initializedargs) -- [InitializedFields](subgraphs.NFT721Upgradeable.md#initializedfields) -- [InitializedFilter](subgraphs.NFT721Upgradeable.md#initializedfilter) -- [InitializedResult](subgraphs.NFT721Upgradeable.md#initializedresult) -- [MultiQueryOptions](subgraphs.NFT721Upgradeable.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.NFT721Upgradeable.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.NFT721Upgradeable.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.NFT721Upgradeable.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.NFT721Upgradeable.md#ownershiptransferredresult) -- [ProxyApprovalArgs](subgraphs.NFT721Upgradeable.md#proxyapprovalargs) -- [ProxyApprovalFields](subgraphs.NFT721Upgradeable.md#proxyapprovalfields) -- [ProxyApprovalFilter](subgraphs.NFT721Upgradeable.md#proxyapprovalfilter) -- [ProxyApprovalResult](subgraphs.NFT721Upgradeable.md#proxyapprovalresult) -- [RoleAdminChangedArgs](subgraphs.NFT721Upgradeable.md#roleadminchangedargs) -- [RoleAdminChangedFields](subgraphs.NFT721Upgradeable.md#roleadminchangedfields) -- [RoleAdminChangedFilter](subgraphs.NFT721Upgradeable.md#roleadminchangedfilter) -- [RoleAdminChangedResult](subgraphs.NFT721Upgradeable.md#roleadminchangedresult) -- [RoleGrantedArgs](subgraphs.NFT721Upgradeable.md#rolegrantedargs) -- [RoleGrantedFields](subgraphs.NFT721Upgradeable.md#rolegrantedfields) -- [RoleGrantedFilter](subgraphs.NFT721Upgradeable.md#rolegrantedfilter) -- [RoleGrantedResult](subgraphs.NFT721Upgradeable.md#rolegrantedresult) -- [RoleRevokedArgs](subgraphs.NFT721Upgradeable.md#rolerevokedargs) -- [RoleRevokedFields](subgraphs.NFT721Upgradeable.md#rolerevokedfields) -- [RoleRevokedFilter](subgraphs.NFT721Upgradeable.md#rolerevokedfilter) -- [RoleRevokedResult](subgraphs.NFT721Upgradeable.md#rolerevokedresult) -- [SingleQueryOptions](subgraphs.NFT721Upgradeable.md#singlequeryoptions) -- [TransferArgs](subgraphs.NFT721Upgradeable.md#transferargs) -- [TransferFields](subgraphs.NFT721Upgradeable.md#transferfields) -- [TransferFilter](subgraphs.NFT721Upgradeable.md#transferfilter) -- [TransferResult](subgraphs.NFT721Upgradeable.md#transferresult) - -### Functions - -- [getApprovalById](subgraphs.NFT721Upgradeable.md#getapprovalbyid) -- [getApprovalForAllById](subgraphs.NFT721Upgradeable.md#getapprovalforallbyid) -- [getApprovalForAlls](subgraphs.NFT721Upgradeable.md#getapprovalforalls) -- [getApprovals](subgraphs.NFT721Upgradeable.md#getapprovals) -- [getInitializedById](subgraphs.NFT721Upgradeable.md#getinitializedbyid) -- [getInitializeds](subgraphs.NFT721Upgradeable.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.NFT721Upgradeable.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.NFT721Upgradeable.md#getownershiptransferreds) -- [getProxyApprovalById](subgraphs.NFT721Upgradeable.md#getproxyapprovalbyid) -- [getProxyApprovals](subgraphs.NFT721Upgradeable.md#getproxyapprovals) -- [getRoleAdminChangedById](subgraphs.NFT721Upgradeable.md#getroleadminchangedbyid) -- [getRoleAdminChangeds](subgraphs.NFT721Upgradeable.md#getroleadminchangeds) -- [getRoleGrantedById](subgraphs.NFT721Upgradeable.md#getrolegrantedbyid) -- [getRoleGranteds](subgraphs.NFT721Upgradeable.md#getrolegranteds) -- [getRoleRevokedById](subgraphs.NFT721Upgradeable.md#getrolerevokedbyid) -- [getRoleRevokeds](subgraphs.NFT721Upgradeable.md#getrolerevokeds) -- [getTransferById](subgraphs.NFT721Upgradeable.md#gettransferbyid) -- [getTransfers](subgraphs.NFT721Upgradeable.md#gettransfers) - -## Type Aliases - -### ApprovalArgs - -Ƭ **ApprovalArgs**<`K`\>: { [Property in keyof Pick]: ApprovalFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------ | -| `K` | extends keyof [`ApprovalResult`](subgraphs.NFT721Upgradeable.md#approvalresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:63 - ---- - -### ApprovalFields - -Ƭ **ApprovalFields**: `Object` - -#### Type declaration - -| Name | Type | -| :--------- | :----- | -| `approved` | `true` | -| `id` | `true` | -| `owner` | `true` | -| `tokenId` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:57 - ---- - -### ApprovalFilter - -Ƭ **ApprovalFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :----------------------- | :-------------------- | -| `approved?` | `string` \| `null` | -| `approved_contains?` | `string` \| `null` | -| `approved_in?` | `string`[] | -| `approved_not?` | `string` \| `null` | -| `approved_not_contains?` | `string` \| `null` | -| `approved_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `owner?` | `string` \| `null` | -| `owner_contains?` | `string` \| `null` | -| `owner_in?` | `string`[] | -| `owner_not?` | `string` \| `null` | -| `owner_not_contains?` | `string` \| `null` | -| `owner_not_in?` | `string`[] | -| `tokenId?` | `WeiSource` \| `null` | -| `tokenId_gt?` | `WeiSource` \| `null` | -| `tokenId_gte?` | `WeiSource` \| `null` | -| `tokenId_in?` | `WeiSource`[] | -| `tokenId_lt?` | `WeiSource` \| `null` | -| `tokenId_lte?` | `WeiSource` \| `null` | -| `tokenId_not?` | `WeiSource` \| `null` | -| `tokenId_not_in?` | `WeiSource`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:21 - ---- - -### ApprovalForAllArgs - -Ƭ **ApprovalForAllArgs**<`K`\>: { [Property in keyof Pick]: ApprovalForAllFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`ApprovalForAllResult`](subgraphs.NFT721Upgradeable.md#approvalforallresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:106 - ---- - -### ApprovalForAllFields - -Ƭ **ApprovalForAllFields**: `Object` - -#### Type declaration - -| Name | Type | -| :--------- | :----- | -| `approved` | `true` | -| `id` | `true` | -| `operator` | `true` | -| `owner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:100 - ---- - -### ApprovalForAllFilter - -Ƭ **ApprovalForAllFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :----------------------- | :------------------ | -| `approved?` | `boolean` \| `null` | -| `approved_in?` | `boolean`[] | -| `approved_not?` | `boolean` \| `null` | -| `approved_not_in?` | `boolean`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `operator?` | `string` \| `null` | -| `operator_contains?` | `string` \| `null` | -| `operator_in?` | `string`[] | -| `operator_not?` | `string` \| `null` | -| `operator_not_contains?` | `string` \| `null` | -| `operator_not_in?` | `string`[] | -| `owner?` | `string` \| `null` | -| `owner_contains?` | `string` \| `null` | -| `owner_in?` | `string`[] | -| `owner_not?` | `string` \| `null` | -| `owner_not_contains?` | `string` \| `null` | -| `owner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:68 - ---- - -### ApprovalForAllResult - -Ƭ **ApprovalForAllResult**: `Object` - -#### Type declaration - -| Name | Type | -| :--------- | :-------- | -| `approved` | `boolean` | -| `id` | `string` | -| `operator` | `string` | -| `owner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:94 - ---- - -### ApprovalResult - -Ƭ **ApprovalResult**: `Object` - -#### Type declaration - -| Name | Type | -| :--------- | :------- | -| `approved` | `string` | -| `id` | `string` | -| `owner` | `string` | -| `tokenId` | `Wei` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:51 - ---- - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721Upgradeable.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:137 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:133 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:111 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:129 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:10 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721Upgradeable.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:174 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:169 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:142 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:164 - ---- - -### ProxyApprovalArgs - -Ƭ **ProxyApprovalArgs**<`K`\>: { [Property in keyof Pick]: ProxyApprovalFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------- | -| `K` | extends keyof [`ProxyApprovalResult`](subgraphs.NFT721Upgradeable.md#proxyapprovalresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:217 - ---- - -### ProxyApprovalFields - -Ƭ **ProxyApprovalFields**: `Object` - -#### Type declaration - -| Name | Type | -| :--------- | :----- | -| `approved` | `true` | -| `id` | `true` | -| `operator` | `true` | -| `sender` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:211 - ---- - -### ProxyApprovalFilter - -Ƭ **ProxyApprovalFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :----------------------- | :------------------ | -| `approved?` | `boolean` \| `null` | -| `approved_in?` | `boolean`[] | -| `approved_not?` | `boolean` \| `null` | -| `approved_not_in?` | `boolean`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `operator?` | `string` \| `null` | -| `operator_contains?` | `string` \| `null` | -| `operator_in?` | `string`[] | -| `operator_not?` | `string` \| `null` | -| `operator_not_contains?` | `string` \| `null` | -| `operator_not_in?` | `string`[] | -| `sender?` | `string` \| `null` | -| `sender_contains?` | `string` \| `null` | -| `sender_in?` | `string`[] | -| `sender_not?` | `string` \| `null` | -| `sender_not_contains?` | `string` \| `null` | -| `sender_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:179 - ---- - -### ProxyApprovalResult - -Ƭ **ProxyApprovalResult**: `Object` - -#### Type declaration - -| Name | Type | -| :--------- | :-------- | -| `approved` | `boolean` | -| `id` | `string` | -| `operator` | `string` | -| `sender` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:205 - ---- - -### RoleAdminChangedArgs - -Ƭ **RoleAdminChangedArgs**<`K`\>: { [Property in keyof Pick]: RoleAdminChangedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.NFT721Upgradeable.md#roleadminchangedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:262 - ---- - -### RoleAdminChangedFields - -Ƭ **RoleAdminChangedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :----- | -| `id` | `true` | -| `newAdminRole` | `true` | -| `previousAdminRole` | `true` | -| `role` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:256 - ---- - -### RoleAdminChangedFilter - -Ƭ **RoleAdminChangedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newAdminRole?` | `string` \| `null` | -| `newAdminRole_contains?` | `string` \| `null` | -| `newAdminRole_in?` | `string`[] | -| `newAdminRole_not?` | `string` \| `null` | -| `newAdminRole_not_contains?` | `string` \| `null` | -| `newAdminRole_not_in?` | `string`[] | -| `previousAdminRole?` | `string` \| `null` | -| `previousAdminRole_contains?` | `string` \| `null` | -| `previousAdminRole_in?` | `string`[] | -| `previousAdminRole_not?` | `string` \| `null` | -| `previousAdminRole_not_contains?` | `string` \| `null` | -| `previousAdminRole_not_in?` | `string`[] | -| `role?` | `string` \| `null` | -| `role_contains?` | `string` \| `null` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| `null` | -| `role_not_contains?` | `string` \| `null` | -| `role_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:222 - ---- - -### RoleAdminChangedResult - -Ƭ **RoleAdminChangedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :------- | -| `id` | `string` | -| `newAdminRole` | `string` | -| `previousAdminRole` | `string` | -| `role` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:250 - ---- - -### RoleGrantedArgs - -Ƭ **RoleGrantedArgs**<`K`\>: { [Property in keyof Pick]: RoleGrantedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------ | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.NFT721Upgradeable.md#rolegrantedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:307 - ---- - -### RoleGrantedFields - -Ƭ **RoleGrantedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `account` | `true` | -| `id` | `true` | -| `role` | `true` | -| `sender` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:301 - ---- - -### RoleGrantedFilter - -Ƭ **RoleGrantedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------- | :----------------- | -| `account?` | `string` \| `null` | -| `account_contains?` | `string` \| `null` | -| `account_in?` | `string`[] | -| `account_not?` | `string` \| `null` | -| `account_not_contains?` | `string` \| `null` | -| `account_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `role?` | `string` \| `null` | -| `role_contains?` | `string` \| `null` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| `null` | -| `role_not_contains?` | `string` \| `null` | -| `role_not_in?` | `string`[] | -| `sender?` | `string` \| `null` | -| `sender_contains?` | `string` \| `null` | -| `sender_in?` | `string`[] | -| `sender_not?` | `string` \| `null` | -| `sender_not_contains?` | `string` \| `null` | -| `sender_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:267 - ---- - -### RoleGrantedResult - -Ƭ **RoleGrantedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `account` | `string` | -| `id` | `string` | -| `role` | `string` | -| `sender` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:295 - ---- - -### RoleRevokedArgs - -Ƭ **RoleRevokedArgs**<`K`\>: { [Property in keyof Pick]: RoleRevokedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------ | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.NFT721Upgradeable.md#rolerevokedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:352 - ---- - -### RoleRevokedFields - -Ƭ **RoleRevokedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `account` | `true` | -| `id` | `true` | -| `role` | `true` | -| `sender` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:346 - ---- - -### RoleRevokedFilter - -Ƭ **RoleRevokedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------- | :----------------- | -| `account?` | `string` \| `null` | -| `account_contains?` | `string` \| `null` | -| `account_in?` | `string`[] | -| `account_not?` | `string` \| `null` | -| `account_not_contains?` | `string` \| `null` | -| `account_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `role?` | `string` \| `null` | -| `role_contains?` | `string` \| `null` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| `null` | -| `role_not_contains?` | `string` \| `null` | -| `role_not_in?` | `string`[] | -| `sender?` | `string` \| `null` | -| `sender_contains?` | `string` \| `null` | -| `sender_in?` | `string`[] | -| `sender_not?` | `string` \| `null` | -| `sender_not_contains?` | `string` \| `null` | -| `sender_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:312 - ---- - -### RoleRevokedResult - -Ƭ **RoleRevokedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `account` | `string` | -| `id` | `string` | -| `role` | `string` | -| `sender` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:340 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:2 - ---- - -### TransferArgs - -Ƭ **TransferArgs**<`K`\>: { [Property in keyof Pick]: TransferFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------ | -| `K` | extends keyof [`TransferResult`](subgraphs.NFT721Upgradeable.md#transferresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:399 - ---- - -### TransferFields - -Ƭ **TransferFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `from` | `true` | -| `id` | `true` | -| `to` | `true` | -| `tokenId` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:393 - ---- - -### TransferFilter - -Ƭ **TransferFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------- | :-------------------- | -| `from?` | `string` \| `null` | -| `from_contains?` | `string` \| `null` | -| `from_in?` | `string`[] | -| `from_not?` | `string` \| `null` | -| `from_not_contains?` | `string` \| `null` | -| `from_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `to?` | `string` \| `null` | -| `to_contains?` | `string` \| `null` | -| `to_in?` | `string`[] | -| `to_not?` | `string` \| `null` | -| `to_not_contains?` | `string` \| `null` | -| `to_not_in?` | `string`[] | -| `tokenId?` | `WeiSource` \| `null` | -| `tokenId_gt?` | `WeiSource` \| `null` | -| `tokenId_gte?` | `WeiSource` \| `null` | -| `tokenId_in?` | `WeiSource`[] | -| `tokenId_lt?` | `WeiSource` \| `null` | -| `tokenId_lte?` | `WeiSource` \| `null` | -| `tokenId_not?` | `WeiSource` \| `null` | -| `tokenId_not_in?` | `WeiSource`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:357 - ---- - -### TransferResult - -Ƭ **TransferResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `from` | `string` | -| `id` | `string` | -| `to` | `string` | -| `tokenId` | `Wei` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:387 - -## Functions - -### getApprovalById - -▸ **getApprovalById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ApprovalResult`](subgraphs.NFT721Upgradeable.md#approvalresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------ | -| `K` | extends keyof [`ApprovalResult`](subgraphs.NFT721Upgradeable.md#approvalresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721Upgradeable.md#singlequeryoptions) | -| `args` | [`ApprovalArgs`](subgraphs.NFT721Upgradeable.md#approvalargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ApprovalResult`](subgraphs.NFT721Upgradeable.md#approvalresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:66 - ---- - -### getApprovalForAllById - -▸ **getApprovalForAllById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ApprovalForAllResult`](subgraphs.NFT721Upgradeable.md#approvalforallresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`ApprovalForAllResult`](subgraphs.NFT721Upgradeable.md#approvalforallresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721Upgradeable.md#singlequeryoptions) | -| `args` | [`ApprovalForAllArgs`](subgraphs.NFT721Upgradeable.md#approvalforallargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ApprovalForAllResult`](subgraphs.NFT721Upgradeable.md#approvalforallresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:109 - ---- - -### getApprovalForAlls - -▸ **getApprovalForAlls**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ApprovalForAllResult`](subgraphs.NFT721Upgradeable.md#approvalforallresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`ApprovalForAllResult`](subgraphs.NFT721Upgradeable.md#approvalforallresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721Upgradeable.md#multiqueryoptions)<[`ApprovalForAllFilter`](subgraphs.NFT721Upgradeable.md#approvalforallfilter), [`ApprovalForAllResult`](subgraphs.NFT721Upgradeable.md#approvalforallresult)\> | -| `args` | [`ApprovalForAllArgs`](subgraphs.NFT721Upgradeable.md#approvalforallargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ApprovalForAllResult`](subgraphs.NFT721Upgradeable.md#approvalforallresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:110 - ---- - -### getApprovals - -▸ **getApprovals**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ApprovalResult`](subgraphs.NFT721Upgradeable.md#approvalresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------ | -| `K` | extends keyof [`ApprovalResult`](subgraphs.NFT721Upgradeable.md#approvalresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721Upgradeable.md#multiqueryoptions)<[`ApprovalFilter`](subgraphs.NFT721Upgradeable.md#approvalfilter), [`ApprovalResult`](subgraphs.NFT721Upgradeable.md#approvalresult)\> | -| `args` | [`ApprovalArgs`](subgraphs.NFT721Upgradeable.md#approvalargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ApprovalResult`](subgraphs.NFT721Upgradeable.md#approvalresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:67 - ---- - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721Upgradeable.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721Upgradeable.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721Upgradeable.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.NFT721Upgradeable.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721Upgradeable.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:140 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721Upgradeable.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFT721Upgradeable.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721Upgradeable.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.NFT721Upgradeable.md#initializedfilter), [`InitializedResult`](subgraphs.NFT721Upgradeable.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.NFT721Upgradeable.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFT721Upgradeable.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:141 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721Upgradeable.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721Upgradeable.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721Upgradeable.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFT721Upgradeable.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721Upgradeable.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:177 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721Upgradeable.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFT721Upgradeable.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721Upgradeable.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.NFT721Upgradeable.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.NFT721Upgradeable.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFT721Upgradeable.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFT721Upgradeable.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:178 - ---- - -### getProxyApprovalById - -▸ **getProxyApprovalById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ProxyApprovalResult`](subgraphs.NFT721Upgradeable.md#proxyapprovalresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------- | -| `K` | extends keyof [`ProxyApprovalResult`](subgraphs.NFT721Upgradeable.md#proxyapprovalresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721Upgradeable.md#singlequeryoptions) | -| `args` | [`ProxyApprovalArgs`](subgraphs.NFT721Upgradeable.md#proxyapprovalargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ProxyApprovalResult`](subgraphs.NFT721Upgradeable.md#proxyapprovalresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:220 - ---- - -### getProxyApprovals - -▸ **getProxyApprovals**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ProxyApprovalResult`](subgraphs.NFT721Upgradeable.md#proxyapprovalresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------- | -| `K` | extends keyof [`ProxyApprovalResult`](subgraphs.NFT721Upgradeable.md#proxyapprovalresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721Upgradeable.md#multiqueryoptions)<[`ProxyApprovalFilter`](subgraphs.NFT721Upgradeable.md#proxyapprovalfilter), [`ProxyApprovalResult`](subgraphs.NFT721Upgradeable.md#proxyapprovalresult)\> | -| `args` | [`ProxyApprovalArgs`](subgraphs.NFT721Upgradeable.md#proxyapprovalargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ProxyApprovalResult`](subgraphs.NFT721Upgradeable.md#proxyapprovalresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:221 - ---- - -### getRoleAdminChangedById - -▸ **getRoleAdminChangedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.NFT721Upgradeable.md#roleadminchangedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.NFT721Upgradeable.md#roleadminchangedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721Upgradeable.md#singlequeryoptions) | -| `args` | [`RoleAdminChangedArgs`](subgraphs.NFT721Upgradeable.md#roleadminchangedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.NFT721Upgradeable.md#roleadminchangedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:265 - ---- - -### getRoleAdminChangeds - -▸ **getRoleAdminChangeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.NFT721Upgradeable.md#roleadminchangedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.NFT721Upgradeable.md#roleadminchangedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721Upgradeable.md#multiqueryoptions)<[`RoleAdminChangedFilter`](subgraphs.NFT721Upgradeable.md#roleadminchangedfilter), [`RoleAdminChangedResult`](subgraphs.NFT721Upgradeable.md#roleadminchangedresult)\> | -| `args` | [`RoleAdminChangedArgs`](subgraphs.NFT721Upgradeable.md#roleadminchangedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.NFT721Upgradeable.md#roleadminchangedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:266 - ---- - -### getRoleGrantedById - -▸ **getRoleGrantedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.NFT721Upgradeable.md#rolegrantedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------ | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.NFT721Upgradeable.md#rolegrantedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721Upgradeable.md#singlequeryoptions) | -| `args` | [`RoleGrantedArgs`](subgraphs.NFT721Upgradeable.md#rolegrantedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.NFT721Upgradeable.md#rolegrantedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:310 - ---- - -### getRoleGranteds - -▸ **getRoleGranteds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.NFT721Upgradeable.md#rolegrantedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------ | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.NFT721Upgradeable.md#rolegrantedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721Upgradeable.md#multiqueryoptions)<[`RoleGrantedFilter`](subgraphs.NFT721Upgradeable.md#rolegrantedfilter), [`RoleGrantedResult`](subgraphs.NFT721Upgradeable.md#rolegrantedresult)\> | -| `args` | [`RoleGrantedArgs`](subgraphs.NFT721Upgradeable.md#rolegrantedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.NFT721Upgradeable.md#rolegrantedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:311 - ---- - -### getRoleRevokedById - -▸ **getRoleRevokedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.NFT721Upgradeable.md#rolerevokedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------ | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.NFT721Upgradeable.md#rolerevokedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721Upgradeable.md#singlequeryoptions) | -| `args` | [`RoleRevokedArgs`](subgraphs.NFT721Upgradeable.md#rolerevokedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.NFT721Upgradeable.md#rolerevokedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:355 - ---- - -### getRoleRevokeds - -▸ **getRoleRevokeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.NFT721Upgradeable.md#rolerevokedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------ | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.NFT721Upgradeable.md#rolerevokedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721Upgradeable.md#multiqueryoptions)<[`RoleRevokedFilter`](subgraphs.NFT721Upgradeable.md#rolerevokedfilter), [`RoleRevokedResult`](subgraphs.NFT721Upgradeable.md#rolerevokedresult)\> | -| `args` | [`RoleRevokedArgs`](subgraphs.NFT721Upgradeable.md#rolerevokedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.NFT721Upgradeable.md#rolerevokedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:356 - ---- - -### getTransferById - -▸ **getTransferById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`TransferResult`](subgraphs.NFT721Upgradeable.md#transferresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------ | -| `K` | extends keyof [`TransferResult`](subgraphs.NFT721Upgradeable.md#transferresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFT721Upgradeable.md#singlequeryoptions) | -| `args` | [`TransferArgs`](subgraphs.NFT721Upgradeable.md#transferargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`TransferResult`](subgraphs.NFT721Upgradeable.md#transferresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:402 - ---- - -### getTransfers - -▸ **getTransfers**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`TransferResult`](subgraphs.NFT721Upgradeable.md#transferresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------ | -| `K` | extends keyof [`TransferResult`](subgraphs.NFT721Upgradeable.md#transferresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFT721Upgradeable.md#multiqueryoptions)<[`TransferFilter`](subgraphs.NFT721Upgradeable.md#transferfilter), [`TransferResult`](subgraphs.NFT721Upgradeable.md#transferresult)\> | -| `args` | [`TransferArgs`](subgraphs.NFT721Upgradeable.md#transferargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`TransferResult`](subgraphs.NFT721Upgradeable.md#transferresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFT721Upgradeable.d.ts:403 diff --git a/docs/api-reference/modules/subgraphs.NFTAccessCondition.md b/docs/api-reference/modules/subgraphs.NFTAccessCondition.md deleted file mode 100644 index 58e09f65e..000000000 --- a/docs/api-reference/modules/subgraphs.NFTAccessCondition.md +++ /dev/null @@ -1,516 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / NFTAccessCondition - -# Namespace: NFTAccessCondition - -[subgraphs](subgraphs.md).NFTAccessCondition - -## Table of contents - -### Type Aliases - -- [FulfilledArgs](subgraphs.NFTAccessCondition.md#fulfilledargs) -- [FulfilledFields](subgraphs.NFTAccessCondition.md#fulfilledfields) -- [FulfilledFilter](subgraphs.NFTAccessCondition.md#fulfilledfilter) -- [FulfilledResult](subgraphs.NFTAccessCondition.md#fulfilledresult) -- [InitializedArgs](subgraphs.NFTAccessCondition.md#initializedargs) -- [InitializedFields](subgraphs.NFTAccessCondition.md#initializedfields) -- [InitializedFilter](subgraphs.NFTAccessCondition.md#initializedfilter) -- [InitializedResult](subgraphs.NFTAccessCondition.md#initializedresult) -- [MultiQueryOptions](subgraphs.NFTAccessCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.NFTAccessCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.NFTAccessCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.NFTAccessCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.NFTAccessCondition.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.NFTAccessCondition.md#singlequeryoptions) - -### Functions - -- [getFulfilledById](subgraphs.NFTAccessCondition.md#getfulfilledbyid) -- [getFulfilleds](subgraphs.NFTAccessCondition.md#getfulfilleds) -- [getInitializedById](subgraphs.NFTAccessCondition.md#getinitializedbyid) -- [getInitializeds](subgraphs.NFTAccessCondition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.NFTAccessCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.NFTAccessCondition.md#getownershiptransferreds) - -## Type Aliases - -### FulfilledArgs - -Ƭ **FulfilledArgs**<`K`\>: { [Property in keyof Pick]: FulfilledFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.NFTAccessCondition.md#fulfilledresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessCondition.d.ts:68 - ---- - -### FulfilledFields - -Ƭ **FulfilledFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------------- | :----- | -| `_agreementId` | `true` | -| `_conditionId` | `true` | -| `_documentId` | `true` | -| `_grantee` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessCondition.d.ts:61 - ---- - -### FulfilledFilter - -Ƭ **FulfilledFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------------------- | :----------------- | -| `_agreementId?` | `string` \| `null` | -| `_agreementId_contains?` | `string` \| `null` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| `null` | -| `_agreementId_not_contains?` | `string` \| `null` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionId?` | `string` \| `null` | -| `_conditionId_contains?` | `string` \| `null` | -| `_conditionId_in?` | `string`[] | -| `_conditionId_not?` | `string` \| `null` | -| `_conditionId_not_contains?` | `string` \| `null` | -| `_conditionId_not_in?` | `string`[] | -| `_documentId?` | `string` \| `null` | -| `_documentId_contains?` | `string` \| `null` | -| `_documentId_in?` | `string`[] | -| `_documentId_not?` | `string` \| `null` | -| `_documentId_not_contains?` | `string` \| `null` | -| `_documentId_not_in?` | `string`[] | -| `_grantee?` | `string` \| `null` | -| `_grantee_contains?` | `string` \| `null` | -| `_grantee_in?` | `string`[] | -| `_grantee_not?` | `string` \| `null` | -| `_grantee_not_contains?` | `string` \| `null` | -| `_grantee_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessCondition.d.ts:20 - ---- - -### FulfilledResult - -Ƭ **FulfilledResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------------- | :------- | -| `_agreementId` | `string` | -| `_conditionId` | `string` | -| `_documentId` | `string` | -| `_grantee` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessCondition.d.ts:54 - ---- - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTAccessCondition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessCondition.d.ts:99 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessCondition.d.ts:95 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessCondition.d.ts:73 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessCondition.d.ts:91 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessCondition.d.ts:9 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTAccessCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessCondition.d.ts:136 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessCondition.d.ts:131 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessCondition.d.ts:104 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessCondition.d.ts:126 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessCondition.d.ts:1 - -## Functions - -### getFulfilledById - -▸ **getFulfilledById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFTAccessCondition.md#fulfilledresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.NFTAccessCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTAccessCondition.md#singlequeryoptions) | -| `args` | [`FulfilledArgs`](subgraphs.NFTAccessCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFTAccessCondition.md#fulfilledresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessCondition.d.ts:71 - ---- - -### getFulfilleds - -▸ **getFulfilleds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFTAccessCondition.md#fulfilledresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.NFTAccessCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTAccessCondition.md#multiqueryoptions)<[`FulfilledFilter`](subgraphs.NFTAccessCondition.md#fulfilledfilter), [`FulfilledResult`](subgraphs.NFTAccessCondition.md#fulfilledresult)\> | -| `args` | [`FulfilledArgs`](subgraphs.NFTAccessCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFTAccessCondition.md#fulfilledresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessCondition.d.ts:72 - ---- - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTAccessCondition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTAccessCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTAccessCondition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.NFTAccessCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTAccessCondition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessCondition.d.ts:102 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTAccessCondition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTAccessCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTAccessCondition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.NFTAccessCondition.md#initializedfilter), [`InitializedResult`](subgraphs.NFTAccessCondition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.NFTAccessCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTAccessCondition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessCondition.d.ts:103 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTAccessCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTAccessCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTAccessCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFTAccessCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTAccessCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessCondition.d.ts:139 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTAccessCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTAccessCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTAccessCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.NFTAccessCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.NFTAccessCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFTAccessCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTAccessCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessCondition.d.ts:140 diff --git a/docs/api-reference/modules/subgraphs.NFTAccessProofTemplate.md b/docs/api-reference/modules/subgraphs.NFTAccessProofTemplate.md deleted file mode 100644 index 41cde21b2..000000000 --- a/docs/api-reference/modules/subgraphs.NFTAccessProofTemplate.md +++ /dev/null @@ -1,564 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / NFTAccessProofTemplate - -# Namespace: NFTAccessProofTemplate - -[subgraphs](subgraphs.md).NFTAccessProofTemplate - -## Table of contents - -### Type Aliases - -- [AgreementCreatedArgs](subgraphs.NFTAccessProofTemplate.md#agreementcreatedargs) -- [AgreementCreatedFields](subgraphs.NFTAccessProofTemplate.md#agreementcreatedfields) -- [AgreementCreatedFilter](subgraphs.NFTAccessProofTemplate.md#agreementcreatedfilter) -- [AgreementCreatedResult](subgraphs.NFTAccessProofTemplate.md#agreementcreatedresult) -- [InitializedArgs](subgraphs.NFTAccessProofTemplate.md#initializedargs) -- [InitializedFields](subgraphs.NFTAccessProofTemplate.md#initializedfields) -- [InitializedFilter](subgraphs.NFTAccessProofTemplate.md#initializedfilter) -- [InitializedResult](subgraphs.NFTAccessProofTemplate.md#initializedresult) -- [MultiQueryOptions](subgraphs.NFTAccessProofTemplate.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.NFTAccessProofTemplate.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.NFTAccessProofTemplate.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.NFTAccessProofTemplate.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.NFTAccessProofTemplate.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.NFTAccessProofTemplate.md#singlequeryoptions) - -### Functions - -- [getAgreementCreatedById](subgraphs.NFTAccessProofTemplate.md#getagreementcreatedbyid) -- [getAgreementCreateds](subgraphs.NFTAccessProofTemplate.md#getagreementcreateds) -- [getInitializedById](subgraphs.NFTAccessProofTemplate.md#getinitializedbyid) -- [getInitializeds](subgraphs.NFTAccessProofTemplate.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.NFTAccessProofTemplate.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.NFTAccessProofTemplate.md#getownershiptransferreds) - -## Type Aliases - -### AgreementCreatedArgs - -Ƭ **AgreementCreatedArgs**<`K`\>: { [Property in keyof Pick]: AgreementCreatedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFTAccessProofTemplate.md#agreementcreatedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessProofTemplate.d.ts:117 - ---- - -### AgreementCreatedFields - -Ƭ **AgreementCreatedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :----- | -| `_accessConsumer` | `true` | -| `_accessProvider` | `true` | -| `_agreementId` | `true` | -| `_conditionIdSeeds` | `true` | -| `_conditionIds` | `true` | -| `_creator` | `true` | -| `_did` | `true` | -| `_idSeed` | `true` | -| `_timeLocks` | `true` | -| `_timeOuts` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessProofTemplate.d.ts:104 - ---- - -### AgreementCreatedFilter - -Ƭ **AgreementCreatedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------------------------------- | :----------------- | -| `_accessConsumer?` | `string` \| `null` | -| `_accessConsumer_contains?` | `string` \| `null` | -| `_accessConsumer_in?` | `string`[] | -| `_accessConsumer_not?` | `string` \| `null` | -| `_accessConsumer_not_contains?` | `string` \| `null` | -| `_accessConsumer_not_in?` | `string`[] | -| `_accessProvider?` | `string` \| `null` | -| `_accessProvider_contains?` | `string` \| `null` | -| `_accessProvider_in?` | `string`[] | -| `_accessProvider_not?` | `string` \| `null` | -| `_accessProvider_not_contains?` | `string` \| `null` | -| `_accessProvider_not_in?` | `string`[] | -| `_agreementId?` | `string` \| `null` | -| `_agreementId_contains?` | `string` \| `null` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| `null` | -| `_agreementId_not_contains?` | `string` \| `null` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionIdSeeds?` | `string`[] | -| `_conditionIdSeeds_contains?` | `string`[] | -| `_conditionIdSeeds_contains_nocase?` | `string`[] | -| `_conditionIdSeeds_not?` | `string`[] | -| `_conditionIdSeeds_not_contains?` | `string`[] | -| `_conditionIdSeeds_not_contains_nocase?` | `string`[] | -| `_conditionIds?` | `string`[] | -| `_conditionIds_contains?` | `string`[] | -| `_conditionIds_contains_nocase?` | `string`[] | -| `_conditionIds_not?` | `string`[] | -| `_conditionIds_not_contains?` | `string`[] | -| `_conditionIds_not_contains_nocase?` | `string`[] | -| `_creator?` | `string` \| `null` | -| `_creator_contains?` | `string` \| `null` | -| `_creator_in?` | `string`[] | -| `_creator_not?` | `string` \| `null` | -| `_creator_not_contains?` | `string` \| `null` | -| `_creator_not_in?` | `string`[] | -| `_did?` | `string` \| `null` | -| `_did_contains?` | `string` \| `null` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| `null` | -| `_did_not_contains?` | `string` \| `null` | -| `_did_not_in?` | `string`[] | -| `_idSeed?` | `string` \| `null` | -| `_idSeed_contains?` | `string` \| `null` | -| `_idSeed_in?` | `string`[] | -| `_idSeed_not?` | `string` \| `null` | -| `_idSeed_not_contains?` | `string` \| `null` | -| `_idSeed_not_in?` | `string`[] | -| `_timeLocks?` | `WeiSource`[] | -| `_timeLocks_contains?` | `WeiSource`[] | -| `_timeLocks_contains_nocase?` | `WeiSource`[] | -| `_timeLocks_not?` | `WeiSource`[] | -| `_timeLocks_not_contains?` | `WeiSource`[] | -| `_timeLocks_not_contains_nocase?` | `WeiSource`[] | -| `_timeOuts?` | `WeiSource`[] | -| `_timeOuts_contains?` | `WeiSource`[] | -| `_timeOuts_contains_nocase?` | `WeiSource`[] | -| `_timeOuts_not?` | `WeiSource`[] | -| `_timeOuts_not_contains?` | `WeiSource`[] | -| `_timeOuts_not_contains_nocase?` | `WeiSource`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessProofTemplate.d.ts:21 - ---- - -### AgreementCreatedResult - -Ƭ **AgreementCreatedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :--------------------- | -| `_accessConsumer` | `string` | -| `_accessProvider` | `string` | -| `_agreementId` | `string` | -| `_conditionIdSeeds` | (`string` \| `null`)[] | -| `_conditionIds` | (`string` \| `null`)[] | -| `_creator` | `string` | -| `_did` | `string` | -| `_idSeed` | `string` | -| `_timeLocks` | (`Wei` \| `null`)[] | -| `_timeOuts` | (`Wei` \| `null`)[] | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessProofTemplate.d.ts:91 - ---- - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTAccessProofTemplate.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessProofTemplate.d.ts:148 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessProofTemplate.d.ts:144 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessProofTemplate.d.ts:122 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessProofTemplate.d.ts:140 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessProofTemplate.d.ts:10 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTAccessProofTemplate.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessProofTemplate.d.ts:185 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessProofTemplate.d.ts:180 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessProofTemplate.d.ts:153 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessProofTemplate.d.ts:175 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessProofTemplate.d.ts:2 - -## Functions - -### getAgreementCreatedById - -▸ **getAgreementCreatedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFTAccessProofTemplate.md#agreementcreatedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFTAccessProofTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTAccessProofTemplate.md#singlequeryoptions) | -| `args` | [`AgreementCreatedArgs`](subgraphs.NFTAccessProofTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFTAccessProofTemplate.md#agreementcreatedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessProofTemplate.d.ts:120 - ---- - -### getAgreementCreateds - -▸ **getAgreementCreateds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFTAccessProofTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFTAccessProofTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTAccessProofTemplate.md#multiqueryoptions)<[`AgreementCreatedFilter`](subgraphs.NFTAccessProofTemplate.md#agreementcreatedfilter), [`AgreementCreatedResult`](subgraphs.NFTAccessProofTemplate.md#agreementcreatedresult)\> | -| `args` | [`AgreementCreatedArgs`](subgraphs.NFTAccessProofTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFTAccessProofTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessProofTemplate.d.ts:121 - ---- - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTAccessProofTemplate.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTAccessProofTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTAccessProofTemplate.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.NFTAccessProofTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTAccessProofTemplate.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessProofTemplate.d.ts:151 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTAccessProofTemplate.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTAccessProofTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTAccessProofTemplate.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.NFTAccessProofTemplate.md#initializedfilter), [`InitializedResult`](subgraphs.NFTAccessProofTemplate.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.NFTAccessProofTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTAccessProofTemplate.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessProofTemplate.d.ts:152 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTAccessProofTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTAccessProofTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTAccessProofTemplate.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFTAccessProofTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTAccessProofTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessProofTemplate.d.ts:188 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTAccessProofTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTAccessProofTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTAccessProofTemplate.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.NFTAccessProofTemplate.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.NFTAccessProofTemplate.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFTAccessProofTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTAccessProofTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessProofTemplate.d.ts:189 diff --git a/docs/api-reference/modules/subgraphs.NFTAccessSwapTemplate.md b/docs/api-reference/modules/subgraphs.NFTAccessSwapTemplate.md deleted file mode 100644 index f627eb71f..000000000 --- a/docs/api-reference/modules/subgraphs.NFTAccessSwapTemplate.md +++ /dev/null @@ -1,564 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / NFTAccessSwapTemplate - -# Namespace: NFTAccessSwapTemplate - -[subgraphs](subgraphs.md).NFTAccessSwapTemplate - -## Table of contents - -### Type Aliases - -- [AgreementCreatedArgs](subgraphs.NFTAccessSwapTemplate.md#agreementcreatedargs) -- [AgreementCreatedFields](subgraphs.NFTAccessSwapTemplate.md#agreementcreatedfields) -- [AgreementCreatedFilter](subgraphs.NFTAccessSwapTemplate.md#agreementcreatedfilter) -- [AgreementCreatedResult](subgraphs.NFTAccessSwapTemplate.md#agreementcreatedresult) -- [InitializedArgs](subgraphs.NFTAccessSwapTemplate.md#initializedargs) -- [InitializedFields](subgraphs.NFTAccessSwapTemplate.md#initializedfields) -- [InitializedFilter](subgraphs.NFTAccessSwapTemplate.md#initializedfilter) -- [InitializedResult](subgraphs.NFTAccessSwapTemplate.md#initializedresult) -- [MultiQueryOptions](subgraphs.NFTAccessSwapTemplate.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.NFTAccessSwapTemplate.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.NFTAccessSwapTemplate.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.NFTAccessSwapTemplate.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.NFTAccessSwapTemplate.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.NFTAccessSwapTemplate.md#singlequeryoptions) - -### Functions - -- [getAgreementCreatedById](subgraphs.NFTAccessSwapTemplate.md#getagreementcreatedbyid) -- [getAgreementCreateds](subgraphs.NFTAccessSwapTemplate.md#getagreementcreateds) -- [getInitializedById](subgraphs.NFTAccessSwapTemplate.md#getinitializedbyid) -- [getInitializeds](subgraphs.NFTAccessSwapTemplate.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.NFTAccessSwapTemplate.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.NFTAccessSwapTemplate.md#getownershiptransferreds) - -## Type Aliases - -### AgreementCreatedArgs - -Ƭ **AgreementCreatedArgs**<`K`\>: { [Property in keyof Pick]: AgreementCreatedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFTAccessSwapTemplate.md#agreementcreatedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessSwapTemplate.d.ts:117 - ---- - -### AgreementCreatedFields - -Ƭ **AgreementCreatedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :----- | -| `_accessConsumer` | `true` | -| `_accessProvider` | `true` | -| `_agreementId` | `true` | -| `_conditionIdSeeds` | `true` | -| `_conditionIds` | `true` | -| `_creator` | `true` | -| `_did` | `true` | -| `_idSeed` | `true` | -| `_timeLocks` | `true` | -| `_timeOuts` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessSwapTemplate.d.ts:104 - ---- - -### AgreementCreatedFilter - -Ƭ **AgreementCreatedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------------------------------- | :----------------- | -| `_accessConsumer?` | `string` \| `null` | -| `_accessConsumer_contains?` | `string` \| `null` | -| `_accessConsumer_in?` | `string`[] | -| `_accessConsumer_not?` | `string` \| `null` | -| `_accessConsumer_not_contains?` | `string` \| `null` | -| `_accessConsumer_not_in?` | `string`[] | -| `_accessProvider?` | `string` \| `null` | -| `_accessProvider_contains?` | `string` \| `null` | -| `_accessProvider_in?` | `string`[] | -| `_accessProvider_not?` | `string` \| `null` | -| `_accessProvider_not_contains?` | `string` \| `null` | -| `_accessProvider_not_in?` | `string`[] | -| `_agreementId?` | `string` \| `null` | -| `_agreementId_contains?` | `string` \| `null` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| `null` | -| `_agreementId_not_contains?` | `string` \| `null` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionIdSeeds?` | `string`[] | -| `_conditionIdSeeds_contains?` | `string`[] | -| `_conditionIdSeeds_contains_nocase?` | `string`[] | -| `_conditionIdSeeds_not?` | `string`[] | -| `_conditionIdSeeds_not_contains?` | `string`[] | -| `_conditionIdSeeds_not_contains_nocase?` | `string`[] | -| `_conditionIds?` | `string`[] | -| `_conditionIds_contains?` | `string`[] | -| `_conditionIds_contains_nocase?` | `string`[] | -| `_conditionIds_not?` | `string`[] | -| `_conditionIds_not_contains?` | `string`[] | -| `_conditionIds_not_contains_nocase?` | `string`[] | -| `_creator?` | `string` \| `null` | -| `_creator_contains?` | `string` \| `null` | -| `_creator_in?` | `string`[] | -| `_creator_not?` | `string` \| `null` | -| `_creator_not_contains?` | `string` \| `null` | -| `_creator_not_in?` | `string`[] | -| `_did?` | `string` \| `null` | -| `_did_contains?` | `string` \| `null` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| `null` | -| `_did_not_contains?` | `string` \| `null` | -| `_did_not_in?` | `string`[] | -| `_idSeed?` | `string` \| `null` | -| `_idSeed_contains?` | `string` \| `null` | -| `_idSeed_in?` | `string`[] | -| `_idSeed_not?` | `string` \| `null` | -| `_idSeed_not_contains?` | `string` \| `null` | -| `_idSeed_not_in?` | `string`[] | -| `_timeLocks?` | `WeiSource`[] | -| `_timeLocks_contains?` | `WeiSource`[] | -| `_timeLocks_contains_nocase?` | `WeiSource`[] | -| `_timeLocks_not?` | `WeiSource`[] | -| `_timeLocks_not_contains?` | `WeiSource`[] | -| `_timeLocks_not_contains_nocase?` | `WeiSource`[] | -| `_timeOuts?` | `WeiSource`[] | -| `_timeOuts_contains?` | `WeiSource`[] | -| `_timeOuts_contains_nocase?` | `WeiSource`[] | -| `_timeOuts_not?` | `WeiSource`[] | -| `_timeOuts_not_contains?` | `WeiSource`[] | -| `_timeOuts_not_contains_nocase?` | `WeiSource`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessSwapTemplate.d.ts:21 - ---- - -### AgreementCreatedResult - -Ƭ **AgreementCreatedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :--------------------- | -| `_accessConsumer` | `string` | -| `_accessProvider` | `string` | -| `_agreementId` | `string` | -| `_conditionIdSeeds` | (`string` \| `null`)[] | -| `_conditionIds` | (`string` \| `null`)[] | -| `_creator` | `string` | -| `_did` | `string` | -| `_idSeed` | `string` | -| `_timeLocks` | (`Wei` \| `null`)[] | -| `_timeOuts` | (`Wei` \| `null`)[] | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessSwapTemplate.d.ts:91 - ---- - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTAccessSwapTemplate.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessSwapTemplate.d.ts:148 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessSwapTemplate.d.ts:144 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessSwapTemplate.d.ts:122 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessSwapTemplate.d.ts:140 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessSwapTemplate.d.ts:10 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTAccessSwapTemplate.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessSwapTemplate.d.ts:185 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessSwapTemplate.d.ts:180 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessSwapTemplate.d.ts:153 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessSwapTemplate.d.ts:175 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessSwapTemplate.d.ts:2 - -## Functions - -### getAgreementCreatedById - -▸ **getAgreementCreatedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFTAccessSwapTemplate.md#agreementcreatedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFTAccessSwapTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTAccessSwapTemplate.md#singlequeryoptions) | -| `args` | [`AgreementCreatedArgs`](subgraphs.NFTAccessSwapTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFTAccessSwapTemplate.md#agreementcreatedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessSwapTemplate.d.ts:120 - ---- - -### getAgreementCreateds - -▸ **getAgreementCreateds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFTAccessSwapTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFTAccessSwapTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTAccessSwapTemplate.md#multiqueryoptions)<[`AgreementCreatedFilter`](subgraphs.NFTAccessSwapTemplate.md#agreementcreatedfilter), [`AgreementCreatedResult`](subgraphs.NFTAccessSwapTemplate.md#agreementcreatedresult)\> | -| `args` | [`AgreementCreatedArgs`](subgraphs.NFTAccessSwapTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFTAccessSwapTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessSwapTemplate.d.ts:121 - ---- - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTAccessSwapTemplate.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTAccessSwapTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTAccessSwapTemplate.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.NFTAccessSwapTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTAccessSwapTemplate.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessSwapTemplate.d.ts:151 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTAccessSwapTemplate.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTAccessSwapTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTAccessSwapTemplate.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.NFTAccessSwapTemplate.md#initializedfilter), [`InitializedResult`](subgraphs.NFTAccessSwapTemplate.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.NFTAccessSwapTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTAccessSwapTemplate.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessSwapTemplate.d.ts:152 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTAccessSwapTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTAccessSwapTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTAccessSwapTemplate.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFTAccessSwapTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTAccessSwapTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessSwapTemplate.d.ts:188 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTAccessSwapTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTAccessSwapTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTAccessSwapTemplate.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.NFTAccessSwapTemplate.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.NFTAccessSwapTemplate.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFTAccessSwapTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTAccessSwapTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessSwapTemplate.d.ts:189 diff --git a/docs/api-reference/modules/subgraphs.NFTAccessTemplate.md b/docs/api-reference/modules/subgraphs.NFTAccessTemplate.md deleted file mode 100644 index 2d887878e..000000000 --- a/docs/api-reference/modules/subgraphs.NFTAccessTemplate.md +++ /dev/null @@ -1,564 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / NFTAccessTemplate - -# Namespace: NFTAccessTemplate - -[subgraphs](subgraphs.md).NFTAccessTemplate - -## Table of contents - -### Type Aliases - -- [AgreementCreatedArgs](subgraphs.NFTAccessTemplate.md#agreementcreatedargs) -- [AgreementCreatedFields](subgraphs.NFTAccessTemplate.md#agreementcreatedfields) -- [AgreementCreatedFilter](subgraphs.NFTAccessTemplate.md#agreementcreatedfilter) -- [AgreementCreatedResult](subgraphs.NFTAccessTemplate.md#agreementcreatedresult) -- [InitializedArgs](subgraphs.NFTAccessTemplate.md#initializedargs) -- [InitializedFields](subgraphs.NFTAccessTemplate.md#initializedfields) -- [InitializedFilter](subgraphs.NFTAccessTemplate.md#initializedfilter) -- [InitializedResult](subgraphs.NFTAccessTemplate.md#initializedresult) -- [MultiQueryOptions](subgraphs.NFTAccessTemplate.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.NFTAccessTemplate.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.NFTAccessTemplate.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.NFTAccessTemplate.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.NFTAccessTemplate.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.NFTAccessTemplate.md#singlequeryoptions) - -### Functions - -- [getAgreementCreatedById](subgraphs.NFTAccessTemplate.md#getagreementcreatedbyid) -- [getAgreementCreateds](subgraphs.NFTAccessTemplate.md#getagreementcreateds) -- [getInitializedById](subgraphs.NFTAccessTemplate.md#getinitializedbyid) -- [getInitializeds](subgraphs.NFTAccessTemplate.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.NFTAccessTemplate.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.NFTAccessTemplate.md#getownershiptransferreds) - -## Type Aliases - -### AgreementCreatedArgs - -Ƭ **AgreementCreatedArgs**<`K`\>: { [Property in keyof Pick]: AgreementCreatedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFTAccessTemplate.md#agreementcreatedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessTemplate.d.ts:117 - ---- - -### AgreementCreatedFields - -Ƭ **AgreementCreatedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :----- | -| `_accessConsumer` | `true` | -| `_accessProvider` | `true` | -| `_agreementId` | `true` | -| `_conditionIdSeeds` | `true` | -| `_conditionIds` | `true` | -| `_creator` | `true` | -| `_did` | `true` | -| `_idSeed` | `true` | -| `_timeLocks` | `true` | -| `_timeOuts` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessTemplate.d.ts:104 - ---- - -### AgreementCreatedFilter - -Ƭ **AgreementCreatedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------------------------------- | :----------------- | -| `_accessConsumer?` | `string` \| `null` | -| `_accessConsumer_contains?` | `string` \| `null` | -| `_accessConsumer_in?` | `string`[] | -| `_accessConsumer_not?` | `string` \| `null` | -| `_accessConsumer_not_contains?` | `string` \| `null` | -| `_accessConsumer_not_in?` | `string`[] | -| `_accessProvider?` | `string` \| `null` | -| `_accessProvider_contains?` | `string` \| `null` | -| `_accessProvider_in?` | `string`[] | -| `_accessProvider_not?` | `string` \| `null` | -| `_accessProvider_not_contains?` | `string` \| `null` | -| `_accessProvider_not_in?` | `string`[] | -| `_agreementId?` | `string` \| `null` | -| `_agreementId_contains?` | `string` \| `null` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| `null` | -| `_agreementId_not_contains?` | `string` \| `null` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionIdSeeds?` | `string`[] | -| `_conditionIdSeeds_contains?` | `string`[] | -| `_conditionIdSeeds_contains_nocase?` | `string`[] | -| `_conditionIdSeeds_not?` | `string`[] | -| `_conditionIdSeeds_not_contains?` | `string`[] | -| `_conditionIdSeeds_not_contains_nocase?` | `string`[] | -| `_conditionIds?` | `string`[] | -| `_conditionIds_contains?` | `string`[] | -| `_conditionIds_contains_nocase?` | `string`[] | -| `_conditionIds_not?` | `string`[] | -| `_conditionIds_not_contains?` | `string`[] | -| `_conditionIds_not_contains_nocase?` | `string`[] | -| `_creator?` | `string` \| `null` | -| `_creator_contains?` | `string` \| `null` | -| `_creator_in?` | `string`[] | -| `_creator_not?` | `string` \| `null` | -| `_creator_not_contains?` | `string` \| `null` | -| `_creator_not_in?` | `string`[] | -| `_did?` | `string` \| `null` | -| `_did_contains?` | `string` \| `null` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| `null` | -| `_did_not_contains?` | `string` \| `null` | -| `_did_not_in?` | `string`[] | -| `_idSeed?` | `string` \| `null` | -| `_idSeed_contains?` | `string` \| `null` | -| `_idSeed_in?` | `string`[] | -| `_idSeed_not?` | `string` \| `null` | -| `_idSeed_not_contains?` | `string` \| `null` | -| `_idSeed_not_in?` | `string`[] | -| `_timeLocks?` | `WeiSource`[] | -| `_timeLocks_contains?` | `WeiSource`[] | -| `_timeLocks_contains_nocase?` | `WeiSource`[] | -| `_timeLocks_not?` | `WeiSource`[] | -| `_timeLocks_not_contains?` | `WeiSource`[] | -| `_timeLocks_not_contains_nocase?` | `WeiSource`[] | -| `_timeOuts?` | `WeiSource`[] | -| `_timeOuts_contains?` | `WeiSource`[] | -| `_timeOuts_contains_nocase?` | `WeiSource`[] | -| `_timeOuts_not?` | `WeiSource`[] | -| `_timeOuts_not_contains?` | `WeiSource`[] | -| `_timeOuts_not_contains_nocase?` | `WeiSource`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessTemplate.d.ts:21 - ---- - -### AgreementCreatedResult - -Ƭ **AgreementCreatedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :--------------------- | -| `_accessConsumer` | `string` | -| `_accessProvider` | `string` | -| `_agreementId` | `string` | -| `_conditionIdSeeds` | (`string` \| `null`)[] | -| `_conditionIds` | (`string` \| `null`)[] | -| `_creator` | `string` | -| `_did` | `string` | -| `_idSeed` | `string` | -| `_timeLocks` | (`Wei` \| `null`)[] | -| `_timeOuts` | (`Wei` \| `null`)[] | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessTemplate.d.ts:91 - ---- - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTAccessTemplate.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessTemplate.d.ts:148 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessTemplate.d.ts:144 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessTemplate.d.ts:122 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessTemplate.d.ts:140 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessTemplate.d.ts:10 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTAccessTemplate.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessTemplate.d.ts:185 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessTemplate.d.ts:180 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessTemplate.d.ts:153 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessTemplate.d.ts:175 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessTemplate.d.ts:2 - -## Functions - -### getAgreementCreatedById - -▸ **getAgreementCreatedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFTAccessTemplate.md#agreementcreatedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFTAccessTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTAccessTemplate.md#singlequeryoptions) | -| `args` | [`AgreementCreatedArgs`](subgraphs.NFTAccessTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFTAccessTemplate.md#agreementcreatedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessTemplate.d.ts:120 - ---- - -### getAgreementCreateds - -▸ **getAgreementCreateds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFTAccessTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFTAccessTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTAccessTemplate.md#multiqueryoptions)<[`AgreementCreatedFilter`](subgraphs.NFTAccessTemplate.md#agreementcreatedfilter), [`AgreementCreatedResult`](subgraphs.NFTAccessTemplate.md#agreementcreatedresult)\> | -| `args` | [`AgreementCreatedArgs`](subgraphs.NFTAccessTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFTAccessTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessTemplate.d.ts:121 - ---- - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTAccessTemplate.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTAccessTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTAccessTemplate.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.NFTAccessTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTAccessTemplate.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessTemplate.d.ts:151 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTAccessTemplate.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTAccessTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTAccessTemplate.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.NFTAccessTemplate.md#initializedfilter), [`InitializedResult`](subgraphs.NFTAccessTemplate.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.NFTAccessTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTAccessTemplate.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessTemplate.d.ts:152 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTAccessTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTAccessTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTAccessTemplate.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFTAccessTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTAccessTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessTemplate.d.ts:188 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTAccessTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTAccessTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTAccessTemplate.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.NFTAccessTemplate.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.NFTAccessTemplate.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFTAccessTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTAccessTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTAccessTemplate.d.ts:189 diff --git a/docs/api-reference/modules/subgraphs.NFTEscrowPaymentCondition.md b/docs/api-reference/modules/subgraphs.NFTEscrowPaymentCondition.md deleted file mode 100644 index 98728c46c..000000000 --- a/docs/api-reference/modules/subgraphs.NFTEscrowPaymentCondition.md +++ /dev/null @@ -1,685 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / NFTEscrowPaymentCondition - -# Namespace: NFTEscrowPaymentCondition - -[subgraphs](subgraphs.md).NFTEscrowPaymentCondition - -## Table of contents - -### Type Aliases - -- [FulfilledArgs](subgraphs.NFTEscrowPaymentCondition.md#fulfilledargs) -- [FulfilledFields](subgraphs.NFTEscrowPaymentCondition.md#fulfilledfields) -- [FulfilledFilter](subgraphs.NFTEscrowPaymentCondition.md#fulfilledfilter) -- [FulfilledResult](subgraphs.NFTEscrowPaymentCondition.md#fulfilledresult) -- [InitializedArgs](subgraphs.NFTEscrowPaymentCondition.md#initializedargs) -- [InitializedFields](subgraphs.NFTEscrowPaymentCondition.md#initializedfields) -- [InitializedFilter](subgraphs.NFTEscrowPaymentCondition.md#initializedfilter) -- [InitializedResult](subgraphs.NFTEscrowPaymentCondition.md#initializedresult) -- [MultiQueryOptions](subgraphs.NFTEscrowPaymentCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.NFTEscrowPaymentCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.NFTEscrowPaymentCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.NFTEscrowPaymentCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.NFTEscrowPaymentCondition.md#ownershiptransferredresult) -- [ReceivedArgs](subgraphs.NFTEscrowPaymentCondition.md#receivedargs) -- [ReceivedFields](subgraphs.NFTEscrowPaymentCondition.md#receivedfields) -- [ReceivedFilter](subgraphs.NFTEscrowPaymentCondition.md#receivedfilter) -- [ReceivedResult](subgraphs.NFTEscrowPaymentCondition.md#receivedresult) -- [SingleQueryOptions](subgraphs.NFTEscrowPaymentCondition.md#singlequeryoptions) - -### Functions - -- [getFulfilledById](subgraphs.NFTEscrowPaymentCondition.md#getfulfilledbyid) -- [getFulfilleds](subgraphs.NFTEscrowPaymentCondition.md#getfulfilleds) -- [getInitializedById](subgraphs.NFTEscrowPaymentCondition.md#getinitializedbyid) -- [getInitializeds](subgraphs.NFTEscrowPaymentCondition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.NFTEscrowPaymentCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.NFTEscrowPaymentCondition.md#getownershiptransferreds) -- [getReceivedById](subgraphs.NFTEscrowPaymentCondition.md#getreceivedbyid) -- [getReceiveds](subgraphs.NFTEscrowPaymentCondition.md#getreceiveds) - -## Type Aliases - -### FulfilledArgs - -Ƭ **FulfilledArgs**<`K`\>: { [Property in keyof Pick]: FulfilledFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.NFTEscrowPaymentCondition.md#fulfilledresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:87 - ---- - -### FulfilledFields - -Ƭ **FulfilledFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `_agreementId` | `true` | -| `_amounts` | `true` | -| `_conditionId` | `true` | -| `_did` | `true` | -| `_receivers` | `true` | -| `_tokenAddress` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:78 - ---- - -### FulfilledFilter - -Ƭ **FulfilledFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :-------------------- | -| `_agreementId?` | `string` \| `null` | -| `_agreementId_contains?` | `string` \| `null` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| `null` | -| `_agreementId_not_contains?` | `string` \| `null` | -| `_agreementId_not_in?` | `string`[] | -| `_amounts?` | `WeiSource` \| `null` | -| `_amounts_gt?` | `WeiSource` \| `null` | -| `_amounts_gte?` | `WeiSource` \| `null` | -| `_amounts_in?` | `WeiSource`[] | -| `_amounts_lt?` | `WeiSource` \| `null` | -| `_amounts_lte?` | `WeiSource` \| `null` | -| `_amounts_not?` | `WeiSource` \| `null` | -| `_amounts_not_in?` | `WeiSource`[] | -| `_conditionId?` | `string` \| `null` | -| `_conditionId_contains?` | `string` \| `null` | -| `_conditionId_in?` | `string`[] | -| `_conditionId_not?` | `string` \| `null` | -| `_conditionId_not_contains?` | `string` \| `null` | -| `_conditionId_not_in?` | `string`[] | -| `_did?` | `string` \| `null` | -| `_did_contains?` | `string` \| `null` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| `null` | -| `_did_not_contains?` | `string` \| `null` | -| `_did_not_in?` | `string`[] | -| `_receivers?` | `string` \| `null` | -| `_receivers_contains?` | `string` \| `null` | -| `_receivers_in?` | `string`[] | -| `_receivers_not?` | `string` \| `null` | -| `_receivers_not_contains?` | `string` \| `null` | -| `_receivers_not_in?` | `string`[] | -| `_tokenAddress?` | `string` \| `null` | -| `_tokenAddress_contains?` | `string` \| `null` | -| `_tokenAddress_in?` | `string`[] | -| `_tokenAddress_not?` | `string` \| `null` | -| `_tokenAddress_not_contains?` | `string` \| `null` | -| `_tokenAddress_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:21 - ---- - -### FulfilledResult - -Ƭ **FulfilledResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `_agreementId` | `string` | -| `_amounts` | `Wei` | -| `_conditionId` | `string` | -| `_did` | `string` | -| `_receivers` | `string` | -| `_tokenAddress` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:69 - ---- - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTEscrowPaymentCondition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:118 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:114 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:92 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:110 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:10 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTEscrowPaymentCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:155 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:150 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:123 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:145 - ---- - -### ReceivedArgs - -Ƭ **ReceivedArgs**<`K`\>: { [Property in keyof Pick]: ReceivedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------- | -| `K` | extends keyof [`ReceivedResult`](subgraphs.NFTEscrowPaymentCondition.md#receivedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:194 - ---- - -### ReceivedFields - -Ƭ **ReceivedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :----- | -| `_from` | `true` | -| `_value` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:189 - ---- - -### ReceivedFilter - -Ƭ **ReceivedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------- | :-------------------- | -| `_from?` | `string` \| `null` | -| `_from_contains?` | `string` \| `null` | -| `_from_in?` | `string`[] | -| `_from_not?` | `string` \| `null` | -| `_from_not_contains?` | `string` \| `null` | -| `_from_not_in?` | `string`[] | -| `_value?` | `WeiSource` \| `null` | -| `_value_gt?` | `WeiSource` \| `null` | -| `_value_gte?` | `WeiSource` \| `null` | -| `_value_in?` | `WeiSource`[] | -| `_value_lt?` | `WeiSource` \| `null` | -| `_value_lte?` | `WeiSource` \| `null` | -| `_value_not?` | `WeiSource` \| `null` | -| `_value_not_in?` | `WeiSource`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:160 - ---- - -### ReceivedResult - -Ƭ **ReceivedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :------- | -| `_from` | `string` | -| `_value` | `Wei` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:184 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:2 - -## Functions - -### getFulfilledById - -▸ **getFulfilledById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFTEscrowPaymentCondition.md#fulfilledresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.NFTEscrowPaymentCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTEscrowPaymentCondition.md#singlequeryoptions) | -| `args` | [`FulfilledArgs`](subgraphs.NFTEscrowPaymentCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFTEscrowPaymentCondition.md#fulfilledresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:90 - ---- - -### getFulfilleds - -▸ **getFulfilleds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFTEscrowPaymentCondition.md#fulfilledresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.NFTEscrowPaymentCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTEscrowPaymentCondition.md#multiqueryoptions)<[`FulfilledFilter`](subgraphs.NFTEscrowPaymentCondition.md#fulfilledfilter), [`FulfilledResult`](subgraphs.NFTEscrowPaymentCondition.md#fulfilledresult)\> | -| `args` | [`FulfilledArgs`](subgraphs.NFTEscrowPaymentCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFTEscrowPaymentCondition.md#fulfilledresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:91 - ---- - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTEscrowPaymentCondition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTEscrowPaymentCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTEscrowPaymentCondition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.NFTEscrowPaymentCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTEscrowPaymentCondition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:121 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTEscrowPaymentCondition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTEscrowPaymentCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTEscrowPaymentCondition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.NFTEscrowPaymentCondition.md#initializedfilter), [`InitializedResult`](subgraphs.NFTEscrowPaymentCondition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.NFTEscrowPaymentCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTEscrowPaymentCondition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:122 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTEscrowPaymentCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTEscrowPaymentCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTEscrowPaymentCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFTEscrowPaymentCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTEscrowPaymentCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:158 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTEscrowPaymentCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTEscrowPaymentCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTEscrowPaymentCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.NFTEscrowPaymentCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.NFTEscrowPaymentCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFTEscrowPaymentCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTEscrowPaymentCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:159 - ---- - -### getReceivedById - -▸ **getReceivedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ReceivedResult`](subgraphs.NFTEscrowPaymentCondition.md#receivedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------- | -| `K` | extends keyof [`ReceivedResult`](subgraphs.NFTEscrowPaymentCondition.md#receivedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTEscrowPaymentCondition.md#singlequeryoptions) | -| `args` | [`ReceivedArgs`](subgraphs.NFTEscrowPaymentCondition.md#receivedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ReceivedResult`](subgraphs.NFTEscrowPaymentCondition.md#receivedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:197 - ---- - -### getReceiveds - -▸ **getReceiveds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ReceivedResult`](subgraphs.NFTEscrowPaymentCondition.md#receivedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------- | -| `K` | extends keyof [`ReceivedResult`](subgraphs.NFTEscrowPaymentCondition.md#receivedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTEscrowPaymentCondition.md#multiqueryoptions)<[`ReceivedFilter`](subgraphs.NFTEscrowPaymentCondition.md#receivedfilter), [`ReceivedResult`](subgraphs.NFTEscrowPaymentCondition.md#receivedresult)\> | -| `args` | [`ReceivedArgs`](subgraphs.NFTEscrowPaymentCondition.md#receivedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ReceivedResult`](subgraphs.NFTEscrowPaymentCondition.md#receivedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTEscrowPaymentCondition.d.ts:198 diff --git a/docs/api-reference/modules/subgraphs.NFTHolderCondition.md b/docs/api-reference/modules/subgraphs.NFTHolderCondition.md deleted file mode 100644 index 39301691b..000000000 --- a/docs/api-reference/modules/subgraphs.NFTHolderCondition.md +++ /dev/null @@ -1,526 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / NFTHolderCondition - -# Namespace: NFTHolderCondition - -[subgraphs](subgraphs.md).NFTHolderCondition - -## Table of contents - -### Type Aliases - -- [FulfilledArgs](subgraphs.NFTHolderCondition.md#fulfilledargs) -- [FulfilledFields](subgraphs.NFTHolderCondition.md#fulfilledfields) -- [FulfilledFilter](subgraphs.NFTHolderCondition.md#fulfilledfilter) -- [FulfilledResult](subgraphs.NFTHolderCondition.md#fulfilledresult) -- [InitializedArgs](subgraphs.NFTHolderCondition.md#initializedargs) -- [InitializedFields](subgraphs.NFTHolderCondition.md#initializedfields) -- [InitializedFilter](subgraphs.NFTHolderCondition.md#initializedfilter) -- [InitializedResult](subgraphs.NFTHolderCondition.md#initializedresult) -- [MultiQueryOptions](subgraphs.NFTHolderCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.NFTHolderCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.NFTHolderCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.NFTHolderCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.NFTHolderCondition.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.NFTHolderCondition.md#singlequeryoptions) - -### Functions - -- [getFulfilledById](subgraphs.NFTHolderCondition.md#getfulfilledbyid) -- [getFulfilleds](subgraphs.NFTHolderCondition.md#getfulfilleds) -- [getInitializedById](subgraphs.NFTHolderCondition.md#getinitializedbyid) -- [getInitializeds](subgraphs.NFTHolderCondition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.NFTHolderCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.NFTHolderCondition.md#getownershiptransferreds) - -## Type Aliases - -### FulfilledArgs - -Ƭ **FulfilledArgs**<`K`\>: { [Property in keyof Pick]: FulfilledFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.NFTHolderCondition.md#fulfilledresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTHolderCondition.d.ts:79 - ---- - -### FulfilledFields - -Ƭ **FulfilledFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------------- | :----- | -| `_address` | `true` | -| `_agreementId` | `true` | -| `_amount` | `true` | -| `_conditionId` | `true` | -| `_did` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTHolderCondition.d.ts:71 - ---- - -### FulfilledFilter - -Ƭ **FulfilledFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------------------- | :-------------------- | -| `_address?` | `string` \| `null` | -| `_address_contains?` | `string` \| `null` | -| `_address_in?` | `string`[] | -| `_address_not?` | `string` \| `null` | -| `_address_not_contains?` | `string` \| `null` | -| `_address_not_in?` | `string`[] | -| `_agreementId?` | `string` \| `null` | -| `_agreementId_contains?` | `string` \| `null` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| `null` | -| `_agreementId_not_contains?` | `string` \| `null` | -| `_agreementId_not_in?` | `string`[] | -| `_amount?` | `WeiSource` \| `null` | -| `_amount_gt?` | `WeiSource` \| `null` | -| `_amount_gte?` | `WeiSource` \| `null` | -| `_amount_in?` | `WeiSource`[] | -| `_amount_lt?` | `WeiSource` \| `null` | -| `_amount_lte?` | `WeiSource` \| `null` | -| `_amount_not?` | `WeiSource` \| `null` | -| `_amount_not_in?` | `WeiSource`[] | -| `_conditionId?` | `string` \| `null` | -| `_conditionId_contains?` | `string` \| `null` | -| `_conditionId_in?` | `string`[] | -| `_conditionId_not?` | `string` \| `null` | -| `_conditionId_not_contains?` | `string` \| `null` | -| `_conditionId_not_in?` | `string`[] | -| `_did?` | `string` \| `null` | -| `_did_contains?` | `string` \| `null` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| `null` | -| `_did_not_contains?` | `string` \| `null` | -| `_did_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTHolderCondition.d.ts:21 - ---- - -### FulfilledResult - -Ƭ **FulfilledResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------------- | :------- | -| `_address` | `string` | -| `_agreementId` | `string` | -| `_amount` | `Wei` | -| `_conditionId` | `string` | -| `_did` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTHolderCondition.d.ts:63 - ---- - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTHolderCondition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTHolderCondition.d.ts:110 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTHolderCondition.d.ts:106 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTHolderCondition.d.ts:84 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTHolderCondition.d.ts:102 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTHolderCondition.d.ts:10 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTHolderCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTHolderCondition.d.ts:147 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTHolderCondition.d.ts:142 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTHolderCondition.d.ts:115 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTHolderCondition.d.ts:137 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTHolderCondition.d.ts:2 - -## Functions - -### getFulfilledById - -▸ **getFulfilledById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFTHolderCondition.md#fulfilledresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.NFTHolderCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTHolderCondition.md#singlequeryoptions) | -| `args` | [`FulfilledArgs`](subgraphs.NFTHolderCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFTHolderCondition.md#fulfilledresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTHolderCondition.d.ts:82 - ---- - -### getFulfilleds - -▸ **getFulfilleds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFTHolderCondition.md#fulfilledresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.NFTHolderCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTHolderCondition.md#multiqueryoptions)<[`FulfilledFilter`](subgraphs.NFTHolderCondition.md#fulfilledfilter), [`FulfilledResult`](subgraphs.NFTHolderCondition.md#fulfilledresult)\> | -| `args` | [`FulfilledArgs`](subgraphs.NFTHolderCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFTHolderCondition.md#fulfilledresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTHolderCondition.d.ts:83 - ---- - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTHolderCondition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTHolderCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTHolderCondition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.NFTHolderCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTHolderCondition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTHolderCondition.d.ts:113 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTHolderCondition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTHolderCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTHolderCondition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.NFTHolderCondition.md#initializedfilter), [`InitializedResult`](subgraphs.NFTHolderCondition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.NFTHolderCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTHolderCondition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTHolderCondition.d.ts:114 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTHolderCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTHolderCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTHolderCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFTHolderCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTHolderCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTHolderCondition.d.ts:150 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTHolderCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTHolderCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTHolderCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.NFTHolderCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.NFTHolderCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFTHolderCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTHolderCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTHolderCondition.d.ts:151 diff --git a/docs/api-reference/modules/subgraphs.NFTLockCondition.md b/docs/api-reference/modules/subgraphs.NFTLockCondition.md deleted file mode 100644 index 4d89bd640..000000000 --- a/docs/api-reference/modules/subgraphs.NFTLockCondition.md +++ /dev/null @@ -1,542 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / NFTLockCondition - -# Namespace: NFTLockCondition - -[subgraphs](subgraphs.md).NFTLockCondition - -## Table of contents - -### Type Aliases - -- [FulfilledArgs](subgraphs.NFTLockCondition.md#fulfilledargs) -- [FulfilledFields](subgraphs.NFTLockCondition.md#fulfilledfields) -- [FulfilledFilter](subgraphs.NFTLockCondition.md#fulfilledfilter) -- [FulfilledResult](subgraphs.NFTLockCondition.md#fulfilledresult) -- [InitializedArgs](subgraphs.NFTLockCondition.md#initializedargs) -- [InitializedFields](subgraphs.NFTLockCondition.md#initializedfields) -- [InitializedFilter](subgraphs.NFTLockCondition.md#initializedfilter) -- [InitializedResult](subgraphs.NFTLockCondition.md#initializedresult) -- [MultiQueryOptions](subgraphs.NFTLockCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.NFTLockCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.NFTLockCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.NFTLockCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.NFTLockCondition.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.NFTLockCondition.md#singlequeryoptions) - -### Functions - -- [getFulfilledById](subgraphs.NFTLockCondition.md#getfulfilledbyid) -- [getFulfilleds](subgraphs.NFTLockCondition.md#getfulfilleds) -- [getInitializedById](subgraphs.NFTLockCondition.md#getinitializedbyid) -- [getInitializeds](subgraphs.NFTLockCondition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.NFTLockCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.NFTLockCondition.md#getownershiptransferreds) - -## Type Aliases - -### FulfilledArgs - -Ƭ **FulfilledArgs**<`K`\>: { [Property in keyof Pick]: FulfilledFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.NFTLockCondition.md#fulfilledresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTLockCondition.d.ts:95 - ---- - -### FulfilledFields - -Ƭ **FulfilledFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------- | :----- | -| `_agreementId` | `true` | -| `_amount` | `true` | -| `_conditionId` | `true` | -| `_did` | `true` | -| `_lockAddress` | `true` | -| `_nftContractAddress` | `true` | -| `_receiver` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTLockCondition.d.ts:85 - ---- - -### FulfilledFilter - -Ƭ **FulfilledFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------------- | :-------------------- | -| `_agreementId?` | `string` \| `null` | -| `_agreementId_contains?` | `string` \| `null` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| `null` | -| `_agreementId_not_contains?` | `string` \| `null` | -| `_agreementId_not_in?` | `string`[] | -| `_amount?` | `WeiSource` \| `null` | -| `_amount_gt?` | `WeiSource` \| `null` | -| `_amount_gte?` | `WeiSource` \| `null` | -| `_amount_in?` | `WeiSource`[] | -| `_amount_lt?` | `WeiSource` \| `null` | -| `_amount_lte?` | `WeiSource` \| `null` | -| `_amount_not?` | `WeiSource` \| `null` | -| `_amount_not_in?` | `WeiSource`[] | -| `_conditionId?` | `string` \| `null` | -| `_conditionId_contains?` | `string` \| `null` | -| `_conditionId_in?` | `string`[] | -| `_conditionId_not?` | `string` \| `null` | -| `_conditionId_not_contains?` | `string` \| `null` | -| `_conditionId_not_in?` | `string`[] | -| `_did?` | `string` \| `null` | -| `_did_contains?` | `string` \| `null` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| `null` | -| `_did_not_contains?` | `string` \| `null` | -| `_did_not_in?` | `string`[] | -| `_lockAddress?` | `string` \| `null` | -| `_lockAddress_contains?` | `string` \| `null` | -| `_lockAddress_in?` | `string`[] | -| `_lockAddress_not?` | `string` \| `null` | -| `_lockAddress_not_contains?` | `string` \| `null` | -| `_lockAddress_not_in?` | `string`[] | -| `_nftContractAddress?` | `string` \| `null` | -| `_nftContractAddress_contains?` | `string` \| `null` | -| `_nftContractAddress_in?` | `string`[] | -| `_nftContractAddress_not?` | `string` \| `null` | -| `_nftContractAddress_not_contains?` | `string` \| `null` | -| `_nftContractAddress_not_in?` | `string`[] | -| `_receiver?` | `string` \| `null` | -| `_receiver_contains?` | `string` \| `null` | -| `_receiver_in?` | `string`[] | -| `_receiver_not?` | `string` \| `null` | -| `_receiver_not_contains?` | `string` \| `null` | -| `_receiver_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTLockCondition.d.ts:21 - ---- - -### FulfilledResult - -Ƭ **FulfilledResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------- | :------- | -| `_agreementId` | `string` | -| `_amount` | `Wei` | -| `_conditionId` | `string` | -| `_did` | `string` | -| `_lockAddress` | `string` | -| `_nftContractAddress` | `string` | -| `_receiver` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTLockCondition.d.ts:75 - ---- - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTLockCondition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTLockCondition.d.ts:126 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTLockCondition.d.ts:122 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTLockCondition.d.ts:100 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTLockCondition.d.ts:118 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTLockCondition.d.ts:10 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTLockCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTLockCondition.d.ts:163 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTLockCondition.d.ts:158 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTLockCondition.d.ts:131 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTLockCondition.d.ts:153 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTLockCondition.d.ts:2 - -## Functions - -### getFulfilledById - -▸ **getFulfilledById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFTLockCondition.md#fulfilledresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.NFTLockCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTLockCondition.md#singlequeryoptions) | -| `args` | [`FulfilledArgs`](subgraphs.NFTLockCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFTLockCondition.md#fulfilledresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTLockCondition.d.ts:98 - ---- - -### getFulfilleds - -▸ **getFulfilleds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFTLockCondition.md#fulfilledresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.NFTLockCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTLockCondition.md#multiqueryoptions)<[`FulfilledFilter`](subgraphs.NFTLockCondition.md#fulfilledfilter), [`FulfilledResult`](subgraphs.NFTLockCondition.md#fulfilledresult)\> | -| `args` | [`FulfilledArgs`](subgraphs.NFTLockCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.NFTLockCondition.md#fulfilledresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTLockCondition.d.ts:99 - ---- - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTLockCondition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTLockCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTLockCondition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.NFTLockCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTLockCondition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTLockCondition.d.ts:129 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTLockCondition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTLockCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTLockCondition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.NFTLockCondition.md#initializedfilter), [`InitializedResult`](subgraphs.NFTLockCondition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.NFTLockCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTLockCondition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTLockCondition.d.ts:130 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTLockCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTLockCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTLockCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFTLockCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTLockCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTLockCondition.d.ts:166 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTLockCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTLockCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTLockCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.NFTLockCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.NFTLockCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFTLockCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTLockCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTLockCondition.d.ts:167 diff --git a/docs/api-reference/modules/subgraphs.NFTSalesTemplate.md b/docs/api-reference/modules/subgraphs.NFTSalesTemplate.md deleted file mode 100644 index 25985f5c6..000000000 --- a/docs/api-reference/modules/subgraphs.NFTSalesTemplate.md +++ /dev/null @@ -1,564 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / NFTSalesTemplate - -# Namespace: NFTSalesTemplate - -[subgraphs](subgraphs.md).NFTSalesTemplate - -## Table of contents - -### Type Aliases - -- [AgreementCreatedArgs](subgraphs.NFTSalesTemplate.md#agreementcreatedargs) -- [AgreementCreatedFields](subgraphs.NFTSalesTemplate.md#agreementcreatedfields) -- [AgreementCreatedFilter](subgraphs.NFTSalesTemplate.md#agreementcreatedfilter) -- [AgreementCreatedResult](subgraphs.NFTSalesTemplate.md#agreementcreatedresult) -- [InitializedArgs](subgraphs.NFTSalesTemplate.md#initializedargs) -- [InitializedFields](subgraphs.NFTSalesTemplate.md#initializedfields) -- [InitializedFilter](subgraphs.NFTSalesTemplate.md#initializedfilter) -- [InitializedResult](subgraphs.NFTSalesTemplate.md#initializedresult) -- [MultiQueryOptions](subgraphs.NFTSalesTemplate.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.NFTSalesTemplate.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.NFTSalesTemplate.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.NFTSalesTemplate.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.NFTSalesTemplate.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.NFTSalesTemplate.md#singlequeryoptions) - -### Functions - -- [getAgreementCreatedById](subgraphs.NFTSalesTemplate.md#getagreementcreatedbyid) -- [getAgreementCreateds](subgraphs.NFTSalesTemplate.md#getagreementcreateds) -- [getInitializedById](subgraphs.NFTSalesTemplate.md#getinitializedbyid) -- [getInitializeds](subgraphs.NFTSalesTemplate.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.NFTSalesTemplate.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.NFTSalesTemplate.md#getownershiptransferreds) - -## Type Aliases - -### AgreementCreatedArgs - -Ƭ **AgreementCreatedArgs**<`K`\>: { [Property in keyof Pick]: AgreementCreatedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFTSalesTemplate.md#agreementcreatedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesTemplate.d.ts:117 - ---- - -### AgreementCreatedFields - -Ƭ **AgreementCreatedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :----- | -| `_accessConsumer` | `true` | -| `_accessProvider` | `true` | -| `_agreementId` | `true` | -| `_conditionIdSeeds` | `true` | -| `_conditionIds` | `true` | -| `_creator` | `true` | -| `_did` | `true` | -| `_idSeed` | `true` | -| `_timeLocks` | `true` | -| `_timeOuts` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesTemplate.d.ts:104 - ---- - -### AgreementCreatedFilter - -Ƭ **AgreementCreatedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------------------------------- | :----------------- | -| `_accessConsumer?` | `string` \| `null` | -| `_accessConsumer_contains?` | `string` \| `null` | -| `_accessConsumer_in?` | `string`[] | -| `_accessConsumer_not?` | `string` \| `null` | -| `_accessConsumer_not_contains?` | `string` \| `null` | -| `_accessConsumer_not_in?` | `string`[] | -| `_accessProvider?` | `string` \| `null` | -| `_accessProvider_contains?` | `string` \| `null` | -| `_accessProvider_in?` | `string`[] | -| `_accessProvider_not?` | `string` \| `null` | -| `_accessProvider_not_contains?` | `string` \| `null` | -| `_accessProvider_not_in?` | `string`[] | -| `_agreementId?` | `string` \| `null` | -| `_agreementId_contains?` | `string` \| `null` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| `null` | -| `_agreementId_not_contains?` | `string` \| `null` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionIdSeeds?` | `string`[] | -| `_conditionIdSeeds_contains?` | `string`[] | -| `_conditionIdSeeds_contains_nocase?` | `string`[] | -| `_conditionIdSeeds_not?` | `string`[] | -| `_conditionIdSeeds_not_contains?` | `string`[] | -| `_conditionIdSeeds_not_contains_nocase?` | `string`[] | -| `_conditionIds?` | `string`[] | -| `_conditionIds_contains?` | `string`[] | -| `_conditionIds_contains_nocase?` | `string`[] | -| `_conditionIds_not?` | `string`[] | -| `_conditionIds_not_contains?` | `string`[] | -| `_conditionIds_not_contains_nocase?` | `string`[] | -| `_creator?` | `string` \| `null` | -| `_creator_contains?` | `string` \| `null` | -| `_creator_in?` | `string`[] | -| `_creator_not?` | `string` \| `null` | -| `_creator_not_contains?` | `string` \| `null` | -| `_creator_not_in?` | `string`[] | -| `_did?` | `string` \| `null` | -| `_did_contains?` | `string` \| `null` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| `null` | -| `_did_not_contains?` | `string` \| `null` | -| `_did_not_in?` | `string`[] | -| `_idSeed?` | `string` \| `null` | -| `_idSeed_contains?` | `string` \| `null` | -| `_idSeed_in?` | `string`[] | -| `_idSeed_not?` | `string` \| `null` | -| `_idSeed_not_contains?` | `string` \| `null` | -| `_idSeed_not_in?` | `string`[] | -| `_timeLocks?` | `WeiSource`[] | -| `_timeLocks_contains?` | `WeiSource`[] | -| `_timeLocks_contains_nocase?` | `WeiSource`[] | -| `_timeLocks_not?` | `WeiSource`[] | -| `_timeLocks_not_contains?` | `WeiSource`[] | -| `_timeLocks_not_contains_nocase?` | `WeiSource`[] | -| `_timeOuts?` | `WeiSource`[] | -| `_timeOuts_contains?` | `WeiSource`[] | -| `_timeOuts_contains_nocase?` | `WeiSource`[] | -| `_timeOuts_not?` | `WeiSource`[] | -| `_timeOuts_not_contains?` | `WeiSource`[] | -| `_timeOuts_not_contains_nocase?` | `WeiSource`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesTemplate.d.ts:21 - ---- - -### AgreementCreatedResult - -Ƭ **AgreementCreatedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :--------------------- | -| `_accessConsumer` | `string` | -| `_accessProvider` | `string` | -| `_agreementId` | `string` | -| `_conditionIdSeeds` | (`string` \| `null`)[] | -| `_conditionIds` | (`string` \| `null`)[] | -| `_creator` | `string` | -| `_did` | `string` | -| `_idSeed` | `string` | -| `_timeLocks` | (`Wei` \| `null`)[] | -| `_timeOuts` | (`Wei` \| `null`)[] | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesTemplate.d.ts:91 - ---- - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTSalesTemplate.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesTemplate.d.ts:148 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesTemplate.d.ts:144 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesTemplate.d.ts:122 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesTemplate.d.ts:140 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesTemplate.d.ts:10 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTSalesTemplate.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesTemplate.d.ts:185 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesTemplate.d.ts:180 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesTemplate.d.ts:153 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesTemplate.d.ts:175 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesTemplate.d.ts:2 - -## Functions - -### getAgreementCreatedById - -▸ **getAgreementCreatedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFTSalesTemplate.md#agreementcreatedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFTSalesTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTSalesTemplate.md#singlequeryoptions) | -| `args` | [`AgreementCreatedArgs`](subgraphs.NFTSalesTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFTSalesTemplate.md#agreementcreatedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesTemplate.d.ts:120 - ---- - -### getAgreementCreateds - -▸ **getAgreementCreateds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFTSalesTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFTSalesTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTSalesTemplate.md#multiqueryoptions)<[`AgreementCreatedFilter`](subgraphs.NFTSalesTemplate.md#agreementcreatedfilter), [`AgreementCreatedResult`](subgraphs.NFTSalesTemplate.md#agreementcreatedresult)\> | -| `args` | [`AgreementCreatedArgs`](subgraphs.NFTSalesTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFTSalesTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesTemplate.d.ts:121 - ---- - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTSalesTemplate.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTSalesTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTSalesTemplate.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.NFTSalesTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTSalesTemplate.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesTemplate.d.ts:151 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTSalesTemplate.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTSalesTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTSalesTemplate.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.NFTSalesTemplate.md#initializedfilter), [`InitializedResult`](subgraphs.NFTSalesTemplate.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.NFTSalesTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTSalesTemplate.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesTemplate.d.ts:152 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTSalesTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTSalesTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTSalesTemplate.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFTSalesTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTSalesTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesTemplate.d.ts:188 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTSalesTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTSalesTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTSalesTemplate.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.NFTSalesTemplate.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.NFTSalesTemplate.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFTSalesTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTSalesTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesTemplate.d.ts:189 diff --git a/docs/api-reference/modules/subgraphs.NFTSalesWithAccessTemplate.md b/docs/api-reference/modules/subgraphs.NFTSalesWithAccessTemplate.md deleted file mode 100644 index 5c72e69f8..000000000 --- a/docs/api-reference/modules/subgraphs.NFTSalesWithAccessTemplate.md +++ /dev/null @@ -1,564 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / NFTSalesWithAccessTemplate - -# Namespace: NFTSalesWithAccessTemplate - -[subgraphs](subgraphs.md).NFTSalesWithAccessTemplate - -## Table of contents - -### Type Aliases - -- [AgreementCreatedArgs](subgraphs.NFTSalesWithAccessTemplate.md#agreementcreatedargs) -- [AgreementCreatedFields](subgraphs.NFTSalesWithAccessTemplate.md#agreementcreatedfields) -- [AgreementCreatedFilter](subgraphs.NFTSalesWithAccessTemplate.md#agreementcreatedfilter) -- [AgreementCreatedResult](subgraphs.NFTSalesWithAccessTemplate.md#agreementcreatedresult) -- [InitializedArgs](subgraphs.NFTSalesWithAccessTemplate.md#initializedargs) -- [InitializedFields](subgraphs.NFTSalesWithAccessTemplate.md#initializedfields) -- [InitializedFilter](subgraphs.NFTSalesWithAccessTemplate.md#initializedfilter) -- [InitializedResult](subgraphs.NFTSalesWithAccessTemplate.md#initializedresult) -- [MultiQueryOptions](subgraphs.NFTSalesWithAccessTemplate.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.NFTSalesWithAccessTemplate.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.NFTSalesWithAccessTemplate.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.NFTSalesWithAccessTemplate.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.NFTSalesWithAccessTemplate.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.NFTSalesWithAccessTemplate.md#singlequeryoptions) - -### Functions - -- [getAgreementCreatedById](subgraphs.NFTSalesWithAccessTemplate.md#getagreementcreatedbyid) -- [getAgreementCreateds](subgraphs.NFTSalesWithAccessTemplate.md#getagreementcreateds) -- [getInitializedById](subgraphs.NFTSalesWithAccessTemplate.md#getinitializedbyid) -- [getInitializeds](subgraphs.NFTSalesWithAccessTemplate.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.NFTSalesWithAccessTemplate.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.NFTSalesWithAccessTemplate.md#getownershiptransferreds) - -## Type Aliases - -### AgreementCreatedArgs - -Ƭ **AgreementCreatedArgs**<`K`\>: { [Property in keyof Pick]: AgreementCreatedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFTSalesWithAccessTemplate.md#agreementcreatedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesWithAccessTemplate.d.ts:117 - ---- - -### AgreementCreatedFields - -Ƭ **AgreementCreatedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :----- | -| `_accessConsumer` | `true` | -| `_accessProvider` | `true` | -| `_agreementId` | `true` | -| `_conditionIdSeeds` | `true` | -| `_conditionIds` | `true` | -| `_creator` | `true` | -| `_did` | `true` | -| `_idSeed` | `true` | -| `_timeLocks` | `true` | -| `_timeOuts` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesWithAccessTemplate.d.ts:104 - ---- - -### AgreementCreatedFilter - -Ƭ **AgreementCreatedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------------------------------- | :----------------- | -| `_accessConsumer?` | `string` \| `null` | -| `_accessConsumer_contains?` | `string` \| `null` | -| `_accessConsumer_in?` | `string`[] | -| `_accessConsumer_not?` | `string` \| `null` | -| `_accessConsumer_not_contains?` | `string` \| `null` | -| `_accessConsumer_not_in?` | `string`[] | -| `_accessProvider?` | `string` \| `null` | -| `_accessProvider_contains?` | `string` \| `null` | -| `_accessProvider_in?` | `string`[] | -| `_accessProvider_not?` | `string` \| `null` | -| `_accessProvider_not_contains?` | `string` \| `null` | -| `_accessProvider_not_in?` | `string`[] | -| `_agreementId?` | `string` \| `null` | -| `_agreementId_contains?` | `string` \| `null` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| `null` | -| `_agreementId_not_contains?` | `string` \| `null` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionIdSeeds?` | `string`[] | -| `_conditionIdSeeds_contains?` | `string`[] | -| `_conditionIdSeeds_contains_nocase?` | `string`[] | -| `_conditionIdSeeds_not?` | `string`[] | -| `_conditionIdSeeds_not_contains?` | `string`[] | -| `_conditionIdSeeds_not_contains_nocase?` | `string`[] | -| `_conditionIds?` | `string`[] | -| `_conditionIds_contains?` | `string`[] | -| `_conditionIds_contains_nocase?` | `string`[] | -| `_conditionIds_not?` | `string`[] | -| `_conditionIds_not_contains?` | `string`[] | -| `_conditionIds_not_contains_nocase?` | `string`[] | -| `_creator?` | `string` \| `null` | -| `_creator_contains?` | `string` \| `null` | -| `_creator_in?` | `string`[] | -| `_creator_not?` | `string` \| `null` | -| `_creator_not_contains?` | `string` \| `null` | -| `_creator_not_in?` | `string`[] | -| `_did?` | `string` \| `null` | -| `_did_contains?` | `string` \| `null` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| `null` | -| `_did_not_contains?` | `string` \| `null` | -| `_did_not_in?` | `string`[] | -| `_idSeed?` | `string` \| `null` | -| `_idSeed_contains?` | `string` \| `null` | -| `_idSeed_in?` | `string`[] | -| `_idSeed_not?` | `string` \| `null` | -| `_idSeed_not_contains?` | `string` \| `null` | -| `_idSeed_not_in?` | `string`[] | -| `_timeLocks?` | `WeiSource`[] | -| `_timeLocks_contains?` | `WeiSource`[] | -| `_timeLocks_contains_nocase?` | `WeiSource`[] | -| `_timeLocks_not?` | `WeiSource`[] | -| `_timeLocks_not_contains?` | `WeiSource`[] | -| `_timeLocks_not_contains_nocase?` | `WeiSource`[] | -| `_timeOuts?` | `WeiSource`[] | -| `_timeOuts_contains?` | `WeiSource`[] | -| `_timeOuts_contains_nocase?` | `WeiSource`[] | -| `_timeOuts_not?` | `WeiSource`[] | -| `_timeOuts_not_contains?` | `WeiSource`[] | -| `_timeOuts_not_contains_nocase?` | `WeiSource`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesWithAccessTemplate.d.ts:21 - ---- - -### AgreementCreatedResult - -Ƭ **AgreementCreatedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :--------------------- | -| `_accessConsumer` | `string` | -| `_accessProvider` | `string` | -| `_agreementId` | `string` | -| `_conditionIdSeeds` | (`string` \| `null`)[] | -| `_conditionIds` | (`string` \| `null`)[] | -| `_creator` | `string` | -| `_did` | `string` | -| `_idSeed` | `string` | -| `_timeLocks` | (`Wei` \| `null`)[] | -| `_timeOuts` | (`Wei` \| `null`)[] | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesWithAccessTemplate.d.ts:91 - ---- - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTSalesWithAccessTemplate.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesWithAccessTemplate.d.ts:148 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesWithAccessTemplate.d.ts:144 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesWithAccessTemplate.d.ts:122 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesWithAccessTemplate.d.ts:140 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesWithAccessTemplate.d.ts:10 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTSalesWithAccessTemplate.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesWithAccessTemplate.d.ts:185 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesWithAccessTemplate.d.ts:180 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesWithAccessTemplate.d.ts:153 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesWithAccessTemplate.d.ts:175 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesWithAccessTemplate.d.ts:2 - -## Functions - -### getAgreementCreatedById - -▸ **getAgreementCreatedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFTSalesWithAccessTemplate.md#agreementcreatedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFTSalesWithAccessTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTSalesWithAccessTemplate.md#singlequeryoptions) | -| `args` | [`AgreementCreatedArgs`](subgraphs.NFTSalesWithAccessTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFTSalesWithAccessTemplate.md#agreementcreatedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesWithAccessTemplate.d.ts:120 - ---- - -### getAgreementCreateds - -▸ **getAgreementCreateds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFTSalesWithAccessTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`AgreementCreatedResult`](subgraphs.NFTSalesWithAccessTemplate.md#agreementcreatedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTSalesWithAccessTemplate.md#multiqueryoptions)<[`AgreementCreatedFilter`](subgraphs.NFTSalesWithAccessTemplate.md#agreementcreatedfilter), [`AgreementCreatedResult`](subgraphs.NFTSalesWithAccessTemplate.md#agreementcreatedresult)\> | -| `args` | [`AgreementCreatedArgs`](subgraphs.NFTSalesWithAccessTemplate.md#agreementcreatedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`AgreementCreatedResult`](subgraphs.NFTSalesWithAccessTemplate.md#agreementcreatedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesWithAccessTemplate.d.ts:121 - ---- - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTSalesWithAccessTemplate.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTSalesWithAccessTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTSalesWithAccessTemplate.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.NFTSalesWithAccessTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTSalesWithAccessTemplate.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesWithAccessTemplate.d.ts:151 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTSalesWithAccessTemplate.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NFTSalesWithAccessTemplate.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTSalesWithAccessTemplate.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.NFTSalesWithAccessTemplate.md#initializedfilter), [`InitializedResult`](subgraphs.NFTSalesWithAccessTemplate.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.NFTSalesWithAccessTemplate.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NFTSalesWithAccessTemplate.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesWithAccessTemplate.d.ts:152 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTSalesWithAccessTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTSalesWithAccessTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NFTSalesWithAccessTemplate.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFTSalesWithAccessTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTSalesWithAccessTemplate.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesWithAccessTemplate.d.ts:188 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTSalesWithAccessTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NFTSalesWithAccessTemplate.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NFTSalesWithAccessTemplate.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.NFTSalesWithAccessTemplate.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.NFTSalesWithAccessTemplate.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NFTSalesWithAccessTemplate.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NFTSalesWithAccessTemplate.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NFTSalesWithAccessTemplate.d.ts:189 diff --git a/docs/api-reference/modules/subgraphs.NeverminedConfig.md b/docs/api-reference/modules/subgraphs.NeverminedConfig.md deleted file mode 100644 index ca88b0ead..000000000 --- a/docs/api-reference/modules/subgraphs.NeverminedConfig.md +++ /dev/null @@ -1,971 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / NeverminedConfig - -# Namespace: NeverminedConfig - -[subgraphs](subgraphs.md).NeverminedConfig - -## Table of contents - -### Type Aliases - -- [InitializedArgs](subgraphs.NeverminedConfig.md#initializedargs) -- [InitializedFields](subgraphs.NeverminedConfig.md#initializedfields) -- [InitializedFilter](subgraphs.NeverminedConfig.md#initializedfilter) -- [InitializedResult](subgraphs.NeverminedConfig.md#initializedresult) -- [MultiQueryOptions](subgraphs.NeverminedConfig.md#multiqueryoptions) -- [NeverminedConfigChangeArgs](subgraphs.NeverminedConfig.md#neverminedconfigchangeargs) -- [NeverminedConfigChangeFields](subgraphs.NeverminedConfig.md#neverminedconfigchangefields) -- [NeverminedConfigChangeFilter](subgraphs.NeverminedConfig.md#neverminedconfigchangefilter) -- [NeverminedConfigChangeResult](subgraphs.NeverminedConfig.md#neverminedconfigchangeresult) -- [OwnershipTransferredArgs](subgraphs.NeverminedConfig.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.NeverminedConfig.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.NeverminedConfig.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.NeverminedConfig.md#ownershiptransferredresult) -- [RoleAdminChangedArgs](subgraphs.NeverminedConfig.md#roleadminchangedargs) -- [RoleAdminChangedFields](subgraphs.NeverminedConfig.md#roleadminchangedfields) -- [RoleAdminChangedFilter](subgraphs.NeverminedConfig.md#roleadminchangedfilter) -- [RoleAdminChangedResult](subgraphs.NeverminedConfig.md#roleadminchangedresult) -- [RoleGrantedArgs](subgraphs.NeverminedConfig.md#rolegrantedargs) -- [RoleGrantedFields](subgraphs.NeverminedConfig.md#rolegrantedfields) -- [RoleGrantedFilter](subgraphs.NeverminedConfig.md#rolegrantedfilter) -- [RoleGrantedResult](subgraphs.NeverminedConfig.md#rolegrantedresult) -- [RoleRevokedArgs](subgraphs.NeverminedConfig.md#rolerevokedargs) -- [RoleRevokedFields](subgraphs.NeverminedConfig.md#rolerevokedfields) -- [RoleRevokedFilter](subgraphs.NeverminedConfig.md#rolerevokedfilter) -- [RoleRevokedResult](subgraphs.NeverminedConfig.md#rolerevokedresult) -- [SingleQueryOptions](subgraphs.NeverminedConfig.md#singlequeryoptions) - -### Functions - -- [getInitializedById](subgraphs.NeverminedConfig.md#getinitializedbyid) -- [getInitializeds](subgraphs.NeverminedConfig.md#getinitializeds) -- [getNeverminedConfigChangeById](subgraphs.NeverminedConfig.md#getneverminedconfigchangebyid) -- [getNeverminedConfigChanges](subgraphs.NeverminedConfig.md#getneverminedconfigchanges) -- [getOwnershipTransferredById](subgraphs.NeverminedConfig.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.NeverminedConfig.md#getownershiptransferreds) -- [getRoleAdminChangedById](subgraphs.NeverminedConfig.md#getroleadminchangedbyid) -- [getRoleAdminChangeds](subgraphs.NeverminedConfig.md#getroleadminchangeds) -- [getRoleGrantedById](subgraphs.NeverminedConfig.md#getrolegrantedbyid) -- [getRoleGranteds](subgraphs.NeverminedConfig.md#getrolegranteds) -- [getRoleRevokedById](subgraphs.NeverminedConfig.md#getrolerevokedbyid) -- [getRoleRevokeds](subgraphs.NeverminedConfig.md#getrolerevokeds) - -## Type Aliases - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NeverminedConfig.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:46 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:42 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:20 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:38 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:9 - ---- - -### NeverminedConfigChangeArgs - -Ƭ **NeverminedConfigChangeArgs**<`K`\>: { [Property in keyof Pick]: NeverminedConfigChangeFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`NeverminedConfigChangeResult`](subgraphs.NeverminedConfig.md#neverminedconfigchangeresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:83 - ---- - -### NeverminedConfigChangeFields - -Ƭ **NeverminedConfigChangeFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------------ | :----- | -| `_parameter` | `true` | -| `_whoChanged` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:78 - ---- - -### NeverminedConfigChangeFilter - -Ƭ **NeverminedConfigChangeFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------------- | :----------------- | -| `_parameter?` | `string` \| `null` | -| `_parameter_contains?` | `string` \| `null` | -| `_parameter_in?` | `string`[] | -| `_parameter_not?` | `string` \| `null` | -| `_parameter_not_contains?` | `string` \| `null` | -| `_parameter_not_in?` | `string`[] | -| `_whoChanged?` | `string` \| `null` | -| `_whoChanged_contains?` | `string` \| `null` | -| `_whoChanged_in?` | `string`[] | -| `_whoChanged_not?` | `string` \| `null` | -| `_whoChanged_not_contains?` | `string` \| `null` | -| `_whoChanged_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:51 - ---- - -### NeverminedConfigChangeResult - -Ƭ **NeverminedConfigChangeResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------------ | :------- | -| `_parameter` | `string` | -| `_whoChanged` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:73 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NeverminedConfig.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:120 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:115 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:88 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:110 - ---- - -### RoleAdminChangedArgs - -Ƭ **RoleAdminChangedArgs**<`K`\>: { [Property in keyof Pick]: RoleAdminChangedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.NeverminedConfig.md#roleadminchangedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:165 - ---- - -### RoleAdminChangedFields - -Ƭ **RoleAdminChangedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :----- | -| `id` | `true` | -| `newAdminRole` | `true` | -| `previousAdminRole` | `true` | -| `role` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:159 - ---- - -### RoleAdminChangedFilter - -Ƭ **RoleAdminChangedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newAdminRole?` | `string` \| `null` | -| `newAdminRole_contains?` | `string` \| `null` | -| `newAdminRole_in?` | `string`[] | -| `newAdminRole_not?` | `string` \| `null` | -| `newAdminRole_not_contains?` | `string` \| `null` | -| `newAdminRole_not_in?` | `string`[] | -| `previousAdminRole?` | `string` \| `null` | -| `previousAdminRole_contains?` | `string` \| `null` | -| `previousAdminRole_in?` | `string`[] | -| `previousAdminRole_not?` | `string` \| `null` | -| `previousAdminRole_not_contains?` | `string` \| `null` | -| `previousAdminRole_not_in?` | `string`[] | -| `role?` | `string` \| `null` | -| `role_contains?` | `string` \| `null` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| `null` | -| `role_not_contains?` | `string` \| `null` | -| `role_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:125 - ---- - -### RoleAdminChangedResult - -Ƭ **RoleAdminChangedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :------- | -| `id` | `string` | -| `newAdminRole` | `string` | -| `previousAdminRole` | `string` | -| `role` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:153 - ---- - -### RoleGrantedArgs - -Ƭ **RoleGrantedArgs**<`K`\>: { [Property in keyof Pick]: RoleGrantedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.NeverminedConfig.md#rolegrantedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:210 - ---- - -### RoleGrantedFields - -Ƭ **RoleGrantedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `account` | `true` | -| `id` | `true` | -| `role` | `true` | -| `sender` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:204 - ---- - -### RoleGrantedFilter - -Ƭ **RoleGrantedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------- | :----------------- | -| `account?` | `string` \| `null` | -| `account_contains?` | `string` \| `null` | -| `account_in?` | `string`[] | -| `account_not?` | `string` \| `null` | -| `account_not_contains?` | `string` \| `null` | -| `account_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `role?` | `string` \| `null` | -| `role_contains?` | `string` \| `null` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| `null` | -| `role_not_contains?` | `string` \| `null` | -| `role_not_in?` | `string`[] | -| `sender?` | `string` \| `null` | -| `sender_contains?` | `string` \| `null` | -| `sender_in?` | `string`[] | -| `sender_not?` | `string` \| `null` | -| `sender_not_contains?` | `string` \| `null` | -| `sender_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:170 - ---- - -### RoleGrantedResult - -Ƭ **RoleGrantedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `account` | `string` | -| `id` | `string` | -| `role` | `string` | -| `sender` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:198 - ---- - -### RoleRevokedArgs - -Ƭ **RoleRevokedArgs**<`K`\>: { [Property in keyof Pick]: RoleRevokedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.NeverminedConfig.md#rolerevokedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:255 - ---- - -### RoleRevokedFields - -Ƭ **RoleRevokedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `account` | `true` | -| `id` | `true` | -| `role` | `true` | -| `sender` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:249 - ---- - -### RoleRevokedFilter - -Ƭ **RoleRevokedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------- | :----------------- | -| `account?` | `string` \| `null` | -| `account_contains?` | `string` \| `null` | -| `account_in?` | `string`[] | -| `account_not?` | `string` \| `null` | -| `account_not_contains?` | `string` \| `null` | -| `account_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `role?` | `string` \| `null` | -| `role_contains?` | `string` \| `null` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| `null` | -| `role_not_contains?` | `string` \| `null` | -| `role_not_in?` | `string`[] | -| `sender?` | `string` \| `null` | -| `sender_contains?` | `string` \| `null` | -| `sender_in?` | `string`[] | -| `sender_not?` | `string` \| `null` | -| `sender_not_contains?` | `string` \| `null` | -| `sender_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:215 - ---- - -### RoleRevokedResult - -Ƭ **RoleRevokedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `account` | `string` | -| `id` | `string` | -| `role` | `string` | -| `sender` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:243 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:1 - -## Functions - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NeverminedConfig.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NeverminedConfig.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NeverminedConfig.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.NeverminedConfig.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NeverminedConfig.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:49 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NeverminedConfig.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NeverminedConfig.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NeverminedConfig.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.NeverminedConfig.md#initializedfilter), [`InitializedResult`](subgraphs.NeverminedConfig.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.NeverminedConfig.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NeverminedConfig.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:50 - ---- - -### getNeverminedConfigChangeById - -▸ **getNeverminedConfigChangeById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`NeverminedConfigChangeResult`](subgraphs.NeverminedConfig.md#neverminedconfigchangeresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`NeverminedConfigChangeResult`](subgraphs.NeverminedConfig.md#neverminedconfigchangeresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NeverminedConfig.md#singlequeryoptions) | -| `args` | [`NeverminedConfigChangeArgs`](subgraphs.NeverminedConfig.md#neverminedconfigchangeargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`NeverminedConfigChangeResult`](subgraphs.NeverminedConfig.md#neverminedconfigchangeresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:86 - ---- - -### getNeverminedConfigChanges - -▸ **getNeverminedConfigChanges**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`NeverminedConfigChangeResult`](subgraphs.NeverminedConfig.md#neverminedconfigchangeresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`NeverminedConfigChangeResult`](subgraphs.NeverminedConfig.md#neverminedconfigchangeresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NeverminedConfig.md#multiqueryoptions)<[`NeverminedConfigChangeFilter`](subgraphs.NeverminedConfig.md#neverminedconfigchangefilter), [`NeverminedConfigChangeResult`](subgraphs.NeverminedConfig.md#neverminedconfigchangeresult)\> | -| `args` | [`NeverminedConfigChangeArgs`](subgraphs.NeverminedConfig.md#neverminedconfigchangeargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`NeverminedConfigChangeResult`](subgraphs.NeverminedConfig.md#neverminedconfigchangeresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:87 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NeverminedConfig.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NeverminedConfig.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NeverminedConfig.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NeverminedConfig.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NeverminedConfig.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:123 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NeverminedConfig.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NeverminedConfig.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NeverminedConfig.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.NeverminedConfig.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.NeverminedConfig.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NeverminedConfig.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NeverminedConfig.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:124 - ---- - -### getRoleAdminChangedById - -▸ **getRoleAdminChangedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.NeverminedConfig.md#roleadminchangedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.NeverminedConfig.md#roleadminchangedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NeverminedConfig.md#singlequeryoptions) | -| `args` | [`RoleAdminChangedArgs`](subgraphs.NeverminedConfig.md#roleadminchangedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.NeverminedConfig.md#roleadminchangedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:168 - ---- - -### getRoleAdminChangeds - -▸ **getRoleAdminChangeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.NeverminedConfig.md#roleadminchangedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.NeverminedConfig.md#roleadminchangedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NeverminedConfig.md#multiqueryoptions)<[`RoleAdminChangedFilter`](subgraphs.NeverminedConfig.md#roleadminchangedfilter), [`RoleAdminChangedResult`](subgraphs.NeverminedConfig.md#roleadminchangedresult)\> | -| `args` | [`RoleAdminChangedArgs`](subgraphs.NeverminedConfig.md#roleadminchangedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.NeverminedConfig.md#roleadminchangedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:169 - ---- - -### getRoleGrantedById - -▸ **getRoleGrantedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.NeverminedConfig.md#rolegrantedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.NeverminedConfig.md#rolegrantedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NeverminedConfig.md#singlequeryoptions) | -| `args` | [`RoleGrantedArgs`](subgraphs.NeverminedConfig.md#rolegrantedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.NeverminedConfig.md#rolegrantedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:213 - ---- - -### getRoleGranteds - -▸ **getRoleGranteds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.NeverminedConfig.md#rolegrantedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.NeverminedConfig.md#rolegrantedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NeverminedConfig.md#multiqueryoptions)<[`RoleGrantedFilter`](subgraphs.NeverminedConfig.md#rolegrantedfilter), [`RoleGrantedResult`](subgraphs.NeverminedConfig.md#rolegrantedresult)\> | -| `args` | [`RoleGrantedArgs`](subgraphs.NeverminedConfig.md#rolegrantedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.NeverminedConfig.md#rolegrantedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:214 - ---- - -### getRoleRevokedById - -▸ **getRoleRevokedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.NeverminedConfig.md#rolerevokedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.NeverminedConfig.md#rolerevokedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NeverminedConfig.md#singlequeryoptions) | -| `args` | [`RoleRevokedArgs`](subgraphs.NeverminedConfig.md#rolerevokedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.NeverminedConfig.md#rolerevokedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:258 - ---- - -### getRoleRevokeds - -▸ **getRoleRevokeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.NeverminedConfig.md#rolerevokedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.NeverminedConfig.md#rolerevokedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NeverminedConfig.md#multiqueryoptions)<[`RoleRevokedFilter`](subgraphs.NeverminedConfig.md#rolerevokedfilter), [`RoleRevokedResult`](subgraphs.NeverminedConfig.md#rolerevokedresult)\> | -| `args` | [`RoleRevokedArgs`](subgraphs.NeverminedConfig.md#rolerevokedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.NeverminedConfig.md#rolerevokedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedConfig.d.ts:259 diff --git a/docs/api-reference/modules/subgraphs.NeverminedToken.md b/docs/api-reference/modules/subgraphs.NeverminedToken.md deleted file mode 100644 index 55e43dc9c..000000000 --- a/docs/api-reference/modules/subgraphs.NeverminedToken.md +++ /dev/null @@ -1,1140 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / NeverminedToken - -# Namespace: NeverminedToken - -[subgraphs](subgraphs.md).NeverminedToken - -## Table of contents - -### Type Aliases - -- [ApprovalArgs](subgraphs.NeverminedToken.md#approvalargs) -- [ApprovalFields](subgraphs.NeverminedToken.md#approvalfields) -- [ApprovalFilter](subgraphs.NeverminedToken.md#approvalfilter) -- [ApprovalResult](subgraphs.NeverminedToken.md#approvalresult) -- [InitializedArgs](subgraphs.NeverminedToken.md#initializedargs) -- [InitializedFields](subgraphs.NeverminedToken.md#initializedfields) -- [InitializedFilter](subgraphs.NeverminedToken.md#initializedfilter) -- [InitializedResult](subgraphs.NeverminedToken.md#initializedresult) -- [MultiQueryOptions](subgraphs.NeverminedToken.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.NeverminedToken.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.NeverminedToken.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.NeverminedToken.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.NeverminedToken.md#ownershiptransferredresult) -- [RoleAdminChangedArgs](subgraphs.NeverminedToken.md#roleadminchangedargs) -- [RoleAdminChangedFields](subgraphs.NeverminedToken.md#roleadminchangedfields) -- [RoleAdminChangedFilter](subgraphs.NeverminedToken.md#roleadminchangedfilter) -- [RoleAdminChangedResult](subgraphs.NeverminedToken.md#roleadminchangedresult) -- [RoleGrantedArgs](subgraphs.NeverminedToken.md#rolegrantedargs) -- [RoleGrantedFields](subgraphs.NeverminedToken.md#rolegrantedfields) -- [RoleGrantedFilter](subgraphs.NeverminedToken.md#rolegrantedfilter) -- [RoleGrantedResult](subgraphs.NeverminedToken.md#rolegrantedresult) -- [RoleRevokedArgs](subgraphs.NeverminedToken.md#rolerevokedargs) -- [RoleRevokedFields](subgraphs.NeverminedToken.md#rolerevokedfields) -- [RoleRevokedFilter](subgraphs.NeverminedToken.md#rolerevokedfilter) -- [RoleRevokedResult](subgraphs.NeverminedToken.md#rolerevokedresult) -- [SingleQueryOptions](subgraphs.NeverminedToken.md#singlequeryoptions) -- [TransferArgs](subgraphs.NeverminedToken.md#transferargs) -- [TransferFields](subgraphs.NeverminedToken.md#transferfields) -- [TransferFilter](subgraphs.NeverminedToken.md#transferfilter) -- [TransferResult](subgraphs.NeverminedToken.md#transferresult) - -### Functions - -- [getApprovalById](subgraphs.NeverminedToken.md#getapprovalbyid) -- [getApprovals](subgraphs.NeverminedToken.md#getapprovals) -- [getInitializedById](subgraphs.NeverminedToken.md#getinitializedbyid) -- [getInitializeds](subgraphs.NeverminedToken.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.NeverminedToken.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.NeverminedToken.md#getownershiptransferreds) -- [getRoleAdminChangedById](subgraphs.NeverminedToken.md#getroleadminchangedbyid) -- [getRoleAdminChangeds](subgraphs.NeverminedToken.md#getroleadminchangeds) -- [getRoleGrantedById](subgraphs.NeverminedToken.md#getrolegrantedbyid) -- [getRoleGranteds](subgraphs.NeverminedToken.md#getrolegranteds) -- [getRoleRevokedById](subgraphs.NeverminedToken.md#getrolerevokedbyid) -- [getRoleRevokeds](subgraphs.NeverminedToken.md#getrolerevokeds) -- [getTransferById](subgraphs.NeverminedToken.md#gettransferbyid) -- [getTransfers](subgraphs.NeverminedToken.md#gettransfers) - -## Type Aliases - -### ApprovalArgs - -Ƭ **ApprovalArgs**<`K`\>: { [Property in keyof Pick]: ApprovalFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------- | -| `K` | extends keyof [`ApprovalResult`](subgraphs.NeverminedToken.md#approvalresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:63 - ---- - -### ApprovalFields - -Ƭ **ApprovalFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `owner` | `true` | -| `spender` | `true` | -| `value` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:57 - ---- - -### ApprovalFilter - -Ƭ **ApprovalFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------- | :-------------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `owner?` | `string` \| `null` | -| `owner_contains?` | `string` \| `null` | -| `owner_in?` | `string`[] | -| `owner_not?` | `string` \| `null` | -| `owner_not_contains?` | `string` \| `null` | -| `owner_not_in?` | `string`[] | -| `spender?` | `string` \| `null` | -| `spender_contains?` | `string` \| `null` | -| `spender_in?` | `string`[] | -| `spender_not?` | `string` \| `null` | -| `spender_not_contains?` | `string` \| `null` | -| `spender_not_in?` | `string`[] | -| `value?` | `WeiSource` \| `null` | -| `value_gt?` | `WeiSource` \| `null` | -| `value_gte?` | `WeiSource` \| `null` | -| `value_in?` | `WeiSource`[] | -| `value_lt?` | `WeiSource` \| `null` | -| `value_lte?` | `WeiSource` \| `null` | -| `value_not?` | `WeiSource` \| `null` | -| `value_not_in?` | `WeiSource`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:21 - ---- - -### ApprovalResult - -Ƭ **ApprovalResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `owner` | `string` | -| `spender` | `string` | -| `value` | `Wei` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:51 - ---- - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NeverminedToken.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:94 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:90 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:68 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:86 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:10 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NeverminedToken.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:131 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:126 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:99 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:121 - ---- - -### RoleAdminChangedArgs - -Ƭ **RoleAdminChangedArgs**<`K`\>: { [Property in keyof Pick]: RoleAdminChangedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.NeverminedToken.md#roleadminchangedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:176 - ---- - -### RoleAdminChangedFields - -Ƭ **RoleAdminChangedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :----- | -| `id` | `true` | -| `newAdminRole` | `true` | -| `previousAdminRole` | `true` | -| `role` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:170 - ---- - -### RoleAdminChangedFilter - -Ƭ **RoleAdminChangedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newAdminRole?` | `string` \| `null` | -| `newAdminRole_contains?` | `string` \| `null` | -| `newAdminRole_in?` | `string`[] | -| `newAdminRole_not?` | `string` \| `null` | -| `newAdminRole_not_contains?` | `string` \| `null` | -| `newAdminRole_not_in?` | `string`[] | -| `previousAdminRole?` | `string` \| `null` | -| `previousAdminRole_contains?` | `string` \| `null` | -| `previousAdminRole_in?` | `string`[] | -| `previousAdminRole_not?` | `string` \| `null` | -| `previousAdminRole_not_contains?` | `string` \| `null` | -| `previousAdminRole_not_in?` | `string`[] | -| `role?` | `string` \| `null` | -| `role_contains?` | `string` \| `null` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| `null` | -| `role_not_contains?` | `string` \| `null` | -| `role_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:136 - ---- - -### RoleAdminChangedResult - -Ƭ **RoleAdminChangedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :------- | -| `id` | `string` | -| `newAdminRole` | `string` | -| `previousAdminRole` | `string` | -| `role` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:164 - ---- - -### RoleGrantedArgs - -Ƭ **RoleGrantedArgs**<`K`\>: { [Property in keyof Pick]: RoleGrantedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.NeverminedToken.md#rolegrantedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:221 - ---- - -### RoleGrantedFields - -Ƭ **RoleGrantedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `account` | `true` | -| `id` | `true` | -| `role` | `true` | -| `sender` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:215 - ---- - -### RoleGrantedFilter - -Ƭ **RoleGrantedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------- | :----------------- | -| `account?` | `string` \| `null` | -| `account_contains?` | `string` \| `null` | -| `account_in?` | `string`[] | -| `account_not?` | `string` \| `null` | -| `account_not_contains?` | `string` \| `null` | -| `account_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `role?` | `string` \| `null` | -| `role_contains?` | `string` \| `null` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| `null` | -| `role_not_contains?` | `string` \| `null` | -| `role_not_in?` | `string`[] | -| `sender?` | `string` \| `null` | -| `sender_contains?` | `string` \| `null` | -| `sender_in?` | `string`[] | -| `sender_not?` | `string` \| `null` | -| `sender_not_contains?` | `string` \| `null` | -| `sender_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:181 - ---- - -### RoleGrantedResult - -Ƭ **RoleGrantedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `account` | `string` | -| `id` | `string` | -| `role` | `string` | -| `sender` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:209 - ---- - -### RoleRevokedArgs - -Ƭ **RoleRevokedArgs**<`K`\>: { [Property in keyof Pick]: RoleRevokedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.NeverminedToken.md#rolerevokedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:266 - ---- - -### RoleRevokedFields - -Ƭ **RoleRevokedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `account` | `true` | -| `id` | `true` | -| `role` | `true` | -| `sender` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:260 - ---- - -### RoleRevokedFilter - -Ƭ **RoleRevokedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------- | :----------------- | -| `account?` | `string` \| `null` | -| `account_contains?` | `string` \| `null` | -| `account_in?` | `string`[] | -| `account_not?` | `string` \| `null` | -| `account_not_contains?` | `string` \| `null` | -| `account_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `role?` | `string` \| `null` | -| `role_contains?` | `string` \| `null` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| `null` | -| `role_not_contains?` | `string` \| `null` | -| `role_not_in?` | `string`[] | -| `sender?` | `string` \| `null` | -| `sender_contains?` | `string` \| `null` | -| `sender_in?` | `string`[] | -| `sender_not?` | `string` \| `null` | -| `sender_not_contains?` | `string` \| `null` | -| `sender_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:226 - ---- - -### RoleRevokedResult - -Ƭ **RoleRevokedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `account` | `string` | -| `id` | `string` | -| `role` | `string` | -| `sender` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:254 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:2 - ---- - -### TransferArgs - -Ƭ **TransferArgs**<`K`\>: { [Property in keyof Pick]: TransferFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------- | -| `K` | extends keyof [`TransferResult`](subgraphs.NeverminedToken.md#transferresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:313 - ---- - -### TransferFields - -Ƭ **TransferFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :----- | -| `from` | `true` | -| `id` | `true` | -| `to` | `true` | -| `value` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:307 - ---- - -### TransferFilter - -Ƭ **TransferFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------- | :-------------------- | -| `from?` | `string` \| `null` | -| `from_contains?` | `string` \| `null` | -| `from_in?` | `string`[] | -| `from_not?` | `string` \| `null` | -| `from_not_contains?` | `string` \| `null` | -| `from_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `to?` | `string` \| `null` | -| `to_contains?` | `string` \| `null` | -| `to_in?` | `string`[] | -| `to_not?` | `string` \| `null` | -| `to_not_contains?` | `string` \| `null` | -| `to_not_in?` | `string`[] | -| `value?` | `WeiSource` \| `null` | -| `value_gt?` | `WeiSource` \| `null` | -| `value_gte?` | `WeiSource` \| `null` | -| `value_in?` | `WeiSource`[] | -| `value_lt?` | `WeiSource` \| `null` | -| `value_lte?` | `WeiSource` \| `null` | -| `value_not?` | `WeiSource` \| `null` | -| `value_not_in?` | `WeiSource`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:271 - ---- - -### TransferResult - -Ƭ **TransferResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------- | -| `from` | `string` | -| `id` | `string` | -| `to` | `string` | -| `value` | `Wei` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:301 - -## Functions - -### getApprovalById - -▸ **getApprovalById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ApprovalResult`](subgraphs.NeverminedToken.md#approvalresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------- | -| `K` | extends keyof [`ApprovalResult`](subgraphs.NeverminedToken.md#approvalresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NeverminedToken.md#singlequeryoptions) | -| `args` | [`ApprovalArgs`](subgraphs.NeverminedToken.md#approvalargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ApprovalResult`](subgraphs.NeverminedToken.md#approvalresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:66 - ---- - -### getApprovals - -▸ **getApprovals**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`ApprovalResult`](subgraphs.NeverminedToken.md#approvalresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------- | -| `K` | extends keyof [`ApprovalResult`](subgraphs.NeverminedToken.md#approvalresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NeverminedToken.md#multiqueryoptions)<[`ApprovalFilter`](subgraphs.NeverminedToken.md#approvalfilter), [`ApprovalResult`](subgraphs.NeverminedToken.md#approvalresult)\> | -| `args` | [`ApprovalArgs`](subgraphs.NeverminedToken.md#approvalargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`ApprovalResult`](subgraphs.NeverminedToken.md#approvalresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:67 - ---- - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NeverminedToken.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NeverminedToken.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NeverminedToken.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.NeverminedToken.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NeverminedToken.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:97 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.NeverminedToken.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.NeverminedToken.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NeverminedToken.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.NeverminedToken.md#initializedfilter), [`InitializedResult`](subgraphs.NeverminedToken.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.NeverminedToken.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.NeverminedToken.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:98 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NeverminedToken.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NeverminedToken.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NeverminedToken.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NeverminedToken.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NeverminedToken.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:134 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NeverminedToken.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.NeverminedToken.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NeverminedToken.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.NeverminedToken.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.NeverminedToken.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.NeverminedToken.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.NeverminedToken.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:135 - ---- - -### getRoleAdminChangedById - -▸ **getRoleAdminChangedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.NeverminedToken.md#roleadminchangedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.NeverminedToken.md#roleadminchangedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NeverminedToken.md#singlequeryoptions) | -| `args` | [`RoleAdminChangedArgs`](subgraphs.NeverminedToken.md#roleadminchangedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.NeverminedToken.md#roleadminchangedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:179 - ---- - -### getRoleAdminChangeds - -▸ **getRoleAdminChangeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.NeverminedToken.md#roleadminchangedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.NeverminedToken.md#roleadminchangedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NeverminedToken.md#multiqueryoptions)<[`RoleAdminChangedFilter`](subgraphs.NeverminedToken.md#roleadminchangedfilter), [`RoleAdminChangedResult`](subgraphs.NeverminedToken.md#roleadminchangedresult)\> | -| `args` | [`RoleAdminChangedArgs`](subgraphs.NeverminedToken.md#roleadminchangedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.NeverminedToken.md#roleadminchangedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:180 - ---- - -### getRoleGrantedById - -▸ **getRoleGrantedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.NeverminedToken.md#rolegrantedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.NeverminedToken.md#rolegrantedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NeverminedToken.md#singlequeryoptions) | -| `args` | [`RoleGrantedArgs`](subgraphs.NeverminedToken.md#rolegrantedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.NeverminedToken.md#rolegrantedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:224 - ---- - -### getRoleGranteds - -▸ **getRoleGranteds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.NeverminedToken.md#rolegrantedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.NeverminedToken.md#rolegrantedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NeverminedToken.md#multiqueryoptions)<[`RoleGrantedFilter`](subgraphs.NeverminedToken.md#rolegrantedfilter), [`RoleGrantedResult`](subgraphs.NeverminedToken.md#rolegrantedresult)\> | -| `args` | [`RoleGrantedArgs`](subgraphs.NeverminedToken.md#rolegrantedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.NeverminedToken.md#rolegrantedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:225 - ---- - -### getRoleRevokedById - -▸ **getRoleRevokedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.NeverminedToken.md#rolerevokedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.NeverminedToken.md#rolerevokedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NeverminedToken.md#singlequeryoptions) | -| `args` | [`RoleRevokedArgs`](subgraphs.NeverminedToken.md#rolerevokedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.NeverminedToken.md#rolerevokedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:269 - ---- - -### getRoleRevokeds - -▸ **getRoleRevokeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.NeverminedToken.md#rolerevokedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.NeverminedToken.md#rolerevokedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NeverminedToken.md#multiqueryoptions)<[`RoleRevokedFilter`](subgraphs.NeverminedToken.md#rolerevokedfilter), [`RoleRevokedResult`](subgraphs.NeverminedToken.md#rolerevokedresult)\> | -| `args` | [`RoleRevokedArgs`](subgraphs.NeverminedToken.md#rolerevokedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.NeverminedToken.md#rolerevokedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:270 - ---- - -### getTransferById - -▸ **getTransferById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`TransferResult`](subgraphs.NeverminedToken.md#transferresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------- | -| `K` | extends keyof [`TransferResult`](subgraphs.NeverminedToken.md#transferresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.NeverminedToken.md#singlequeryoptions) | -| `args` | [`TransferArgs`](subgraphs.NeverminedToken.md#transferargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`TransferResult`](subgraphs.NeverminedToken.md#transferresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:316 - ---- - -### getTransfers - -▸ **getTransfers**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`TransferResult`](subgraphs.NeverminedToken.md#transferresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------- | -| `K` | extends keyof [`TransferResult`](subgraphs.NeverminedToken.md#transferresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.NeverminedToken.md#multiqueryoptions)<[`TransferFilter`](subgraphs.NeverminedToken.md#transferfilter), [`TransferResult`](subgraphs.NeverminedToken.md#transferresult)\> | -| `args` | [`TransferArgs`](subgraphs.NeverminedToken.md#transferargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`TransferResult`](subgraphs.NeverminedToken.md#transferresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/NeverminedToken.d.ts:317 diff --git a/docs/api-reference/modules/subgraphs.RewardsDistributor.md b/docs/api-reference/modules/subgraphs.RewardsDistributor.md deleted file mode 100644 index c55f5bf6c..000000000 --- a/docs/api-reference/modules/subgraphs.RewardsDistributor.md +++ /dev/null @@ -1,202 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / RewardsDistributor - -# Namespace: RewardsDistributor - -[subgraphs](subgraphs.md).RewardsDistributor - -## Table of contents - -### Type Aliases - -- [InitializedArgs](subgraphs.RewardsDistributor.md#initializedargs) -- [InitializedFields](subgraphs.RewardsDistributor.md#initializedfields) -- [InitializedFilter](subgraphs.RewardsDistributor.md#initializedfilter) -- [InitializedResult](subgraphs.RewardsDistributor.md#initializedresult) -- [MultiQueryOptions](subgraphs.RewardsDistributor.md#multiqueryoptions) -- [SingleQueryOptions](subgraphs.RewardsDistributor.md#singlequeryoptions) - -### Functions - -- [getInitializedById](subgraphs.RewardsDistributor.md#getinitializedbyid) -- [getInitializeds](subgraphs.RewardsDistributor.md#getinitializeds) - -## Type Aliases - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.RewardsDistributor.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/RewardsDistributor.d.ts:46 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/RewardsDistributor.d.ts:42 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/RewardsDistributor.d.ts:20 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/RewardsDistributor.d.ts:38 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/RewardsDistributor.d.ts:9 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/RewardsDistributor.d.ts:1 - -## Functions - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.RewardsDistributor.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.RewardsDistributor.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.RewardsDistributor.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.RewardsDistributor.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.RewardsDistributor.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/RewardsDistributor.d.ts:49 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.RewardsDistributor.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.RewardsDistributor.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.RewardsDistributor.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.RewardsDistributor.md#initializedfilter), [`InitializedResult`](subgraphs.RewardsDistributor.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.RewardsDistributor.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.RewardsDistributor.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/RewardsDistributor.d.ts:50 diff --git a/docs/api-reference/modules/subgraphs.SignCondition.md b/docs/api-reference/modules/subgraphs.SignCondition.md deleted file mode 100644 index a7185f88d..000000000 --- a/docs/api-reference/modules/subgraphs.SignCondition.md +++ /dev/null @@ -1,351 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / SignCondition - -# Namespace: SignCondition - -[subgraphs](subgraphs.md).SignCondition - -## Table of contents - -### Type Aliases - -- [InitializedArgs](subgraphs.SignCondition.md#initializedargs) -- [InitializedFields](subgraphs.SignCondition.md#initializedfields) -- [InitializedFilter](subgraphs.SignCondition.md#initializedfilter) -- [InitializedResult](subgraphs.SignCondition.md#initializedresult) -- [MultiQueryOptions](subgraphs.SignCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.SignCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.SignCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.SignCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.SignCondition.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.SignCondition.md#singlequeryoptions) - -### Functions - -- [getInitializedById](subgraphs.SignCondition.md#getinitializedbyid) -- [getInitializeds](subgraphs.SignCondition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.SignCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.SignCondition.md#getownershiptransferreds) - -## Type Aliases - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.SignCondition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/SignCondition.d.ts:46 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/SignCondition.d.ts:42 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/SignCondition.d.ts:20 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/SignCondition.d.ts:38 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/SignCondition.d.ts:9 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.SignCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/SignCondition.d.ts:83 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/SignCondition.d.ts:78 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/SignCondition.d.ts:51 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/SignCondition.d.ts:73 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/SignCondition.d.ts:1 - -## Functions - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.SignCondition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.SignCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.SignCondition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.SignCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.SignCondition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/SignCondition.d.ts:49 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.SignCondition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.SignCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.SignCondition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.SignCondition.md#initializedfilter), [`InitializedResult`](subgraphs.SignCondition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.SignCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.SignCondition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/SignCondition.d.ts:50 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.SignCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.SignCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.SignCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.SignCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.SignCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/SignCondition.d.ts:86 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.SignCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.SignCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.SignCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.SignCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.SignCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.SignCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.SignCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/SignCondition.d.ts:87 diff --git a/docs/api-reference/modules/subgraphs.StandardRoyalties.md b/docs/api-reference/modules/subgraphs.StandardRoyalties.md deleted file mode 100644 index abd370790..000000000 --- a/docs/api-reference/modules/subgraphs.StandardRoyalties.md +++ /dev/null @@ -1,202 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / StandardRoyalties - -# Namespace: StandardRoyalties - -[subgraphs](subgraphs.md).StandardRoyalties - -## Table of contents - -### Type Aliases - -- [InitializedArgs](subgraphs.StandardRoyalties.md#initializedargs) -- [InitializedFields](subgraphs.StandardRoyalties.md#initializedfields) -- [InitializedFilter](subgraphs.StandardRoyalties.md#initializedfilter) -- [InitializedResult](subgraphs.StandardRoyalties.md#initializedresult) -- [MultiQueryOptions](subgraphs.StandardRoyalties.md#multiqueryoptions) -- [SingleQueryOptions](subgraphs.StandardRoyalties.md#singlequeryoptions) - -### Functions - -- [getInitializedById](subgraphs.StandardRoyalties.md#getinitializedbyid) -- [getInitializeds](subgraphs.StandardRoyalties.md#getinitializeds) - -## Type Aliases - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.StandardRoyalties.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/StandardRoyalties.d.ts:46 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/StandardRoyalties.d.ts:42 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/StandardRoyalties.d.ts:20 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/StandardRoyalties.d.ts:38 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/StandardRoyalties.d.ts:9 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/StandardRoyalties.d.ts:1 - -## Functions - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.StandardRoyalties.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.StandardRoyalties.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.StandardRoyalties.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.StandardRoyalties.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.StandardRoyalties.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/StandardRoyalties.d.ts:49 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.StandardRoyalties.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.StandardRoyalties.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.StandardRoyalties.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.StandardRoyalties.md#initializedfilter), [`InitializedResult`](subgraphs.StandardRoyalties.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.StandardRoyalties.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.StandardRoyalties.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/StandardRoyalties.d.ts:50 diff --git a/docs/api-reference/modules/subgraphs.TemplateStoreManager.md b/docs/api-reference/modules/subgraphs.TemplateStoreManager.md deleted file mode 100644 index 3df6b5f54..000000000 --- a/docs/api-reference/modules/subgraphs.TemplateStoreManager.md +++ /dev/null @@ -1,351 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / TemplateStoreManager - -# Namespace: TemplateStoreManager - -[subgraphs](subgraphs.md).TemplateStoreManager - -## Table of contents - -### Type Aliases - -- [InitializedArgs](subgraphs.TemplateStoreManager.md#initializedargs) -- [InitializedFields](subgraphs.TemplateStoreManager.md#initializedfields) -- [InitializedFilter](subgraphs.TemplateStoreManager.md#initializedfilter) -- [InitializedResult](subgraphs.TemplateStoreManager.md#initializedresult) -- [MultiQueryOptions](subgraphs.TemplateStoreManager.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.TemplateStoreManager.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.TemplateStoreManager.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.TemplateStoreManager.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.TemplateStoreManager.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.TemplateStoreManager.md#singlequeryoptions) - -### Functions - -- [getInitializedById](subgraphs.TemplateStoreManager.md#getinitializedbyid) -- [getInitializeds](subgraphs.TemplateStoreManager.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.TemplateStoreManager.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.TemplateStoreManager.md#getownershiptransferreds) - -## Type Aliases - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.TemplateStoreManager.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TemplateStoreManager.d.ts:46 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TemplateStoreManager.d.ts:42 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TemplateStoreManager.d.ts:20 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TemplateStoreManager.d.ts:38 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TemplateStoreManager.d.ts:9 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.TemplateStoreManager.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TemplateStoreManager.d.ts:83 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TemplateStoreManager.d.ts:78 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TemplateStoreManager.d.ts:51 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TemplateStoreManager.d.ts:73 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TemplateStoreManager.d.ts:1 - -## Functions - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.TemplateStoreManager.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.TemplateStoreManager.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.TemplateStoreManager.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.TemplateStoreManager.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.TemplateStoreManager.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TemplateStoreManager.d.ts:49 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.TemplateStoreManager.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.TemplateStoreManager.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.TemplateStoreManager.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.TemplateStoreManager.md#initializedfilter), [`InitializedResult`](subgraphs.TemplateStoreManager.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.TemplateStoreManager.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.TemplateStoreManager.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TemplateStoreManager.d.ts:50 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.TemplateStoreManager.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.TemplateStoreManager.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.TemplateStoreManager.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.TemplateStoreManager.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.TemplateStoreManager.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TemplateStoreManager.d.ts:86 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.TemplateStoreManager.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.TemplateStoreManager.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.TemplateStoreManager.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.TemplateStoreManager.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.TemplateStoreManager.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.TemplateStoreManager.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.TemplateStoreManager.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TemplateStoreManager.d.ts:87 diff --git a/docs/api-reference/modules/subgraphs.ThresholdCondition.md b/docs/api-reference/modules/subgraphs.ThresholdCondition.md deleted file mode 100644 index 5dd52c38a..000000000 --- a/docs/api-reference/modules/subgraphs.ThresholdCondition.md +++ /dev/null @@ -1,351 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / ThresholdCondition - -# Namespace: ThresholdCondition - -[subgraphs](subgraphs.md).ThresholdCondition - -## Table of contents - -### Type Aliases - -- [InitializedArgs](subgraphs.ThresholdCondition.md#initializedargs) -- [InitializedFields](subgraphs.ThresholdCondition.md#initializedfields) -- [InitializedFilter](subgraphs.ThresholdCondition.md#initializedfilter) -- [InitializedResult](subgraphs.ThresholdCondition.md#initializedresult) -- [MultiQueryOptions](subgraphs.ThresholdCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.ThresholdCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.ThresholdCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.ThresholdCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.ThresholdCondition.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.ThresholdCondition.md#singlequeryoptions) - -### Functions - -- [getInitializedById](subgraphs.ThresholdCondition.md#getinitializedbyid) -- [getInitializeds](subgraphs.ThresholdCondition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.ThresholdCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.ThresholdCondition.md#getownershiptransferreds) - -## Type Aliases - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.ThresholdCondition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ThresholdCondition.d.ts:46 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ThresholdCondition.d.ts:42 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ThresholdCondition.d.ts:20 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ThresholdCondition.d.ts:38 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ThresholdCondition.d.ts:9 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.ThresholdCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ThresholdCondition.d.ts:83 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ThresholdCondition.d.ts:78 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ThresholdCondition.d.ts:51 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ThresholdCondition.d.ts:73 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ThresholdCondition.d.ts:1 - -## Functions - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.ThresholdCondition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.ThresholdCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.ThresholdCondition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.ThresholdCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.ThresholdCondition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ThresholdCondition.d.ts:49 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.ThresholdCondition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.ThresholdCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.ThresholdCondition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.ThresholdCondition.md#initializedfilter), [`InitializedResult`](subgraphs.ThresholdCondition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.ThresholdCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.ThresholdCondition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ThresholdCondition.d.ts:50 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.ThresholdCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.ThresholdCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.ThresholdCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.ThresholdCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.ThresholdCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ThresholdCondition.d.ts:86 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.ThresholdCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.ThresholdCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.ThresholdCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.ThresholdCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.ThresholdCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.ThresholdCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.ThresholdCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/ThresholdCondition.d.ts:87 diff --git a/docs/api-reference/modules/subgraphs.TransferDIDOwnershipCondition.md b/docs/api-reference/modules/subgraphs.TransferDIDOwnershipCondition.md deleted file mode 100644 index 9293dd7b5..000000000 --- a/docs/api-reference/modules/subgraphs.TransferDIDOwnershipCondition.md +++ /dev/null @@ -1,516 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / TransferDIDOwnershipCondition - -# Namespace: TransferDIDOwnershipCondition - -[subgraphs](subgraphs.md).TransferDIDOwnershipCondition - -## Table of contents - -### Type Aliases - -- [FulfilledArgs](subgraphs.TransferDIDOwnershipCondition.md#fulfilledargs) -- [FulfilledFields](subgraphs.TransferDIDOwnershipCondition.md#fulfilledfields) -- [FulfilledFilter](subgraphs.TransferDIDOwnershipCondition.md#fulfilledfilter) -- [FulfilledResult](subgraphs.TransferDIDOwnershipCondition.md#fulfilledresult) -- [InitializedArgs](subgraphs.TransferDIDOwnershipCondition.md#initializedargs) -- [InitializedFields](subgraphs.TransferDIDOwnershipCondition.md#initializedfields) -- [InitializedFilter](subgraphs.TransferDIDOwnershipCondition.md#initializedfilter) -- [InitializedResult](subgraphs.TransferDIDOwnershipCondition.md#initializedresult) -- [MultiQueryOptions](subgraphs.TransferDIDOwnershipCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.TransferDIDOwnershipCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.TransferDIDOwnershipCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.TransferDIDOwnershipCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.TransferDIDOwnershipCondition.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.TransferDIDOwnershipCondition.md#singlequeryoptions) - -### Functions - -- [getFulfilledById](subgraphs.TransferDIDOwnershipCondition.md#getfulfilledbyid) -- [getFulfilleds](subgraphs.TransferDIDOwnershipCondition.md#getfulfilleds) -- [getInitializedById](subgraphs.TransferDIDOwnershipCondition.md#getinitializedbyid) -- [getInitializeds](subgraphs.TransferDIDOwnershipCondition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.TransferDIDOwnershipCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.TransferDIDOwnershipCondition.md#getownershiptransferreds) - -## Type Aliases - -### FulfilledArgs - -Ƭ **FulfilledArgs**<`K`\>: { [Property in keyof Pick]: FulfilledFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.TransferDIDOwnershipCondition.md#fulfilledresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferDIDOwnershipCondition.d.ts:68 - ---- - -### FulfilledFields - -Ƭ **FulfilledFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------------- | :----- | -| `_agreementId` | `true` | -| `_conditionId` | `true` | -| `_did` | `true` | -| `_receiver` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferDIDOwnershipCondition.d.ts:61 - ---- - -### FulfilledFilter - -Ƭ **FulfilledFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------------------- | :----------------- | -| `_agreementId?` | `string` \| `null` | -| `_agreementId_contains?` | `string` \| `null` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| `null` | -| `_agreementId_not_contains?` | `string` \| `null` | -| `_agreementId_not_in?` | `string`[] | -| `_conditionId?` | `string` \| `null` | -| `_conditionId_contains?` | `string` \| `null` | -| `_conditionId_in?` | `string`[] | -| `_conditionId_not?` | `string` \| `null` | -| `_conditionId_not_contains?` | `string` \| `null` | -| `_conditionId_not_in?` | `string`[] | -| `_did?` | `string` \| `null` | -| `_did_contains?` | `string` \| `null` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| `null` | -| `_did_not_contains?` | `string` \| `null` | -| `_did_not_in?` | `string`[] | -| `_receiver?` | `string` \| `null` | -| `_receiver_contains?` | `string` \| `null` | -| `_receiver_in?` | `string`[] | -| `_receiver_not?` | `string` \| `null` | -| `_receiver_not_contains?` | `string` \| `null` | -| `_receiver_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferDIDOwnershipCondition.d.ts:20 - ---- - -### FulfilledResult - -Ƭ **FulfilledResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------------- | :------- | -| `_agreementId` | `string` | -| `_conditionId` | `string` | -| `_did` | `string` | -| `_receiver` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferDIDOwnershipCondition.d.ts:54 - ---- - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.TransferDIDOwnershipCondition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferDIDOwnershipCondition.d.ts:99 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferDIDOwnershipCondition.d.ts:95 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferDIDOwnershipCondition.d.ts:73 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferDIDOwnershipCondition.d.ts:91 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferDIDOwnershipCondition.d.ts:9 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.TransferDIDOwnershipCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferDIDOwnershipCondition.d.ts:136 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferDIDOwnershipCondition.d.ts:131 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferDIDOwnershipCondition.d.ts:104 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferDIDOwnershipCondition.d.ts:126 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferDIDOwnershipCondition.d.ts:1 - -## Functions - -### getFulfilledById - -▸ **getFulfilledById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.TransferDIDOwnershipCondition.md#fulfilledresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.TransferDIDOwnershipCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.TransferDIDOwnershipCondition.md#singlequeryoptions) | -| `args` | [`FulfilledArgs`](subgraphs.TransferDIDOwnershipCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.TransferDIDOwnershipCondition.md#fulfilledresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferDIDOwnershipCondition.d.ts:71 - ---- - -### getFulfilleds - -▸ **getFulfilleds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.TransferDIDOwnershipCondition.md#fulfilledresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.TransferDIDOwnershipCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.TransferDIDOwnershipCondition.md#multiqueryoptions)<[`FulfilledFilter`](subgraphs.TransferDIDOwnershipCondition.md#fulfilledfilter), [`FulfilledResult`](subgraphs.TransferDIDOwnershipCondition.md#fulfilledresult)\> | -| `args` | [`FulfilledArgs`](subgraphs.TransferDIDOwnershipCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.TransferDIDOwnershipCondition.md#fulfilledresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferDIDOwnershipCondition.d.ts:72 - ---- - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.TransferDIDOwnershipCondition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.TransferDIDOwnershipCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.TransferDIDOwnershipCondition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.TransferDIDOwnershipCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.TransferDIDOwnershipCondition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferDIDOwnershipCondition.d.ts:102 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.TransferDIDOwnershipCondition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.TransferDIDOwnershipCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.TransferDIDOwnershipCondition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.TransferDIDOwnershipCondition.md#initializedfilter), [`InitializedResult`](subgraphs.TransferDIDOwnershipCondition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.TransferDIDOwnershipCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.TransferDIDOwnershipCondition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferDIDOwnershipCondition.d.ts:103 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.TransferDIDOwnershipCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.TransferDIDOwnershipCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.TransferDIDOwnershipCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.TransferDIDOwnershipCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.TransferDIDOwnershipCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferDIDOwnershipCondition.d.ts:139 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.TransferDIDOwnershipCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.TransferDIDOwnershipCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.TransferDIDOwnershipCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.TransferDIDOwnershipCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.TransferDIDOwnershipCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.TransferDIDOwnershipCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.TransferDIDOwnershipCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferDIDOwnershipCondition.d.ts:140 diff --git a/docs/api-reference/modules/subgraphs.TransferNFT721Condition.md b/docs/api-reference/modules/subgraphs.TransferNFT721Condition.md deleted file mode 100644 index a0522af5a..000000000 --- a/docs/api-reference/modules/subgraphs.TransferNFT721Condition.md +++ /dev/null @@ -1,1005 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / TransferNFT721Condition - -# Namespace: TransferNFT721Condition - -[subgraphs](subgraphs.md).TransferNFT721Condition - -## Table of contents - -### Type Aliases - -- [FulfilledArgs](subgraphs.TransferNFT721Condition.md#fulfilledargs) -- [FulfilledFields](subgraphs.TransferNFT721Condition.md#fulfilledfields) -- [FulfilledFilter](subgraphs.TransferNFT721Condition.md#fulfilledfilter) -- [FulfilledResult](subgraphs.TransferNFT721Condition.md#fulfilledresult) -- [InitializedArgs](subgraphs.TransferNFT721Condition.md#initializedargs) -- [InitializedFields](subgraphs.TransferNFT721Condition.md#initializedfields) -- [InitializedFilter](subgraphs.TransferNFT721Condition.md#initializedfilter) -- [InitializedResult](subgraphs.TransferNFT721Condition.md#initializedresult) -- [MultiQueryOptions](subgraphs.TransferNFT721Condition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.TransferNFT721Condition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.TransferNFT721Condition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.TransferNFT721Condition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.TransferNFT721Condition.md#ownershiptransferredresult) -- [RoleAdminChangedArgs](subgraphs.TransferNFT721Condition.md#roleadminchangedargs) -- [RoleAdminChangedFields](subgraphs.TransferNFT721Condition.md#roleadminchangedfields) -- [RoleAdminChangedFilter](subgraphs.TransferNFT721Condition.md#roleadminchangedfilter) -- [RoleAdminChangedResult](subgraphs.TransferNFT721Condition.md#roleadminchangedresult) -- [RoleGrantedArgs](subgraphs.TransferNFT721Condition.md#rolegrantedargs) -- [RoleGrantedFields](subgraphs.TransferNFT721Condition.md#rolegrantedfields) -- [RoleGrantedFilter](subgraphs.TransferNFT721Condition.md#rolegrantedfilter) -- [RoleGrantedResult](subgraphs.TransferNFT721Condition.md#rolegrantedresult) -- [RoleRevokedArgs](subgraphs.TransferNFT721Condition.md#rolerevokedargs) -- [RoleRevokedFields](subgraphs.TransferNFT721Condition.md#rolerevokedfields) -- [RoleRevokedFilter](subgraphs.TransferNFT721Condition.md#rolerevokedfilter) -- [RoleRevokedResult](subgraphs.TransferNFT721Condition.md#rolerevokedresult) -- [SingleQueryOptions](subgraphs.TransferNFT721Condition.md#singlequeryoptions) - -### Functions - -- [getFulfilledById](subgraphs.TransferNFT721Condition.md#getfulfilledbyid) -- [getFulfilleds](subgraphs.TransferNFT721Condition.md#getfulfilleds) -- [getInitializedById](subgraphs.TransferNFT721Condition.md#getinitializedbyid) -- [getInitializeds](subgraphs.TransferNFT721Condition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.TransferNFT721Condition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.TransferNFT721Condition.md#getownershiptransferreds) -- [getRoleAdminChangedById](subgraphs.TransferNFT721Condition.md#getroleadminchangedbyid) -- [getRoleAdminChangeds](subgraphs.TransferNFT721Condition.md#getroleadminchangeds) -- [getRoleGrantedById](subgraphs.TransferNFT721Condition.md#getrolegrantedbyid) -- [getRoleGranteds](subgraphs.TransferNFT721Condition.md#getrolegranteds) -- [getRoleRevokedById](subgraphs.TransferNFT721Condition.md#getrolerevokedbyid) -- [getRoleRevokeds](subgraphs.TransferNFT721Condition.md#getrolerevokeds) - -## Type Aliases - -### FulfilledArgs - -Ƭ **FulfilledArgs**<`K`\>: { [Property in keyof Pick]: FulfilledFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.TransferNFT721Condition.md#fulfilledresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:87 - ---- - -### FulfilledFields - -Ƭ **FulfilledFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------------- | :----- | -| `_agreementId` | `true` | -| `_amount` | `true` | -| `_conditionId` | `true` | -| `_contract` | `true` | -| `_did` | `true` | -| `_receiver` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:78 - ---- - -### FulfilledFilter - -Ƭ **FulfilledFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------------------- | :-------------------- | -| `_agreementId?` | `string` \| `null` | -| `_agreementId_contains?` | `string` \| `null` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| `null` | -| `_agreementId_not_contains?` | `string` \| `null` | -| `_agreementId_not_in?` | `string`[] | -| `_amount?` | `WeiSource` \| `null` | -| `_amount_gt?` | `WeiSource` \| `null` | -| `_amount_gte?` | `WeiSource` \| `null` | -| `_amount_in?` | `WeiSource`[] | -| `_amount_lt?` | `WeiSource` \| `null` | -| `_amount_lte?` | `WeiSource` \| `null` | -| `_amount_not?` | `WeiSource` \| `null` | -| `_amount_not_in?` | `WeiSource`[] | -| `_conditionId?` | `string` \| `null` | -| `_conditionId_contains?` | `string` \| `null` | -| `_conditionId_in?` | `string`[] | -| `_conditionId_not?` | `string` \| `null` | -| `_conditionId_not_contains?` | `string` \| `null` | -| `_conditionId_not_in?` | `string`[] | -| `_contract?` | `string` \| `null` | -| `_contract_contains?` | `string` \| `null` | -| `_contract_in?` | `string`[] | -| `_contract_not?` | `string` \| `null` | -| `_contract_not_contains?` | `string` \| `null` | -| `_contract_not_in?` | `string`[] | -| `_did?` | `string` \| `null` | -| `_did_contains?` | `string` \| `null` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| `null` | -| `_did_not_contains?` | `string` \| `null` | -| `_did_not_in?` | `string`[] | -| `_receiver?` | `string` \| `null` | -| `_receiver_contains?` | `string` \| `null` | -| `_receiver_in?` | `string`[] | -| `_receiver_not?` | `string` \| `null` | -| `_receiver_not_contains?` | `string` \| `null` | -| `_receiver_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:21 - ---- - -### FulfilledResult - -Ƭ **FulfilledResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------------- | :------- | -| `_agreementId` | `string` | -| `_amount` | `Wei` | -| `_conditionId` | `string` | -| `_contract` | `string` | -| `_did` | `string` | -| `_receiver` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:69 - ---- - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.TransferNFT721Condition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:118 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:114 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:92 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:110 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:10 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.TransferNFT721Condition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:155 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:150 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:123 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:145 - ---- - -### RoleAdminChangedArgs - -Ƭ **RoleAdminChangedArgs**<`K`\>: { [Property in keyof Pick]: RoleAdminChangedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.TransferNFT721Condition.md#roleadminchangedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:200 - ---- - -### RoleAdminChangedFields - -Ƭ **RoleAdminChangedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :----- | -| `id` | `true` | -| `newAdminRole` | `true` | -| `previousAdminRole` | `true` | -| `role` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:194 - ---- - -### RoleAdminChangedFilter - -Ƭ **RoleAdminChangedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newAdminRole?` | `string` \| `null` | -| `newAdminRole_contains?` | `string` \| `null` | -| `newAdminRole_in?` | `string`[] | -| `newAdminRole_not?` | `string` \| `null` | -| `newAdminRole_not_contains?` | `string` \| `null` | -| `newAdminRole_not_in?` | `string`[] | -| `previousAdminRole?` | `string` \| `null` | -| `previousAdminRole_contains?` | `string` \| `null` | -| `previousAdminRole_in?` | `string`[] | -| `previousAdminRole_not?` | `string` \| `null` | -| `previousAdminRole_not_contains?` | `string` \| `null` | -| `previousAdminRole_not_in?` | `string`[] | -| `role?` | `string` \| `null` | -| `role_contains?` | `string` \| `null` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| `null` | -| `role_not_contains?` | `string` \| `null` | -| `role_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:160 - ---- - -### RoleAdminChangedResult - -Ƭ **RoleAdminChangedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :------- | -| `id` | `string` | -| `newAdminRole` | `string` | -| `previousAdminRole` | `string` | -| `role` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:188 - ---- - -### RoleGrantedArgs - -Ƭ **RoleGrantedArgs**<`K`\>: { [Property in keyof Pick]: RoleGrantedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.TransferNFT721Condition.md#rolegrantedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:245 - ---- - -### RoleGrantedFields - -Ƭ **RoleGrantedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `account` | `true` | -| `id` | `true` | -| `role` | `true` | -| `sender` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:239 - ---- - -### RoleGrantedFilter - -Ƭ **RoleGrantedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------- | :----------------- | -| `account?` | `string` \| `null` | -| `account_contains?` | `string` \| `null` | -| `account_in?` | `string`[] | -| `account_not?` | `string` \| `null` | -| `account_not_contains?` | `string` \| `null` | -| `account_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `role?` | `string` \| `null` | -| `role_contains?` | `string` \| `null` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| `null` | -| `role_not_contains?` | `string` \| `null` | -| `role_not_in?` | `string`[] | -| `sender?` | `string` \| `null` | -| `sender_contains?` | `string` \| `null` | -| `sender_in?` | `string`[] | -| `sender_not?` | `string` \| `null` | -| `sender_not_contains?` | `string` \| `null` | -| `sender_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:205 - ---- - -### RoleGrantedResult - -Ƭ **RoleGrantedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `account` | `string` | -| `id` | `string` | -| `role` | `string` | -| `sender` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:233 - ---- - -### RoleRevokedArgs - -Ƭ **RoleRevokedArgs**<`K`\>: { [Property in keyof Pick]: RoleRevokedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.TransferNFT721Condition.md#rolerevokedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:290 - ---- - -### RoleRevokedFields - -Ƭ **RoleRevokedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `account` | `true` | -| `id` | `true` | -| `role` | `true` | -| `sender` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:284 - ---- - -### RoleRevokedFilter - -Ƭ **RoleRevokedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------- | :----------------- | -| `account?` | `string` \| `null` | -| `account_contains?` | `string` \| `null` | -| `account_in?` | `string`[] | -| `account_not?` | `string` \| `null` | -| `account_not_contains?` | `string` \| `null` | -| `account_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `role?` | `string` \| `null` | -| `role_contains?` | `string` \| `null` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| `null` | -| `role_not_contains?` | `string` \| `null` | -| `role_not_in?` | `string`[] | -| `sender?` | `string` \| `null` | -| `sender_contains?` | `string` \| `null` | -| `sender_in?` | `string`[] | -| `sender_not?` | `string` \| `null` | -| `sender_not_contains?` | `string` \| `null` | -| `sender_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:250 - ---- - -### RoleRevokedResult - -Ƭ **RoleRevokedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `account` | `string` | -| `id` | `string` | -| `role` | `string` | -| `sender` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:278 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:2 - -## Functions - -### getFulfilledById - -▸ **getFulfilledById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.TransferNFT721Condition.md#fulfilledresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.TransferNFT721Condition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.TransferNFT721Condition.md#singlequeryoptions) | -| `args` | [`FulfilledArgs`](subgraphs.TransferNFT721Condition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.TransferNFT721Condition.md#fulfilledresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:90 - ---- - -### getFulfilleds - -▸ **getFulfilleds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.TransferNFT721Condition.md#fulfilledresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :-------------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.TransferNFT721Condition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.TransferNFT721Condition.md#multiqueryoptions)<[`FulfilledFilter`](subgraphs.TransferNFT721Condition.md#fulfilledfilter), [`FulfilledResult`](subgraphs.TransferNFT721Condition.md#fulfilledresult)\> | -| `args` | [`FulfilledArgs`](subgraphs.TransferNFT721Condition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.TransferNFT721Condition.md#fulfilledresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:91 - ---- - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.TransferNFT721Condition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.TransferNFT721Condition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.TransferNFT721Condition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.TransferNFT721Condition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.TransferNFT721Condition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:121 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.TransferNFT721Condition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`InitializedResult`](subgraphs.TransferNFT721Condition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.TransferNFT721Condition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.TransferNFT721Condition.md#initializedfilter), [`InitializedResult`](subgraphs.TransferNFT721Condition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.TransferNFT721Condition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.TransferNFT721Condition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:122 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.TransferNFT721Condition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.TransferNFT721Condition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.TransferNFT721Condition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.TransferNFT721Condition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.TransferNFT721Condition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:158 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.TransferNFT721Condition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.TransferNFT721Condition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.TransferNFT721Condition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.TransferNFT721Condition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.TransferNFT721Condition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.TransferNFT721Condition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.TransferNFT721Condition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:159 - ---- - -### getRoleAdminChangedById - -▸ **getRoleAdminChangedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.TransferNFT721Condition.md#roleadminchangedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.TransferNFT721Condition.md#roleadminchangedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.TransferNFT721Condition.md#singlequeryoptions) | -| `args` | [`RoleAdminChangedArgs`](subgraphs.TransferNFT721Condition.md#roleadminchangedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.TransferNFT721Condition.md#roleadminchangedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:203 - ---- - -### getRoleAdminChangeds - -▸ **getRoleAdminChangeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.TransferNFT721Condition.md#roleadminchangedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.TransferNFT721Condition.md#roleadminchangedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.TransferNFT721Condition.md#multiqueryoptions)<[`RoleAdminChangedFilter`](subgraphs.TransferNFT721Condition.md#roleadminchangedfilter), [`RoleAdminChangedResult`](subgraphs.TransferNFT721Condition.md#roleadminchangedresult)\> | -| `args` | [`RoleAdminChangedArgs`](subgraphs.TransferNFT721Condition.md#roleadminchangedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.TransferNFT721Condition.md#roleadminchangedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:204 - ---- - -### getRoleGrantedById - -▸ **getRoleGrantedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.TransferNFT721Condition.md#rolegrantedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.TransferNFT721Condition.md#rolegrantedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.TransferNFT721Condition.md#singlequeryoptions) | -| `args` | [`RoleGrantedArgs`](subgraphs.TransferNFT721Condition.md#rolegrantedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.TransferNFT721Condition.md#rolegrantedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:248 - ---- - -### getRoleGranteds - -▸ **getRoleGranteds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.TransferNFT721Condition.md#rolegrantedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.TransferNFT721Condition.md#rolegrantedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.TransferNFT721Condition.md#multiqueryoptions)<[`RoleGrantedFilter`](subgraphs.TransferNFT721Condition.md#rolegrantedfilter), [`RoleGrantedResult`](subgraphs.TransferNFT721Condition.md#rolegrantedresult)\> | -| `args` | [`RoleGrantedArgs`](subgraphs.TransferNFT721Condition.md#rolegrantedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.TransferNFT721Condition.md#rolegrantedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:249 - ---- - -### getRoleRevokedById - -▸ **getRoleRevokedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.TransferNFT721Condition.md#rolerevokedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.TransferNFT721Condition.md#rolerevokedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.TransferNFT721Condition.md#singlequeryoptions) | -| `args` | [`RoleRevokedArgs`](subgraphs.TransferNFT721Condition.md#rolerevokedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.TransferNFT721Condition.md#rolerevokedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:293 - ---- - -### getRoleRevokeds - -▸ **getRoleRevokeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.TransferNFT721Condition.md#rolerevokedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------ | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.TransferNFT721Condition.md#rolerevokedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.TransferNFT721Condition.md#multiqueryoptions)<[`RoleRevokedFilter`](subgraphs.TransferNFT721Condition.md#rolerevokedfilter), [`RoleRevokedResult`](subgraphs.TransferNFT721Condition.md#rolerevokedresult)\> | -| `args` | [`RoleRevokedArgs`](subgraphs.TransferNFT721Condition.md#rolerevokedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.TransferNFT721Condition.md#rolerevokedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFT721Condition.d.ts:294 diff --git a/docs/api-reference/modules/subgraphs.TransferNFTCondition.md b/docs/api-reference/modules/subgraphs.TransferNFTCondition.md deleted file mode 100644 index b6cf9d178..000000000 --- a/docs/api-reference/modules/subgraphs.TransferNFTCondition.md +++ /dev/null @@ -1,1005 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / TransferNFTCondition - -# Namespace: TransferNFTCondition - -[subgraphs](subgraphs.md).TransferNFTCondition - -## Table of contents - -### Type Aliases - -- [FulfilledArgs](subgraphs.TransferNFTCondition.md#fulfilledargs) -- [FulfilledFields](subgraphs.TransferNFTCondition.md#fulfilledfields) -- [FulfilledFilter](subgraphs.TransferNFTCondition.md#fulfilledfilter) -- [FulfilledResult](subgraphs.TransferNFTCondition.md#fulfilledresult) -- [InitializedArgs](subgraphs.TransferNFTCondition.md#initializedargs) -- [InitializedFields](subgraphs.TransferNFTCondition.md#initializedfields) -- [InitializedFilter](subgraphs.TransferNFTCondition.md#initializedfilter) -- [InitializedResult](subgraphs.TransferNFTCondition.md#initializedresult) -- [MultiQueryOptions](subgraphs.TransferNFTCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.TransferNFTCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.TransferNFTCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.TransferNFTCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.TransferNFTCondition.md#ownershiptransferredresult) -- [RoleAdminChangedArgs](subgraphs.TransferNFTCondition.md#roleadminchangedargs) -- [RoleAdminChangedFields](subgraphs.TransferNFTCondition.md#roleadminchangedfields) -- [RoleAdminChangedFilter](subgraphs.TransferNFTCondition.md#roleadminchangedfilter) -- [RoleAdminChangedResult](subgraphs.TransferNFTCondition.md#roleadminchangedresult) -- [RoleGrantedArgs](subgraphs.TransferNFTCondition.md#rolegrantedargs) -- [RoleGrantedFields](subgraphs.TransferNFTCondition.md#rolegrantedfields) -- [RoleGrantedFilter](subgraphs.TransferNFTCondition.md#rolegrantedfilter) -- [RoleGrantedResult](subgraphs.TransferNFTCondition.md#rolegrantedresult) -- [RoleRevokedArgs](subgraphs.TransferNFTCondition.md#rolerevokedargs) -- [RoleRevokedFields](subgraphs.TransferNFTCondition.md#rolerevokedfields) -- [RoleRevokedFilter](subgraphs.TransferNFTCondition.md#rolerevokedfilter) -- [RoleRevokedResult](subgraphs.TransferNFTCondition.md#rolerevokedresult) -- [SingleQueryOptions](subgraphs.TransferNFTCondition.md#singlequeryoptions) - -### Functions - -- [getFulfilledById](subgraphs.TransferNFTCondition.md#getfulfilledbyid) -- [getFulfilleds](subgraphs.TransferNFTCondition.md#getfulfilleds) -- [getInitializedById](subgraphs.TransferNFTCondition.md#getinitializedbyid) -- [getInitializeds](subgraphs.TransferNFTCondition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.TransferNFTCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.TransferNFTCondition.md#getownershiptransferreds) -- [getRoleAdminChangedById](subgraphs.TransferNFTCondition.md#getroleadminchangedbyid) -- [getRoleAdminChangeds](subgraphs.TransferNFTCondition.md#getroleadminchangeds) -- [getRoleGrantedById](subgraphs.TransferNFTCondition.md#getrolegrantedbyid) -- [getRoleGranteds](subgraphs.TransferNFTCondition.md#getrolegranteds) -- [getRoleRevokedById](subgraphs.TransferNFTCondition.md#getrolerevokedbyid) -- [getRoleRevokeds](subgraphs.TransferNFTCondition.md#getrolerevokeds) - -## Type Aliases - -### FulfilledArgs - -Ƭ **FulfilledArgs**<`K`\>: { [Property in keyof Pick]: FulfilledFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.TransferNFTCondition.md#fulfilledresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:87 - ---- - -### FulfilledFields - -Ƭ **FulfilledFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------------- | :----- | -| `_agreementId` | `true` | -| `_amount` | `true` | -| `_conditionId` | `true` | -| `_contract` | `true` | -| `_did` | `true` | -| `_receiver` | `true` | -| `id` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:78 - ---- - -### FulfilledFilter - -Ƭ **FulfilledFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------------------- | :-------------------- | -| `_agreementId?` | `string` \| `null` | -| `_agreementId_contains?` | `string` \| `null` | -| `_agreementId_in?` | `string`[] | -| `_agreementId_not?` | `string` \| `null` | -| `_agreementId_not_contains?` | `string` \| `null` | -| `_agreementId_not_in?` | `string`[] | -| `_amount?` | `WeiSource` \| `null` | -| `_amount_gt?` | `WeiSource` \| `null` | -| `_amount_gte?` | `WeiSource` \| `null` | -| `_amount_in?` | `WeiSource`[] | -| `_amount_lt?` | `WeiSource` \| `null` | -| `_amount_lte?` | `WeiSource` \| `null` | -| `_amount_not?` | `WeiSource` \| `null` | -| `_amount_not_in?` | `WeiSource`[] | -| `_conditionId?` | `string` \| `null` | -| `_conditionId_contains?` | `string` \| `null` | -| `_conditionId_in?` | `string`[] | -| `_conditionId_not?` | `string` \| `null` | -| `_conditionId_not_contains?` | `string` \| `null` | -| `_conditionId_not_in?` | `string`[] | -| `_contract?` | `string` \| `null` | -| `_contract_contains?` | `string` \| `null` | -| `_contract_in?` | `string`[] | -| `_contract_not?` | `string` \| `null` | -| `_contract_not_contains?` | `string` \| `null` | -| `_contract_not_in?` | `string`[] | -| `_did?` | `string` \| `null` | -| `_did_contains?` | `string` \| `null` | -| `_did_in?` | `string`[] | -| `_did_not?` | `string` \| `null` | -| `_did_not_contains?` | `string` \| `null` | -| `_did_not_in?` | `string`[] | -| `_receiver?` | `string` \| `null` | -| `_receiver_contains?` | `string` \| `null` | -| `_receiver_in?` | `string`[] | -| `_receiver_not?` | `string` \| `null` | -| `_receiver_not_contains?` | `string` \| `null` | -| `_receiver_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:21 - ---- - -### FulfilledResult - -Ƭ **FulfilledResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------------- | :------- | -| `_agreementId` | `string` | -| `_amount` | `Wei` | -| `_conditionId` | `string` | -| `_contract` | `string` | -| `_did` | `string` | -| `_receiver` | `string` | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:69 - ---- - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.TransferNFTCondition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:118 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:114 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:92 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:110 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:10 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.TransferNFTCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:155 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:150 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:123 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:145 - ---- - -### RoleAdminChangedArgs - -Ƭ **RoleAdminChangedArgs**<`K`\>: { [Property in keyof Pick]: RoleAdminChangedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.TransferNFTCondition.md#roleadminchangedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:200 - ---- - -### RoleAdminChangedFields - -Ƭ **RoleAdminChangedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :----- | -| `id` | `true` | -| `newAdminRole` | `true` | -| `previousAdminRole` | `true` | -| `role` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:194 - ---- - -### RoleAdminChangedFilter - -Ƭ **RoleAdminChangedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newAdminRole?` | `string` \| `null` | -| `newAdminRole_contains?` | `string` \| `null` | -| `newAdminRole_in?` | `string`[] | -| `newAdminRole_not?` | `string` \| `null` | -| `newAdminRole_not_contains?` | `string` \| `null` | -| `newAdminRole_not_in?` | `string`[] | -| `previousAdminRole?` | `string` \| `null` | -| `previousAdminRole_contains?` | `string` \| `null` | -| `previousAdminRole_in?` | `string`[] | -| `previousAdminRole_not?` | `string` \| `null` | -| `previousAdminRole_not_contains?` | `string` \| `null` | -| `previousAdminRole_not_in?` | `string`[] | -| `role?` | `string` \| `null` | -| `role_contains?` | `string` \| `null` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| `null` | -| `role_not_contains?` | `string` \| `null` | -| `role_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:160 - ---- - -### RoleAdminChangedResult - -Ƭ **RoleAdminChangedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :------- | -| `id` | `string` | -| `newAdminRole` | `string` | -| `previousAdminRole` | `string` | -| `role` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:188 - ---- - -### RoleGrantedArgs - -Ƭ **RoleGrantedArgs**<`K`\>: { [Property in keyof Pick]: RoleGrantedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.TransferNFTCondition.md#rolegrantedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:245 - ---- - -### RoleGrantedFields - -Ƭ **RoleGrantedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `account` | `true` | -| `id` | `true` | -| `role` | `true` | -| `sender` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:239 - ---- - -### RoleGrantedFilter - -Ƭ **RoleGrantedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------- | :----------------- | -| `account?` | `string` \| `null` | -| `account_contains?` | `string` \| `null` | -| `account_in?` | `string`[] | -| `account_not?` | `string` \| `null` | -| `account_not_contains?` | `string` \| `null` | -| `account_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `role?` | `string` \| `null` | -| `role_contains?` | `string` \| `null` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| `null` | -| `role_not_contains?` | `string` \| `null` | -| `role_not_in?` | `string`[] | -| `sender?` | `string` \| `null` | -| `sender_contains?` | `string` \| `null` | -| `sender_in?` | `string`[] | -| `sender_not?` | `string` \| `null` | -| `sender_not_contains?` | `string` \| `null` | -| `sender_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:205 - ---- - -### RoleGrantedResult - -Ƭ **RoleGrantedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `account` | `string` | -| `id` | `string` | -| `role` | `string` | -| `sender` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:233 - ---- - -### RoleRevokedArgs - -Ƭ **RoleRevokedArgs**<`K`\>: { [Property in keyof Pick]: RoleRevokedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.TransferNFTCondition.md#rolerevokedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:290 - ---- - -### RoleRevokedFields - -Ƭ **RoleRevokedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `account` | `true` | -| `id` | `true` | -| `role` | `true` | -| `sender` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:284 - ---- - -### RoleRevokedFilter - -Ƭ **RoleRevokedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------- | :----------------- | -| `account?` | `string` \| `null` | -| `account_contains?` | `string` \| `null` | -| `account_in?` | `string`[] | -| `account_not?` | `string` \| `null` | -| `account_not_contains?` | `string` \| `null` | -| `account_not_in?` | `string`[] | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `role?` | `string` \| `null` | -| `role_contains?` | `string` \| `null` | -| `role_in?` | `string`[] | -| `role_not?` | `string` \| `null` | -| `role_not_contains?` | `string` \| `null` | -| `role_not_in?` | `string`[] | -| `sender?` | `string` \| `null` | -| `sender_contains?` | `string` \| `null` | -| `sender_in?` | `string`[] | -| `sender_not?` | `string` \| `null` | -| `sender_not_contains?` | `string` \| `null` | -| `sender_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:250 - ---- - -### RoleRevokedResult - -Ƭ **RoleRevokedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `account` | `string` | -| `id` | `string` | -| `role` | `string` | -| `sender` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:278 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:2 - -## Functions - -### getFulfilledById - -▸ **getFulfilledById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.TransferNFTCondition.md#fulfilledresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.TransferNFTCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.TransferNFTCondition.md#singlequeryoptions) | -| `args` | [`FulfilledArgs`](subgraphs.TransferNFTCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.TransferNFTCondition.md#fulfilledresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:90 - ---- - -### getFulfilleds - -▸ **getFulfilleds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`FulfilledResult`](subgraphs.TransferNFTCondition.md#fulfilledresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------------------------- | -| `K` | extends keyof [`FulfilledResult`](subgraphs.TransferNFTCondition.md#fulfilledresult) | - -#### Parameters - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.TransferNFTCondition.md#multiqueryoptions)<[`FulfilledFilter`](subgraphs.TransferNFTCondition.md#fulfilledfilter), [`FulfilledResult`](subgraphs.TransferNFTCondition.md#fulfilledresult)\> | -| `args` | [`FulfilledArgs`](subgraphs.TransferNFTCondition.md#fulfilledargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`FulfilledResult`](subgraphs.TransferNFTCondition.md#fulfilledresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:91 - ---- - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.TransferNFTCondition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.TransferNFTCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.TransferNFTCondition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.TransferNFTCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.TransferNFTCondition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:121 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.TransferNFTCondition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.TransferNFTCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.TransferNFTCondition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.TransferNFTCondition.md#initializedfilter), [`InitializedResult`](subgraphs.TransferNFTCondition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.TransferNFTCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.TransferNFTCondition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:122 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.TransferNFTCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.TransferNFTCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.TransferNFTCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.TransferNFTCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.TransferNFTCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:158 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.TransferNFTCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.TransferNFTCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.TransferNFTCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.TransferNFTCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.TransferNFTCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.TransferNFTCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.TransferNFTCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:159 - ---- - -### getRoleAdminChangedById - -▸ **getRoleAdminChangedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.TransferNFTCondition.md#roleadminchangedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.TransferNFTCondition.md#roleadminchangedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.TransferNFTCondition.md#singlequeryoptions) | -| `args` | [`RoleAdminChangedArgs`](subgraphs.TransferNFTCondition.md#roleadminchangedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.TransferNFTCondition.md#roleadminchangedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:203 - ---- - -### getRoleAdminChangeds - -▸ **getRoleAdminChangeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.TransferNFTCondition.md#roleadminchangedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleAdminChangedResult`](subgraphs.TransferNFTCondition.md#roleadminchangedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.TransferNFTCondition.md#multiqueryoptions)<[`RoleAdminChangedFilter`](subgraphs.TransferNFTCondition.md#roleadminchangedfilter), [`RoleAdminChangedResult`](subgraphs.TransferNFTCondition.md#roleadminchangedresult)\> | -| `args` | [`RoleAdminChangedArgs`](subgraphs.TransferNFTCondition.md#roleadminchangedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleAdminChangedResult`](subgraphs.TransferNFTCondition.md#roleadminchangedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:204 - ---- - -### getRoleGrantedById - -▸ **getRoleGrantedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.TransferNFTCondition.md#rolegrantedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.TransferNFTCondition.md#rolegrantedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.TransferNFTCondition.md#singlequeryoptions) | -| `args` | [`RoleGrantedArgs`](subgraphs.TransferNFTCondition.md#rolegrantedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.TransferNFTCondition.md#rolegrantedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:248 - ---- - -### getRoleGranteds - -▸ **getRoleGranteds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.TransferNFTCondition.md#rolegrantedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleGrantedResult`](subgraphs.TransferNFTCondition.md#rolegrantedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.TransferNFTCondition.md#multiqueryoptions)<[`RoleGrantedFilter`](subgraphs.TransferNFTCondition.md#rolegrantedfilter), [`RoleGrantedResult`](subgraphs.TransferNFTCondition.md#rolegrantedresult)\> | -| `args` | [`RoleGrantedArgs`](subgraphs.TransferNFTCondition.md#rolegrantedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleGrantedResult`](subgraphs.TransferNFTCondition.md#rolegrantedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:249 - ---- - -### getRoleRevokedById - -▸ **getRoleRevokedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.TransferNFTCondition.md#rolerevokedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.TransferNFTCondition.md#rolerevokedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.TransferNFTCondition.md#singlequeryoptions) | -| `args` | [`RoleRevokedArgs`](subgraphs.TransferNFTCondition.md#rolerevokedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.TransferNFTCondition.md#rolerevokedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:293 - ---- - -### getRoleRevokeds - -▸ **getRoleRevokeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.TransferNFTCondition.md#rolerevokedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :--------------------------------------------------------------------------------------- | -| `K` | extends keyof [`RoleRevokedResult`](subgraphs.TransferNFTCondition.md#rolerevokedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.TransferNFTCondition.md#multiqueryoptions)<[`RoleRevokedFilter`](subgraphs.TransferNFTCondition.md#rolerevokedfilter), [`RoleRevokedResult`](subgraphs.TransferNFTCondition.md#rolerevokedresult)\> | -| `args` | [`RoleRevokedArgs`](subgraphs.TransferNFTCondition.md#rolerevokedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`RoleRevokedResult`](subgraphs.TransferNFTCondition.md#rolerevokedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/TransferNFTCondition.d.ts:294 diff --git a/docs/api-reference/modules/subgraphs.WhitelistingCondition.md b/docs/api-reference/modules/subgraphs.WhitelistingCondition.md deleted file mode 100644 index 8163c1a72..000000000 --- a/docs/api-reference/modules/subgraphs.WhitelistingCondition.md +++ /dev/null @@ -1,351 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / [subgraphs](subgraphs.md) / WhitelistingCondition - -# Namespace: WhitelistingCondition - -[subgraphs](subgraphs.md).WhitelistingCondition - -## Table of contents - -### Type Aliases - -- [InitializedArgs](subgraphs.WhitelistingCondition.md#initializedargs) -- [InitializedFields](subgraphs.WhitelistingCondition.md#initializedfields) -- [InitializedFilter](subgraphs.WhitelistingCondition.md#initializedfilter) -- [InitializedResult](subgraphs.WhitelistingCondition.md#initializedresult) -- [MultiQueryOptions](subgraphs.WhitelistingCondition.md#multiqueryoptions) -- [OwnershipTransferredArgs](subgraphs.WhitelistingCondition.md#ownershiptransferredargs) -- [OwnershipTransferredFields](subgraphs.WhitelistingCondition.md#ownershiptransferredfields) -- [OwnershipTransferredFilter](subgraphs.WhitelistingCondition.md#ownershiptransferredfilter) -- [OwnershipTransferredResult](subgraphs.WhitelistingCondition.md#ownershiptransferredresult) -- [SingleQueryOptions](subgraphs.WhitelistingCondition.md#singlequeryoptions) - -### Functions - -- [getInitializedById](subgraphs.WhitelistingCondition.md#getinitializedbyid) -- [getInitializeds](subgraphs.WhitelistingCondition.md#getinitializeds) -- [getOwnershipTransferredById](subgraphs.WhitelistingCondition.md#getownershiptransferredbyid) -- [getOwnershipTransferreds](subgraphs.WhitelistingCondition.md#getownershiptransferreds) - -## Type Aliases - -### InitializedArgs - -Ƭ **InitializedArgs**<`K`\>: { [Property in keyof Pick]: InitializedFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.WhitelistingCondition.md#initializedresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/WhitelistingCondition.d.ts:46 - ---- - -### InitializedFields - -Ƭ **InitializedFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :----- | -| `id` | `true` | -| `version` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/WhitelistingCondition.d.ts:42 - ---- - -### InitializedFilter - -Ƭ **InitializedFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `version?` | `number` \| `null` | -| `version_gt?` | `number` \| `null` | -| `version_gte?` | `number` \| `null` | -| `version_in?` | `number`[] | -| `version_lt?` | `number` \| `null` | -| `version_lte?` | `number` \| `null` | -| `version_not?` | `number` \| `null` | -| `version_not_in?` | `number`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/WhitelistingCondition.d.ts:20 - ---- - -### InitializedResult - -Ƭ **InitializedResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `id` | `string` | -| `version` | `number` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/WhitelistingCondition.d.ts:38 - ---- - -### MultiQueryOptions - -Ƭ **MultiQueryOptions**<`T`, `R`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `R` | - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `first?` | `number` | -| `orderBy?` | keyof `R` | -| `orderDirection?` | `"asc"` \| `"desc"` | -| `where?` | `T` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/WhitelistingCondition.d.ts:9 - ---- - -### OwnershipTransferredArgs - -Ƭ **OwnershipTransferredArgs**<`K`\>: { [Property in keyof Pick]: OwnershipTransferredFields[Property] } - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.WhitelistingCondition.md#ownershiptransferredresult) | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/WhitelistingCondition.d.ts:83 - ---- - -### OwnershipTransferredFields - -Ƭ **OwnershipTransferredFields**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----- | -| `id` | `true` | -| `newOwner` | `true` | -| `previousOwner` | `true` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/WhitelistingCondition.d.ts:78 - ---- - -### OwnershipTransferredFilter - -Ƭ **OwnershipTransferredFilter**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------- | :----------------- | -| `id?` | `string` \| `null` | -| `id_gt?` | `string` \| `null` | -| `id_gte?` | `string` \| `null` | -| `id_in?` | `string`[] | -| `id_lt?` | `string` \| `null` | -| `id_lte?` | `string` \| `null` | -| `id_not?` | `string` \| `null` | -| `id_not_in?` | `string`[] | -| `newOwner?` | `string` \| `null` | -| `newOwner_contains?` | `string` \| `null` | -| `newOwner_in?` | `string`[] | -| `newOwner_not?` | `string` \| `null` | -| `newOwner_not_contains?` | `string` \| `null` | -| `newOwner_not_in?` | `string`[] | -| `previousOwner?` | `string` \| `null` | -| `previousOwner_contains?` | `string` \| `null` | -| `previousOwner_in?` | `string`[] | -| `previousOwner_not?` | `string` \| `null` | -| `previousOwner_not_contains?` | `string` \| `null` | -| `previousOwner_not_in?` | `string`[] | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/WhitelistingCondition.d.ts:51 - ---- - -### OwnershipTransferredResult - -Ƭ **OwnershipTransferredResult**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------- | -| `id` | `string` | -| `newOwner` | `string` | -| `previousOwner` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/WhitelistingCondition.d.ts:73 - ---- - -### SingleQueryOptions - -Ƭ **SingleQueryOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------------------------------------------- | -| `block?` | { `number`: `number` } \| { `hash`: `string` } | -| `id` | `string` | - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/WhitelistingCondition.d.ts:1 - -## Functions - -### getInitializedById - -▸ **getInitializedById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.WhitelistingCondition.md#initializedresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.WhitelistingCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.WhitelistingCondition.md#singlequeryoptions) | -| `args` | [`InitializedArgs`](subgraphs.WhitelistingCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.WhitelistingCondition.md#initializedresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/WhitelistingCondition.d.ts:49 - ---- - -### getInitializeds - -▸ **getInitializeds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`InitializedResult`](subgraphs.WhitelistingCondition.md#initializedresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------- | -| `K` | extends keyof [`InitializedResult`](subgraphs.WhitelistingCondition.md#initializedresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.WhitelistingCondition.md#multiqueryoptions)<[`InitializedFilter`](subgraphs.WhitelistingCondition.md#initializedfilter), [`InitializedResult`](subgraphs.WhitelistingCondition.md#initializedresult)\> | -| `args` | [`InitializedArgs`](subgraphs.WhitelistingCondition.md#initializedargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`InitializedResult`](subgraphs.WhitelistingCondition.md#initializedresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/WhitelistingCondition.d.ts:50 - ---- - -### getOwnershipTransferredById - -▸ **getOwnershipTransferredById**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.WhitelistingCondition.md#ownershiptransferredresult), `K`\>\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.WhitelistingCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`SingleQueryOptions`](subgraphs.WhitelistingCondition.md#singlequeryoptions) | -| `args` | [`OwnershipTransferredArgs`](subgraphs.WhitelistingCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.WhitelistingCondition.md#ownershiptransferredresult), `K`\>\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/WhitelistingCondition.d.ts:86 - ---- - -### getOwnershipTransferreds - -▸ **getOwnershipTransferreds**<`K`\>(`url`, `options`, `args`): `Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.WhitelistingCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------------------------------------------- | -| `K` | extends keyof [`OwnershipTransferredResult`](subgraphs.WhitelistingCondition.md#ownershiptransferredresult) | - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | `string` | -| `options` | [`MultiQueryOptions`](subgraphs.WhitelistingCondition.md#multiqueryoptions)<[`OwnershipTransferredFilter`](subgraphs.WhitelistingCondition.md#ownershiptransferredfilter), [`OwnershipTransferredResult`](subgraphs.WhitelistingCondition.md#ownershiptransferredresult)\> | -| `args` | [`OwnershipTransferredArgs`](subgraphs.WhitelistingCondition.md#ownershiptransferredargs)<`K`\> | - -#### Returns - -`Promise`<`Pick`<[`OwnershipTransferredResult`](subgraphs.WhitelistingCondition.md#ownershiptransferredresult), `K`\>[]\> - -#### Defined in - -node_modules/@nevermined-io/subgraphs/build/WhitelistingCondition.d.ts:87 diff --git a/docs/api-reference/modules/subgraphs.md b/docs/api-reference/modules/subgraphs.md deleted file mode 100644 index b447b6243..000000000 --- a/docs/api-reference/modules/subgraphs.md +++ /dev/null @@ -1,57 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / subgraphs - -# Namespace: subgraphs - -## Table of contents - -### Namespaces - -- [AaveBorrowCondition](subgraphs.AaveBorrowCondition.md) -- [AaveCollateralDepositCondition](subgraphs.AaveCollateralDepositCondition.md) -- [AaveCollateralWithdrawCondition](subgraphs.AaveCollateralWithdrawCondition.md) -- [AaveCreditTemplate](subgraphs.AaveCreditTemplate.md) -- [AaveRepayCondition](subgraphs.AaveRepayCondition.md) -- [AccessCondition](subgraphs.AccessCondition.md) -- [AccessProofCondition](subgraphs.AccessProofCondition.md) -- [AccessProofTemplate](subgraphs.AccessProofTemplate.md) -- [AccessTemplate](subgraphs.AccessTemplate.md) -- [AgreementStoreManager](subgraphs.AgreementStoreManager.md) -- [ComputeExecutionCondition](subgraphs.ComputeExecutionCondition.md) -- [ConditionStoreManager](subgraphs.ConditionStoreManager.md) -- [DIDRegistry](subgraphs.DIDRegistry.md) -- [DIDSalesTemplate](subgraphs.DIDSalesTemplate.md) -- [Dispenser](subgraphs.Dispenser.md) -- [DistributeNFTCollateralCondition](subgraphs.DistributeNFTCollateralCondition.md) -- [EscrowComputeExecutionTemplate](subgraphs.EscrowComputeExecutionTemplate.md) -- [EscrowPaymentCondition](subgraphs.EscrowPaymentCondition.md) -- [HashLockCondition](subgraphs.HashLockCondition.md) -- [LockPaymentCondition](subgraphs.LockPaymentCondition.md) -- [NFT721AccessProofTemplate](subgraphs.NFT721AccessProofTemplate.md) -- [NFT721AccessSwapTemplate](subgraphs.NFT721AccessSwapTemplate.md) -- [NFT721AccessTemplate](subgraphs.NFT721AccessTemplate.md) -- [NFT721EscrowPaymentCondition](subgraphs.NFT721EscrowPaymentCondition.md) -- [NFT721HolderCondition](subgraphs.NFT721HolderCondition.md) -- [NFT721LockCondition](subgraphs.NFT721LockCondition.md) -- [NFT721SalesTemplate](subgraphs.NFT721SalesTemplate.md) -- [NFT721SalesWithAccessTemplate](subgraphs.NFT721SalesWithAccessTemplate.md) -- [NFT721Upgradeable](subgraphs.NFT721Upgradeable.md) -- [NFTAccessCondition](subgraphs.NFTAccessCondition.md) -- [NFTAccessProofTemplate](subgraphs.NFTAccessProofTemplate.md) -- [NFTAccessSwapTemplate](subgraphs.NFTAccessSwapTemplate.md) -- [NFTAccessTemplate](subgraphs.NFTAccessTemplate.md) -- [NFTEscrowPaymentCondition](subgraphs.NFTEscrowPaymentCondition.md) -- [NFTHolderCondition](subgraphs.NFTHolderCondition.md) -- [NFTLockCondition](subgraphs.NFTLockCondition.md) -- [NFTSalesTemplate](subgraphs.NFTSalesTemplate.md) -- [NFTSalesWithAccessTemplate](subgraphs.NFTSalesWithAccessTemplate.md) -- [NeverminedConfig](subgraphs.NeverminedConfig.md) -- [NeverminedToken](subgraphs.NeverminedToken.md) -- [RewardsDistributor](subgraphs.RewardsDistributor.md) -- [SignCondition](subgraphs.SignCondition.md) -- [StandardRoyalties](subgraphs.StandardRoyalties.md) -- [TemplateStoreManager](subgraphs.TemplateStoreManager.md) -- [ThresholdCondition](subgraphs.ThresholdCondition.md) -- [TransferDIDOwnershipCondition](subgraphs.TransferDIDOwnershipCondition.md) -- [TransferNFT721Condition](subgraphs.TransferNFT721Condition.md) -- [TransferNFTCondition](subgraphs.TransferNFTCondition.md) -- [WhitelistingCondition](subgraphs.WhitelistingCondition.md) diff --git a/docs/api-reference/modules/templates.md b/docs/api-reference/modules/templates.md deleted file mode 100644 index 1e7686cd2..000000000 --- a/docs/api-reference/modules/templates.md +++ /dev/null @@ -1,47 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / templates - -# Namespace: templates - -## Table of contents - -### References - -- [AgreementTemplate](templates.md#agreementtemplate) - -### Classes - -- [AaveCreditTemplate](../classes/templates.AaveCreditTemplate.md) -- [AccessTemplate](../classes/templates.AccessTemplate.md) -- [BaseTemplate](../classes/templates.BaseTemplate.md) -- [DIDSalesTemplate](../classes/templates.DIDSalesTemplate.md) -- [EscrowComputeExecutionTemplate](../classes/templates.EscrowComputeExecutionTemplate.md) -- [NFT721AccessTemplate](../classes/templates.NFT721AccessTemplate.md) -- [NFT721SalesTemplate](../classes/templates.NFT721SalesTemplate.md) -- [NFTAccessTemplate](../classes/templates.NFTAccessTemplate.md) -- [NFTSalesTemplate](../classes/templates.NFTSalesTemplate.md) - -### Interfaces - -- [AgreementConditionsStatus](../interfaces/templates.AgreementConditionsStatus.md) -- [AgreementInstance](../interfaces/templates.AgreementInstance.md) -- [PaymentData](../interfaces/templates.PaymentData.md) - -### Type Aliases - -- [ParameterType](templates.md#parametertype) - -## References - -### AgreementTemplate - -Re-exports [AgreementTemplate](../classes/AgreementTemplate.md) - -## Type Aliases - -### ParameterType - -Ƭ **ParameterType**: `string` \| `number` \| `number`[] \| [`Account`](../classes/Account.md) \| [`BabyjubPublicKey`](../classes/KeyTransfer.BabyjubPublicKey.md) \| `Service` \| `ServiceType` \| `TxParameters` - -#### Defined in - -[src/keeper/contracts/templates/AgreementTemplate.abstract.ts:38](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/keeper/contracts/templates/AgreementTemplate.abstract.ts#L38) diff --git a/docs/api-reference/modules/utils.md b/docs/api-reference/modules/utils.md deleted file mode 100644 index 95fbe538e..000000000 --- a/docs/api-reference/modules/utils.md +++ /dev/null @@ -1,506 +0,0 @@ -[@nevermined-io/sdk](../code-reference.md) / utils - -# Namespace: utils - -## Table of contents - -### References - -- [LoggerInstance](utils.md#loggerinstance) - -### Enumerations - -- [LogLevel](../enums/utils.LogLevel.md) -- [OrderProgressStep](../enums/utils.OrderProgressStep.md) - -### Classes - -- [Logger](../classes/utils.Logger.md) -- [SubscribableObserver](../classes/utils.SubscribableObserver.md) -- [SubscribablePromise](../classes/utils.SubscribablePromise.md) - -### Variables - -- [ZeroAddress](utils.md#zeroaddress) - -### Functions - -- [didPrefixed](utils.md#didprefixed) -- [didTransformer](utils.md#didtransformer) -- [didZeroX](utils.md#didzerox) -- [eventToObject](utils.md#eventtoobject) -- [fillConditionsWithDDO](utils.md#fillconditionswithddo) -- [findServiceConditionByName](utils.md#findserviceconditionbyname) -- [generateId](utils.md#generateid) -- [getAssetPriceFromDDOByService](utils.md#getassetrewardsfromddobyservice) -- [getAssetPriceFromService](utils.md#getassetrewardsfromservice) -- [getDIDFromService](utils.md#getdidfromservice) -- [getNftAmountFromService](utils.md#getnftamountfromservice) -- [getNftHolderFromService](utils.md#getnftholderfromservice) -- [makeAccounts](utils.md#makeaccounts) -- [makeBuffer](utils.md#makebuffer) -- [noDidPrefixed](utils.md#nodidprefixed) -- [noZeroX](utils.md#nozerox) -- [objectPromiseAll](utils.md#objectpromiseall) -- [setAssetPriceFromDDOByService](utils.md#setassetrewardsfromddobyservice) -- [setNFTRewardsFromDDOByService](utils.md#setnftrewardsfromddobyservice) -- [zeroX](utils.md#zerox) -- [zeroXTransformer](utils.md#zeroxtransformer) - -## References - -### LoggerInstance - -Renames and re-exports [Logger](../code-reference.md#logger) - -## Variables - -### ZeroAddress - -• `Const` **ZeroAddress**: `"0x0000000000000000000000000000000000000000"` - -#### Defined in - -[src/utils/ConversionTypeHelpers.ts:53](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/ConversionTypeHelpers.ts#L53) - -## Functions - -### didPrefixed - -▸ **didPrefixed**(`input`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `input` | `string` | - -#### Returns - -`string` - -#### Defined in - -[src/utils/ConversionTypeHelpers.ts:17](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/ConversionTypeHelpers.ts#L17) - ---- - -### didTransformer - -▸ **didTransformer**(`input?`, `prefixOutput`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------------- | :-------- | :------------ | -| `input` | `string` | `''` | -| `prefixOutput` | `boolean` | `undefined` | - -#### Returns - -`string` - -#### Defined in - -[src/utils/ConversionTypeHelpers.ts:20](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/ConversionTypeHelpers.ts#L20) - ---- - -### didZeroX - -▸ **didZeroX**(`input`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `input` | `string` | - -#### Returns - -`string` - -#### Defined in - -[src/utils/ConversionTypeHelpers.ts:30](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/ConversionTypeHelpers.ts#L30) - ---- - -### eventToObject - -▸ **eventToObject**(`event`): `any` - -#### Parameters - -| Name | Type | -| :------ | :---- | -| `event` | `any` | - -#### Returns - -`any` - -#### Defined in - -[src/utils/Events.ts:1](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/Events.ts#L1) - ---- - -### fillConditionsWithDDO - -▸ **fillConditionsWithDDO**(`conditions`, `ddo`, `assetPrice?`, `erc20TokenContract?`, `nftTokenContract?`, `nftHolder?`, `nftAmount?`, `nftTransfer?`, `duration?`): `ServiceAgreementTemplateCondition`[] - -Fill some static parameters that depends on the metadata. - -#### Parameters - -| Name | Type | Default value | Description | -| :-------------------- | :------------------------------------ | :------------ | :------------------------------ | -| `conditions` | `ServiceAgreementTemplateCondition`[] | `undefined` | Conditions to fill. | -| `ddo` | [`DDO`](../classes/DDO.md) | `undefined` | DDO related to this conditions. | -| `assetPrice` | `default` | `undefined` | Rewards distribution | -| `erc20TokenContract?` | `string` | `undefined` | Number of nfts to handle | -| `nftTokenContract?` | `string` | `undefined` | Number of nfts to handle | -| `nftHolder?` | `string` | `undefined` | - | -| `nftAmount?` | `default` | `undefined` | Number of nfts to handle | -| `nftTransfer` | `boolean` | `false` | - | -| `duration` | `number` | `0` | - | - -#### Returns - -`ServiceAgreementTemplateCondition`[] - -Filled conditions. - -#### Defined in - -[src/utils/DDOHelpers.ts:71](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/DDOHelpers.ts#L71) - ---- - -### findServiceConditionByName - -▸ **findServiceConditionByName**(`service`, `name`): `ServiceAgreementTemplateCondition` - -#### Parameters - -| Name | Type | -| :-------- | :-------------- | -| `service` | `ServiceCommon` | -| `name` | `ConditionType` | - -#### Returns - -`ServiceAgreementTemplateCondition` - -#### Defined in - -[src/utils/DDOHelpers.ts:100](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/DDOHelpers.ts#L100) - ---- - -### generateId - -▸ **generateId**(`length?`): `string` - -#### Parameters - -| Name | Type | Default value | -| :------- | :------- | :------------ | -| `length` | `number` | `64` | - -#### Returns - -`string` - -#### Defined in - -[src/utils/GeneratorHelpers.ts:3](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/GeneratorHelpers.ts#L3) - ---- - -### getAssetPriceFromDDOByService - -▸ **getAssetPriceFromDDOByService**(`ddo`, `service`): `AssetPrice` - -#### Parameters - -| Name | Type | -| :-------- | :------------------------- | -| `ddo` | [`DDO`](../classes/DDO.md) | -| `service` | `ServiceType` | - -#### Returns - -`AssetPrice` - -#### Defined in - -[src/utils/DDOHelpers.ts:109](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/DDOHelpers.ts#L109) - ---- - -### getAssetPriceFromService - -▸ **getAssetPriceFromService**(`service`): `AssetPrice` - -#### Parameters - -| Name | Type | -| :-------- | :-------------- | -| `service` | `ServiceCommon` | - -#### Returns - -`AssetPrice` - -#### Defined in - -[src/utils/DDOHelpers.ts:148](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/DDOHelpers.ts#L148) - ---- - -### getDIDFromService - -▸ **getDIDFromService**(`service`): `string` - -#### Parameters - -| Name | Type | -| :-------- | :-------------- | -| `service` | `ServiceCommon` | - -#### Returns - -`string` - -#### Defined in - -[src/utils/DDOHelpers.ts:167](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/DDOHelpers.ts#L167) - ---- - -### getNftAmountFromService - -▸ **getNftAmountFromService**(`service`): `BigNumber` - -#### Parameters - -| Name | Type | -| :-------- | :-------------- | -| `service` | `ServiceCommon` | - -#### Returns - -`BigNumber` - -#### Defined in - -[src/utils/DDOHelpers.ts:179](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/DDOHelpers.ts#L179) - ---- - -### getNftHolderFromService - -▸ **getNftHolderFromService**(`service`): `string` - -#### Parameters - -| Name | Type | -| :-------- | :-------------- | -| `service` | `ServiceCommon` | - -#### Returns - -`string` - -#### Defined in - -[src/utils/DDOHelpers.ts:173](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/DDOHelpers.ts#L173) - ---- - -### makeAccounts - -▸ **makeAccounts**(`seedphrase`): `ethers.Wallet`[] - -#### Parameters - -| Name | Type | -| :----------- | :------- | -| `seedphrase` | `string` | - -#### Returns - -`ethers.Wallet`[] - -#### Defined in - -[src/utils/MakeAccounts.ts:4](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/MakeAccounts.ts#L4) - ---- - -### makeBuffer - -▸ **makeBuffer**(`a`, `b`): `Buffer` - -#### Parameters - -| Name | Type | -| :--- | :---- | -| `a` | `any` | -| `b` | `any` | - -#### Returns - -`Buffer` - -#### Defined in - -[src/utils/index.ts:12](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/index.ts#L12) - ---- - -### noDidPrefixed - -▸ **noDidPrefixed**(`input`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `input` | `string` | - -#### Returns - -`string` - -#### Defined in - -[src/utils/ConversionTypeHelpers.ts:18](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/ConversionTypeHelpers.ts#L18) - ---- - -### noZeroX - -▸ **noZeroX**(`input`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `input` | `string` | - -#### Returns - -`string` - -#### Defined in - -[src/utils/ConversionTypeHelpers.ts:5](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/ConversionTypeHelpers.ts#L5) - ---- - -### objectPromiseAll - -▸ **objectPromiseAll**(`obj`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :---- | :------- | -| `obj` | `Object` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[src/utils/PromiseResolver.ts:11](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/PromiseResolver.ts#L11) - ---- - -### setAssetPriceFromDDOByService - -▸ **setAssetPriceFromDDOByService**(`ddo`, `serviceType`, `rewards`): `void` - -#### Parameters - -| Name | Type | -| :------------ | :------------------------- | -| `ddo` | [`DDO`](../classes/DDO.md) | -| `serviceType` | `ServiceType` | -| `rewards` | `default` | - -#### Returns - -`void` - -#### Defined in - -[src/utils/DDOHelpers.ts:132](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/DDOHelpers.ts#L132) - ---- - -### setNFTRewardsFromDDOByService - -▸ **setNFTRewardsFromDDOByService**(`ddo`, `serviceType`, `rewards`, `holderAddress`): `void` - -#### Parameters - -| Name | Type | -| :-------------- | :------------------------- | -| `ddo` | [`DDO`](../classes/DDO.md) | -| `serviceType` | `ServiceType` | -| `rewards` | `default` | -| `holderAddress` | `string` | - -#### Returns - -`void` - -#### Defined in - -[src/utils/DDOHelpers.ts:116](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/DDOHelpers.ts#L116) - ---- - -### zeroX - -▸ **zeroX**(`input`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `input` | `string` | - -#### Returns - -`string` - -#### Defined in - -[src/utils/ConversionTypeHelpers.ts:4](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/ConversionTypeHelpers.ts#L4) - ---- - -### zeroXTransformer - -▸ **zeroXTransformer**(`input?`, `zeroOutput`): `string` - -#### Parameters - -| Name | Type | Default value | -| :----------- | :-------- | :------------ | -| `input` | `string` | `''` | -| `zeroOutput` | `boolean` | `undefined` | - -#### Returns - -`string` - -#### Defined in - -[src/utils/ConversionTypeHelpers.ts:7](https://github.com/nevermined-io/sdk-js/blob/55f88d2/src/utils/ConversionTypeHelpers.ts#L7) diff --git a/package.json b/package.json index 1fb56ecfe..91a553480 100644 --- a/package.json +++ b/package.json @@ -126,8 +126,8 @@ "tar": "^6.1.11", "terser-webpack-plugin": "^5.3.1", "ts-node": "^10.9.1", - "typedoc": "^0.24.7", - "typedoc-plugin-markdown": "^3.13.4", + "typedoc": "^0.25.2", + "typedoc-plugin-markdown": "^3.16.0", "typescript": "^5.1.6", "url": "^0.11.0", "webpack": "^5.69.1",