@nevermined-io/sdk - v3.0.44 / Nevermined
Main interface for Nevermined Protocol.
↳ Nevermined
• new Nevermined(): Nevermined
src/nevermined/Nevermined.ts:263
• accounts: AccountsApi
Accounts submodule
src/nevermined/Nevermined.ts:206
• agreements: AgreementsApi
Agreements submodule
src/nevermined/Nevermined.ts:211
• assets: AssetsApi
Assets API
src/nevermined/Nevermined.ts:216
• compute: ComputeApi
Compute API
src/nevermined/Nevermined.ts:221
• contracts: Object
Nevermined very own contract reflector.
Name | Type | Description |
---|---|---|
loadErc20 |
(address : string ) => Promise <CustomToken > |
- |
loadNft1155 |
(address : string ) => Promise <NFT1155Api > |
- |
loadNft1155Api |
(api : NFT1155Api ) => Promise <NFT1155Api > |
- |
loadNft1155Contract |
(address : string ) => Promise <Nft1155Contract > |
- |
loadNft721 |
(address : string ) => Promise <NFT721Api > |
- |
loadNft721Api |
(api : NFT721Api ) => Promise <NFT721Api > |
- |
loadNft721Contract |
(address : string ) => Promise <Nft721Contract > |
- |
src/nevermined/Nevermined.ts:121
• isKeeperConnected: boolean
If keeper is connected
src/nevermined/Nevermined.ts:261
• keeper: Keeper
Keeper instance.
src/nevermined/Nevermined.ts:201
• nfts1155: NFT1155Api
ERC-1155 Nfts API
src/nevermined/Nevermined.ts:226
• nfts721: NFT721Api
ERC-721 Nfts API
src/nevermined/Nevermined.ts:231
• provenance: ProvenanceApi
Provenance submodule
src/nevermined/Nevermined.ts:236
• search: SearchApi
SearchApi API
src/nevermined/Nevermined.ts:241
• services: ServicesApi
SearchApi API
src/nevermined/Nevermined.ts:246
• utils: UtilsApi
Utils submodule
src/nevermined/Nevermined.ts:251
▪ Static
DEFAULT_INITIALIZATION_OPTIONS: NeverminedInitializationOptions
src/nevermined/Nevermined.ts:24
• get
artifactsFolder(): undefined
| string
undefined
| string
Instantiable.artifactsFolder
src/Instantiable.abstract.ts:137
• get
circuitsFolder(): undefined
| string
undefined
| string
Instantiable.circuitsFolder
src/Instantiable.abstract.ts:141
• get
client(): Web3Clients
Instantiable.client
src/Instantiable.abstract.ts:89
• get
config(): NeverminedOptions
Instantiable.config
src/Instantiable.abstract.ts:120
• get
instanceConfig(): InstantiableConfig
Instantiable.instanceConfig
src/Instantiable.abstract.ts:145
• get
instantiableConfig(): undefined
| InstantiableConfig
undefined
| InstantiableConfig
Instantiable.instantiableConfig
src/Instantiable.abstract.ts:113
• get
logger(): Logger
Logger
Instantiable.logger
src/Instantiable.abstract.ts:128
• get
nevermined(): Nevermined
Instantiable.nevermined
src/Instantiable.abstract.ts:81
• get
publicClient(): Object
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 |
- |
Instantiable.publicClient
src/Instantiable.abstract.ts:97
• get
walletClient(): Object
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}`> |
- |
Instantiable.walletClient
src/Instantiable.abstract.ts:105
▸ setInstanceConfig(config
): void
Name | Type |
---|---|
config |
InstantiableConfig |
void
Instantiable.setInstanceConfig
src/Instantiable.abstract.ts:163
▸ getInstance(config
, initOptions?
): Promise
<Nevermined
>
Returns the instance of Nevermined.
Name | Type | Description |
---|---|---|
config |
NeverminedOptions |
Nevermined instance configuration. |
initOptions |
NeverminedInitializationOptions |
- |
Promise
<Nevermined
>
A Nevermined instance
Example
import { Nevermined, Config } from '@nevermined-io/sdk'
const config: Config = {...}
const nevermined = await Nevermined.getInstance(config)
src/nevermined/Nevermined.ts:51
▸ getSearchOnlyInstance(config
): Promise
<Nevermined
>
Name | Type |
---|---|
config |
NeverminedOptions |
Promise
<Nevermined
>
src/nevermined/Nevermined.ts:102
▸ setInstanceConfig<T
>(instance
, instantiableConfig
): void
Name | Type |
---|---|
T |
extends Instantiable |
Name | Type |
---|---|
instance |
T |
instantiableConfig |
InstantiableConfig |
void
Instantiable.setInstanceConfig