dedot 0.0.1-alpha.22

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,245 @@
+# dedot
+
+A fast & lightweight JavaScript/TypeScript client for [Polkadot](https://polkadot.network/) & [Substrate](https://substrate.io/)
+
+<p align="left">
+  <img src="https://img.shields.io/github/license/dedotdev/dedot?style=flat-square"/>
+  <img src="https://img.shields.io/github/actions/workflow/status/dedotdev/dedot/run-tests.yml?label=unit%20tests&style=flat-square"/>
+  <img src="https://img.shields.io/github/package-json/v/dedotdev/dedot?filename=packages%2Fapi%2Fpackage.json&style=flat-square"/>
+</p>
+
+_Note: The project is still in active development phase, the information on this page might be outdated. Feel free to raise an [issue](https://github.com/dedotdev/dedot/issues/new) if you run into any problems or want to share any ideas._
+
+---
+### Have a quick taste
+
+Try `dedot` now on [CodeSandbox Playground](https://codesandbox.io/p/devbox/trydedot-th96cm?file=%2Fmain.ts%3A24%2C26) or follow the below steps to run it on your local environment.
+- Install `dedot` package
+```shell
+# via yarn
+yarn add dedot
+
+# via npm
+npm i dedot
+```
+
+- Install `@dedot/chaintypes` package for chain types & APIs suggestion. Skip this step if you don't use TypeScript.
+```shell
+# via yarn
+yarn add -D @dedot/chaintypes
+
+# via npm
+npm i -D @dedot/chaintypes
+```
+
+- Initialize the API client and start interacting with Polkadot network
+```typescript
+// main.ts
+import { Dedot } from 'dedot';
+import type { PolkadotApi } from '@dedot/chaintypes';
+
+const run = async () => {
+  const api = await Dedot.new<PolkadotApi>('wss://rpc.polkadot.io');
+
+  // Call rpc `state_getMetadata` to fetch raw scale-encoded metadata and decode it.
+  const metadata = await api.rpc.state.getMetadata();
+  console.log('Metadata:', metadata);
+
+  // Query on-chain storage
+  const address = '14...';
+  const balance = await api.query.system.account(address);
+  console.log('Balance:', balance);
+
+
+  // Subscribe to on-chain storage changes
+  const unsub = await api.query.system.number((blockNumber) => {
+    console.log(`Current block number: ${blockNumber}`);
+  });
+
+  // Get pallet constants
+  const ss58Prefix = api.consts.system.ss58Prefix;
+  console.log('Polkadot ss58Prefix:', ss58Prefix)
+
+  // await unsub();
+  // await api.disconnect();
+}
+
+run().catch(console.error);
+```
+- You can also import `dedot` using `require`.
+
+```js
+// main.js
+const { Dedot } = require('dedot');
+// ...
+const api = await Dedot.new('wss://rpc.polkadot.io');
+```
+### Table of contents
+- [Status](#status)
+- [Chain Types & APIs](#chain-types--apis)
+- [Execute RPC Methods](#execute-rpc-methods)
+- [Query On-chain Storage](#query-on-chain-storage)
+- [Constants](#constants)
+- [Runtime APIs ⏳](#runtime-apis)
+- [Submit Transactions ⏳](#submit-transactions)
+- [Events](#events)
+- [Errors](#errors)
+- [Credit](#credit)
+
+### Status
+
+| Feature                                               | Status |
+|-------------------------------------------------------| ----------- |
+| Execute RPC (`api.rpc`)                               | ✅ |
+| Query on-chain storage (`api.query`)                  | ✅ |
+| Get runtime constants (`api.consts`)                  | ✅ |
+| Runtime APIs (`api.call`)                             | ⏳ |
+| Transaction APIs (`api.tx`)                           | ⏳ |
+| Events (`api.events`)                                 | ✅ |
+| Errors (`api.errors`)                                 | ✅ |
+| Contract APIs                                         | ⏳ |
+| Metadata v14                                          | ✅ |
+| Metadata v15                                          | ✅ |
+| [RPC v2](https://github.com/dedotdev/dedot/issues/20) | ⏳ |
+
+### Chain Types & APIs
+
+Each Substrate-based blockchain has their own set of data types & APIs to interact with, so being aware of those types & APIs when working with a blockchain will greatly improve the overall development experience. `dedot` exposes TypeScript's types & APIs for each individual Substrate-based blockchain, we recommend using TypeScript for your project to have the best experience.
+
+Types & APIs for each Substrate-based blockchains are defined in package [`@dedot/chaintypes`](https://github.com/dedotdev/dedot/tree/main/packages/chaintypes):
+```shell
+# via yarn
+yarn add -D @dedot/chaintypes
+
+# via npm
+npm i -D @dedot/chaintypes
+```
+
+Initialize a `DelighfulApi` instance using the `ChainApi` interface for a target chain to enable types & APIs suggestion/autocompletion for that particular chain:
+```typescript
+import { Dedot } from 'dedot';
+import type { PolkadotApi, KusamaApi, MoonbeamApi, AstarApi } from '@dedot/chaintypes';
+
+// ...
+
+const polkadotApi = await Dedot.new<PolkadotApi>('wss://rpc.polkadot.io');
+console.log(await polkadotApi.query.babe.authorities());
+
+const kusamaApi = await Dedot.new<KusamaApi>('wss://kusama-rpc.polkadot.io');
+console.log(await kusamaApi.query.society.memberCount());
+
+const moonbeamApi = await Dedot.new<MoonbeamApi>('wss://wss.api.moonbeam.network');
+console.log(await moonbeamApi.query.ethereumChainId.chainId());
+
+const astarApi = await Dedot.new<AstarApi>('wss://rpc.astar.network');
+console.log(await astarApi.query.dappsStaking.blockRewardAccumulator());
+
+const genericApi = await Dedot.new('ws://localhost:9944');
+
+// ...
+```
+
+In alpha test version, we only support `ChainApi` interfaces for 4 networks (Polkadot, Kusama, Moonbeam & Astar), we plan to expand this list to support more Substrate-based blockchains in the near future.
+
+### Execute RPC Methods
+
+RPCs can be execute via `api.rpc` entry point. After creating a `Dedot` instance with a `ChainApi` interface of the network you want to interact with, all RPC methods of the network will be exposed in the autocompletion/suggestion with format: `api.rpc.<module>.<methodName>`. E.g: you can find all supported RPC methods for Polkadot network [here](https://github.com/dedotdev/dedot/blob/main/packages/chaintypes/src/polkadot/rpc.ts), similarly for other networks as well.
+
+Examples:
+```typescript
+// Call rpc: `state_getMetadata`
+const metadata = await api.rpc.state.getMetadata(); 
+
+// Call an arbitrary rpc: `module_rpc_name` with arguments ['param1', 'param2']
+const result = await api.rpc.module.rpc_name('param1', 'param2');
+```
+
+### Query On-chain Storage
+
+On-chain storage can be query via `api.query` entry point. All the available storage entries for a chain are exposed in the `ChainApi` interface for that chain and can be execute with format: `api.query.<pallet>.<storgeEntry>`. E.g: You can find all the available storage queries of Polkadot network [here](https://github.com/dedotdev/dedot/blob/main/packages/chaintypes/src/polkadot/query.ts), similarly for other networks as well.
+
+Examples:
+```typescript
+// Query account balance
+const balance = await api.query.system.account(<address>);
+
+// Get all events of current block
+const events = await api.query.system.events();
+```
+### Constants
+
+Runtime constants (parameter types) are defined in metadata, and can be inspect via `api.consts` entry point with format: `api.consts.<pallet>.<constantName>`. All available constants are also exposed in the `ChainApi` interface. E.g: Available constants for Polkadot network is defined [here](https://github.com/dedotdev/dedot/blob/main/packages/chaintypes/src/polkadot/consts.ts), similarly for other networks.
+
+Examples:
+```typescript
+// Get runtime version
+const runtimeVersion = api.consts.system.version;
+
+// Get existential deposit in pallet balances
+const existentialDeposit = api.consts.balances.existentialDeposit;
+```
+
+### Runtime APIs
+
+⏳ _coming soon_
+
+### Submit Transactions
+
+⏳ _coming soon_
+
+### Events
+
+Events for each pallet emit during runtime operations and are defined in the medata. Available events are also exposed in `ChainApi` interface so we can get information of an event through syntax `api.events.<pallet>.<eventName>`. E.g: Events for Polkadot network can be found [here](https://github.com/dedotdev/dedot/blob/main/packages/chaintypes/src/polkadot/events.ts), similarly for other network as well.
+
+This `api.events` is helpful when we want quickly check if an event matches with an event that we're expecting in a list of events, the API also comes with type narrowing for the matched event, so event name & related data of the event are fully typed.
+
+Example to list new accounts created in each block:
+```typescript
+// ...
+const ss58Prefix = api.consts.system.ss58Prefix;
+await api.query.system.events(async (eventRecords) => {
+  const newAccountEvents = eventRecords
+    .map(({ event }) => api.events.system.NewAccount.as(event))
+    .filter((one) => one);
+
+  console.log(newAccountEvents.length, 'account(s) was created in block', await api.query.system.number());
+
+  newAccountEvents.forEach((event, index) => {
+    console.log(`New Account ${index + 1}:`, event.palletEvent.data.account.address(ss58Prefix));
+  });
+});
+// ...
+```
+
+### Errors
+
+Pallet errors are thrown out when things go wrong in the runtime, those are defined in the metadata. Available errors for each pallet are also exposed in `ChainApi` interface, so we can get information an error through this syntax: `api.errors.<pallet>.<errorName>`. E.g: Available errors for Polkadot network can be found [here](https://github.com/dedotdev/dedot/blob/main/packages/chaintypes/src/polkadot/errors.ts).
+
+Similar to events API, this API is helpful when we want to check if an error maches with an error that we're expecting.
+
+Example if an error is `AlreadyExists` from `Assets` pallet:
+```typescript
+// ...
+await api.query.system.events(async (eventRecords) => {
+  for (const tx of eventRecords) {
+    if (api.events.system.ExtrinsicFailed.is(tx.event)) {
+      const { dispatchError } = tx.event.palletEvent.data;
+      if (dispatchError.tag === 'Module' && api.errors.assets.AlreadyExists.is(dispatchError.value)) {
+        console.log('Assets.AlreadyExists error occurred!');
+      } else {
+        console.log('Other error occurred', dispatchError);
+      }
+    }
+  }
+});
+// ...
+```
+
+### Credit
+
+`dedot` take a lot of inspirations from project [@polkadot/api](https://github.com/polkadot-js/api). A big thank to all the maintainers/contributors of this awesome library.
+
+### License
+
+[Apache-2.0](https://github.com/dedotdev/dedot/blob/main/LICENSE)
+