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
- addDefaultMetadataService
- addProof
- addService
- addSignature
- assignDid
- checksum
- findServiceById
- findServiceByType
- generateDidSeed
- generateProof
- getPriceByService
- shortId
- updateService
- deserialize
- getInstance
- serialize
Constructors
constructor
• new DDO(ddo?
)
Parameters
Name | Type |
---|---|
ddo | Partial <DDO > |
Defined in
Properties
@context
• @context: string
= 'https://w3id.org/did/v1'
Defined in
_nvm
• _nvm: NvmConfig
Defined in
authentication
• authentication: Authentication
[] = []
Defined in
created
• created: string
Defined in
didSeed
• didSeed: string
= null
Defined in
id
• id: string
= null
DID, decentralizes ID.
Defined in
proof
• proof: Proof
Defined in
publicKey
• publicKey: PublicKey
[] = []
Defined in
service
• service: ServiceCommon
[] = []
Defined in
Methods
addDefaultMetadataService
▸ addDefaultMetadataService(metadata
, nftAttributes?
): Promise
<MetaDataMain
>
Parameters
Name | Type |
---|---|
metadata | MetaData |
nftAttributes? | NFTAttributes |
Returns
Promise
<MetaDataMain
>
Defined in
addProof
▸ addProof(publicKey
): Promise
<void
>
Generates and adds a proof using personal sign on the DDO.
Parameters
Name | Type | Description |
---|---|---|
publicKey | string | Public key to be used on personal sign. |
Returns
Promise
<void
>
Proof object.
Defined in
addService
▸ addService(service
): Promise
<void
>
Parameters
Name | Type |
---|---|
service | any |
Returns
Promise
<void
>
Defined in
addSignature
▸ addSignature(nevermined
, publicKey
): Promise
<void
>
Parameters
Name | Type |
---|---|
nevermined | Nevermined |
publicKey | string |
Returns
Promise
<void
>
Defined in
assignDid
▸ assignDid(didSeed
, didRegistry
, publisher
): Promise
<void
>
Parameters
Name | Type |
---|---|
didSeed | string |
didRegistry | default |
publisher | Account |
Returns
Promise
<void
>
Defined in
checksum
▸ checksum(seed
): string
Parameters
Name | Type |
---|---|
seed | string |
Returns
string
Defined in
findServiceById
▸ findServiceById<T
>(index
): Service
<T
>
Finds a service of a DDO by index.
Type parameters
Name | Type |
---|---|
T | extends ServiceType |
Parameters
Name | Type | Description |
---|---|---|
index | number | index. |
Returns
Service
<T
>
Service.
Defined in
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
Name | Type |
---|---|
T | extends ServiceType |
Parameters
Name | Type | Description |
---|---|---|
serviceType | T | Service type. |
Returns
Service
<T
>
Defined in
generateDidSeed
▸ generateDidSeed(seed
): Promise
<string
>
Parameters
Name | Type |
---|---|
seed | any |
Returns
Promise
<string
>
Defined in
generateProof
▸ generateProof(publicKey
): Promise
<Proof
>
Generates proof using personal sign.
Parameters
Name | Type | Description |
---|---|---|
publicKey | string | Public key to be used on personal sign. |
Returns
Promise
<Proof
>
Proof object.
Defined in
getPriceByService
▸ getPriceByService(serviceType?
): default
Get the total price of a service.
Example
const price = ddo.getPriceByService('nft-access')
Throws
DDOPriceNotFoundError
Parameters
Name | Type | Default value | Description |
---|---|---|---|
serviceType | ServiceType | 'access' | Service type |
Returns
default
BigNumber
Defined in
shortId
▸ shortId(): string
Returns
string
Defined in
updateService
▸ updateService(nevermined
, service
): Promise
<void
>
Parameters
Name | Type |
---|---|
nevermined | Nevermined |
service | any |
Returns
Promise
<void
>
Defined in
deserialize
▸ Static
deserialize(ddoString
): DDO
Deserializes the DDO object.
Parameters
Name | Type | Description |
---|---|---|
ddoString | string | The serialized DDO to be deserialized. |
Returns
The deserialized DDO.
Defined in
getInstance
▸ Static
getInstance(userId
, publisherAddress
, appId?
): DDO
Parameters
Name | Type |
---|---|
userId | string |
publisherAddress | string |
appId? | string |
Returns
Defined in
serialize
▸ Static
serialize(ddo
): string
Serializes the DDO object.
Parameters
Name | Type | Description |
---|---|---|
ddo | DDO | The DDO to be serialized. |
Returns
string
DDO serialized.