SearchApi
@nevermined-io/sdk - v3.0.40 / 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
Hierarchy
↳
SearchApi
Table of contents
Constructors
Accessors
- artifactsFolder
- circuitsFolder
- client
- config
- instanceConfig
- instantiableConfig
- logger
- nevermined
- publicClient
- walletClient
Methods
- byDID
- byPrice
- bySubscriptionContractAddress
- byText
- byType
- datasetsByNftContract
- datasetsBySubscription
- query
- servicesByNftContract
- servicesBySubscription
- setInstanceConfig
- subscriptionsCreated
- subscriptionsPurchased
- getInstance
- setInstanceConfig
Constructors
constructor
• new SearchApi(config
): SearchApi
Creates a new SearchApi
Parameters
Name | Type | Description |
---|---|---|
config | InstantiableConfig | Configuration of the Nevermined instance |
Returns
Overrides
Defined in
src/nevermined/api/SearchApi.ts:30
Accessors
artifactsFolder
• get
artifactsFolder(): undefined
| string
Returns
undefined
| string
Inherited from
Instantiable.artifactsFolder
Defined in
src/Instantiable.abstract.ts:137
circuitsFolder
• get
circuitsFolder(): undefined
| string
Returns
undefined
| string
Inherited from
Instantiable.circuitsFolder
Defined in
src/Instantiable.abstract.ts:141
client
• get
client(): Web3Clients
Returns
Inherited from
Instantiable.client
Defined in
src/Instantiable.abstract.ts:89
config
• get
config(): NeverminedOptions
Returns
Inherited from
Instantiable.config
Defined in
src/Instantiable.abstract.ts:120
instanceConfig
• get
instanceConfig(): InstantiableConfig
Returns
Inherited from
Instantiable.instanceConfig
Defined in
src/Instantiable.abstract.ts:145
instantiableConfig
• get
instantiableConfig(): undefined
| InstantiableConfig
Returns
undefined
| InstantiableConfig
Inherited from
Instantiable.instantiableConfig
Defined in
src/Instantiable.abstract.ts:113
logger
• get
logger(): Logger
Returns
Logger
Inherited from
Instantiable.logger
Defined in
src/Instantiable.abstract.ts:128
nevermined
• get
nevermined(): Nevermined
Returns
Inherited from
Instantiable.nevermined
Defined in
src/Instantiable.abstract.ts:81
publicClient
• get
publicClient(): Object
Returns
Object
Name | Type | Description |
---|---|---|
account | undefined | The Account of the Client. |
batch? | { multicall? : boolean | { batchSize? : number ; wait? : number } } | Flags for batch settings. |
batch.multicall? | boolean | { batchSize? : number ; wait? : number } | Toggle to enable eth_call multicall aggregation. |
cacheTime | number | Time (in ms) that cached data will remain in memory. |
call | (parameters : CallParameters \<undefined | Chain >) => Promise \<CallReturnType > | - |
ccipRead? | false | { request? : (parameters : CcipRequestParameters ) => Promise \<`0x${string}`> } | CCIP Read configuration. |
chain | undefined | Chain | Chain for the client. |
createBlockFilter | () => Promise \<{ id : `0x${string}` ; request : EIP1193RequestFn \<readonly [{ Method : "eth_getFilterChanges" ; Parameters : [filterId: `0x${string}`] ; ReturnType : `0x${string}`[] | RpcLog [] }, { Method : "eth_getFilterLogs" ; Parameters : [filterId: `0x${string}`] ; ReturnType : RpcLog [] }, { Method : "eth_uninstallFilter" ; Parameters : [filterId: `0x${string}`] ; ReturnType : boolean }]> ; type : "block" }> | - |
createContractEventFilter | \<TAbi, TEventName, TArgs, TStrict, TFromBlock, TToBlock>(args : CreateContractEventFilterParameters \<TAbi , TEventName , TArgs , TStrict , TFromBlock , TToBlock >) => Promise \<CreateContractEventFilterReturnType \<TAbi , TEventName , TArgs , TStrict , TFromBlock , TToBlock >> | - |
createEventFilter | \<TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock, _EventName, _Args>(args? : CreateEventFilterParameters \<TAbiEvent , TAbiEvents , TStrict , TFromBlock , TToBlock , _EventName , _Args >) => Promise \<{ [K in string | number | symbol]: Filter\<"event", TAbiEvents, _EventName, _Args, TStrict, TFromBlock, TToBlock>[K] }> | - |
createPendingTransactionFilter | () => Promise \<{ id : `0x${string}` ; request : EIP1193RequestFn \<readonly [{ Method : "eth_getFilterChanges" ; Parameters : [filterId: `0x${string}`] ; ReturnType : `0x${string}`[] | RpcLog [] }, { Method : "eth_getFilterLogs" ; Parameters : [filterId: `0x${string}`] ; ReturnType : RpcLog [] }, { Method : "eth_uninstallFilter" ; Parameters : [filterId: `0x${string}`] ; ReturnType : boolean }]> ; type : "transaction" }> | - |
estimateContractGas | \<TChain, abi, functionName, args>(args : EstimateContractGasParameters \<abi , functionName , args , TChain >) => Promise \<bigint > | - |
estimateFeesPerGas | \<TChainOverride, TType>(args? : EstimateFeesPerGasParameters \<undefined | Chain , TChainOverride , TType >) => Promise \<EstimateFeesPerGasReturnType > | - |
estimateGas | (args : EstimateGasParameters \<undefined | Chain >) => Promise \<bigint > | - |
estimateMaxPriorityFeePerGas | \<TChainOverride>(args? : { chain : null | TChainOverride }) => Promise \<bigint > | - |
extend | \<client>(fn : (client : Client \<Transport , undefined | Chain , undefined , PublicRpcSchema , PublicActions \<Transport , undefined | Chain >>) => client ) => Client \<Transport , undefined | Chain , undefined , PublicRpcSchema , { [K in string | number | symbol]: client[K] } & PublicActions \<Transport , undefined | Chain >> | - |
getBalance | (args : GetBalanceParameters ) => Promise \<bigint > | - |
getBlobBaseFee | () => Promise \<bigint > | - |
getBlock | \<TIncludeTransactions, TBlockTag>(args? : GetBlockParameters \<TIncludeTransactions , TBlockTag >) => Promise \<{ baseFeePerGas : null | bigint ; blobGasUsed : bigint ; difficulty : bigint ; excessBlobGas : bigint ; extraData : `0x${string}` ; gasLimit : bigint ; gasUsed : bigint ; hash : TBlockTag extends "pending" ? null : `0x${string}` ; logsBloom : TBlockTag extends "pending" ? null : `0x${string}` ; miner : `0x${string}` ; mixHash : `0x${string}` ; nonce : TBlockTag extends "pending" ? null : `0x${string}` ; number : TBlockTag extends "pending" ? null : bigint ; parentHash : `0x${string}` ; receiptsRoot : `0x${string}` ; sealFields : `0x${string}`[] ; sha3Uncles : `0x${string}` ; size : bigint ; stateRoot : `0x${string}` ; timestamp : bigint ; totalDifficulty : null | bigint ; transactions : TIncludeTransactions extends true ? ({ accessList? : undefined ; blobVersionedHashes? : undefined ; blockHash : TBlockTag extends "pending" ? true : false extends true ? null : `0x${string}` ; blockNumber : TBlockTag extends "pending" ? true : false extends true ? null : bigint ; chainId? : number ; from : `0x${string}` ; gas : bigint ; gasPrice : bigint ; hash : `0x${string}` ; input : `0x${string}` ; maxFeePerBlobGas? : undefined ; maxFeePerGas? : undefined ; maxPriorityFeePerGas? : undefined ; nonce : number ; r : `0x${string}` ; s : `0x${string}` ; to : null | `0x${string}` ; transactionIndex : TBlockTag extends "pending" ? true : false extends true ? null : number ; type : "legacy" ; typeHex : null | `0x${string}` ; v : bigint ; value : bigint ; yParity? : undefined } | { accessList : AccessList ; blobVersionedHashes? : undefined ; blockHash : TBlockTag extends "pending" ? true : false extends true ? null : `0x${string}` ; blockNumber : TBlockTag extends "pending" ? true : false extends true ? null : bigint ; chainId : number ; from : `0x${string}` ; gas : bigint ; gasPrice : bigint ; hash : `0x${string}` ; input : `0x${string}` ; maxFeePerBlobGas? : undefined ; maxFeePerGas? : undefined ; maxPriorityFeePerGas? : undefined ; nonce : number ; r : `0x${string}` ; s : `0x${string}` ; to : null | `0x${string}` ; transactionIndex : TBlockTag extends "pending" ? true : false extends true ? null : number ; type : "eip2930" ; typeHex : null | `0x${string}` ; v : bigint ; value : bigint ; yParity : number } | { accessList : AccessList ; blobVersionedHashes? : undefined ; blockHash : TBlockTag extends "pending" ? true : false extends true ? null : `0x${string}` ; blockNumber : TBlockTag extends "pending" ? true : false extends true ? null : bigint ; chainId : number ; from : `0x${string}` ; gas : bigint ; gasPrice? : undefined ; hash : `0x${string}` ; input : `0x${string}` ; maxFeePerBlobGas? : undefined ; maxFeePerGas : bigint ; maxPriorityFeePerGas : bigint ; nonce : number ; r : `0x${string}` ; s : `0x${string}` ; to : null | `0x${string}` ; transactionIndex : TBlockTag extends "pending" ? true : false extends true ? null : number ; type : "eip1559" ; typeHex : null | `0x${string}` ; v : bigint ; value : bigint ; yParity : number } | { accessList : AccessList ; blobVersionedHashes : `0x${string}`[] ; blockHash : TBlockTag extends "pending" ? true : false extends true ? null : `0x${string}` ; blockNumber : TBlockTag extends "pending" ? true : false extends true ? null : bigint ; chainId : number ; from : `0x${string}` ; gas : bigint ; gasPrice? : undefined ; hash : `0x${string}` ; input : `0x${string}` ; maxFeePerBlobGas : bigint ; maxFeePerGas : bigint ; maxPriorityFeePerGas : bigint ; nonce : number ; r : `0x${string}` ; s : `0x${string}` ; to : null | `0x${string}` ; transactionIndex : TBlockTag extends "pending" ? true : false extends true ? null : number ; type : "eip4844" ; typeHex : null | `0x${string}` ; v : bigint ; value : bigint ; yParity : number })[] : `0x${string}`[] ; transactionsRoot : `0x${string}` ; uncles : `0x${string}`[] ; withdrawals? : Withdrawal [] ; withdrawalsRoot? : `0x${string}` }> | - |
getBlockNumber | (args? : GetBlockNumberParameters ) => Promise \<bigint > | - |
getBlockTransactionCount | (args? : GetBlockTransactionCountParameters ) => Promise \<number > | - |
getBytecode | (args : GetBytecodeParameters ) => Promise \<GetBytecodeReturnType > | - |
getChainId | () => Promise \<number > | - |
getContractEvents | \<abi, eventName, strict, fromBlock, toBlock>(args : GetContractEventsParameters \<abi , eventName , strict , fromBlock , toBlock >) => Promise \<GetContractEventsReturnType \<abi , eventName , strict , fromBlock , toBlock >> | - |
getEnsAddress | (args : { blockNumber? : bigint ; blockTag? : BlockTag ; coinType? : number ; gatewayUrls? : string [] ; name : string ; strict? : boolean ; universalResolverAddress? : `0x${string}` }) => Promise \<GetEnsAddressReturnType > | - |
getEnsAvatar | (args : { assetGatewayUrls? : AssetGatewayUrls ; blockNumber? : bigint ; blockTag? : BlockTag ; gatewayUrls? : string [] ; name : string ; strict? : boolean ; universalResolverAddress? : `0x${string}` }) => Promise \<GetEnsAvatarReturnType > | - |
getEnsName | (args : { address : `0x${string}` ; blockNumber? : bigint ; blockTag? : BlockTag ; gatewayUrls? : string [] ; strict? : boolean ; universalResolverAddress? : `0x${string}` }) => Promise \<GetEnsNameReturnType > | - |
getEnsResolver | (args : { blockNumber? : bigint ; blockTag? : BlockTag ; name : string ; universalResolverAddress? : `0x${string}` }) => Promise \<`0x${string}`> | - |
getEnsText | (args : { blockNumber? : bigint ; blockTag? : BlockTag ; gatewayUrls? : string [] ; key : string ; name : string ; strict? : boolean ; universalResolverAddress? : `0x${string}` }) => Promise \<GetEnsTextReturnType > | - |
getFeeHistory | (args : GetFeeHistoryParameters ) => Promise \<GetFeeHistoryReturnType > | - |
getFilterChanges | \<TFilterType, TAbi, TEventName, TStrict, TFromBlock, TToBlock>(args : GetFilterChangesParameters \<TFilterType , TAbi , TEventName , TStrict , TFromBlock , TToBlock >) => Promise \<GetFilterChangesReturnType \<TFilterType , TAbi , TEventName , TStrict , TFromBlock , TToBlock >> | - |
getFilterLogs | \<TAbi, TEventName, TStrict, TFromBlock, TToBlock>(args : GetFilterLogsParameters \<TAbi , TEventName , TStrict , TFromBlock , TToBlock >) => Promise \<GetFilterLogsReturnType \<TAbi , TEventName , TStrict , TFromBlock , TToBlock >> | - |
getGasPrice | () => Promise \<bigint > | - |
getLogs | \<TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock>(args? : GetLogsParameters \<TAbiEvent , TAbiEvents , TStrict , TFromBlock , TToBlock >) => Promise \<GetLogsReturnType \<TAbiEvent , TAbiEvents , TStrict , TFromBlock , TToBlock >> | - |
getProof | (args : GetProofParameters ) => Promise \<GetProofReturnType > | - |
getStorageAt | (args : GetStorageAtParameters ) => Promise \<GetStorageAtReturnType > | - |
getTransaction | \<TBlockTag>(args : GetTransactionParameters \<TBlockTag >) => Promise \<{ accessList? : undefined ; blobVersionedHashes? : undefined ; blockHash : TBlockTag extends "pending" ? true : false extends true ? null : `0x${string}` ; blockNumber : TBlockTag extends "pending" ? true : false extends true ? null : bigint ; chainId? : number ; from : `0x${string}` ; gas : bigint ; gasPrice : bigint ; hash : `0x${string}` ; input : `0x${string}` ; maxFeePerBlobGas? : undefined ; maxFeePerGas? : undefined ; maxPriorityFeePerGas? : undefined ; nonce : number ; r : `0x${string}` ; s : `0x${string}` ; to : null | `0x${string}` ; transactionIndex : TBlockTag extends "pending" ? true : false extends true ? null : number ; type : "legacy" ; typeHex : null | `0x${string}` ; v : bigint ; value : bigint ; yParity? : undefined } | { accessList : AccessList ; blobVersionedHashes? : undefined ; blockHash : TBlockTag extends "pending" ? true : false extends true ? null : `0x${string}` ; blockNumber : TBlockTag extends "pending" ? true : false extends true ? null : bigint ; chainId : number ; from : `0x${string}` ; gas : bigint ; gasPrice : bigint ; hash : `0x${string}` ; input : `0x${string}` ; maxFeePerBlobGas? : undefined ; maxFeePerGas? : undefined ; maxPriorityFeePerGas? : undefined ; nonce : number ; r : `0x${string}` ; s : `0x${string}` ; to : null | `0x${string}` ; transactionIndex : TBlockTag extends "pending" ? true : false extends true ? null : number ; type : "eip2930" ; typeHex : null | `0x${string}` ; v : bigint ; value : bigint ; yParity : number } | { accessList : AccessList ; blobVersionedHashes? : undefined ; blockHash : TBlockTag extends "pending" ? true : false extends true ? null : `0x${string}` ; blockNumber : TBlockTag extends "pending" ? true : false extends true ? null : bigint ; chainId : number ; from : `0x${string}` ; gas : bigint ; gasPrice? : undefined ; hash : `0x${string}` ; input : `0x${string}` ; maxFeePerBlobGas? : undefined ; maxFeePerGas : bigint ; maxPriorityFeePerGas : bigint ; nonce : number ; r : `0x${string}` ; s : `0x${string}` ; to : null | `0x${string}` ; transactionIndex : TBlockTag extends "pending" ? true : false extends true ? null : number ; type : "eip1559" ; typeHex : null | `0x${string}` ; v : bigint ; value : bigint ; yParity : number } | { accessList : AccessList ; blobVersionedHashes : `0x${string}`[] ; blockHash : TBlockTag extends "pending" ? true : false extends true ? null : `0x${string}` ; blockNumber : TBlockTag extends "pending" ? true : false extends true ? null : bigint ; chainId : number ; from : `0x${string}` ; gas : bigint ; gasPrice? : undefined ; hash : `0x${string}` ; input : `0x${string}` ; maxFeePerBlobGas : bigint ; maxFeePerGas : bigint ; maxPriorityFeePerGas : bigint ; nonce : number ; r : `0x${string}` ; s : `0x${string}` ; to : null | `0x${string}` ; transactionIndex : TBlockTag extends "pending" ? true : false extends true ? null : number ; type : "eip4844" ; typeHex : null | `0x${string}` ; v : bigint ; value : bigint ; yParity : number }> | - |
getTransactionConfirmations | (args : GetTransactionConfirmationsParameters \<undefined | Chain >) => Promise \<bigint > | - |
getTransactionCount | (args : GetTransactionCountParameters ) => Promise \<number > | - |
getTransactionReceipt | (args : GetTransactionReceiptParameters ) => Promise \<TransactionReceipt > | - |
key | string | A key for the client. |
multicall | \<contracts, allowFailure>(args : MulticallParameters \<contracts , allowFailure >) => Promise \<MulticallReturnType \<contracts , allowFailure >> | - |
name | string | A name for the client. |
pollingInterval | number | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. |
prepareTransactionRequest | \<TRequest, TChainOverride, TAccountOverride>(args : PrepareTransactionRequestParameters \<undefined | Chain , undefined | Account , TChainOverride , TAccountOverride , TRequest >) => Promise \<{ [K in string | number | symbol]: (UnionRequiredBy\<Extract\<UnionOmit\<(...), (...)> & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)> extends true ? unknown : ExactPartial\<(...)>> & Object, ParameterTypeToParameters\<TRequest["parameters"] extends readonly PrepareTransactionRequestParameterType[] ? any[any][number] : "type" | "gas" | "nonce" | "blobVersionedHashes" | "chainId" | "fees">> & (unknown extends TRequest["kzg"] ? Object : Pick\<TRequest, "kzg">))[K] }> | - |
readContract | \<abi, functionName, args>(args : ReadContractParameters \<abi , functionName , args >) => Promise \<ReadContractReturnType \<abi , functionName , args >> | - |
request | EIP1193RequestFn \<PublicRpcSchema > | Request function wrapped with friendly error handling |
sendRawTransaction | (args : SendRawTransactionParameters ) => Promise \<`0x${string}`> | - |
simulateContract | \<abi, functionName, args, chainOverride, accountOverride>(args : SimulateContractParameters \<abi , functionName , args , undefined | Chain , chainOverride , accountOverride >) => Promise \<SimulateContractReturnType \<abi , functionName , args , undefined | Chain , undefined | Account , chainOverride , accountOverride >> | - |
transport | TransportConfig \<string , EIP1193RequestFn > & Record \<string , any > | The RPC transport |
type | string | The type of client. |
uid | string | A unique ID for the client. |
uninstallFilter | (args : UninstallFilterParameters ) => Promise \<boolean > | - |
verifyMessage | (args : VerifyMessageParameters ) => Promise \<boolean > | - |
verifyTypedData | (args : VerifyTypedDataParameters ) => Promise \<boolean > | - |
waitForTransactionReceipt | (args : WaitForTransactionReceiptParameters \<undefined | Chain >) => Promise \<TransactionReceipt > | - |
watchBlockNumber | (args : WatchBlockNumberParameters ) => WatchBlockNumberReturnType | - |
watchBlocks | \<TIncludeTransactions, TBlockTag>(args : WatchBlocksParameters \<Transport , undefined | Chain , TIncludeTransactions , TBlockTag >) => WatchBlocksReturnType | - |
watchContractEvent | \<TAbi, TEventName, TStrict>(args : WatchContractEventParameters \<TAbi , TEventName , TStrict , Transport >) => WatchContractEventReturnType | - |
watchEvent | \<TAbiEvent, TAbiEvents, TStrict>(args : WatchEventParameters \<TAbiEvent , TAbiEvents , TStrict , Transport >) => WatchEventReturnType | - |
watchPendingTransactions | (args : WatchPendingTransactionsParameters \<Transport >) => WatchPendingTransactionsReturnType | - |
Inherited from
Instantiable.publicClient
Defined in
src/Instantiable.abstract.ts:97
walletClient
• get
walletClient(): Object
Returns
Object
Name | Type | Description |
---|---|---|
account | undefined | Account | The Account of the Client. |
addChain | (args : AddChainParameters ) => Promise \<void > | - |
batch? | { multicall? : boolean | { batchSize? : number ; wait? : number } } | Flags for batch settings. |
batch.multicall? | boolean | { batchSize? : number ; wait? : number } | Toggle to enable eth_call multicall aggregation. |
cacheTime | number | Time (in ms) that cached data will remain in memory. |
ccipRead? | false | { request? : (parameters : CcipRequestParameters ) => Promise \<`0x${string}`> } | CCIP Read configuration. |
chain | undefined | Chain | Chain for the client. |
deployContract | \<abi, chainOverride>(args : DeployContractParameters \<abi , undefined | Chain , undefined | Account , chainOverride >) => Promise \<`0x${string}`> | - |
extend | \<client>(fn : (client : Client \<Transport , undefined | Chain , undefined | Account , WalletRpcSchema , WalletActions \<undefined | Chain , undefined | Account >>) => client ) => Client \<Transport , undefined | Chain , undefined | Account , WalletRpcSchema , { [K in string | number | symbol]: client[K] } & WalletActions \<undefined | Chain , undefined | Account >> | - |
getAddresses | () => Promise \<GetAddressesReturnType > | - |
getChainId | () => Promise \<number > | - |
getPermissions | () => Promise \<GetPermissionsReturnType > | - |
key | string | A key for the client. |
name | string | A name for the client. |
pollingInterval | number | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. |
prepareTransactionRequest | \<TRequest, TChainOverride, TAccountOverride>(args : PrepareTransactionRequestParameters \<undefined | Chain , undefined | Account , TChainOverride , TAccountOverride , TRequest >) => Promise \<{ [K in string | number | symbol]: (UnionRequiredBy\<Extract\<UnionOmit\<(...), (...)> & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)> extends true ? unknown : ExactPartial\<(...)>> & Object, ParameterTypeToParameters\<TRequest["parameters"] extends readonly PrepareTransactionRequestParameterType[] ? any[any][number] : "type" | "gas" | "nonce" | "blobVersionedHashes" | "chainId" | "fees">> & (unknown extends TRequest["kzg"] ? Object : Pick\<TRequest, "kzg">))[K] }> | - |
request | EIP1193RequestFn \<WalletRpcSchema > | Request function wrapped with friendly error handling |
requestAddresses | () => Promise \<RequestAddressesReturnType > | - |
requestPermissions | (args : { eth_accounts : Record \<string , any > }) => Promise \<RequestPermissionsReturnType > | - |
sendRawTransaction | (args : SendRawTransactionParameters ) => Promise \<`0x${string}`> | - |
sendTransaction | \<TRequest, TChainOverride>(args : SendTransactionParameters \<undefined | Chain , undefined | Account , TChainOverride , TRequest >) => Promise \<`0x${string}`> | - |
signMessage | (args : SignMessageParameters \<undefined | Account >) => Promise \<`0x${string}`> | - |
signTransaction | \<TChainOverride>(args : SignTransactionParameters \<undefined | Chain , undefined | Account , TChainOverride >) => Promise \<`0x02${string}` | `0x01${string}` | `0x03${string}` | TransactionSerializedLegacy > | - |
signTypedData | \<TTypedData, TPrimaryType>(args : SignTypedDataParameters \<TTypedData , TPrimaryType , undefined | Account >) => Promise \<`0x${string}`> | - |
switchChain | (args : SwitchChainParameters ) => Promise \<void > | - |
transport | TransportConfig \<string , EIP1193RequestFn > & Record \<string , any > | The RPC transport |
type | string | The type of client. |
uid | string | A unique ID for the client. |
watchAsset | (args : WatchAssetParams ) => Promise \<boolean > | - |
writeContract | \<abi, functionName, args, TChainOverride>(args : WriteContractParameters \<abi , functionName , args , undefined | Chain , undefined | Account , TChainOverride >) => Promise \<`0x${string}`> | - |
Inherited from
Instantiable.walletClient
Defined in
src/Instantiable.abstract.ts:105
Methods
byDID
▸ byDID(did
, metadataServiceEndpoint?
): Promise
\<DDO
>
Search over the assets using a keyword.
Parameters
Name | Type | Description |
---|---|---|
did | string | DID | DID of the asset. |
metadataServiceEndpoint? | string | Metadata service endpoint. |
Returns
Promise
\<DDO
>
DDO of the asset.
Defined in
src/nevermined/api/SearchApi.ts:41
byPrice
▸ byPrice(minPrice
, maxPrice
, serviceType?
, offset?
, page?
, sort?
, appId?
): Promise
\<QueryResult
>
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 | 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
>
Example
const results = await nevermined.search.byPrice(1, 20)
Defined in
src/nevermined/api/SearchApi.ts:110
bySubscriptionContractAddress
▸ bySubscriptionContractAddress(contractAddress
, nftType
, customNestedQueries?
, offset?
, page?
, sort?
, appId?
): Promise
\<QueryResult
>
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
>
Defined in
src/nevermined/api/SearchApi.ts:163
byText
▸ byText(text
, offset?
, page?
, sort?
, appId?
): Promise
\<QueryResult
>
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
>
A list of DDOs.
Defined in
src/nevermined/api/SearchApi.ts:78
byType
▸ byType(assetType?
, text?
, offset?
, page?
, appId?
): Promise
\<QueryResult
>
Parameters
Name | Type | Default value |
---|---|---|
assetType | "compute" | "workflow" | "service" | "dataset" | "algorithm" | "subscription" | "model" | "file" | "other" | "assistant" | "agent" | 'agent' |
text? | string | undefined |
offset | number | 100 |
page | number | 1 |
appId? | string | undefined |
Returns
Promise
\<QueryResult
>
Defined in
src/nevermined/api/SearchApi.ts:791
datasetsByNftContract
▸ datasetsByNftContract(nftContractAddress
, nftType?
, tokenId?
, customNestedQueries?
, offset?
, page?
, sort?
, appId?
): Promise
\<QueryResult
>
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 | NeverminedNFT1155Type | 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
>
Defined in
src/nevermined/api/SearchApi.ts:632
datasetsBySubscription
▸ datasetsBySubscription(subscriptionDid
, nftType?
, customNestedQueries?
, offset?
, page?
, sort?
, appId?
): Promise
\<QueryResult
>
Search of all datasets belonging to a subscription
Parameters
Name | Type | Default value | Description |
---|---|---|---|
subscriptionDid | string | undefined | The DID of the subscription. |
nftType? | NeverminedNFT721Type | NeverminedNFT1155Type | 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
>
Defined in
src/nevermined/api/SearchApi.ts:753
query
▸ query(query
): Promise
\<QueryResult
>
Search over the assets using a query.
Parameters
Name | Type | Description |
---|---|---|
query | SearchQuery | Query to filter the assets. |
Returns
Promise
\<QueryResult
>
A list of DDOs 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:55
servicesByNftContract
▸ servicesByNftContract(nftContractAddress
, nftType?
, tokenId?
, customNestedQueries?
, offset?
, page?
, sort?
, appId?
): Promise
\<QueryResult
>
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 | NeverminedNFT1155Type | 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
>
Defined in
src/nevermined/api/SearchApi.ts:472
servicesBySubscription
▸ servicesBySubscription(subscriptionDid
, nftType?
, customNestedQueries?
, offset?
, page?
, sort?
, appId?
): Promise
\<QueryResult
>
Search of all services belonging to a subscription
Parameters
Name | Type | Default value | Description |
---|---|---|---|
subscriptionDid | string | undefined | The DID of the subscription. |
nftType? | NeverminedNFT721Type | NeverminedNFT1155Type | 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
>
Defined in
src/nevermined/api/SearchApi.ts:582
setInstanceConfig
▸ setInstanceConfig(config
): void
Parameters
Name | Type |
---|---|
config | InstantiableConfig |
Returns
void
Inherited from
Instantiable.setInstanceConfig
Defined in
src/Instantiable.abstract.ts:163
subscriptionsCreated
▸ subscriptionsCreated(account
, nftType?
, customNestedQueries?
, offset?
, page?
, sort?
, appId?
): Promise
\<QueryResult
>
Search of all subscriptions created by account
Parameters
Name | Type | Default value | Description |
---|---|---|---|
account | NvmAccount | undefined | The account that created the subscriptions. |
nftType? | NeverminedNFT721Type | NeverminedNFT1155Type | 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
>
Defined in
src/nevermined/api/SearchApi.ts:262
subscriptionsPurchased
▸ subscriptionsPurchased(account
, nftType?
, ercType?
, customNestedQueries?
, offset?
, page?
, sort?
, appId?
): Promise
\<QueryResult
>
Search of all subscriptions purchased by account
Parameters
Name | Type | Default value | Description |
---|---|---|---|
account | NvmAccount | undefined | The account that purchased the subscriptions. |
nftType? | NeverminedNFT721Type | NeverminedNFT1155Type | 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
>
Defined in
src/nevermined/api/SearchApi.ts:354
getInstance
▸ getInstance(..._args
): any
Parameters
Name | Type |
---|---|
..._args | any |
Returns
any
Inherited from
Defined in
src/Instantiable.abstract.ts:150
setInstanceConfig
▸ setInstanceConfig\<T
>(instance
, instantiableConfig
): void
Type parameters
Name | Type |
---|---|
T | extends Instantiable |
Parameters
Name | Type |
---|---|
instance | T |
instantiableConfig | InstantiableConfig |
Returns
void
Inherited from
Instantiable.setInstanceConfig