Skip to main content

DDO

@nevermined-io/nevermined-sdk-js / DDO

Class: DDO

DID Descriptor Object. Contains all the data related to an asset.

Table of contents​

Constructors​

Properties​

Methods​

Constructors​

constructor​

• new DDO(ddo?)

Parameters​

NameType
ddoPartial<DDO>

Defined in​

src/ddo/DDO.ts:62

Properties​

@context​

• @context: string = 'https://w3id.org/did/v1'

Defined in​

src/ddo/DDO.ts:41

_nvm​

• _nvm: NvmConfig

Defined in​

src/ddo/DDO.ts:50

authentication​

• authentication: Authentication[] = []

Defined in​

src/ddo/DDO.ts:56

created​

• created: string

Defined in​

src/ddo/DDO.ts:52

didSeed​

• didSeed: string = null

Defined in​

src/ddo/DDO.ts:48

id​

• id: string = null

DID, decentralizes ID.

Defined in​

src/ddo/DDO.ts:46

proof​

• proof: Proof

Defined in​

src/ddo/DDO.ts:60

publicKey​

• publicKey: PublicKey[] = []

Defined in​

src/ddo/DDO.ts:54

service​

• service: ServiceCommon[] = []

Defined in​

src/ddo/DDO.ts:58

Methods​

addDefaultMetadataService​

▸ addDefaultMetadataService(metadata, nftAttributes?): Promise<MetaDataMain>

Parameters​

NameType
metadataMetaData
nftAttributes?NFTAttributes

Returns​

Promise<MetaDataMain>

Defined in​

src/ddo/DDO.ts:199

addProof​

▸ addProof(publicKey): Promise<void>

Generates and adds a proof using personal sign on the DDO.

Parameters​

NameTypeDescription
publicKeystringPublic key to be used on personal sign.

Returns​

Promise<void>

Proof object.

Defined in​

src/ddo/DDO.ts:188

addService​

▸ addService(service): Promise<void>

Parameters​

NameType
serviceany

Returns​

Promise<void>

Defined in​

src/ddo/DDO.ts:195

addSignature​

▸ addSignature(nevermined, publicKey): Promise<void>

Parameters​

NameType
neverminedNevermined
publicKeystring

Returns​

Promise<void>

Defined in​

src/ddo/DDO.ts:250

assignDid​

▸ assignDid(didSeed, didRegistry, publisher): Promise<void>

Parameters​

NameType
didSeedstring
didRegistrydefault
publisherAccount

Returns​

Promise<void>

Defined in​

src/ddo/DDO.ts:234

checksum​

▸ checksum(seed): string

Parameters​

NameType
seedstring

Returns​

string

Defined in​

src/ddo/DDO.ts:156

findServiceById​

▸ findServiceById<T>(index): Service<T>

Finds a service of a DDO by index.

Type parameters​

NameType
Textends ServiceType

Parameters​

NameTypeDescription
indexnumberindex.

Returns​

Service<T>

Service.

Defined in​

src/ddo/DDO.ts:106

findServiceByType​

▸ findServiceByType<T>(serviceType): Service<T>

Finds a service of a DDO by type.

Throws

DDOServiceNotFoundError If the service is not in the DDO.

Type parameters​

NameType
Textends ServiceType

Parameters​

NameTypeDescription
serviceTypeTService type.

Returns​

Service<T>

Service.

Defined in​

src/ddo/DDO.ts:126

generateDidSeed​

▸ generateDidSeed(seed): Promise<string>

Parameters​

NameType
seedany

Returns​

Promise<string>

Defined in​

src/ddo/DDO.ts:246

generateProof​

▸ generateProof(publicKey): Promise<Proof>

Generates proof using personal sign.

Parameters​

NameTypeDescription
publicKeystringPublic key to be used on personal sign.

Returns​

Promise<Proof>

Proof object.

Defined in​

src/ddo/DDO.ts:167

getPriceByService​

▸ getPriceByService(serviceType?): default

Get the total price of a service.

Example

const price = ddo.getPriceByService('nft-access')

Throws

DDOPriceNotFoundError

Parameters​

NameTypeDefault valueDescription
serviceTypeServiceType'access'Service type

Returns​

default

BigNumber

Defined in​

src/ddo/DDO.ts:146

shortId​

▸ shortId(): string

Returns​

string

Defined in​

src/ddo/DDO.ts:97

updateService​

▸ updateService(nevermined, service): Promise<void>

Parameters​

NameType
neverminedNevermined
serviceany

Returns​

Promise<void>

Defined in​

src/ddo/DDO.ts:230

deserialize​

▸ Static deserialize(ddoString): DDO

Deserializes the DDO object.

Parameters​

NameTypeDescription
ddoStringstringThe serialized DDO to be deserialized.

Returns​

DDO

The deserialized DDO.

Defined in​

src/ddo/DDO.ts:35

getInstance​

▸ Static getInstance(userId, publisherAddress, appId?): DDO

Parameters​

NameType
userIdstring
publisherAddressstring
appId?string

Returns​

DDO

Defined in​

src/ddo/DDO.ts:69

serialize​

▸ Static serialize(ddo): string

Serializes the DDO object.

Parameters​

NameTypeDescription
ddoDDOThe DDO to be serialized.

Returns​

string

DDO serialized.

Defined in​

src/ddo/DDO.ts:26