pshenmic-dpp 1.0.4 → 1.0.6

package/docs/ChainLockProof.md

@@ -0,0 +1,63 @@
+# ChainAssetLockProofWASM
+This class allows to create and interact with ChainAssetLockProof struct
+
+`ChainAssetLockProofWASM` can be created via constructor and `fromRawObject`
+
+Constructor arguments: 
+- `coreChainLockedHeight -> Number`
+- `outPoint -> OutPointWASM`
+
+___
+
+## Navigation
+
+- [Example](#Example)
+- [Fields](#fields)
+- [Static](#static)
+
+___
+
+### Example
+
+```js
+const outpoint = new wasm.OutPointWASM('e8b43025641eea4fd21190f01bd870ef90f1a8b199d8fc3376c5b62c0b1a179d', 1)
+
+const chainlock = new wasm.ChainAssetLockProofWASM(11, outpoint)
+// or
+const chainlock = wasm.ChainAssetLockProofWASM.fromRawObject({
+  coreChainLockedHeight: 11,
+  outPoint: Array.from(outpoint.toBytes())
+})
+```
+
+___
+
+
+## Fields
+All fields are readable and writable.
+
+### `coreChainLockedHeight`
+Contains core chain locked height in `Number`
+
+```js
+chainlock.coreChainLockedHeight = 1111
+
+chainlock.coreChainLockedHeight // -> Number
+```
+
+___
+
+### `outPoint`
+Contains out point for chain asset lock proof in `OutPointWASM`
+
+```js
+const outpoint = new wasm.OutPointWASM('e8b43025641eea4fd21190f01bd870ef90f1a8b199d8fc3376c5b62c0b1a179d', 1)
+
+chainlock.outPoint = 1111
+
+chainlock.outPoint // -> OutPointWASM
+```
+
+___
+
+## Static

package/docs/CoreScript.md

@@ -0,0 +1,17 @@
+# CoreScriptWASM
+
+This class allows to create and interact with CoreScript struct.
+
+`CoreScriptWASM` can be created via 3 methods or from other classes
+
+```js
+const script = wasm.CoreScriptWASM.fromBytes([118, 169, 20, 195, 219, 253, 64, 231, 248, 164, 132, 92, 47, 142, 134, 138, 22, 124, 152, 64, 73, 118, 73, 136, 172])
+// or
+const script = wasm.CoreScriptWASM.newP2PKH([195, 219, 253, 64, 231, 248, 164, 132, 92, 47, 142, 134, 138, 22, 124, 152, 64, 73, 118, 73])
+// or
+const script = wasm.CoreScriptWASM.newP2SH([195, 219, 253, 64, 231, 248, 164, 132, 92, 47, 142, 134, 138, 22, 124, 152, 64, 73, 118, 73])
+
+script.toASMString() // -> ASM String
+
+script.toBytes() // -> Uint8Array
+```

package/docs/DataContract.md

@@ -0,0 +1,192 @@
+# DataContractWASM
+
+This class allows to create instance of DataContract and interact with him.
+
+You can create `DataContractWASM` via constructor, bytes and from raw value
+
+Arguments in constructor:
+
+- `ownerId -> IdentifierWASM | String | ArrayLike`
+- `identityNonce -> BigInt`
+- `schema -> Object`
+- `definitions -> Object | undefined`
+- `fullValidation -> Boolean`
+- `platformVersion -> ?PlatformVersionEnum`
+
+If you want to create DataContract from bytes,
+you need to use serialized to bytes DataContract from `rs-dpp` or `pshenmic-dpp`
+
+This class also contains static method for DataContract id generation:
+
+- `generateId`
+    - `ownerId -> IdentifierWASM | String | ArrayLike`
+    - `nonce -> BigInt`
+
+___
+
+## Navigation
+
+- [Example](#example)
+- [Getters methods](#getters-methods)
+    - [getSchema](#getschema)
+    - [getVersion](#getversion)
+    - [getId](#getid)
+    - [getOwnerId](#getownerid)
+    - [getConfig](#getconfig)
+- [Setters methods](#setters-methods)
+    - [setSchema](#setschema)
+    - [setVersion](#setversion)
+    - [setId](#setid)
+    - [setOwnerId](#setownerid)
+    - [setConfig](#setconfig)
+
+___
+
+## Example
+
+```js
+const identifier = new IdentifierWASM('11111111111111111111111111111111')
+const schema = {
+  "note": {
+    "type": "object",
+    "properties": {
+      "message": {
+        "type": "string",
+        "position": 0
+      }
+    },
+    "additionalProperties": false
+  }
+}
+
+const dataContract = new DataContractWASM(identifier, BigInt(2), schema, null, false)
+```
+
+___
+
+## Getters methods
+
+### `getSchema`
+
+Returns DataContract schema as `Object`
+
+```js
+dataContractInstance.getSchema() // -> Object
+```
+
+___
+
+### `getVersion`
+
+Returns DataContract version in `Number`
+
+```js
+dataContractInstance.getVersion() // -> Number
+```
+
+___
+
+### `getId`
+
+Returns DataContract identifier in `IdentifierWASM`
+
+```js
+dataContractInstance.getId() // -> IdentifierWASM
+```
+
+___
+
+### `getOwnerId`
+
+Returns DataContract owner identifier in `IdentifierWASM`
+
+```js
+dataContractInstance.getOwnerId() // -> IdentifierWASM
+```
+
+___
+
+### `getConfig`
+
+Returns DataContract config in `Object`
+
+```js
+dataContractInstance.getConfig() // -> Object
+```
+
+___
+
+## Setters methods
+
+### `setSchema`
+
+Allows to set DataContract schema in `Object`
+
+```js
+const schema = {
+  "note": {
+    "type": "object",
+    "properties": {
+      "message": {
+        "type": "string",
+        "position": 0
+      }
+    },
+    "additionalProperties": false
+  }
+}
+
+dataContractInstance.setSchema(schema)
+```
+
+___
+
+### `setVersion`
+
+Allows to set DataContract version in `Number`
+
+```js
+dataContractInstance.setVersion(11)
+```
+
+___
+
+### `setId`
+
+Allows to set DataContract identifier in `IdentifierWASM | String | ArrayLike`
+
+```js
+dataContractInstance.setId('GgZekwh38XcWQTyWWWvmw6CEYFnLU7yiZFPWZEjqKHit') 
+```
+
+___
+
+### `setOwnerId`
+
+Allows to set DataContract owner identifier in `IdentifierWASM | String | ArrayLike`
+
+```js
+dataContractInstance.setOwnerId('GgZekwh38XcWQTyWWWvmw6CEYFnLU7yiZFPWZEjqKHit')
+```
+
+___
+
+### `setConfig`
+
+Allows to set DataContract config in `Object`
+
+```js
+const config = {
+  "$format_version": "0",
+  "canBeDeleted": false,
+  "readonly": false,
+  "keepsHistory": false,
+  "documentsKeepHistoryContractDefault": false,
+  "documentsMutableContractDefault": true,
+  "documentsCanBeDeletedContractDefault": true,
+  "requiresIdentityEncryptionBoundedKey": null,
+  "requiresIdentityDecryptionBoundedKey": null
+}
+
+dataContractInstance.setConfig(config)
+```

package/docs/DataContractCreateTransition.md

@@ -0,0 +1,84 @@
+# DataContractCreateTransitionWASM
+
+This class allows to create DataContractCreateTransition and interact
+
+`DataContractCreateTransitionWASM` can be created via constructor, bytes and state transition
+
+Constructor arguments:
+
+- `dataContract -> DataContractWASM`
+- `identityContractNonce -> BigInt`
+- `platformVersion -> ?PlatformVersionEnum`
+
+___
+
+## Navigation
+
+- [Example](#example)
+- [Getters methods](#getters-methods)
+  - [getFeatureVersion](#getfeatureversion)
+  - [verifyProtocolVersion](#verifyprotocolversion)
+  - [getDataContract](#getdatacontract)
+- [Setters methods](#setters-methods)
+  - [setDataContract](#setdatacontract)
+
+___
+
+## Example
+
+```js
+const dataContract = DataContractWASM.fromValue(value, false, PlatformVersionWASM.PLATFORM_V1)
+
+const dataContractTransition = new DataContractCreateTransitionWASM(dataContract, BigInt(1))
+```
+
+___
+
+## Getters methods
+
+### `getFeatureVersion`
+
+Returns feature version of transition in `Number`
+
+```js
+dataContractTransition.getFeatureVersion() // -> Number
+```
+
+___
+
+### `verifyProtocolVersion`
+
+Returns `Boolean` if selected protocol version equal protocol version in transition
+
+```js
+dataContractTransition.verifyProtocolVersion(1) // -> Boolean
+```
+
+___
+
+### `getDataContract`
+
+Returns DataContract in `DataContractWASM`
+
+Arguments:
+
+- `pltaformVersion -> PlatformVersionEnum`
+- `fullValidation -> Boolean`
+
+```js
+dataContractTransition.getDataContract('PLATFORM_V1', true) // -> DataContractWASM 
+```
+
+___
+
+## Setters methods
+
+### `setDataContract`
+
+Allows to set DataContract in `DataContractWASM` with `PlatformVersionEnum`
+
+```js
+const dataContract = DataContractWASM.fromValue(value, false, PlatformVersionWASM.PLATFORM_V1)
+
+dataContractTransition.setDataContract('PLATFORM_V1')
+```

package/docs/DataContractUpdateTransition.md

@@ -0,0 +1,84 @@
+# DataContractUpdateTransitionWASM
+
+This class allows to create DataContractUpdateTransition and interact
+
+`DataContractUpdateTransitionWASM` can be created via constructor, bytes and state transition
+
+Constructor arguments:
+
+- `dataContract -> DataContractWASM`
+- `identityContractNonce -> BigInt`
+- `platformVersion -> ?PlatformVersionEnum`
+
+___
+
+## Navigation
+
+- [Example](#example)
+- [Getters methods](#getters-methods)
+    - [getFeatureVersion](#getfeatureversion)
+    - [verifyProtocolVersion](#verifyprotocolversion)
+    - [getDataContract](#getdatacontract)
+- [Setters methods](#setters-methods)
+    - [setDataContract](#setdatacontract)
+
+___
+
+## Example
+
+```js
+const dataContract = DataContractWASM.fromValue(value, false, PlatformVersionWASM.PLATFORM_V1)
+
+const dataContractTransition = new DataContractUpdateTransitionWASM(dataContract, BigInt(1))
+```
+
+___
+
+## Getters methods
+
+### `getFeatureVersion`
+
+Returns feature version of transition in `Number`
+
+```js
+dataContractTransition.getFeatureVersion() // -> Number
+```
+
+___
+
+### `verifyProtocolVersion`
+
+Returns `Boolean` if selected protocol version equal protocol version in transition
+
+```js
+dataContractTransition.verifyProtocolVersion(1) // -> Boolean
+```
+
+___
+
+### `getDataContract`
+
+Returns DataContract in `DataContractWASM`
+
+Arguments:
+
+- `pltaformVersion -> PlatformVersionEnum`
+- `fullValidation -> Boolean`
+
+```js
+dataContractTransition.getDataContract('PLATFORM_V1', true) // -> DataContractWASM 
+```
+
+___
+
+## Setters methods
+
+### `setDataContract`
+
+Allows to set DataContract in `DataContractWASM` with `PlatformVersionEnum`
+
+```js
+const dataContract = DataContractWASM.fromValue(value, false, PlatformVersionWASM.PLATFORM_V1)
+
+dataContractTransition.setDataContract('PLATFORM_V1')
+```