@cheqd/sdk 5.3.4 → 5.3.5

package/build/esm/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@cheqd/sdk-esm",
-	"version": "5.3.4-develop.4",
+	"version": "5.3.5-develop.1",
 	"description": "A TypeScript SDK built with CosmJS to interact with cheqd network ledger",
 	"license": "Apache-2.0",
 	"author": "Cheqd Foundation Limited (https://github.com/cheqd)",

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@cheqd/sdk",
-	"version": "5.3.4",
+	"version": "5.3.5",
 	"description": "A TypeScript SDK built with CosmJS to interact with the cheqd network ledger",
 	"license": "Apache-2.0",
 	"author": "Cheqd Foundation Limited (https://github.com/cheqd)",

package/build/esm/build/LICENSE

@@ -1,190 +0,0 @@
-                                 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
-
-   Copyright 2021 Cheqd Foundation Limited (doing business as "cheqd")
-
-   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/build/esm/build/README.md

@@ -1,382 +0,0 @@
-# TypeScript SDK for cheqd
-
-[![GitHub release (latest by date)](https://img.shields.io/github/v/release/cheqd/sdk?color=green&label=stable%20release&style=flat-square)](https://github.com/cheqd/sdk/releases/latest) ![GitHub Release Date](https://img.shields.io/github/release-date/cheqd/sdk?color=green&style=flat-square) [![GitHub license](https://img.shields.io/github/license/cheqd/sdk?color=blue&style=flat-square)](https://github.com/cheqd/sdk/blob/main/LICENSE)
-
-[![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/cheqd/sdk?include_prereleases&label=dev%20release&style=flat-square)](https://github.com/cheqd/sdk/releases/) ![GitHub commits since latest release (by date)](https://img.shields.io/github/commits-since/cheqd/sdk/latest?style=flat-square) [![GitHub contributors](https://img.shields.io/github/contributors/cheqd/sdk?label=contributors%20%E2%9D%A4%EF%B8%8F&style=flat-square)](https://github.com/cheqd/sdk/graphs/contributors)
-
-[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/cheqd/sdk/dispatch.yml?label=workflows&style=flat-square)](https://github.com/cheqd/sdk/actions/workflows/dispatch.yml) [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/cheqd/sdk/codeql.yml?label=CodeQL&style=flat-square)](https://github.com/cheqd/sdk/actions/workflows/codeql.yml) ![GitHub repo size](https://img.shields.io/github/repo-size/cheqd/sdk?style=flat-square)
-
-## ℹ️ Overview
-
-The purpose of this [`@cheqd/sdk` NPM package](https://www.npmjs.com/package/@cheqd/sdk) is to provide base functionality for interacting with cheqd network. It combines the [Decentralized Identifier (DID)](https://docs.cheqd.io/product/architecture/adr-list/adr-001-cheqd-did-method) and [DID-Linked Resources](https://docs.cheqd.io/product/studio/did-linked-resources) modules, putting them into a Cosmos transaction wrapper using [CosmJS](https://github.com/cosmos/cosmjs).
-
-This package is consumed by other SDKs/libraries such as [Veramo SDK for cheqd](https://docs.cheqd.io/product/sdk/veramo) and [Credo](https://github.com/openwallet-foundation/credo-ts) to add cheqd network support.
-
-This package includes:
-
-* [TypeScript Protobuf definitions](https://github.com/cheqd/ts-proto) for custom cheqd Cosmos SDK modules
-* [CosmJS](https://github.com/cosmos/cosmjs), for base Cosmos SDK module functions
-
-## 🆔 Features
-
-Our identity documentation site provides [tutorials for utilising the identity features](https://docs.cheqd.io/product) on cheqd network.
-
-With this SDK, developers are able to:
-
-* ✅ Create a `did:cheqd` method [DID](https://docs.cheqd.io/product/architecture/adr-list/adr-001-cheqd-did-method)
-* ✅ Update a `did:cheqd` method [DID](https://docs.cheqd.io/product/architecture/adr-list/adr-001-cheqd-did-method)
-* ✅ Deactivate a `did:cheqd` method [DID](https://docs.cheqd.io/product/architecture/adr-list/adr-001-cheqd-did-method)
-* ✅ Create or update [a DID-Linked Resource](https://docs.cheqd.io/product/studio/did-linked-resources)
-
-### 🧰 Tooling
-
-* ✅ **Raw payload creator**: Enables users to generate a valid raw DID payload which is ready to be populated, depending on the use case. For example, `did-provider-cheqd` leverages this helper in the CLI application.
-* ✅ **Identity key converter**: Enables users to convert specific key formats from different kinds of SDKs, by transforming the input keys into valid sign inputs for a cheqd specific DID transaction (e.g. `createDidDocTx`, `updateDidDocTx`). For example, the Veramo SDK for cheqd uses this helper to enable users to pass a key in a Veramo SDK specific format to a cheqd sign input keys interface.
-
-## 💰 Fee Abstraction
-
-The Cheqd SDK provides comprehensive fee abstraction functionality that allows users to pay transaction fees using IBC tokens from other chains instead of native CHEQ tokens. This feature enables cross-chain interoperability and improved user experience by allowing users to transact without holding native tokens.
-
-### Overview
-
-Fee abstraction on Cheqd enables:
-
-* **Cross-chain fee payments**: Pay transaction fees using tokens from other Cosmos chains
-* **Host zone management**: Add and configure supported chains for fee abstraction
-* **Automatic token swaps**: Convert IBC tokens to CHEQ for fee payment behind the scenes
-* **Module account funding**: Provide liquidity for fee abstraction operations
-
-### 📁 Module Files
-
-The fee abstraction functionality is implemented in the following files:
-
-**CJS (CommonJS)**:
-
-* Main module: [`cjs/src/modules/feeabstraction.ts`](./cjs/src/modules/feeabstraction.ts)
-* Type definitions: [`cjs/src/types.ts`](./cjs/src/types.ts)
-
-**ESM (ECMAScript Modules)**:
-
-* Main module: [`esm/src/modules/feeabstraction.ts`](./esm/src/modules/feeabstraction.ts)
-* Type definitions: [`esm/src/types.ts`](./esm/src/types.ts)
-
-### 🚀 Basic Usage
-
-#### Setting up Fee Abstraction
-
-```typescript
-import { createCheqdSDK, CheqdNetwork } from '@cheqd/sdk';
-
-// Create wallet instance (e.g., using DirectSecp256k1HdWallet from CosmJS)
-import { DirectSecp256k1HdWallet } from '@cosmjs/proto-signing';
-const wallet = await DirectSecp256k1HdWallet.fromMnemonic('your mnemonic here', { prefix: 'cheqd' }); // replace with your mnemonic, remember to keep it secure
-
-// Set up the SDK options with fee abstraction capabilities
-const sdkOptions = {
-    modules: [
-        FeeabstractionModule as unknown as AbstractCheqdSDKModule,
-        // other modules can be added here
-    ],
-    // other SDK options can be configured here
-    rpcUrl: 'https://rpc.cheqd.network', // or your preferred RPC endpoint
-    network: CheqdNetwork.Testnet, // or CheqdNetwork.Mainnet
-    wallet,
-};
-
-// Initialize SDK with fee abstraction support
-const sdk = await createCheqdSDK(sdkOptions);
-```
-
-### 💳 IBC Asset Requirements
-
-Before using fee abstraction functionality, ensure that your account has the necessary IBC assets bridged from supported chains like Osmosis:
-
-#### Bridging Assets from Osmosis
-
-To use fee abstraction, you'll need to have IBC tokens in your Cheqd account that were bridged from Osmosis:
-
-```typescript
-// Example IBC denominations that might be supported
-const supportedIBCDenoms = [
-  'ibc/1480B8FD20AD5FCAE81EA87584D269547DD4D436843C1D20F15E00EB64743EF4', // ATOM from Osmosis
-  'ibc/14F9BC3E44B8A9C1BE1FB08980FAB87034C9905EF17CF2442BE1FA40E2E5F16', // OSMO from Osmosis
-  // Add other supported IBC denominations
-];
-
-// Your account should have these IBC tokens available
-async function checkIBCBalances(accountAddress: string) {
-  const balances = await sdk.querier.bank.allBalances({ address: accountAddress });
-
-  const ibcBalances = balances.balances.filter(balance =>
-    balance.denom.startsWith('ibc/')
-  );
-
-  console.log('Available IBC tokens:', ibcBalances);
-  return ibcBalances;
-}
-```
-
-**Note**: To bridge assets from Osmosis to Cheqd, you can use:
-
-* [Osmosis Frontend](https://app.osmosis.zone/) for manual transfers
-* [IBC Transfer tools](https://ibc.fun/) for cross-chain transfers
-* Direct IBC transfer commands via CLI
-
-### 📊 Querying Fee Abstraction Data
-
-#### Host Chain Configuration
-
-```typescript
-async function queryHostChainConfig() {
-  const configResponse = await sdk.querier[defaultFeeabstractionExtensionKey].hostChainConfig({
-    // Query parameters can be added here if needed
-  });
-
-  console.log('Host chain configuration:', configResponse);
-}
-```
-
-#### Module Balances
-
-```typescript
-async function queryModuleBalances() {
-  const balancesResponse = await sdk.querier[defaultFeeabstractionExtensionKey].feeabsModuleBalances({
-    // Query parameters can be added here if needed
-  });
-
-  console.log('Fee abstraction module balances:', balancesResponse);
-}
-```
-
-#### Osmosis TWAP Data
-
-```typescript
-async function queryOsmosisTWAP() {
-  const twapResponse = await sdk.querier[defaultFeeabstractionExtensionKey].osmosisArithmeticTwap({
-    poolId: '1', // Pool ID on Osmosis
-    baseAsset: 'uosmo',
-    quoteAsset: 'ibc/ABC123...',
-    startTime: new Date(Date.now() - 24 * 60 * 60 * 1000), // 24 hours ago
-    endTime: new Date()
-  });
-
-  console.log('TWAP data:', twapResponse);
-}
-```
-
-### 🏛️ Governance Operations
-
-Fee abstraction supports governance proposals for configuration changes:
-
-#### Adding a Host Zone
-
-```typescript
-import { MsgAddHostZone } from '@cheqd/ts-proto/feeabstraction/feeabs/v1beta1/index';
-
-async function proposeAddHostZone() {
-  const hostZoneData: MsgAddHostZone = {
-    authority: 'cheqd1gov...', // Governance authority address
-    hostChainId: 'osmosis-1',
-    connectionId: 'connection-0',
-    ibcDenom: 'ibc/ABC123...',
-    nativeDenom: 'uosmo',
-    transferChannelId: 'channel-0',
-    minSwapAmount: '1000'
-  };
-
-  const proposalResponse = await sdk.addHostZoneProposal(
-    hostZoneData,
-    'Add Osmosis as Host Zone', // Proposal title
-    [{ denom: 'ncheq', amount: '10000000000' }], // Deposit
-    'cheqd1proposer...', // Proposer address
-    {
-      amount: [{ denom: 'ncheq', amount: '5000' }],
-      gas: '300000'
-    }
-  );
-
-  console.log('Host zone proposal submitted:', proposalResponse.transactionHash);
-}
-```
-
-#### Updating Host Zone Configuration
-
-```typescript
-async function proposeUpdateHostZone() {
-  const updateData = {
-    authority: 'cheqd1gov...',
-    hostChainId: 'osmosis-1',
-    // Updated configuration parameters
-    minSwapAmount: '2000' // New minimum swap amount
-  };
-
-  const updateResponse = await sdk.updateHostZoneProposal(
-    updateData,
-    'Update Osmosis Host Zone Configuration',
-    [{ denom: 'ncheq', amount: '10000000000' }],
-    'cheqd1proposer...',
-    {
-      amount: [{ denom: 'ncheq', amount: '5000' }],
-      gas: '300000'
-    }
-  );
-
-  console.log('Update proposal submitted:', updateResponse.transactionHash);
-}
-```
-
-### 🔧 Advanced Configuration
-
-#### TWAP Query for Price Data
-
-```typescript
-async function sendTWAPQuery() {
-  const twapQueryResponse = await sdk.sendQueryIbcDenomTWAP(
-    'cheqd1sender...',
-    'ibc/ABC123...', // IBC denomination
-    {
-      amount: [{ denom: 'ncheq', amount: '5000' }],
-      gas: '200000'
-    },
-    'Query TWAP for price data'
-  );
-
-  console.log('TWAP query sent:', twapQueryResponse);
-}
-```
-
-#### Complete Fee Abstraction Workflow
-
-```typescript
-async function completeFeeAbstractionWorkflow() {
-  try {
-    // 1. Check account has IBC assets available
-    const accountAddress = 'cheqd1sender...';
-    const ibcBalances = await checkIBCBalances(accountAddress);
-    
-    if (ibcBalances.length === 0) {
-      throw new Error('No IBC tokens available. Please bridge assets from Osmosis first.');
-    }
-
-    // 2. Query host chain configuration
-    const hostConfig = await sdk.querier[defaultFeeabstractionExtensionKey].hostChainConfig({});
-    console.log('Host chain config:', hostConfig);
-
-    // 3. Query current module balances
-    const moduleBalances = await sdk.querier[defaultFeeabstractionExtensionKey].feeabsModuleBalances({});
-    console.log('Module balances:', moduleBalances);
-
-    // 4. Use IBC tokens for transaction fees directly
-    // Fee abstraction automatically handles the conversion behind the scenes
-    console.log('Fee abstraction is ready for use with IBC tokens');
-
-    console.log('Fee abstraction workflow completed successfully');
-  } catch (error) {
-    console.error('Fee abstraction workflow failed:', error);
-  }
-}
-```
-
-### 📋 Error Handling
-
-```typescript
-async function handleFeeAbstractionErrors() {
-  try {
-    // Example: Using fee abstraction in a DID operation
-    const didCreationResponse = await sdk.createDidDocTx(
-      'cheqd1sender...',
-      didDocument,
-      'key1',
-      { amount: [{ denom: 'ibc/ABC123...', amount: '100000' }], gas: '300000' }
-    );
-  } catch (error) {
-    if (error.message.includes('insufficient funds')) {
-      console.error('Account has insufficient IBC tokens');
-      console.log('Please bridge more assets from Osmosis');
-    } else if (error.message.includes('invalid denom')) {
-      console.error('Invalid IBC denomination provided');
-      console.log('Check supported IBC denominations');
-    } else if (error.message.includes('host zone not found')) {
-      console.error('Host zone not configured for this IBC token');
-    } else {
-      console.error('Unexpected fee abstraction error:', error);
-    }
-  }
-}
-```
-
-### 🔗 Integration with Other Modules
-
-Fee abstraction can be used alongside other Cheqd SDK modules:
-
-```typescript
-async function useWithDIDOperations() {
-  // Create a DID document using fee abstraction for payment
-  const didDocument = {
-    // DID document structure
-  };
-
-  // Use IBC tokens for fee payment via fee abstraction
-  const didCreationResponse = await sdk.createDidDocTx(
-    'cheqd1creator...',
-    didDocument,
-    'key1',
-    {
-      amount: [{ denom: 'ibc/ABC123...', amount: '100000' }], // Pay with IBC tokens
-      gas: '300000'
-    }
-  );
-
-  console.log('DID created with fee abstraction:', didCreationResponse.transactionHash);
-}
-```
-
-### 💡 Best Practices
-
-1. **Bridge IBC Assets First**: Ensure you have bridged the required IBC tokens from Osmosis before attempting to use fee abstraction
-2. **Check Account Balances**: Verify your account has sufficient IBC token balances before transactions
-3. **Handle IBC Delays**: Account for IBC token transfer delays in your application flow
-4. **Validate Host Zones**: Always verify that host zones are properly configured before using IBC tokens
-5. **Error Recovery**: Implement robust error handling for network and token-related issues
-6. **Gas Estimation**: Use appropriate gas limits for transactions using fee abstraction
-7. **Monitor Supported Denominations**: Keep track of which IBC denominations are supported for fee abstraction
-
-For more detailed information about fee abstraction concepts and implementation, visit our [fee abstraction documentation](https://docs.cheqd.io/product).
-
-## 🧑‍💻 Developer Guide
-
-### Installing in ESM projects
-
-To install this NPM package in a project that needs ESM builds, use our `latest` release channel to install the stable version:
-
-```bash
-npm install @cheqd/sdk@latest
-```
-
-To install beta releases instead, use our `-develop` releases from the `beta` channel:
-
-```bash
-npm install @cheqd/sdk@beta
-```
-
-### Installing in CommonJS projects
-
-To install this NPM package in a project that needs CommonJS builds, use our `cjs` release channel to install the latest stable CommonJS version:
-
-```bash
-npm install @cheqd/sdk@cjs
-```
-
-## 📖 Documentation
-
-Our [product documentation site](https://docs.cheqd.io/product) explains how `@cheqd/sdk` is [consumed in Veramo SDK for cheqd](https://docs.cheqd.io/product/sdk/veramo) (as an example of how this package can be consumed).
-
-## 💬 Community
-
-Our [**Discord server**](http://cheqd.link/discord-github) is the primary chat channel for our open-source community, software developers, and node operators.
-
-Please reach out to us there for discussions, help, and feedback on the project.
-
-## 🙋 Find us elsewhere
-
-[![Telegram](https://img.shields.io/badge/Telegram-2CA5E0?style=for-the-badge\&logo=telegram\&logoColor=white)](https://t.me/cheqd) [![Discord](https://img.shields.io/badge/Discord-7289DA?style=for-the-badge\&logo=discord\&logoColor=white)](http://cheqd.link/discord-github) [![Twitter](https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge\&logo=twitter\&logoColor=white)](https://twitter.com/intent/follow?screen\_name=cheqd\_io) [![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge\&logo=linkedin\&logoColor=white)](http://cheqd.link/linkedin) [![Medium](https://img.shields.io/badge/Medium-12100E?style=for-the-badge\&logo=medium\&logoColor=white)](https://blog.cheqd.io) [![YouTube](https://img.shields.io/badge/YouTube-FF0000?style=for-the-badge\&logo=youtube\&logoColor=white)](https://www.youtube.com/channel/UCBUGvvH6t3BAYo5u41hJPzw/)