Class DocumentsController

Collection of methods to work with documents like creation, querying or preparing a transition action

Index

Methods

create createStateTransition query

Methods

create

create(
    dataContractId: IdentifierLike,
    documentType: string,
    data: object,
    owner: IdentifierLike,
    revision?: bigint,
): Promise<DocumentWASM>
Creates a {DocumentWASM} instance that can be used to submit a document in the network.
Parameters
- dataContractId: IdentifierLike
  {IdentifierLike} Identifier of the Data Contract
- documentType: string
  {string} Document type as string
- data: object
  {object} Data as JSON object
- owner: IdentifierLike
  {IdentifierLike} Identifier of the document's owner
- Optionalrevision: bigint
  {bigint=} revision (optional)
Returns Promise<DocumentWASM>
- Defined in src/documents/index.ts:32

createStateTransition

createStateTransition(
    document: DocumentWASM,
    batchType: BatchType,
    identityContractNonce: bigint,
    params?: CreateStateTransitionDocumentBatchParams,
): StateTransitionWASM
Helper function for creating {StateTransitionWASM} from documents. It may be used to create any of 6 Document Transition actions:
1. Create - creates a document
2. Replace - replaces a document
3. Delete - deletes a document
4. Transfer - transfer a document from one identity to another
5. SetPrice - set a price for a document in credits
6. Purchase - purchase a document from identity (if price was set)
Parameters
- document: DocumentWASM
  {DocumentWASM} Instance of the document to make transition with
- batchType: BatchType
  {BatchType} Type of the document transition
- identityContractNonce: bigint
  {bigint} Identity contract nonce
- Optionalparams: CreateStateTransitionDocumentBatchParams
  {CreateStateTransitionDocumentBatchParams=} Additional params, required for Transfer, SetPrice, Purchase transitions
Returns StateTransitionWASM
- Defined in src/documents/index.ts:70

query

query(
    dataContractId: IdentifierLike,
    documentType: string,
    where?: ArrayLike<any>,
    orderBy?: ArrayLike<any>,
    limit?: number,
    startAt?: IdentifierWASM,
    startAfter?: IdentifierWASM,
): Promise<DocumentWASM[]>
Make a query for documents retrieval from the network.
Parameters
- dataContractId: IdentifierLike
  {IdentifierLike} Identifier of the Data Contract where fetch documents from
- documentType: string
  {string} Document type of the data contract
- Optionalwhere: ArrayLike<any>
  {object=} Where query clauses according syntax https://docs.dash.org/projects/platform/en/stable/docs/reference/query-syntax.html
- OptionalorderBy: ArrayLike<any>
  {object=} Order by clauses according syntax https://docs.dash.org/projects/platform/en/stable/docs/reference/query-syntax.html
- Optionallimit: number
  {number=} Limit amount of documents per request
- OptionalstartAt: IdentifierWASM
  {IdentifierLike=} Optional offset, where startAt is an identifier of the document. Use identifier of last item in previous response
- OptionalstartAfter: IdentifierWASM
  {IdentifierLike=} Same as previous, but with exclusion. Cannot be set if startAt already provided
Returns Promise<DocumentWASM[]>
- Defined in src/documents/index.ts:47