DPP

Classes

DashPlatformProtocol

DashPlatformProtocol

DataContractFacade

DataContractFactory

DataContract

DocumentFacade

DocumentFactory

Document

DataTriggerExecutionContext

DataTriggerExecutionResult

DataTrigger

IdentityFacade

IdentityFacade

IdentityFactory

Identity

IdentityPublicKey

Identifier

StateTransitionFactory

Metadata

StateRepository

StateRepository interface definition

Functions

generateDataContractId(ownerId, entropy) ⇒ Buffer

Generate data contract id based on owner id and entropy

buildBinaryPropertiesMap(schema, [propertyName]) ⇒ Object

Recursively build properties map

getBinaryPropertiesFromSchema(documentSchema) ⇒ Object

Construct and get all properties with contentEncoding keyword

getPropertyDefinitionByPathFactory() ⇒ getPropertyDefinitionByPath

fetchAndValidateDataContractFactory(stateRepository) ⇒ fetchAndValidateDataContract

generateDocumentId(contractId, ownerId, type, entropy) ⇒ Buffer

Generates document ID

getDataTriggersFactory() ⇒ getDataTriggers

Get respective data triggers (factory)

rejectDataTrigger(documentTransition, context) ⇒ Promise.<DataTriggerExecutionResult>

Data trigger for domain deletion process

createAndValidateIdentifier(name, buffer, result) ⇒ Identifier

Typedefs

RawDataContract : Object

JsonDataContract : Object

enrichDataContractWithBaseSchema ⇒ DataContract

getPropertyDefinitionByPath ⇒ Object

Get user property definition

RawDocument : Object

JsonDocument : Object

fetchAndValidateDataContract ⇒ ValidationResult

getDataTriggers ⇒ Array.<DataTrigger>

Get respective data triggers

RawIdentity : Object

JsonIdentity : Object

RawIdentityPublicKey : Object

JsonIdentityPublicKey : Object

DashPlatformProtocol

Kind: global class

• DashPlatformProtocol
  • new DashPlatformProtocol(options)
  • .initialize() ⇒ Promise.<boolean>
  • .getJsonSchemaValidator() ⇒ JsonSchemaValidator
  • .getStateRepository() ⇒ StateRepository
  • .getProtocolVersion() ⇒ number
  • .setProtocolVersion(version)

new DashPlatformProtocol(options)

Param	Type
options	Object
[options.stateRepository]	StateRepository
[options.jsonSchemaValidator]	JsonSchemaValidator
[options.protocolVersion]	number

dashPlatformProtocol.initialize() ⇒ Promise.<boolean>

Initialize

Kind: instance method of DashPlatformProtocol

dashPlatformProtocol.getJsonSchemaValidator() ⇒ JsonSchemaValidator

Kind: instance method of DashPlatformProtocol

dashPlatformProtocol.getStateRepository() ⇒ StateRepository

Get State Repository

Kind: instance method of DashPlatformProtocol

dashPlatformProtocol.getProtocolVersion() ⇒ number

Get protocol version

Kind: instance method of DashPlatformProtocol

dashPlatformProtocol.setProtocolVersion(version)

Set protocol version

Kind: instance method of DashPlatformProtocol

Param	Type
version	number

DashPlatformProtocol

Kind: global class

• DashPlatformProtocol
  • new DashPlatformProtocol(options)
  • .initialize() ⇒ Promise.<boolean>
  • .getJsonSchemaValidator() ⇒ JsonSchemaValidator
  • .getStateRepository() ⇒ StateRepository
  • .getProtocolVersion() ⇒ number
  • .setProtocolVersion(version)

new DashPlatformProtocol(options)

Param	Type
options	Object
[options.stateRepository]	StateRepository
[options.jsonSchemaValidator]	JsonSchemaValidator
[options.protocolVersion]	number

dashPlatformProtocol.initialize() ⇒ Promise.<boolean>

Initialize

Kind: instance method of DashPlatformProtocol

dashPlatformProtocol.getJsonSchemaValidator() ⇒ JsonSchemaValidator

Kind: instance method of DashPlatformProtocol

dashPlatformProtocol.getStateRepository() ⇒ StateRepository

Get State Repository

Kind: instance method of DashPlatformProtocol

dashPlatformProtocol.getProtocolVersion() ⇒ number

Get protocol version

Kind: instance method of DashPlatformProtocol

dashPlatformProtocol.setProtocolVersion(version)

Set protocol version

Kind: instance method of DashPlatformProtocol

Param	Type
version	number

DataContractFacade

Kind: global class

• DataContractFacade
  • new DataContractFacade(dpp, RE2)
  • .create(ownerId, documents) ⇒ DataContract
  • .createFromObject(rawDataContract, options) ⇒ Promise.<DataContract>
  • .createFromBuffer(buffer, options) ⇒ Promise.<DataContract>
  • .createStateTransition(dataContract) ⇒ DataContractCreateTransition
  • .validate(dataContract) ⇒ Promise.<ValidationResult>

new DataContractFacade(dpp, RE2)

Param	Type
dpp	DashPlatformProtocol
RE2	RE2

dataContractFacade.create(ownerId, documents) ⇒ DataContract

Create Data Contract

Kind: instance method of DataContractFacade

Param	Type
ownerId	Buffer
documents	Object

dataContractFacade.createFromObject(rawDataContract, options) ⇒ Promise.<DataContract>

Create Data Contract from plain object

Kind: instance method of DataContractFacade

Param	Type	Default
rawDataContract	RawDataContract
options	Object
[options.skipValidation]	boolean	false

dataContractFacade.createFromBuffer(buffer, options) ⇒ Promise.<DataContract>

Create Data Contract from buffer

Kind: instance method of DataContractFacade

Param	Type	Default
buffer	Buffer
options	Object
[options.skipValidation]	boolean	false

dataContractFacade.createStateTransition(dataContract) ⇒ DataContractCreateTransition

Create Data Contract State Transition

Kind: instance method of DataContractFacade

Param	Type
dataContract	DataContract

dataContractFacade.validate(dataContract) ⇒ Promise.<ValidationResult>

Validate Data Contract

Kind: instance method of DataContractFacade

Param	Type
dataContract	DataContract | RawDataContract

DataContractFactory

Kind: global class

• DataContractFactory
  • new DataContractFactory(dpp, validateDataContract, decodeProtocolEntity)
  • .create(ownerId, documents) ⇒ DataContract
  • .createFromObject(rawDataContract, options) ⇒ Promise.<DataContract>
  • .createFromBuffer(buffer, options) ⇒ Promise.<DataContract>
  • .createStateTransition(dataContract) ⇒ DataContractCreateTransition

new DataContractFactory(dpp, validateDataContract, decodeProtocolEntity)

Param	Type
dpp	DashPlatformProtocol
validateDataContract	validateDataContract
decodeProtocolEntity	decodeProtocolEntity

dataContractFactory.create(ownerId, documents) ⇒ DataContract

Create Data Contract

Kind: instance method of DataContractFactory

Param	Type
ownerId	Buffer
documents	Object

dataContractFactory.createFromObject(rawDataContract, options) ⇒ Promise.<DataContract>

Create Data Contract from plain object

Kind: instance method of DataContractFactory

Param	Type	Default
rawDataContract	RawDataContract
options	Object
[options.skipValidation]	boolean	false

dataContractFactory.createFromBuffer(buffer, options) ⇒ Promise.<DataContract>

Create Data Contract from buffer

Kind: instance method of DataContractFactory

Param	Type	Default
buffer	Buffer
options	Object
[options.skipValidation]	boolean	false

dataContractFactory.createStateTransition(dataContract) ⇒ DataContractCreateTransition

Create Data Contract State Transition

Kind: instance method of DataContractFactory

Param	Type
dataContract	DataContract

DataContract

Kind: global class

• DataContract
  • new DataContract(rawDataContract)
  • .getProtocolVersion() ⇒ number
  • .getId() ⇒ Identifier
  • .getOwnerId() ⇒ Identifier
  • .getJsonSchemaId() ⇒ string
  • .setJsonMetaSchema(schema)
  • .getJsonMetaSchema() ⇒ string
  • .setDocuments(documents) ⇒ DataContract
  • .getDocuments() ⇒ Object.<string, Object>
  • .isDocumentDefined(type) ⇒ boolean
  • .setDocumentSchema(type, schema) ⇒ DataContract
  • .getDocumentSchema(type) ⇒ Object
  • .getDocumentSchemaRef(type) ⇒ Object
  • .setDefinitions($defs) ⇒ DataContract
  • .getDefinitions() ⇒ Object.<string, Object>
  • .setEntropy(entropy) ⇒ DataContract
  • .getEntropy() ⇒ Buffer
  • .getBinaryProperties(type) ⇒ Object
  • .setMetadata(metadata)
  • .getMetadata() ⇒ Metadata | null
  • .toObject([options]) ⇒ RawDataContract
  • .toJSON() ⇒ JsonDataContract
  • .toBuffer() ⇒ Buffer
  • .hash() ⇒ Buffer

new DataContract(rawDataContract)

Param	Type
rawDataContract	RawDataContract

dataContract.getProtocolVersion() ⇒ number

Get Data Contract protocol version

Kind: instance method of DataContract

dataContract.getId() ⇒ Identifier

Get ID

Kind: instance method of DataContract

dataContract.getOwnerId() ⇒ Identifier

Get owner id

Kind: instance method of DataContract

dataContract.getJsonSchemaId() ⇒ string

Get JSON Schema ID

Kind: instance method of DataContract

dataContract.setJsonMetaSchema(schema)

Kind: instance method of DataContract

Param	Type
schema	string

dataContract.getJsonMetaSchema() ⇒ string

Kind: instance method of DataContract

dataContract.setDocuments(documents) ⇒ DataContract

Kind: instance method of DataContract

Param	Type
documents	Object.<string, Object>

dataContract.getDocuments() ⇒ Object.<string, Object>

Kind: instance method of DataContract

dataContract.isDocumentDefined(type) ⇒ boolean

Returns true if document type is defined

Kind: instance method of DataContract

Param	Type
type	string

dataContract.setDocumentSchema(type, schema) ⇒ DataContract

Kind: instance method of DataContract

Param	Type
type	string
schema	object

dataContract.getDocumentSchema(type) ⇒ Object

Kind: instance method of DataContract

Param	Type
type	string

dataContract.getDocumentSchemaRef(type) ⇒ Object

Kind: instance method of DataContract

Param	Type
type	string

dataContract.setDefinitions($defs) ⇒ DataContract

Kind: instance method of DataContract

Param	Type
$defs	Object.<string, Object>

dataContract.getDefinitions() ⇒ Object.<string, Object>

Kind: instance method of DataContract

dataContract.setEntropy(entropy) ⇒ DataContract

Set Data Contract entropy

Kind: instance method of DataContract

Param	Type
entropy	Buffer

dataContract.getEntropy() ⇒ Buffer

Get Data Contract entropy

Kind: instance method of DataContract

dataContract.getBinaryProperties(type) ⇒ Object

Get properties with contentEncoding constraint

Kind: instance method of DataContract

Param	Type
type	string

dataContract.setMetadata(metadata)

Set metadata

Kind: instance method of DataContract

Param	Type
metadata	Metadata

dataContract.getMetadata() ⇒ Metadata | null

Get metadata

Kind: instance method of DataContract

dataContract.toObject([options]) ⇒ RawDataContract

Return Data Contract as plain object

Kind: instance method of DataContract

Param	Type	Default
[options]	Object
[options.skipIdentifiersConversion]	boolean	false

dataContract.toJSON() ⇒ JsonDataContract

Return Data Contract as JSON object

Kind: instance method of DataContract

dataContract.toBuffer() ⇒ Buffer

Return Data Contract as a Buffer

Kind: instance method of DataContract

dataContract.hash() ⇒ Buffer

Returns hex string with Data Contract hash

Kind: instance method of DataContract

DocumentFacade

Kind: global class

• DocumentFacade
  • new DocumentFacade(dpp)
  • .create(dataContract, ownerId, type, [data]) ⇒ Document
  • .createFromObject(rawDocument, options) ⇒ Promise.<Document>
  • .createFromBuffer(buffer, options) ⇒ Promise.<Document>
  • .createStateTransition(documents) ⇒ DocumentsBatchTransition
  • .validate(document) ⇒ Promise.<ValidationResult>

new DocumentFacade(dpp)

Param	Type
dpp	DashPlatformProtocol

documentFacade.create(dataContract, ownerId, type, [data]) ⇒ Document

Create Document

Kind: instance method of DocumentFacade

Param	Type
dataContract	DataContract
ownerId	Identifier | Buffer
type	string
[data]	Object

documentFacade.createFromObject(rawDocument, options) ⇒ Promise.<Document>

Create Document from plain object

Kind: instance method of DocumentFacade

Param	Type	Default
rawDocument	RawDocument
options	Object
[options.skipValidation]	boolean	false
[options.action]	boolean

documentFacade.createFromBuffer(buffer, options) ⇒ Promise.<Document>

Create Document from buffer

Kind: instance method of DocumentFacade

Param	Type	Default
buffer	Buffer
options	Object
[options.skipValidation]	boolean	false
[options.action]	boolean

documentFacade.createStateTransition(documents) ⇒ DocumentsBatchTransition

Create Documents State Transition

Kind: instance method of DocumentFacade

Param	Type
documents	Object
[documents.create]	Array.<Document>
[documents.replace]	Array.<Document>
[documents.delete]	Array.<Document>

documentFacade.validate(document) ⇒ Promise.<ValidationResult>

Validate document

Kind: instance method of DocumentFacade

Param	Type
document	Document | RawDocument

DocumentFactory

Kind: global class

• DocumentFactory
  • new DocumentFactory(dpp, validateDocument, fetchAndValidateDataContract, decodeProtocolEntity)
  • .create(dataContract, ownerId, type, [data]) ⇒ Document
  • .createFromObject(rawDocument, options) ⇒ Document
  • .createFromBuffer(buffer, options) ⇒ Promise.<Document>
  • .createStateTransition(documents) ⇒ DocumentsBatchTransition

new DocumentFactory(dpp, validateDocument, fetchAndValidateDataContract, decodeProtocolEntity)

Param	Type
dpp	DashPlatformProtocol
validateDocument	validateDocument
fetchAndValidateDataContract	fetchAndValidateDataContract
decodeProtocolEntity	decodeProtocolEntity

documentFactory.create(dataContract, ownerId, type, [data]) ⇒ Document

Create Document

Kind: instance method of DocumentFactory

Param	Type
dataContract	DataContract
ownerId	Identifier | Buffer
type	string
[data]	Object

documentFactory.createFromObject(rawDocument, options) ⇒ Document

Create Document from plain object

Kind: instance method of DocumentFactory

Param	Type	Default
rawDocument	RawDocument
options	Object
[options.skipValidation]	boolean	false
[options.action]	boolean

documentFactory.createFromBuffer(buffer, options) ⇒ Promise.<Document>

Create Document from buffer

Kind: instance method of DocumentFactory

Param	Type	Default
buffer	Buffer
options	Object
[options.skipValidation]	boolean	false
[options.action]	boolean

documentFactory.createStateTransition(documents) ⇒ DocumentsBatchTransition

Create Documents State Transition

Kind: instance method of DocumentFactory

Param	Type
documents	Object
[documents.create]	Array.<Document>
[documents.replace]	Array.<Document>
[documents.delete]	Array.<Document>

Document

Kind: global class

• Document
  • new Document(rawDocument, dataContract)
  • .getProtocolVersion() ⇒ number
  • .getId() ⇒ Identifier
  • .getType() ⇒ string
  • .getDataContractId() ⇒ Identifier
  • .getDataContract() ⇒ DataContract
  • .getOwnerId() ⇒ Identifier
  • .setRevision(revision) ⇒
  • .getRevision() ⇒ number
  • .setEntropy(entropy)
  • .getEntropy() ⇒ Buffer
  • .setData(data) ⇒ Document
  • .getData() ⇒ Object
  • .get(path) ⇒ *
  • .set(path, value) ⇒ Document
  • .setCreatedAt(date) ⇒ Document
  • .getCreatedAt() ⇒ Date
  • .setUpdatedAt(date) ⇒ Document
  • .getUpdatedAt() ⇒ Date
  • .setMetadata(metadata)
  • .getMetadata() ⇒ Metadata | null
  • .toObject([options]) ⇒ RawDocument
  • .toJSON() ⇒ JsonDocument
  • .toBuffer() ⇒ Buffer
  • .hash() ⇒ Buffer

new Document(rawDocument, dataContract)

Param	Type
rawDocument	RawDocument
dataContract	DataContract

document.getProtocolVersion() ⇒ number

Get Document protocol version

Kind: instance method of Document

document.getId() ⇒ Identifier

Get ID

Kind: instance method of Document

document.getType() ⇒ string

Get type

Kind: instance method of Document

document.getDataContractId() ⇒ Identifier

Get Data Contract ID

Kind: instance method of Document

document.getDataContract() ⇒ DataContract

Get Data Contract

Kind: instance method of Document

document.getOwnerId() ⇒ Identifier

Get Owner ID

Kind: instance method of Document

document.setRevision(revision) ⇒

Set revision

Kind: instance method of Document
Returns: Document

Param	Type
revision	number

document.getRevision() ⇒ number

Get revision

Kind: instance method of Document

document.setEntropy(entropy)

Set entropy

Kind: instance method of Document

Param	Type
entropy	Buffer

document.getEntropy() ⇒ Buffer

Get entropy

Kind: instance method of Document

document.setData(data) ⇒ Document

Set data

Kind: instance method of Document

Param	Type
data	Object

document.getData() ⇒ Object

Get data

Kind: instance method of Document

document.get(path) ⇒ *

Retrieves the field specified by {path}

Kind: instance method of Document

Param	Type
path	string

document.set(path, value) ⇒ Document

Set the field specified by {path}

Kind: instance method of Document

Param	Type
path	string
value	*

document.setCreatedAt(date) ⇒ Document

Set document creation date

Kind: instance method of Document

Param	Type
date	Date

document.getCreatedAt() ⇒ Date

Get document creation date

Kind: instance method of Document

document.setUpdatedAt(date) ⇒ Document

Set document updated date

Kind: instance method of Document

Param	Type
date	Date

document.getUpdatedAt() ⇒ Date

Get document updated date

Kind: instance method of Document

document.setMetadata(metadata)

Set metadata

Kind: instance method of Document

Param	Type
metadata	Metadata

document.getMetadata() ⇒ Metadata | null

Get metadata

Kind: instance method of Document

document.toObject([options]) ⇒ RawDocument

Return Document as plain object

Kind: instance method of Document

Param	Type	Default
[options]	Object
[options.skipIdentifiersConversion]	boolean	false

document.toJSON() ⇒ JsonDocument

Return Document as JSON object

Kind: instance method of Document

document.toBuffer() ⇒ Buffer

Return serialized Document

Kind: instance method of Document

document.hash() ⇒ Buffer

Returns hex string with object hash

Kind: instance method of Document

DataTriggerExecutionContext

Kind: global class

• DataTriggerExecutionContext
  • new DataTriggerExecutionContext(stateRepository, ownerId, dataContract)
  • .stateRepository : StateRepository
  • .getStateRepository() ⇒ StateRepository
  • .getOwnerId() ⇒ Buffer | Identifier
  • .getDataContract() ⇒ DataContract

new DataTriggerExecutionContext(stateRepository, ownerId, dataContract)

Param	Type
stateRepository	StateRepository
ownerId	Buffer | Identifier
dataContract	DataContract

dataTriggerExecutionContext.stateRepository : StateRepository

Kind: instance property of DataTriggerExecutionContext

dataTriggerExecutionContext.getStateRepository() ⇒ StateRepository

Kind: instance method of DataTriggerExecutionContext

dataTriggerExecutionContext.getOwnerId() ⇒ Buffer | Identifier

Kind: instance method of DataTriggerExecutionContext

dataTriggerExecutionContext.getDataContract() ⇒ DataContract

Kind: instance method of DataTriggerExecutionContext

DataTriggerExecutionResult

Kind: global class

• DataTriggerExecutionResult
  • new DataTriggerExecutionResult(errors)
  • .addError(...error)
  • .getErrors() ⇒ Array.<AbstractDataTriggerError>
  • .isOk() ⇒ boolean

new DataTriggerExecutionResult(errors)

Param	Type
errors	Array.<AbstractDataTriggerError>

dataTriggerExecutionResult.addError(...error)

Add an error to result

Kind: instance method of DataTriggerExecutionResult

Param	Type
...error	AbstractDataTriggerError

dataTriggerExecutionResult.getErrors() ⇒ Array.<AbstractDataTriggerError>

Get all data trigger execution errors

Kind: instance method of DataTriggerExecutionResult

dataTriggerExecutionResult.isOk() ⇒ boolean

Check if result have no errors

Kind: instance method of DataTriggerExecutionResult

DataTrigger

Kind: global class

• DataTrigger
  • new DataTrigger(dataContractId, documentType, transitionAction, trigger, topLevelIdentity)
  • .isMatchingTriggerForData(dataContractId, documentType, transitionAction) ⇒ boolean
  • .execute(documentTransition, context) ⇒ Promise.<DataTriggerExecutionResult>

new DataTrigger(dataContractId, documentType, transitionAction, trigger, topLevelIdentity)

Param	Type
dataContractId	Buffer | Identifier
documentType	string
transitionAction	number
trigger	function
topLevelIdentity	Buffer | Identifier

dataTrigger.isMatchingTriggerForData(dataContractId, documentType, transitionAction) ⇒ boolean

Check this trigger is matching for specified data

Kind: instance method of DataTrigger

Param	Type
dataContractId	string
documentType	string
transitionAction	number

dataTrigger.execute(documentTransition, context) ⇒ Promise.<DataTriggerExecutionResult>

Execute data trigger

Kind: instance method of DataTrigger

Param	Type
documentTransition	Array.<DocumentCreateTransition> | Array.<DocumentReplaceTransition> | Array.<DocumentDeleteTransition>
context	DataTriggerExecutionContext

IdentityFacade

Kind: global class
Properties

Name	Type
validateIdentity	validateIdentity

• IdentityFacade
  • new IdentityFacade(dpp)
  • .create(assetLockProof, publicKeys) ⇒ Identity
  • .createFromObject(rawIdentity, [options]) ⇒ Identity
  • .createFromBuffer(buffer, [options]) ⇒ Identity
  • .validate(identity) ⇒ ValidationResult
  • .createInstantAssetLockProof(instantLock, assetLockTransaction, outputIndex) ⇒ InstantAssetLockProof
  • .createChainAssetLockProof(coreChainLockedHeight, outPoint) ⇒ InstantAssetLockProof | ChainAssetLockProof
  • .createIdentityCreateTransition(identity) ⇒ IdentityCreateTransition
  • .createIdentityTopUpTransition(identityId, assetLockProof) ⇒ IdentityTopUpTransition

new IdentityFacade(dpp)

Param	Type
dpp	DashPlatformProtocol

identityFacade.create(assetLockProof, publicKeys) ⇒ Identity

Create Identity

Kind: instance method of IdentityFacade

Param	Type
assetLockProof	InstantAssetLockProof | ChainAssetLockProof
publicKeys	Array.<PublicKey>

identityFacade.createFromObject(rawIdentity, [options]) ⇒ Identity

Create Identity from the plain object

Kind: instance method of IdentityFacade

Param	Type
rawIdentity	RawIdentity
[options]
[options.skipValidation]	boolean

identityFacade.createFromBuffer(buffer, [options]) ⇒ Identity

Create identity from a Buffer

Kind: instance method of IdentityFacade

Param	Type
buffer	Buffer
[options]
[options.skipValidation]	boolean

identityFacade.validate(identity) ⇒ ValidationResult

Validate identity

Kind: instance method of IdentityFacade

Param	Type
identity	Identity | RawIdentity

identityFacade.createInstantAssetLockProof(instantLock, assetLockTransaction, outputIndex) ⇒ InstantAssetLockProof

Create Instant Asset Lock proof

Kind: instance method of IdentityFacade

Param	Type
instantLock	InstantLock
assetLockTransaction	Transaction
outputIndex	number

identityFacade.createChainAssetLockProof(coreChainLockedHeight, outPoint) ⇒ InstantAssetLockProof | ChainAssetLockProof

Create Chain Asset Lock proof

Kind: instance method of IdentityFacade

Param	Type
coreChainLockedHeight	number
outPoint	Buffer

identityFacade.createIdentityCreateTransition(identity) ⇒ IdentityCreateTransition

Create identity create transition

Kind: instance method of IdentityFacade

Param	Type
identity	Identity

identityFacade.createIdentityTopUpTransition(identityId, assetLockProof) ⇒ IdentityTopUpTransition

Create identity top up transition

Kind: instance method of IdentityFacade

Param	Type	Description
identityId	Identifier | Buffer | string	identity to top up
assetLockProof	InstantAssetLockProof | ChainAssetLockProof

IdentityFacade

Kind: global class

• IdentityFacade
  • new IdentityFacade(dpp)
  • .create(assetLockProof, publicKeys) ⇒ Identity
  • .createFromObject(rawIdentity, [options]) ⇒ Identity
  • .createFromBuffer(buffer, [options]) ⇒ Identity
  • .validate(identity) ⇒ ValidationResult
  • .createInstantAssetLockProof(instantLock, assetLockTransaction, outputIndex) ⇒ InstantAssetLockProof
  • .createChainAssetLockProof(coreChainLockedHeight, outPoint) ⇒ InstantAssetLockProof | ChainAssetLockProof
  • .createIdentityCreateTransition(identity) ⇒ IdentityCreateTransition
  • .createIdentityTopUpTransition(identityId, assetLockProof) ⇒ IdentityTopUpTransition

new IdentityFacade(dpp)

Param	Type
dpp	DashPlatformProtocol

identityFacade.create(assetLockProof, publicKeys) ⇒ Identity

Create Identity

Kind: instance method of IdentityFacade

Param	Type
assetLockProof	InstantAssetLockProof | ChainAssetLockProof
publicKeys	Array.<PublicKey>

identityFacade.createFromObject(rawIdentity, [options]) ⇒ Identity

Create Identity from the plain object

Kind: instance method of IdentityFacade

Param	Type
rawIdentity	RawIdentity
[options]
[options.skipValidation]	boolean

identityFacade.createFromBuffer(buffer, [options]) ⇒ Identity

Create identity from a Buffer

Kind: instance method of IdentityFacade

Param	Type
buffer	Buffer
[options]
[options.skipValidation]	boolean

identityFacade.validate(identity) ⇒ ValidationResult

Validate identity

Kind: instance method of IdentityFacade

Param	Type
identity	Identity | RawIdentity

identityFacade.createInstantAssetLockProof(instantLock, assetLockTransaction, outputIndex) ⇒ InstantAssetLockProof

Create Instant Asset Lock proof

Kind: instance method of IdentityFacade

Param	Type
instantLock	InstantLock
assetLockTransaction	Transaction
outputIndex	number

identityFacade.createChainAssetLockProof(coreChainLockedHeight, outPoint) ⇒ InstantAssetLockProof | ChainAssetLockProof

Create Chain Asset Lock proof

Kind: instance method of IdentityFacade

Param	Type
coreChainLockedHeight	number
outPoint	Buffer

identityFacade.createIdentityCreateTransition(identity) ⇒ IdentityCreateTransition

Create identity create transition

Kind: instance method of IdentityFacade

Param	Type
identity	Identity

identityFacade.createIdentityTopUpTransition(identityId, assetLockProof) ⇒ IdentityTopUpTransition

Create identity top up transition

Kind: instance method of IdentityFacade

Param	Type	Description
identityId	Identifier | Buffer | string	identity to top up
assetLockProof	InstantAssetLockProof | ChainAssetLockProof

IdentityFactory

Kind: global class

• IdentityFactory
  • new IdentityFactory(dpp, validateIdentity, decodeProtocolEntity)
  • .create(assetLockProof, publicKeys) ⇒ Identity
  • .createFromObject(rawIdentity, [options]) ⇒ Identity
  • .createFromBuffer(buffer, options) ⇒ Identity
  • .createInstantAssetLockProof(instantLock, assetLockTransaction, outputIndex) ⇒ InstantAssetLockProof
  • .createChainAssetLockProof(coreChainLockedHeight, outPoint) ⇒ InstantAssetLockProof
  • .createIdentityCreateTransition(identity) ⇒ IdentityCreateTransition
  • .createIdentityTopUpTransition(identityId, assetLockProof) ⇒ IdentityTopUpTransition

new IdentityFactory(dpp, validateIdentity, decodeProtocolEntity)

Param	Type
dpp	DashPlatformProtocol
validateIdentity	validateIdentity
decodeProtocolEntity	decodeProtocolEntity

identityFactory.create(assetLockProof, publicKeys) ⇒ Identity

Create Identity

Kind: instance method of IdentityFactory

Param	Type
assetLockProof	InstantAssetLockProof
publicKeys	Array.<PublicKey>

identityFactory.createFromObject(rawIdentity, [options]) ⇒ Identity

Create identity from a plain object

Kind: instance method of IdentityFactory

Param	Type
rawIdentity	RawIdentity
[options]
[options.skipValidation]	boolean

identityFactory.createFromBuffer(buffer, options) ⇒ Identity

Create Identity from a Buffer

Kind: instance method of IdentityFactory

Param	Type	Default
buffer	Buffer
options	Object
[options.skipValidation]	boolean	false

identityFactory.createInstantAssetLockProof(instantLock, assetLockTransaction, outputIndex) ⇒ InstantAssetLockProof

Create Instant Asset Lock proof

Kind: instance method of IdentityFactory

Param	Type
instantLock	InstantLock
assetLockTransaction	Transaction
outputIndex	number

identityFactory.createChainAssetLockProof(coreChainLockedHeight, outPoint) ⇒ InstantAssetLockProof

Create Chain Asset Lock proof

Kind: instance method of IdentityFactory

Param	Type
coreChainLockedHeight	number
outPoint	Buffer

identityFactory.createIdentityCreateTransition(identity) ⇒ IdentityCreateTransition

Create identity create transition

Kind: instance method of IdentityFactory

Param	Type
identity	Identity

identityFactory.createIdentityTopUpTransition(identityId, assetLockProof) ⇒ IdentityTopUpTransition

Create identity top up transition

Kind: instance method of IdentityFactory

Param	Type	Description
identityId	Identifier | Buffer | string	identity to top up
assetLockProof	InstantAssetLockProof

Identity

Kind: global class

• Identity
  • new Identity(rawIdentity)
  • .getProtocolVersion() ⇒ number
  • .getId() ⇒ Identifier
  • .setPublicKeys(publicKeys) ⇒ Identity
  • .getPublicKeys() ⇒ Array.<IdentityPublicKey>
  • .getPublicKeyById(keyId) ⇒ IdentityPublicKey
  • .toObject() ⇒ RawIdentity
  • .toJSON() ⇒ JsonIdentity
  • .toBuffer() ⇒ Buffer
  • .hash() ⇒ Buffer
  • .getBalance() ⇒ number
  • .setBalance(balance) ⇒ Identity
  • .increaseBalance(amount) ⇒ number
  • .reduceBalance(amount) ⇒ number
  • .setAssetLockProof(assetLockProof) ⇒ Identity
  • .getAssetLockProof() ⇒ InstantAssetLockProof | ChainAssetLockProof
  • .getRevision() ⇒ number
  • .setRevision(revision) ⇒ Identity
  • .setMetadata(metadata)
  • .getMetadata() ⇒ Metadata | null

new Identity(rawIdentity)

Param	Type
rawIdentity	RawIdentity

identity.getProtocolVersion() ⇒ number

Kind: instance method of Identity

identity.getId() ⇒ Identifier

Kind: instance method of Identity

identity.setPublicKeys(publicKeys) ⇒ Identity

Kind: instance method of Identity

Param	Type
publicKeys	Array.<IdentityPublicKey>

identity.getPublicKeys() ⇒ Array.<IdentityPublicKey>

Kind: instance method of Identity

identity.getPublicKeyById(keyId) ⇒ IdentityPublicKey

Returns a public key for a given id

Kind: instance method of Identity

Param	Type
keyId	number

identity.toObject() ⇒ RawIdentity

Get plain object representation

Kind: instance method of Identity

identity.toJSON() ⇒ JsonIdentity

Get JSON representation

Kind: instance method of Identity

identity.toBuffer() ⇒ Buffer

Kind: instance method of Identity

identity.hash() ⇒ Buffer

Kind: instance method of Identity

identity.getBalance() ⇒ number

Returns balance

Kind: instance method of Identity

identity.setBalance(balance) ⇒ Identity

Set Identity balance

Kind: instance method of Identity

Param	Type
balance	number

identity.increaseBalance(amount) ⇒ number

Increase balance

Kind: instance method of Identity

Param	Type
amount	number

identity.reduceBalance(amount) ⇒ number

Reduce balance

Kind: instance method of Identity

Param	Type
amount	number

identity.setAssetLockProof(assetLockProof) ⇒ Identity

Set asset lock proof

Kind: instance method of Identity

Param	Type
assetLockProof	InstantAssetLockProof | ChainAssetLockProof

identity.getAssetLockProof() ⇒ InstantAssetLockProof | ChainAssetLockProof

Get asset lock proof

Kind: instance method of Identity

identity.getRevision() ⇒ number

Get Identity revision

Kind: instance method of Identity

identity.setRevision(revision) ⇒ Identity

Set Identity revision

Kind: instance method of Identity

Param	Type
revision	number

identity.setMetadata(metadata)

Set metadata

Kind: instance method of Identity

Param	Type
metadata	Metadata

identity.getMetadata() ⇒ Metadata | null

Get metadata

Kind: instance method of Identity

IdentityPublicKey

Kind: global class

• IdentityPublicKey
  • new IdentityPublicKey([rawIdentityPublicKey])
  • .getId() ⇒ number
  • .setId(id) ⇒ IdentityPublicKey
  • .getType() ⇒ number
  • .setType(type) ⇒ IdentityPublicKey
  • .setData(data) ⇒ IdentityPublicKey
  • .getData() ⇒ Buffer
  • .hash() ⇒ Buffer
  • .toObject() ⇒ RawIdentityPublicKey
  • .toJSON() ⇒ JsonIdentityPublicKey

new IdentityPublicKey([rawIdentityPublicKey])

Param	Type
[rawIdentityPublicKey]	RawIdentityPublicKey

identityPublicKey.getId() ⇒ number

Get key ID

Kind: instance method of IdentityPublicKey

identityPublicKey.setId(id) ⇒ IdentityPublicKey

Set key ID

Kind: instance method of IdentityPublicKey

Param	Type
id	number

identityPublicKey.getType() ⇒ number

Get key type

Kind: instance method of IdentityPublicKey

identityPublicKey.setType(type) ⇒ IdentityPublicKey

Set key type

Kind: instance method of IdentityPublicKey

Param	Type
type	number

identityPublicKey.setData(data) ⇒ IdentityPublicKey

Set raw public key

Kind: instance method of IdentityPublicKey

Param	Type
data	Buffer

identityPublicKey.getData() ⇒ Buffer

Get raw public key

Kind: instance method of IdentityPublicKey

identityPublicKey.hash() ⇒ Buffer

Get original public key hash

Kind: instance method of IdentityPublicKey

identityPublicKey.toObject() ⇒ RawIdentityPublicKey

Get plain object representation

Kind: instance method of IdentityPublicKey

identityPublicKey.toJSON() ⇒ JsonIdentityPublicKey

Get JSON representation

Kind: instance method of IdentityPublicKey

Identifier

Kind: global class

• Identifier
  • new Identifier(buffer)
  • instance
    • .toBuffer() ⇒ Buffer
    • .encodeCBOR(encoder) ⇒ boolean
    • .toJSON() ⇒ string
    • .toString([encoding]) ⇒ string
  • static
    • .from(value, encoding) ⇒ Identifier

new Identifier(buffer)

Param	Type
buffer	Buffer

identifier.toBuffer() ⇒ Buffer

Convert to Buffer

Kind: instance method of Identifier

identifier.encodeCBOR(encoder) ⇒ boolean

Encode to CBOR

Kind: instance method of Identifier

Param	Type
encoder	Encoder

identifier.toJSON() ⇒ string

Convert to JSON

Kind: instance method of Identifier

identifier.toString([encoding]) ⇒ string

Encode to string

Kind: instance method of Identifier

Param	Type	Default
[encoding]	string	"base58"

Identifier.from(value, encoding) ⇒ Identifier

Create Identifier from buffer or encoded string

Kind: static method of Identifier

Param	Type
value	string | Buffer
encoding	string

StateTransitionFactory

Kind: global class

• StateTransitionFactory
  • new StateTransitionFactory(validateStateTransitionBasic, createStateTransition, dpp, decodeProtocolEntity)
  • .createFromObject(rawStateTransition, [options]) ⇒ AbstractStateTransition
  • .createFromBuffer(buffer, options) ⇒ RawDataContractCreateTransition | DocumentsBatchTransition

new StateTransitionFactory(validateStateTransitionBasic, createStateTransition, dpp, decodeProtocolEntity)

Param	Type
validateStateTransitionBasic	validateStateTransitionBasic
createStateTransition	createStateTransition
dpp	DashPlatformProtocol
decodeProtocolEntity	decodeProtocolEntity

stateTransitionFactory.createFromObject(rawStateTransition, [options]) ⇒ AbstractStateTransition

Create State Transition from plain object

Kind: instance method of StateTransitionFactory

Param	Type	Default
rawStateTransition	RawStateTransition
[options]	Object
[options.skipValidation]	boolean	false

stateTransitionFactory.createFromBuffer(buffer, options) ⇒ RawDataContractCreateTransition | DocumentsBatchTransition

Create State Transition from buffer

Kind: instance method of StateTransitionFactory

Param	Type	Default
buffer	Buffer
options	Object
[options.skipValidation]	boolean	false

Metadata

Kind: global class

• Metadata
  • new Metadata(rawMetadata)
  • .getBlockHeight() ⇒ number
  • .getCoreChainLockedHeight() ⇒ number

new Metadata(rawMetadata)

Param	Type
rawMetadata	Object
rawMetadata.blockHeight	number
rawMetadata.coreChainLockedHeight	number

metadata.getBlockHeight() ⇒ number

Get block height

Kind: instance method of Metadata

metadata.getCoreChainLockedHeight() ⇒ number

Get core chain-locked height

Kind: instance method of Metadata

StateRepository

StateRepository interface definition

Kind: global class

• StateRepository
  • .fetchDataContract(id) ⇒ Promise.<(DataContract|null)>
  • .storeDataContract(dataContract) ⇒ Promise.<void>
  • .fetchDocuments(contractId, type, [options]) ⇒ Promise.<Array.<Document>>
  • .storeDocument(document) ⇒ Promise.<void>
  • .removeDocument(contractId, type, id) ⇒ Promise.<void>
  • .fetchTransaction(id) ⇒ Promise.<(Object|null)>
  • .fetchIdentity(id) ⇒ Promise.<(Identity|null)>
  • .storeIdentity(identity) ⇒ Promise.<void>
  • .storeIdentityPublicKeyHashes(identityId, publicKeyHashes) ⇒ Promise.<void>
  • .fetchIdentityIdsByPublicKeyHashes(publicKeyHashes) ⇒ Promise.<Array.<(Identifier|null)>>
  • .fetchLatestPlatformBlockHeader() ⇒ Promise.<abci.IHeader>
  • .verifyInstantLock(instantLock) ⇒ Promise.<boolean>
  • .isAssetLockTransactionOutPointAlreadyUsed(outPointBuffer) ⇒ Promise.<boolean>
  • .markAssetLockTransactionOutPointAsUsed(outPointBuffer) ⇒ Promise.<void>

stateRepository.fetchDataContract(id) ⇒ Promise.<(DataContract|null)>

Fetch Data Contract by ID

Kind: instance method of StateRepository

Param	Type
id	Identifier

stateRepository.storeDataContract(dataContract) ⇒ Promise.<void>

Store Data Contract

Kind: instance method of StateRepository

Param	Type
dataContract	DataContract

stateRepository.fetchDocuments(contractId, type, [options]) ⇒ Promise.<Array.<Document>>

Fetch Documents by Data Contract ID and type

Kind: instance method of StateRepository

Param	Type
contractId	Identifier
type	string
[options]	Object

stateRepository.storeDocument(document) ⇒ Promise.<void>

Store document

Kind: instance method of StateRepository

Param	Type
document	Document

stateRepository.removeDocument(contractId, type, id) ⇒ Promise.<void>

Remove document

Kind: instance method of StateRepository

Param	Type
contractId	Identifier
type	string
id	Identifier

stateRepository.fetchTransaction(id) ⇒ Promise.<(Object|null)>

Fetch transaction by ID

Kind: instance method of StateRepository

Param	Type
id	string

stateRepository.fetchIdentity(id) ⇒ Promise.<(Identity|null)>

Fetch identity by ID

Kind: instance method of StateRepository

Param	Type
id	Identifier

stateRepository.storeIdentity(identity) ⇒ Promise.<void>

Store identity

Kind: instance method of StateRepository

Param	Type
identity	Identity

stateRepository.storeIdentityPublicKeyHashes(identityId, publicKeyHashes) ⇒ Promise.<void>

Store public keys hashes and identity id pair

Kind: instance method of StateRepository

Param	Type
identityId	Identifier
publicKeyHashes	Array.<Buffer>

stateRepository.fetchIdentityIdsByPublicKeyHashes(publicKeyHashes) ⇒ Promise.<Array.<(Identifier|null)>>

Fetch identity ids by public keys hashes

Kind: instance method of StateRepository

Param	Type
publicKeyHashes	Array.<Buffer>

stateRepository.fetchLatestPlatformBlockHeader() ⇒ Promise.<abci.IHeader>

Fetch latest platform block header

Kind: instance method of StateRepository

stateRepository.verifyInstantLock(instantLock) ⇒ Promise.<boolean>

Verify Instant Lock

Kind: instance method of StateRepository

Param	Type
instantLock	InstantLock

stateRepository.isAssetLockTransactionOutPointAlreadyUsed(outPointBuffer) ⇒ Promise.<boolean>

Check if AssetLock Transaction outPoint exists in spent list

Kind: instance method of StateRepository

Param	Type
outPointBuffer	Buffer

stateRepository.markAssetLockTransactionOutPointAsUsed(outPointBuffer) ⇒ Promise.<void>

Store AssetLock Transaction outPoint in spent list

Kind: instance method of StateRepository

Param	Type
outPointBuffer	Buffer

generateDataContractId(ownerId, entropy) ⇒ Buffer

Generate data contract id based on owner id and entropy

Kind: global function

Param	Type
ownerId	Buffer
entropy	Buffer

buildBinaryPropertiesMap(schema, [propertyName]) ⇒ Object

Recursively build properties map

Kind: global function

Param	Type
schema	Object
[propertyName]	string

getBinaryPropertiesFromSchema(documentSchema) ⇒ Object

Construct and get all properties with contentEncoding keyword

Kind: global function

Param	Type
documentSchema	Object

getPropertyDefinitionByPathFactory() ⇒ getPropertyDefinitionByPath

Kind: global function

fetchAndValidateDataContractFactory(stateRepository) ⇒ fetchAndValidateDataContract

Kind: global function

Param	Type
stateRepository	StateRepository

generateDocumentId(contractId, ownerId, type, entropy) ⇒ Buffer

Generates document ID

Kind: global function

Param	Type
contractId	Buffer
ownerId	Buffer
type	string
entropy	Buffer

getDataTriggersFactory() ⇒ getDataTriggers

Get respective data triggers (factory)

Kind: global function

rejectDataTrigger(documentTransition, context) ⇒ Promise.<DataTriggerExecutionResult>

Data trigger for domain deletion process

Kind: global function

Param	Type
documentTransition	DocumentDeleteTransition
context	DataTriggerExecutionContext

createAndValidateIdentifier(name, buffer, result) ⇒ Identifier

Kind: global function

Param	Type
name	string
buffer	Buffer
result	ValidationResult

RawDataContract : Object

Kind: global typedef
Properties

Name	Type
protocolVersion	number
$id	Buffer
$schema	string
ownerId	Buffer
documents	Object.<string, Object>
[$defs]	Object.<string, Object>

JsonDataContract : Object

Kind: global typedef
Properties

Name	Type
protocolVersion	number
$id	string
$schema	string
ownerId	string
documents	Object.<string, Object>
[$defs]	Object.<string, Object>

enrichDataContractWithBaseSchema ⇒ DataContract

Kind: global typedef

Param	Type
dataContract	DataContract
baseSchema	Object
schemaIdBytePrefix	number
[excludeProperties]	Array.<string>

getPropertyDefinitionByPath ⇒ Object

Get user property definition

Kind: global typedef

Param	Type
documentDefinition	Object
path	string

RawDocument : Object

Kind: global typedef
Properties

Name	Type
$protocolVersion	number
$id	Buffer
$type	string
$dataContractId	Buffer
$ownerId	Buffer
$revision	number
[$createdAt]	number
[$updatedAt]	number

JsonDocument : Object

Kind: global typedef
Properties

Name	Type
$protocolVersion	number
$id	string
$type	string
$dataContractId	string
$ownerId	string
$revision	number
[$createdAt]	number
[$updatedAt]	number

fetchAndValidateDataContract ⇒ ValidationResult

Kind: global typedef

Param	Type
rawDocument	RawDocument

getDataTriggers ⇒ Array.<DataTrigger>

Get respective data triggers

Kind: global typedef

Param	Type
dataContractId	Identifier | Buffer
documentType	string
transitionAction	number

RawIdentity : Object

Kind: global typedef
Properties

Name	Type
protocolVersion	number
id	Buffer
publicKeys	Array.<RawIdentityPublicKey>
balance	number
revision	number

JsonIdentity : Object

Kind: global typedef
Properties

Name	Type
protocolVersion	number
id	string
publicKeys	Array.<JsonIdentityPublicKey>
balance	number
revision	number

RawIdentityPublicKey : Object

Kind: global typedef
Properties

Name	Type
id	number
type	number
data	Buffer

JsonIdentityPublicKey : Object

Kind: global typedef
Properties

Name	Type
id	number
type	number
data	string