@polymeshassociation/polymesh-sdk 15.0.0 → 15.0.1-beta.1

package/CHANGELOG.md

@@ -1,140 +1,6 @@
-# [15.0.0](https://github.com/PolymathNetwork/polymesh-sdk/compare/v14.1.2...v15.0.0) (2022-08-10)
+## [15.0.1-beta.1](https://github.com/PolymathNetwork/polymesh-sdk/compare/v15.0.0...v15.0.1-beta.1) (2022-08-11)
 
 
 ### Bug Fixes
 
-* 🐛 Add missing validations in `controllerTransfer` proc ([efb07c8](https://github.com/PolymathNetwork/polymesh-sdk/commit/efb07c8b650cb416ce69b46433510cdf3cee3797))
-* 🐛 Correct the `amount`, `withheldTax` returned by `DividendDistribution.getPaymentHistory` ([f6ab2c5](https://github.com/PolymathNetwork/polymesh-sdk/commit/f6ab2c57bbc0e46664990e5bd1450f0c48c5b767))
-* 🐛 disregard pallets without calls ([af684ae](https://github.com/PolymathNetwork/polymesh-sdk/commit/af684ae30c58687c38924fc5e00bfa0115e504fb))
-* 🐛 Fix asset.settlement.canTransfer method ([6f32e4d](https://github.com/PolymathNetwork/polymesh-sdk/commit/6f32e4d72b19795a8bf73f9c5943f4bcb5e7a6d6))
-* 🐛 Handle NoData claimType in conversion util ([1f9bbfa](https://github.com/PolymathNetwork/polymesh-sdk/commit/1f9bbfa3bbc049092c8913bc05a71e2bbaa3dc9a))
-* 🐛 ignore portfolio locked balances with zero amount ([be57838](https://github.com/PolymathNetwork/polymesh-sdk/commit/be57838b616b4035a6e8de757cd38ff2768bfe6f))
-* 🐛 Pin polkadot dependencies ([d79f561](https://github.com/PolymathNetwork/polymesh-sdk/commit/d79f561124846c3681d2bf01ec5639b4c738600a))
-* 🐛 Remove polymeshApi Proxy in Context ([fdd14a8](https://github.com/PolymathNetwork/polymesh-sdk/commit/fdd14a86945c6cde66c6cb7a81ac46766366c055))
-* 🐛 Settlement not being modifable before end block ([#762](https://github.com/PolymathNetwork/polymesh-sdk/issues/762)) ([517a2a7](https://github.com/PolymathNetwork/polymesh-sdk/commit/517a2a712c9e0da8d365e74efe7585806653e7b3))
-* 🐛 Undo postProcess augment-rpc ([c758e08](https://github.com/PolymathNetwork/polymesh-sdk/commit/c758e08191db2d9c66c47536df544127ac06d011))
-* 🐛 Update polkadot api to fix pagination issue ([6c032e6](https://github.com/PolymathNetwork/polymesh-sdk/commit/6c032e667d969f11c59ef33128a206e100e05c1a))
-* 🐛 use proper type for document URIs ([615782a](https://github.com/PolymathNetwork/polymesh-sdk/commit/615782a471e9cafcb832af42231b80c16d8279a3))
-* 🐛 Validate primary key on `modifySignerPermissions` ([0676035](https://github.com/PolymathNetwork/polymesh-sdk/commit/06760350625d2fccdd67e5fedc4d521d58b247d3))
-
-
-### Code Refactoring
-
-* 💡 GetReturnType to GetTransferRestrictionReturnType ([cff18a5](https://github.com/PolymathNetwork/polymesh-sdk/commit/cff18a5d6b4b2aa3a7271eb560b002370089f4ae))
-* 💡 Rename `toJson` to `toHuman` in all entities ([cb684fb](https://github.com/PolymathNetwork/polymesh-sdk/commit/cb684fb7e868e5ae351a93ce0fec8860e5a33352))
-
-
-* Da 179/upgrade 5.0.0 (#742) ([2450467](https://github.com/PolymathNetwork/polymesh-sdk/commit/245046707f68ffae4a3c97aad0c2fb74babc6a7d)), closes [#742](https://github.com/PolymathNetwork/polymesh-sdk/issues/742)
-
-
-### Features
-
-* 🎸 (WIP) Add support for 5.0.0 rc-1 ([7a4e503](https://github.com/PolymathNetwork/polymesh-sdk/commit/7a4e50346ea855cdf462c0585ab5c7b6f15deea2))
-* 🎸 (WIP) Add support for 5.0.0 rc-1 ([a7d7a8b](https://github.com/PolymathNetwork/polymesh-sdk/commit/a7d7a8b97339d339d4a33d8b17b602142bd828c4))
-* 🎸 Add enableStat to transferRestriction namespace ([#782](https://github.com/PolymathNetwork/polymesh-sdk/issues/782)) ([c862841](https://github.com/PolymathNetwork/polymesh-sdk/commit/c862841b0bec896e3a040085890d7a5cbd365c19))
-* 🎸 add getSecondaryPermissions method ([86e86fd](https://github.com/PolymathNetwork/polymesh-sdk/commit/86e86fddb0a3c5b73b6c08d26e43b927dbe612cf))
-* 🎸 Add guard to Asset.investorCount if stat is not enabled ([3cfcc58](https://github.com/PolymathNetwork/polymesh-sdk/commit/3cfcc58085c3856093e44138accec0c070b76677))
-* 🎸 Add method to get all assets on chain (with pagination) ([77f1579](https://github.com/PolymathNetwork/polymesh-sdk/commit/77f1579286f4f85e7f4e8d973c7142e047d53926))
-* 🎸 add pagination for getSecondaryAccounts ([7d37e02](https://github.com/PolymathNetwork/polymesh-sdk/commit/7d37e026511af9481dd6131f0f45fc127327e38a))
-* 🎸 Add support for FIGI asset identifiers ([6fa8cf1](https://github.com/PolymathNetwork/polymesh-sdk/commit/6fa8cf139ac79ea26809a2fe6663764aff7581ca))
-* 🎸 Always return `TickerReservation` from `assets.getTickerReservation` ([4b59621](https://github.com/PolymathNetwork/polymesh-sdk/commit/4b59621ee74144d5fa9a9a5147e476710be3fee3))
-* 🎸 bump supported chain version to 5.0.2 ([a73ced2](https://github.com/PolymathNetwork/polymesh-sdk/commit/a73ced246ee34ef9d8180c9785bde5676c8572cc))
-* 🎸 Bump supported version range to 5.0.x ([44ec9f5](https://github.com/PolymathNetwork/polymesh-sdk/commit/44ec9f57429f7ab4c2eee52a66c2728181486dad))
-* 🎸 DA-311 Add support for middleware v2 with claims POC ([3b75f49](https://github.com/PolymathNetwork/polymesh-sdk/commit/3b75f49444d80645f0e1757f052f2786682b82fa))
-* 🎸 DA-315 Migrate middleware queries to subquery native ([389e84d](https://github.com/PolymathNetwork/polymesh-sdk/commit/389e84d8ff9f859a040aea47567603a45d9fbbb2))
-* 🎸 expose transaction index within block ([e6c6983](https://github.com/PolymathNetwork/polymesh-sdk/commit/e6c6983433487c3935b4b28f5204c44a95268fb5))
-* 🎸 log a warning for minor and patch version mismatch ([30dd691](https://github.com/PolymathNetwork/polymesh-sdk/commit/30dd69163aa75df81614f1feea8f45803f1a59d6))
-* 🎸 Migrate external agents queries to subquery native ([1f6a5c7](https://github.com/PolymathNetwork/polymesh-sdk/commit/1f6a5c72c3a271276242763ecee99b4d904c93c6))
-* 🎸 Migrate settlements query to subquery native ([e3ac5c2](https://github.com/PolymathNetwork/polymesh-sdk/commit/e3ac5c2ca7fe135195f47e3bac178c0ce1782bae))
-* 🎸 move getSecondaryAccountPermissions into internal tool ([d547463](https://github.com/PolymathNetwork/polymesh-sdk/commit/d5474634564142f99683af8b85dcc28d45173d0e))
-* 🎸 Multiple tags support while getting protocol fees ([e0f8897](https://github.com/PolymathNetwork/polymesh-sdk/commit/e0f889701737a7b3dceab5371c91074cf8c09a6f))
-* 🎸 Pin transtive polkadot dependencies ([463ce32](https://github.com/PolymathNetwork/polymesh-sdk/commit/463ce3254c59f5741bcbea10eb9657894a208f71))
-* 🎸 Proper calculation of investor count with PUIS enabled ([1924cdd](https://github.com/PolymathNetwork/polymesh-sdk/commit/1924cddeae75165583ef9948dac36afcacd9a35e))
-* 🎸 Publish to polymesh association npm ([#777](https://github.com/PolymathNetwork/polymesh-sdk/issues/777)) ([38ee807](https://github.com/PolymathNetwork/polymesh-sdk/commit/38ee8078e5ec6c3a825431c6338e2c3d1fd08974))
-* 🎸 Refactor code to use new trasnfer restrictions api ([37b146a](https://github.com/PolymathNetwork/polymesh-sdk/commit/37b146a2d2d4f37dc2070a24db652f782e5bf9a2))
-* 🎸 Return gasFees, protocolFees in `getTransactionByHash` ([032222c](https://github.com/PolymathNetwork/polymesh-sdk/commit/032222c6aeb28b8dd62f73de4eb34fecf4318a69))
-* 🎸 Round post-tax dividend amounts ([dfb9625](https://github.com/PolymathNetwork/polymesh-sdk/commit/dfb962504c874396362205d470cbf7fb2d91ce18))
-* 🎸 Support 5.0.0-rc-1 ([33b77e4](https://github.com/PolymathNetwork/polymesh-sdk/commit/33b77e4af822f2a9e03eded85042bd4643c2e142))
-* 🎸 Support callback for getSecondaryAccounts ([1a9c6fe](https://github.com/PolymathNetwork/polymesh-sdk/commit/1a9c6fed13472b3c95f4426c7d93258ee1dfd798))
-* 🎸 support passing existing group permissions ([ff3e8ae](https://github.com/PolymathNetwork/polymesh-sdk/commit/ff3e8aecdb9ce7f953d0474721cd3b99bf4eb7aa))
-* 🎸 support passing null (full) permissions on `inviteAgent ([8001b7b](https://github.com/PolymathNetwork/polymesh-sdk/commit/8001b7b6d7570eb9fe1cdc6a0c21decd82fbdb82))
-* 🎸 throw an error when fetching an asset identity ([8949e13](https://github.com/PolymathNetwork/polymesh-sdk/commit/8949e13ad2969b8db6659a01f10f8bd66dcb44cc))
-* 🎸 Update granular permissions results for new types ([fe2b072](https://github.com/PolymathNetwork/polymesh-sdk/commit/fe2b072545f8d89be7cb6edae1557be4939b586e))
-* 🎸 Upgrade polkadot SDK along with 5.0.0 chain types ([2e9ee2c](https://github.com/PolymathNetwork/polymesh-sdk/commit/2e9ee2ca40421ba95b97d92f37d013dc5e2de553))
-* 🎸 upgrade polkadot.js to 8.9.1 ([ba358ad](https://github.com/PolymathNetwork/polymesh-sdk/commit/ba358ada87ac3f7a1d04b2273d416e39bc895dfa))
-* 🎸 use `createGroupAndAddAuth` when appropriate ([ed0d022](https://github.com/PolymathNetwork/polymesh-sdk/commit/ed0d022e46e28336831336671dee5a433fc421dd))
-* 🎸 Use batching fully for add restriction ([5bd29d5](https://github.com/PolymathNetwork/polymesh-sdk/commit/5bd29d51161d4ee5b281fae4ddd124ee4976783d))
-* 🎸 use batching when modifying CA defaults ([296949b](https://github.com/PolymathNetwork/polymesh-sdk/commit/296949bd4187b9949d3f5fa01b0bbe34bfced0ca))
-* 🎸 use composite extrinsic to create and change group ([8c0a9f0](https://github.com/PolymathNetwork/polymesh-sdk/commit/8c0a9f02c291622a2ece31f2ba35689e57bbdf01))
-* 🎸 use composite extrinsic to create CA and distribution ([29fb0ad](https://github.com/PolymathNetwork/polymesh-sdk/commit/29fb0ad65d5a1f2ca4db28ee6951d4b5b4ca372a))
-* 🎸 Use names prefixed with PolymeshPrimitives and Pallet ([7874b57](https://github.com/PolymathNetwork/polymesh-sdk/commit/7874b57fde6b054e25e376e846e0e61b135b2bc0))
-* 🎸 Use proper batching for setTransferRestriction ([f895ec8](https://github.com/PolymathNetwork/polymesh-sdk/commit/f895ec85c68f41b0449a3117cf103122ee44f949))
-* 🎸 validate chain spec version when connecting ([af76f93](https://github.com/PolymathNetwork/polymesh-sdk/commit/af76f93796c577a9c8ef72b9a7fc55c0c99d65e8))
-* 🎸 WIP Update transfer restrictions to create stats ([32d7d94](https://github.com/PolymathNetwork/polymesh-sdk/commit/32d7d94e939c5d1f0194d62addd9ed01ceb15e45))
-
-
-### BREAKING CHANGES
-
-* 🧨 getSecondaryAccounts is now paginated
-* 🧨 Type `GetReturnType<T>` is now renamed to
-`GetTransferRestrictionReturnType<T>`
-* 🧨 no longer throw an error when adding an external agent with explicit
-permissions if there is already an existing permission group with those
-permissions
-* 🧨 `accountManagement.modifyPermissions` and `accountManagement.revokePermissions`
- now throw an error if the signing Account is not the primary Account of the Identity
- whose secondary Accounts' permissions are modified/revoked
-* 🧨 Asset.investorCount throws if stat is not enabled
-
-* fix: 🐛 Remove polymeshApi Proxy in Context
-
-polkadot.js began using a private accesor (e.g. #registry) internally.
-This causes an error to be thrown when called by a proxied instance.
-Context Proxy was used to guard against having no signer which is taken
-care of by the singning manager, so this shouldn't cause any behavior to
-change
-
-* feat: 🎸 Bump supported version range to 5.0.x
-
-* chore: 🤖 use stored metadata to generate country code enum
-
-* chore: 🤖 remove country code generation from definitions script
-
-* feat: 🎸 expose transaction index within block
-
-Also fix compilation errors that arise in sandbox
-
-* fix: 🐛 disregard pallets without calls
-
-* fix: 🐛 use proper type for document URIs
-
-Also fixed documentHash conversion util tests
-
-* feat: 🎸 validate chain spec version when connecting
-* 🧨 throw an error instead of a warning when the chain versions aren't
-within the expected ranges
-
-* refactor: 💡 Eliminate RPC specific conversion functions
-
-Modify the schema object to make its types compatible with the rest of
-the api. This elminates snake case conversion functions to DRY the code
-base
-
-Update types to use PolymeshPrimitivesIdentityId instead of IdentityId
-
-* feat: 🎸 log a warning for minor and patch version mismatch
-
-Co-authored-by: Jeremias Diaz <monitz87@gmail.com>
-Co-authored-by: Victor Vicente <VictorVicente@users.noreply.github.com>
-* 🧨 `network.getProtocolFees` now supports passing multiple `TxTags`.
-Also, the return type has been changed from `Promise<BigNumber>`
-to `Promise<ProtocolFees[]>` specifying protocol fees for each tag argument.
-* 🧨 throw an error instead of a warning when the chain versions aren't
-within the expected ranges
-* 🧨 Asset.investorCount throws if stat is not enabled
-* 🧨 Return type of `network.getTransactionByHash` is changed from
-`Promise<ExtrinsicData | null>` to `Promise<ExtrinsicDataWithFees | null>`
-* 🧨 `toJson` method within all entities has been renamed to `toHuman`
-* 🧨 `assets.isTickerAvailable` has been removed.
-To check ticker availability, directly get the `TickerReservation` instance
-and use `details.status` to check the availability
+* 🐛 missing readme from npm ([9632afe](https://github.com/PolymathNetwork/polymesh-sdk/commit/9632afec9f2217cdb2d24c66f1af4780acc122a5))

package/README.md

@@ -0,0 +1,109 @@
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+[![js-semistandard-style](https://img.shields.io/badge/code%20style-semistandard-brightgreen.svg?style=flat-square)](https://github.com/standard/semistandard)
+[![Types](https://img.shields.io/npm/types/@polymathnetwork/polymesh-sdk)](https://)
+[![npm](https://img.shields.io/npm/v/@polymathnetwork/polymesh-sdk)](https://www.npmjs.com/package/@polymathnetwork/polymesh-sdk)
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=PolymathNetwork_polymesh-sdk&metric=coverage)](https://sonarcloud.io/dashboard?id=PolymathNetwork_polymesh-sdk)
+[![Github Actions Workflow](https://github.com/PolymathNetwork/polymesh-sdk/actions/workflows/main.yml/badge.svg)](https://github.com/Polymathnetwork/polymesh-sdk/actions)
+[![Sonarcloud Status](https://sonarcloud.io/api/project_badges/measure?project=PolymathNetwork_polymesh-sdk&metric=alert_status)](https://sonarcloud.io/dashboard?id=PolymathNetwork_polymesh-sdk)
+[![Issues](https://img.shields.io/github/issues/PolymathNetwork/polymesh-sdk)](https://github.com/PolymathNetwork/polymesh-sdk/issues)
+
+## @polymathnetwork/polymesh-sdk
+
+<!--- This section is autogenerated, do not modify --->
+
+## Polymesh version
+
+This release is compatible with Polymesh v5.0
+
+<!--- End of section --->
+
+## Getting Started
+
+### Purpose
+
+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.
+
+### Before moving on
+
+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.
+
+### Technical Pre-requisites
+
+In order to use the Polymath SDK, you must install [node](https://nodejs.org/) \(version 10\) 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
+
+Token Studio SDK Walkthrough:
+
+https://developers.polymath.network/token-studio-api-walkthrough/
+
+Polymesh SDK API Reference:
+
+https://github.com/PolymeshAssociation/polymesh-sdk/wiki
+
+### How to use
+
+#### Installation
+
+`npm i @polymathnetwork/polymesh-sdk --save`
+
+Or, if you're using yarn
+
+`yarn add @polymathnetwork/polymesh-sdk`
+
+Or, if using pnpm
+
+`pnpm add @polymathnetwork/polymesh-sdk`
+
+**NOTE** it is _highly_ recommended that you use one of these three package managers. This project uses package resolutions/overrides to pin certain problematic dependencies, and these are only supported by the aforementioned package managers. Using a different package manager may result in unexpected behavior
+
+**NOTE** if using TypeScript the compiler option "skipLibCheck" should be set to true in your tsconfig.json file
+
+#### Initializing the client
+
+Before you can start registering Tickers and creating Assets, you have to connect the Polymesh SDK client to a Polymesh node. This is a pretty straightforward process:
+
+```typescript
+import { Polymesh } from '@polymathnetwork/polymesh-sdk';
+import { LocalSigningManager } from '@polymathnetwork/local-signing-manager';
+
+async function run() {
+  const signingManager = await LocalSigningManager.create({
+    accounts: [
+      {
+        seed: 'YOU_WISH',
+      },
+    ],
+  });
+  const polyClient = await Polymesh.connect({
+    nodeUrl: 'wss://some-node-url.com',
+    signingManager,
+  });
+
+  // do stuff with the client
+}
+```
+
+Here is an overview of the parameters passed to the `connect` function:
+
+- `nodeUrl` is a URL that points to a running Polymesh node
+- `signingManager` is an object that complies with the `SigningManager` interface. It holds the Accounts capable of signing transactions, and the signing logic itself. In this example, `LocalSigningManager` is a simple signing manager that holds private keys in memory and signs with them
+
+**NOTE:** if using the SDK on a browser environment \(i.e. with the Polymesh wallet browser extension\), you would use the `BrowserExtensionSigningManager` provided by `@polymathnetwork/browser-extension-signing-manager`
+
+```typescript
+import { Polymesh } from '@polymathnetwork/polymesh-sdk';
+import { BrowserExtensionSigningManager } from '@polymathnetwork/browser-extension-signing-manager';
+
+async function run() {
+  const signingManager = await BrowserExtensionSigningManager.create('MY_APP_NAME'); // The Polymesh wallet extension will ask the user to authorize MY_APP_NAME for access
+
+  const polyClient = await Polymesh.connect({
+    nodeUrl: 'wss://some-node-url.com',
+    signingManager,
+  });
+
+  // do stuff with the client
+}
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@polymeshassociation/polymesh-sdk",
-  "version": "15.0.0",
+  "version": "15.0.1-beta.1",
   "description": "High-level API to interact with the Polymesh blockchain",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",