pshenmic-dpp 1.0.4 → 1.0.6

package/Cargo.toml

@@ -1,43 +1,52 @@
+[package]
+name = "pshenmic-dpp"
+version = "1.0.6"
+edition = "2024"
+rust-version = "1.85"
+
+[workspace.package]
+version = "1.0.5"
+
 [workspace]
 resolver = "2"
 members = [
     "packages/document",
-    "packages/document_batch",
+    "packages/documents_batch",
     "packages/cbor_conversation",
     "packages/enums",
     "packages/mock_bls",
     "packages/private_key",
-    "packages/public_key",
+    "packages/identity_public_key",
     "packages/utils",
     "packages/identity",
     "packages/identity_transitions",
     "packages/state_transition",
-    "packages/data_contract"
-, "packages/data_contract_transitions"]
+    "packages/data_contract",
+    "packages/asset_lock_proof",
+    "packages/data_contract_transitions", "packages/core_script"]
 
 [lib]
 crate-type = ["cdylib", "lib"]
 
-[package]
-name = "pshenmic-dpp"
-version = "1.0.4"
-edition = "2024"
-rust-version = "1.85"
-
 [dependencies]
-bincode = { version = "=2.0.0-rc.3" }
-bincode_derive = { version = "=2.0.0-rc.3" }
-pshenmic_dpp_document_batch = { path = "packages/document_batch" }
+wee_alloc = { version = "0.4.5", default-features = false }
+bincode = "=2.0.0-rc.3"
+bincode_derive = "=2.0.0-rc.3"
+pshenmic_dpp_documents_batch = { path = "packages/documents_batch" }
 pshenmic_dpp_document_search = { path = "packages/cbor_conversation" }
 pshenmic_dpp_identity = { path = "packages/identity" }
+pshenmic_dpp_identifier = { path = "packages/identifier" }
 pshenmic_dpp_state_transition = { path = "packages/state_transition" }
 pshenmic_dpp_identity_transitions = { path = "packages/identity_transitions" }
-pshenmic_dpp_data_contract = {path = "packages/data_contract"}
-pshenmic_dpp_data_contract_transitions = {path = "packages/data_contract_transitions"}
-pshenmic_dpp_enums = {path = "packages/enums"}
+pshenmic_dpp_data_contract = { path = "packages/data_contract" }
+pshenmic_dpp_data_contract_transitions = { path = "packages/data_contract_transitions" }
+pshenmic_dpp_enums = { path = "packages/enums" }
 
 [profile.release]
-lto = true
-opt-level = 'z'
-strip = true
+lto = "fat"
+opt-level = "z"
+strip = "symbols"
 codegen-units = 1
+panic = "abort"
+incremental = false
+debug = false

package/README.md

@@ -1,26 +1,81 @@
 # PSHENMIC-DPP
+### **AT THIS MOMENT MODULE UNDER DEVELOPMENT**
 
-
+## General
+Pshenmic-dpp is package with rust bindings for JS 
 
 That module uses [rs-dpp](https://github.com/dashpay/platform) and creates bindings for JavaScript.
-Each structure from rs-dpp is represented by a separate package, so you can build not the whole module, but only a part of it
+Each structure from rs-dpp is represented by a separate package, so you can build not the whole module, but only a part of it.
+
+One of the advantages of this module is that you can build `.wasm` file not with all modules, but only with the ones you are interested in + minimal dependencies for them
+___
+## How To Install
+`yarn add pshenmic-dpp`
+___
+## Manual Building
+### Install dependencies
+`yarn`
+
+### Build JS
+`yarn build:full`
+
+**NOTE. If you want to use ES6 module without CJS, you need to run `yarn babel`**
+
+### Build with binary instead base64
+`yarn build:raw`
+Now you can import `.js` with base64 buffer for WebAssembly module, or binary which smaller
+___
+## Why you need to use `pshenmic-dpp` instead `wasm-dpp`
+
+- `pshenmic-dpp` weighs much less, currently taking up only 2.8 mb in base64 format
+- You can build only necessary modules by removing imports from `lib.rs` before building
+- More accurately replicates `rs-dpp`
+- Some sugar, like enums, which you can pass in string with any case or just use numbers
+___
+
+## Current features
 
 **At this moment available structs:**
 - `Document`
 - `DocumentsBatch`
+- `DocumentsBaseTransition`
+- `DocumentsTransition`
+- `PrefundedVotingBalance`
+- DocumentsTransitions:
+  - `DocuemntCreateTransition`
+  - `DocuemntDeleteTransition`
+  - `DocuemntPurchaseTransition`
+  - `DocuemntReplaceTransition`
+  - `DocumentTransferTransition`
+  - `DocumentUpdatePriceTransition`
 - `IdentityPublicKey`
+- IdentityTransitions:
+  - `IdentityCreateTransition`
+  - `IdentityCreditWithdrawalTransition`
+  - `IdentityCreditTransferTransition`
+  - `IdentityTopUpTransition`
+  - `IdentityUpdateTransition`
+- `IdentityPublicKeyInCreationWASM`
+- `AssetLockProof`
+- `OutPoint`
+- `TxOut`
+- `CoreScript`
 - `PrivateKey`
 - `Identity`
 - `StateTransition`
-- `IdentityTransitions`
 - `DataContract`
 - `Enums`
 
-## How to build
-Default scripts allows to build full module
+**At this moment available static methods**
+- `objectToCbor`
+- `cborToObject`
+- `generateId` for data contract class
+- `generateId` for document class
+- 
+
+## How to run unit tests
 ```
-yarn
-yarn build:full
+yarn tests
 ```
 
 ## Example
@@ -29,12 +84,6 @@ yarn build:full
 import * as wasm from '../wasm/pshenmic_dpp';
 import wasmBytes from "../wasm/pshenmic_dpp_bg"
 
-function toHexString(byteArray) {
-  return Array.prototype.map.call(byteArray, function(byte) {
-    return ('0' + (byte & 0xFF).toString(16)).slice(-2);
-  }).join('');
-}
-
 let binaryString = atob(wasmBytes);
 let bytes = new Uint8Array(binaryString.length);
 for (let i = 0; i < binaryString.length; i++) {
@@ -43,7 +92,7 @@ for (let i = 0; i < binaryString.length; i++) {
 
 wasm.initSync({module: bytes.buffer})
 
-const document = wasm.DocumentWASM.new(
+const document = new wasm.DocumentWASM(
     {
         "name": "MyPool",
         "type": "EVONODE",
@@ -56,7 +105,7 @@ const document = wasm.DocumentWASM.new(
     "B7kcE1juMBWEWkuYRJhVdAE2e6RaevrGxRsa1DrLCpQH"
 )
 
-const pubKey = wasm.IdentityPublicKeyWASM.new(
+const pubKey = new wasm.IdentityPublicKeyWASM(
     1,
     wasm.Purpose.AUTHENTICATION,
     wasm.SecurityLevel.HIGH,
@@ -65,15 +114,18 @@ const pubKey = wasm.IdentityPublicKeyWASM.new(
     'your_binary_data_in_hex'
 )
 
-const privKey = wasm.PrivateKeyWASM.new('wif_key')
+const privKey = new wasm.PrivateKeyWASM('your_wif_key')
 
-const batch = wasm.DocumentBatchWASM.new(
-    wasm.BatchType.CREATE,
-    document,
-    BigInt(3),
-)
+const createTransition = new wasm.DocumentCreateTransitionWASM(document, BigInt(1), 'preorder')
+
+const documentTransition = createTransition.toDocumentTransition()
+
+const batchTransition = new wasm.DocumentsBatchWASM([documentTransition, documentTransition], Array.from(documentInstance.getOwnerId()), 1)
+
+const st = batchTransition.toStateTransition()
 
-batch.sign(privKey, pubKey)
+st.sign(privKey, pubKey)
 
-console.log(toHexString(batch.toBuffer()))
+console.log(st.toBytes())
+console.log(st.hash(false))
 ```

package/babel.config.json

@@ -0,0 +1,19 @@
+{
+  "presets": [
+    [
+      "@babel/preset-env",
+      {
+        "targets": {
+          "edge": "17",
+          "firefox": "60",
+          "chrome": "67",
+          "safari": "11.1",
+          "node": "18"
+        },
+        "useBuiltIns": "usage",
+        "corejs": "3.6.5"
+      }
+    ]
+  ],
+  "plugins": ["@babel/plugin-transform-modules-commonjs"]
+}

package/dist/wasm/index.d.ts

@@ -0,0 +1,52 @@
+import * as DPP from './pshenmic_dpp';
+
+export * from './pshenmic_dpp';
+
+export class DashPlatformProtocolWASM {
+    // CLASSES
+    AssetLockProofWASM: typeof DPP.AssetLockProofWASM
+    ChainAssetLockProofWASM: typeof DPP.ChainAssetLockProofWASM
+    CoreScriptWASM: typeof DPP.CoreScriptWASM
+    DataContractCreateTransitionWASM: typeof DPP.DataContractCreateTransitionWASM
+    DataContractUpdateTransitionWASM: typeof DPP.DataContractUpdateTransitionWASM
+    DataContractWASM: typeof DPP.DataContractWASM
+    DocumentBaseTransitionWASM: typeof DPP.DocumentBaseTransitionWASM
+    DocumentCreateTransitionWASM: typeof DPP.DocumentCreateTransitionWASM
+    DocumentDeleteTransitionWASM: typeof DPP.DocumentDeleteTransitionWASM
+    DocumentPurchaseTransitionWASM: typeof DPP.DocumentPurchaseTransitionWASM
+    DocumentReplaceTransitionWASM: typeof DPP.DocumentReplaceTransitionWASM
+    DocumentTransferTransitionWASM: typeof DPP.DocumentTransferTransitionWASM
+    DocumentTransitionWASM: typeof DPP.DocumentTransitionWASM
+    DocumentUpdatePriceTransitionWASM: typeof DPP.DocumentUpdatePriceTransitionWASM
+    DocumentWASM: typeof DPP.DocumentWASM
+    DocumentsBatchWASM: typeof DPP.DocumentsBatchWASM
+    IdentifierWASM: typeof DPP.IdentifierWASM
+    IdentityCreateTransitionWASM: typeof DPP.IdentityCreateTransitionWASM
+    IdentityCreditTransferWASM: typeof DPP.IdentityCreditTransferWASM
+    IdentityCreditWithdrawalTransitionWASM: typeof DPP.IdentityCreditWithdrawalTransitionWASM
+    IdentityPublicKeyInCreationWASM: typeof DPP.IdentityPublicKeyInCreationWASM
+    IdentityPublicKeyWASM: typeof DPP.IdentityPublicKeyWASM
+    IdentityTopUpTransitionWASM: typeof DPP.IdentityTopUpTransitionWASM
+    IdentityUpdateTransitionWASM: typeof DPP.IdentityUpdateTransitionWASM
+    IdentityWASM: typeof DPP.IdentityWASM
+    InstantAssetLockProofWASM: typeof DPP.InstantAssetLockProofWASM
+    InstantLockWASM: typeof DPP.InstantLockWASM
+    OutPointWASM: typeof DPP.OutPointWASM
+    PrefundedVotingBalanceWASM: typeof DPP.PrefundedVotingBalanceWASM
+    PrivateKeyWASM: typeof DPP.PrivateKeyWASM
+    StateTransitionWASM: typeof DPP.StateTransitionWASM
+    TxOutWASM: typeof DPP.TxOutWASM
+    // ENUMS
+    AssetLockProofTypeWASM: typeof DPP.AssetLockProofTypeWASM
+    BatchType: typeof DPP.BatchType
+    KeyType: typeof DPP.KeyType
+    NetworkWASM: typeof DPP.NetworkWASM
+    PlatformVersionWASM: typeof DPP.PlatformVersionWASM
+    PoolingWASM: typeof DPP.PoolingWASM
+    Purpose: typeof DPP.Purpose
+    SecurityLevel: typeof DPP.SecurityLevel
+    // METHODS
+    cborToObject: typeof DPP.cborToObject
+    objectToCbor: typeof DPP.objectToCbor
+    initSync: typeof DPP.initSync
+}