pshenmic-dpp 1.0.5 → 1.0.6

package/docs/DocumentPurchaseTransition.md

@@ -0,0 +1,109 @@
+# DocumentPurchaseTransitionWASM
+
+This class allows to create DocumentPurchaseTransition and interact
+
+`DocumentPurchaseTransitionWASM` can be created via constructor and document transition `fromDocumentTransition()`
+
+Constructor arguments:
+
+- `document -> DocumentWASM`
+- `identityContractNonce -> BigInt`
+- `documentTypeName -> String`
+- `price -> BigInt`
+
+___
+
+## Navigation
+
+- [Example](#example)
+- [Fields](#fields)
+    - [base](#base)
+    - [price](#price)
+    - [revision](#revision)
+- [Getters methods](#getters-methods)
+    - [toDocumentTransition](#todocumenttransition)
+
+___
+
+## Example
+
+```js
+const dataContractIdentifier = new IdentifierWASM('GnXgMaiqAwTxh44ccQe8AoCgFvcseHK5CncH3sUorW4X')
+const ownerIdentifier = new IdentifierWASM('CXH2kZCATjvDTnQAPVg28EgPg9WySUvwvnR5ZkmNqY5i')
+
+const properties = {"message": "Tutorial CI Test @ Tue, 07 Jan 2025 15:27:50 GMT"}
+
+const documentInstance = new DocumentWASM(properties, "note", BigInt(1), dataContractIdentifier, ownerIdentifier)
+
+const purchaseTransition = new DocumentPurchaseTransitionWASM(documentInstance, BigInt(1), 'preorder', BigInt(100))
+```
+
+___
+
+## Fields
+
+All fields are readable and writable.
+
+### `base`
+
+Contains document base transition `DocumentBaseTransitionWASM`
+
+```js
+const purchaseTransition = new DocumentPurchaseTransitionWASM(documentInstance, BigInt(1), 'preorder', BigInt(100))
+
+const base = new DocumentBaseTransitionWASM(
+  '9tSsCqKHTZ8ro16MydChSxgHBukFW36eMLJKKRtebJEn',
+  BigInt(12350),
+  'note',
+  'CXH2kZCATjvDTnQAPVg28EgPg9WySUvwvnR5ZkmNqY5i'
+)
+
+purchaseTransition.base // -> DocumentBaseTransitionWASM
+
+purchaseTransition.base = base 
+```
+
+___
+
+### `price`
+
+Contains price for purchase in `BigInt`
+
+```js
+purchaseTransition.price // -> BigInt
+
+purchaseTransition.price = BigInt(213)
+```
+
+___
+
+### `revision`
+
+Contains document revision in `BigInt`
+
+```js
+purchaseTransition.revision // -> BigInt
+
+purchaseTransition.revision = BigInt(213)
+```
+
+___
+
+## Getters methods
+
+### `toDocumentTransition`
+
+Returns document create transition in `DocumentCreateTransitionWASM`
+
+```js
+const dataContractIdentifier = new IdentifierWASM('GnXgMaiqAwTxh44ccQe8AoCgFvcseHK5CncH3sUorW4X')
+const ownerIdentifier = new IdentifierWASM('CXH2kZCATjvDTnQAPVg28EgPg9WySUvwvnR5ZkmNqY5i')
+
+const properties = {"message": "Tutorial CI Test @ Tue, 07 Jan 2025 15:27:50 GMT"}
+
+const documentInstance = new DocumentWASM(properties, "note", BigInt(1), dataContractIdentifier, ownerIdentifier)
+
+const purchaseTransition = new DocumentPurchaseTransitionWASM(documentInstance, BigInt(1), 'preorder', BigInt(100))
+
+purchaseTransition.toDocumentTransition() // -> DocumentTransitionWASM
+```

package/docs/DocumentReplaceTransition.md

@@ -0,0 +1,112 @@
+# DocumentReplaceTransitionWASM
+
+This class allows to create DocumentReplaceTransition and interact
+
+`DocumentReplaceTransitionWASM` can be created via constructor and document transition `fromDocumentTransition()`
+
+Constructor arguments:
+
+- `document -> DocumentWASM`
+- `identityContractNonce -> BigInt`
+- `documentTypeName -> String`
+
+___
+
+## Navigation
+
+- [Example](#example)
+- [Fields](#fields)
+    - [base](#base)
+    - [data](#data)
+    - [revision](#revision)
+- [Getters methods](#getters-methods)
+    - [toDocumentTransition](#todocumenttransition)
+
+___
+
+## Example
+
+```js
+const dataContractIdentifier = new IdentifierWASM('GnXgMaiqAwTxh44ccQe8AoCgFvcseHK5CncH3sUorW4X')
+const ownerIdentifier = new IdentifierWASM('CXH2kZCATjvDTnQAPVg28EgPg9WySUvwvnR5ZkmNqY5i')
+
+const properties = {"message": "Tutorial CI Test @ Tue, 07 Jan 2025 15:27:50 GMT"}
+
+const documentInstance = new DocumentWASM(properties, "note", BigInt(1), dataContractIdentifier, ownerIdentifier)
+
+const replaceTransition = new DocumentReplaceTransitionWASM(documentInstance, BigInt(1), 'preorder')
+```
+
+___
+
+## Fields
+
+All fields are readable and writable.
+
+### `base`
+
+Contains document base transition `DocumentBaseTransitionWASM`
+
+```js
+const replaceTransition = new DocumentReplaceTransitionWASM(documentInstance, BigInt(1), 'preorder')
+
+const base = new DocumentBaseTransitionWASM(
+  '9tSsCqKHTZ8ro16MydChSxgHBukFW36eMLJKKRtebJEn',
+  BigInt(12350),
+  'note',
+  'CXH2kZCATjvDTnQAPVg28EgPg9WySUvwvnR5ZkmNqY5i'
+)
+
+replaceTransition.base // -> DocumentBaseTransitionWASM
+
+replaceTransition.base = base 
+```
+
+___
+
+### `data`
+
+Contains document data in `Object`
+
+```js
+const replaceTransition = new DocumentReplaceTransitionWASM(documentInstance, BigInt(1), 'preorder')
+
+replaceTransition.data // -> Object
+
+replaceTransition.data = {"message": "Tutorial CI Test @ Tue, 07 Jan 2025 15:27:50 GMT"}
+```
+
+___
+
+### `revision`
+
+Contains document revision in `BigInt`
+
+```js
+const replaceTransition = new DocumentReplaceTransitionWASM(documentInstance, BigInt(1), 'preorder')
+
+replaceTransition.revision // -> BigInt
+
+replaceTransition.revision = BigInt(213)
+```
+
+___
+
+## Getters methods
+
+### `toDocumentTransition`
+
+Returns document create transition in `DocumentCreateTransitionWASM`
+
+```js
+const dataContractIdentifier = new IdentifierWASM('GnXgMaiqAwTxh44ccQe8AoCgFvcseHK5CncH3sUorW4X')
+const ownerIdentifier = new IdentifierWASM('CXH2kZCATjvDTnQAPVg28EgPg9WySUvwvnR5ZkmNqY5i')
+
+const properties = {"message": "Tutorial CI Test @ Tue, 07 Jan 2025 15:27:50 GMT"}
+
+const documentInstance = new DocumentWASM(properties, "note", BigInt(1), dataContractIdentifier, ownerIdentifier)
+
+const deleteTransition = new DocumentDeleteTransitionWASM(documentInstance, BigInt(1), 'preorder')
+
+deleteTransition.toDocumentTransition() // -> DocumentTransitionWASM
+```

package/docs/DocumentTransferTransition.md

@@ -0,0 +1,96 @@
+# DocumentTransferTransitionWASM
+
+This class allows to create DocumentTransferTransition and interact
+
+`DocumentTransferTransitionWASM` can be created via constructor and document transition `fromDocumentTransition()`
+
+Constructor arguments:
+
+- `document -> DocumentWASM`
+- `identityContractNonce -> BigInt`
+- `documentTypeName -> String`
+- `recipientId -> IdentifierWASM | String | ArrayLike`
+___
+
+## Navigation
+
+- [Example](#example)
+- [Fields](#fields)
+    - [base](#base)
+    - [recipientId](#recipientid)
+- [Getters methods](#getters-methods)
+    - [toDocumentTransition](#todocumenttransition)
+
+___
+
+## Example
+
+```js
+const dataContractIdentifier = new IdentifierWASM('GnXgMaiqAwTxh44ccQe8AoCgFvcseHK5CncH3sUorW4X')
+const ownerIdentifier = new IdentifierWASM('CXH2kZCATjvDTnQAPVg28EgPg9WySUvwvnR5ZkmNqY5i')
+const recipientIdentifier = new IdentifierWASM('HzHXSQcBkU9Ve5YAxhGd8NgA72xFcG9nCZKKxhayn1NW')
+
+const properties = {"message": "Tutorial CI Test @ Tue, 07 Jan 2025 15:27:50 GMT"}
+
+const documentInstance = new DocumentWASM(properties, "note", BigInt(1), dataContractIdentifier, ownerIdentifier)
+
+const transferTransition = new DocumentTransferTransitionWASM(documentInstance, BigInt(1), 'preorder', recipientIdentifier)
+```
+___
+## Fields
+All fields are readable and writable.
+
+### `base`
+
+Contains document base transition `DocumentBaseTransitionWASM`
+
+```js
+const transferTransition = new DocumentTransferTransitionWASM(documentInstance, BigInt(1), 'preorder', recipientIdentifier)
+
+const base = new DocumentBaseTransitionWASM(
+  '9tSsCqKHTZ8ro16MydChSxgHBukFW36eMLJKKRtebJEn',
+  BigInt(12350),
+  'note',
+  'CXH2kZCATjvDTnQAPVg28EgPg9WySUvwvnR5ZkmNqY5i'
+)
+
+transferTransition.base // -> DocumentBaseTransitionWASM
+
+transferTransition.base = base 
+```
+
+___
+
+### `recipientId`
+
+Contains recipient identifier in `IdentifierWASM`
+
+```js
+const transferTransition = new DocumentTransferTransitionWASM(documentInstance, BigInt(1), 'preorder', recipientIdentifier)
+
+transferTransition.recipientId // -> IdentifierWASM
+
+transferTransition.recipientId = 'CXH2kZCATjvDTnQAPVg28EgPg9WySUvwvnR5ZkmNqY5i'
+```
+
+___
+
+## Getters methods
+
+### `toDocumentTransition`
+
+Returns document create transition in `DocumentCreateTransitionWASM`
+
+```js
+const dataContractIdentifier = new IdentifierWASM('GnXgMaiqAwTxh44ccQe8AoCgFvcseHK5CncH3sUorW4X')
+const ownerIdentifier = new IdentifierWASM('CXH2kZCATjvDTnQAPVg28EgPg9WySUvwvnR5ZkmNqY5i')
+const recipientIdentifier = new IdentifierWASM('HzHXSQcBkU9Ve5YAxhGd8NgA72xFcG9nCZKKxhayn1NW')
+
+const properties = {"message": "Tutorial CI Test @ Tue, 07 Jan 2025 15:27:50 GMT"}
+
+const documentInstance = new DocumentWASM(properties, "note", BigInt(1), dataContractIdentifier, ownerIdentifier)
+
+const transferTransition = new DocumentTransferTransitionWASM(documentInstance, BigInt(1), 'preorder', recipientIdentifier)
+
+transferTransition.toDocumentTransition() // -> DocumentTransitionWASM
+```

package/docs/DocumentTransition.md

@@ -0,0 +1,125 @@
+# DocumentTransitionWASM
+
+This class allows to crate DocumentTransitions and interact
+
+`DocumentTransitionWASM` can't be created via constructor
+or any other methods for deserialization
+
+Instance of `DocumentTransitionWASM` can be returned from getters
+of other instances, like `DocumentBatchWASM` or any DocumentTransition
+___
+
+## Navigation
+
+- [Fields](#fields)
+    - [actionType](#actiontype)
+    - [dataContractId](#datacontractid)
+    - [revision](#revision)
+    - [identityContractNonce](#identitycontractnonce)
+    - [id](#id)
+    - [documentTypeName](#documenttypename)
+    - [entropy](#entropy)
+    - [Transition conversions](#transition-conversions)
+
+___
+
+## Fields
+
+All fields are read-only, exception: `dataContractId`, `revision`, `identityContractNonce`
+
+### `actionType`
+
+Contains action `String` from `BatchTypeEnum`
+
+````js
+transitionInstance.actionType // -> String
+````
+
+___
+
+### `dataContractId`
+
+Contains DataContract identifier in `IdentifierWASM`
+
+```js
+transitionInstance.dataContractId // -> IdentifierWASM
+
+transitionInstance.dataContractId = 'GgZekwh38XcWQTyWWWvmw6CEYFnLU7yiZFPWZEjqKHit'
+```
+
+___
+
+### `revision`
+
+Contains revision in `BigInt`
+
+```js
+transitionInstance.revision // -> BigInt
+
+transitionInstance.revision = BigInt(1)
+```
+
+___
+
+### `identityContractNonce`
+
+Contains identity contract nonce in `BigInt`
+
+```js
+transitionInstance.identityContractNonce // -> BigInt
+
+transitionInstance.identityContractNonce = BigInt(12)
+```
+
+___
+
+### `id`
+
+Contains document identity in `IdentifierWASM`
+
+```js
+transitionInstance.id // -> IdentifierWASM
+```
+
+___
+
+### `documentTypeName`
+
+Contains document type name in `String`
+
+```js
+transitionInstance.documentTypeName // -> String
+```
+
+___
+
+### `entropy`
+
+Contains entropy in `Uint8Array` for transition with entropy
+
+```js
+transitionInstance.entropy // -> Uint8Array
+```
+
+___
+
+### Transition conversions
+
+Every DocumentTransition contains one of available Document Transition.
+You can get one of they by these fields:
+
+- `createTransition`
+- `replaceTransition`
+- `deleteTransition`
+- `purchaseTransition`
+- `transferTransition`
+- `updatePriceTransition`
+
+```js
+transitionInstance.createTransition // -> DocumentCreateTransitionWASM
+transitionInstance.replaceTransition // -> DocumentReplaceTransitionWASM
+transitionInstance.deleteTransition // -> DocumentDeleteTransitionWASM
+transitionInstance.purchaseTransition // -> DocumentPurchaseTransitionWASM
+transitionInstance.transferTransition // -> DocumentTransferTransitionWASM
+transitionInstance.updatePriceTransition // -> DocumentUpdatePriceTransitionWASM
+```

package/docs/DocumentUpdatePriceTransition.md

@@ -0,0 +1,109 @@
+# DocumentUpdatePriceTransitionWASM
+
+This class allows to create DocumentUpdatePriceTransition and interact
+
+`DocumentUpdatePriceTransitionWASM` can be created via constructor and document transition `fromDocumentTransition()`
+
+Constructor arguments:
+
+- `document -> DocumentWASM`
+- `identityContractNonce -> BigInt`
+- `documentTypeName -> String`
+- `price -> BigInt`
+
+___
+
+## Navigation
+
+- [Example](#example)
+- [Fields](#fields)
+    - [base](#base)
+    - [price](#price)
+    - [revision](#revision)
+- [Getters methods](#getters-methods)
+    - [toDocumentTransition](#todocumenttransition)
+
+___
+
+## Example
+
+```js
+const dataContractIdentifier = new IdentifierWASM('GnXgMaiqAwTxh44ccQe8AoCgFvcseHK5CncH3sUorW4X')
+const ownerIdentifier = new IdentifierWASM('CXH2kZCATjvDTnQAPVg28EgPg9WySUvwvnR5ZkmNqY5i')
+
+const properties = {"message": "Tutorial CI Test @ Tue, 07 Jan 2025 15:27:50 GMT"}
+
+const documentInstance = new DocumentWASM(properties, "note", BigInt(1), dataContractIdentifier, ownerIdentifier)
+
+const updatePriceTransition = new DocumentUpdatePriceTransitionWASM(documentInstance, BigInt(1), 'preorder', BigInt(100))
+```
+
+___
+
+## Fields
+
+All fields are readable and writable.
+
+### `base`
+
+Contains document base transition `DocumentBaseTransitionWASM`
+
+```js
+const updatePriceTransition = new DocumentUpdatePriceTransitionWASM(documentInstance, BigInt(1), 'preorder', BigInt(100))
+
+const base = new DocumentBaseTransitionWASM(
+  '9tSsCqKHTZ8ro16MydChSxgHBukFW36eMLJKKRtebJEn',
+  BigInt(12350),
+  'note',
+  'CXH2kZCATjvDTnQAPVg28EgPg9WySUvwvnR5ZkmNqY5i'
+)
+
+updatePriceTransition.base // -> DocumentBaseTransitionWASM
+
+updatePriceTransition.base = base 
+```
+
+___
+
+### `price`
+
+Contains price for purchase in `BigInt`
+
+```js
+updatePriceTransition.price // -> BigInt
+
+updatePriceTransition.price = BigInt(213)
+```
+
+___
+
+### `revision`
+
+Contains document revision in `BigInt`
+
+```js
+updatePriceTransition.revision // -> BigInt
+
+updatePriceTransition.revision = BigInt(213)
+```
+
+___
+
+## Getters methods
+
+### `toDocumentTransition`
+
+Returns document create transition in `DocumentCreateTransitionWASM`
+
+```js
+const dataContractIdentifier = new IdentifierWASM('GnXgMaiqAwTxh44ccQe8AoCgFvcseHK5CncH3sUorW4X')
+const ownerIdentifier = new IdentifierWASM('CXH2kZCATjvDTnQAPVg28EgPg9WySUvwvnR5ZkmNqY5i')
+
+const properties = {"message": "Tutorial CI Test @ Tue, 07 Jan 2025 15:27:50 GMT"}
+
+const documentInstance = new DocumentWASM(properties, "note", BigInt(1), dataContractIdentifier, ownerIdentifier)
+
+const updatePriceTransition = new DocumentUpdatePriceTransitionWASM(documentInstance, BigInt(1), 'preorder', BigInt(100))
+
+updatePriceTransition.toDocumentTransition() // -> DocumentTransitionWASM
+```

package/docs/DocumentsBatch.md

@@ -0,0 +1,133 @@
+# DocumentsBatchWASM
+
+This class allows to create DocumentBatch from transitions and interact
+
+`DocumentsBatchWASM` can be created from constructor, bytes and state transition
+
+Constructor arguments:
+
+- `documentTransitions -> [DocumentTransitionWASM]`
+- `ownerId -> IdentifierWASM | String | ArrayLike`
+- `userFeeIncrease -> Number`
+- `publicKeyId -> ?Number`
+- `signature -> ?ArrayLike`
+
+If you want to create instance from bytes,
+use `fromBytes()` with `ArrayLike` as argument.
+Also, you can use `fromStateTransition` with
+`StateTransitionWASM` instance as argument
+
+___
+
+## Navigation
+
+- [Example](#example)
+- [Fields](#fields)
+    - [transitions](#transitions)
+    - [signature](#signature)
+    - [signaturePublicKeyId](#signaturepublickeyid)
+    - [allPurchasesAmount](#allpurchasesamount)
+    - [ownerId](#ownerid)
+    - [modifiedDataIds](#modifieddataids)
+    - [allConflictingIndexCollateralVotingFunds](#allconflictingindexcollateralvotingfunds)
+
+___
+
+## Example
+
+```js
+const documentInstance = new DocumentWASM(document, documentTypeName, revision, dataContractId, ownerId, id)
+const createTransition = new DocumentCreateTransitionWASM(documentInstance, BigInt(1), 'preorder')
+
+const documentTransition = createTransition.toDocumentTransition()
+
+const batchTransition = new DocumentsBatchWASM([documentTransition], documentInstance.getOwnerId(), 1)
+```
+
+___
+
+## Fields
+
+Not all fields are readable and writable.
+
+### `transitions`
+
+Contains array of `DocumentTransitionWASM` in `[DocumentTransitionWASM]`
+
+```js
+batchTransition.transitions // -> [DocumentTransitionWASM]
+
+batchTransition.transitions = [documentTransition1, documentTransition2]
+```
+
+___
+
+### `signature`
+
+Contains array of bytes in `Uint8Array`
+
+```js
+batchTransition.signature // -> Uint8Array
+
+batchTransition.signature = [1, 2, 3]
+```
+
+___
+
+### `signaturePublicKeyId`
+
+Contains key id for signature in `Number`
+
+```js
+batchTransition.signaturePublicKeyId // -> Number
+
+batchTransition.signaturePublicKeyId = 3
+```
+
+___
+
+### `allPurchasesAmount`
+
+Contains amount of credits for purchase in `BigInt`
+
+**ONLY READ**
+
+```js
+batchTransition.allPurchasesAmount // -> BigInt
+```
+
+___
+
+### `ownerId`
+
+Contains owner id in `IdentifierWASM`
+
+**ONLY READ**
+
+```js
+batchTransition.ownerId // -> IdentifierWASM
+```
+
+___
+
+### `modifiedDataIds`
+
+Contains array of ids for modifier data in `[IdentifierWASM]`
+
+**ONLY READ**
+
+```js
+batchTransition.ownerId // -> IdentifierWASM
+```
+
+___
+
+### `allConflictingIndexCollateralVotingFunds`
+
+Contains array conflicting funds in `BigInt`
+
+**ONLY READ**
+
+```js
+batchTransition.allConflictingIndexCollateralVotingFunds // -> BigInt
+```