Merge pull request #22 from PolymeshAssociation/alpha-into-beta

Alpha into beta

README.md

@@ -14,27 +14,29 @@
 
 ## Polymesh version
 
-This release is compatible with Polymesh v6.x.x
+This release is compatible with Polymesh v6.x.x and Polymesh Private v1.x.x
 
 <!--- End of section --->
 
 ## Getting Started
 
-### Purpose
+This package provides confidential asset support (aka [Polymesh Private](https://polymesh.network/private)) and is an extension of the [public SDK](https://github.com/PolymeshAssociation/polymesh-sdk).
+
+Unless you specifically need confidential asset support, then you should use the public version. If you are adding confidential support then upgrading from public version should be a matter of updating the import from `@polymeshassociation/polymesh-sdk` to `@polymeshassociation/private-polymesh-sdk`, and updating the version. The public API should remain unchanged.
 
-The Polymesh SDK's main goal is to provide external developers with a set of tools that will allow them to build powerful applications that interact with the Polymesh protocol. It focuses on abstracting away all the complexities of the Polymesh blockchain and expose a simple but complete interface. The result is a feature-rich, user-friendly node.js library.
+Note, the SDK does not contain any logic around generating confidential proofs. To generate zero knowledge proofs a [confidential proof server](https://github.com/PolymeshAssociation/polymesh-private-proof-api) needs to be available, and integrating code will need to call the right endpoints when appropriate.
 
-### Before moving on
+### Purpose
 
-This document assumes you are already familiar with [Security Tokens](https://thesecuritytokenstandard.org/) in general and [Polymath](https://www.polymath.network/) as well as [Polymesh](https://polymath.network/polymesh) in particular.
+The Polymesh Private SDK's provides additional functions to the Polymesh SDK to provide support for confidential assets.
 
 ### Technical Pre-requisites
 
-In order to use the Polymath SDK, you must install [node](https://nodejs.org/) \(version 16\) and [npm](https://www.npmjs.com/). The library is written in [typescript](https://www.typescriptlang.org/), but can also be used in plain javascript. This document will assume you are using typescript, but the translation to javascript is very simple.
+In order to use the Polymesh Private SDK, you must install [node](https://nodejs.org/) \(version 16\) and [npm](https://www.npmjs.com/). The library is written in [typescript](https://www.typescriptlang.org/), but can also be used in plain javascript. This document will assume you are using typescript, but the translation to javascript is very simple.
 
 ### Documentation
 
-Polymesh SDK API Reference:
+Polymesh Public SDK API Reference:
 
 https://developers.polymesh.network/sdk-docs/
 

package.json

@@ -49,6 +49,7 @@
     "@babel/plugin-transform-modules-commonjs": "7.22.11",
     "@commitlint/cli": "^17.7.1",
     "@commitlint/config-conventional": "^17.7.0",
+    "@golevelup/ts-jest": "^0.4.0",
     "@graphql-codegen/cli": "5.0.0",
     "@graphql-codegen/typescript": "4.0.1",
     "@ovos-media/ts-transform-paths": "^1.7.18-1",
@@ -122,9 +123,11 @@
   },
   "dependencies": {
     "@apollo/client": "^3.8.1",
+    "@noble/curves": "^1.4.0",
     "@polkadot/api": "10.9.1",
     "@polkadot/util": "12.4.2",
     "@polkadot/util-crypto": "12.4.2",
+    "@polymeshassociation/polymesh-sdk": "24.1.0",
     "bignumber.js": "9.0.1",
     "bluebird": "^3.7.2",
     "cross-fetch": "^4.0.0",