coreum-js 2.6.7 → 2.6.8

package/README.md

@@ -1,6 +1,7 @@
 # coreum-js
 
-# IMPORTANT: This library is still in development and it is not production ready.
+> **Warning:**
+> This library is still in development and it is not production ready.
 
 [![NPM](https://nodei.co/npm/coreum-js.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/coreum-js/)
 
@@ -8,25 +9,28 @@ A JavaScript/TypeScript library for interacting with the Coreum Blockchain
 
 This is the recommended library for integrating a JavaScript/TypeScript app with the Coreum Blockchain, especially for the use of the modules assetft, assetnft, and more. It supports integration with the most popular Browser-Extension wallets; like Keplr, Cosmostation and Leap.
 
-## IMPORTANT: IF DECIDE TO USE THE **MNEMONIC SIGNER**, FOR SECURITY USE ONLY ON THE SERVER SIDE.
+> **Warning**
+> IF YOU DECIDE TO USE A **MNEMONIC SIGNER**, FOR BETTER SECURITY USE ONLY ON THE SERVER-SIDE.
 
-## Features
+## Contents
 
-1. Connect using the most popular Browser-Extension wallets ([Keplr](https://www.keplr.app#extension), [Cosmostation](https://www.cosmostation.io/wallet#extension), [Leap](https://www.leapwallet.io/download))
-2. Sign and broadcast transactions to the Coreum Blockchain ([Client.sendTx](https://musical-sawine-260235.netlify.app/classes/client#sendTx) & custom Coreum messages)
-3. Subscribe to events that happen on the Coreum Blockchain
-4. Query the Coreum Blockchain with ease, using the QueryClients.
+1. [Features](#features)
+2. [Installation](#installation)
+3. [Query Clients](#query-clients)
+4. [Transaction Modules](#transaction-modules)
+5. [Usage - General](#general)
+6. [Usage - Query balances](#query-balances)
+7. [Usage - Submit Transaction](#submit-transaction)
+8. [Usage - Event Subscription](#event-subscription)
 
-# Contents
+## Features
 
-1. [QuickStart](#md:quickstart)
-2. [Usage](#md:usage)
-3. [Transaction Modules](#md:transaction-modules)
-4. [Query for balances](#md:query-balances)
-5. [Submit Transaction](#md:submit-transaction)
-6. [Event Subscription](#md:event-subscription)
+1. Query the Coreum Blockchain with ease, using the [QueryClients](#query-clients).
+2. Sign and broadcast transactions to the Coreum Blockchain using [Transaction Modules](#transaction-modules)
+3. [Subscribe to events](<(#event-subscription)>) that happen on the Coreum Blockchain
+4. Connect using the most popular Browser-Extension wallets ([Keplr](https://www.keplr.app#extension), [Cosmostation](https://www.cosmostation.io/wallet#extension), [Leap](https://www.leapwallet.io/download))
 
-## Quickstart
+## Installation
 
 Installing coreum-js
 
@@ -34,7 +38,39 @@ Installing coreum-js
 npm i coreum-js
 ```
 
-## Usage
+## Query Clients
+
+_coreum-js_ comes with out-of-the-box modules to query the Coreum Blockchain.
+
+- [Auth](./docs/interfaces/ClientQueryClient.md#auth)
+- [Bank](./docs/interfaces/ClientQueryClient.md#bank)
+- [Coreum Asset-FT](./docs/interfaces/ClientQueryClient.md#ft)
+- [Coreum Asset-NFT](./docs/interfaces/ClientQueryClient.md#nft)
+- [Distribution](./docs/interfaces/ClientQueryClient.md#distribution)
+- [Feegrant](./docs/interfaces/ClientQueryClient.md#feegrant)
+- [Gov](./docs/interfaces/ClientQueryClient.md#gov)
+- [IBC](./docs/interfaces/ClientQueryClient.md#ibc)
+- [Mint](./docs/interfaces/ClientQueryClient.md#mint)
+- [NFTBeta](./docs/interfaces/ClientQueryClient.md#nftbeta)
+- [Staking](./docs/interfaces/ClientQueryClient.md#staking)
+- [TX](./docs/interfaces/ClientQueryClient.md#tx)
+- [WASM](./docs/interfaces/ClientQueryClient.md#wasm)
+
+## Transaction Modules
+
+_coreum-js_ comes with out-of-the-box modules to create transaction messages compatible with the Cosmos-SDK and Coreum Blockchain.
+
+- [Authz vesting](./docs/modules/Vesting.md) - Vesting itself
+- [Authz](./docs/modules/Authz.md)- Authorization for accounts to perform actions on behalf of other accounts.
+- [Bank](./docs/modules/Bank.md) - Token transfer functionalities.
+- [Coreum Asset-FT](./docs/modules/FT.md) - Token issuance and management functionalities.
+- [Coreum Asset-NFT](./docs/modules/NFT.md) - Non-Fungible Tokens minting and management functionalities.
+- [CosmWasm](./docs/modules/CosmWasm.md) - Smart Contracts functionalities.
+- [Distribution](./docs/modules/Distribution.md) - Fee distribution, and staking token provision distribution.
+- [Feegrant](./docs/modules/Feegrant.md) - Grant fee allowances for executing transactions.
+- [Staking](./docs/modules/Staking.md) - Proof-of-Stake layer for public blockchains.
+
+### General
 
 ```typescript
 import { Client } from "coreum-js";
@@ -48,8 +84,8 @@ const connectOptions = {
   withWS: true | false, // optional
 };
 // connect() will only connect for querying purposes, it won't sign any transaction.
-// In order to sign transactions, you need to connect with connectWithExtension (currently only working with Keplr)
-// Or with connectWithMnemonic, if choose connectWithMnemonic, DO NOT USE ON CLIENT SIDE.
+// In order to sign transactions, you need to connect with connectWithExtension or with connectWithMnemonic,
+// If choose connectWithMnemonic, DO NOT USE ON CLIENT SIDE.
 await coreum.connect(connectOptions); // connectWithExtension || connectWithMnemonic
 // If withWS is true, the client will also create and connect to the Coreum Websocket.
 
@@ -95,49 +131,9 @@ subscription.unsubscribe();
 const registry = Client.getRegistry();
 ```
 
-## Transaction Modules
-
-_coreum-js_ comes with out-of-the-box modules to create messages compatible with the Cosmos-SDK and Coreum Blockchain.
-
-- [Authz](./modules/Authz.html)
-  Authorization for accounts to perform actions on behalf of other accounts.
-- [Bank](./modules/Bank.html)
-  Token transfer functionalities.
-- [CosmWasm](./modules/CosmWasm.html)
-  Smart Contracts functionalities.
-- [Distribution](./modules/Distribution.html)
-  Fee distribution, and staking token provision distribution.
-- [Feegrant](./modules/Feegrant.html)
-  Grant fee allowances for executing transactions.
-- [FT](./modules/FT.html)
-  Token issuance and management functionalities.
-- [NFT](./modules/NFT.html)
-  Non-Fungible Tokens minting and management functionalities.
-- [Staking](./modules/Staking.html)
-  Proof-of-Stake layer for public blockchains.
-- [Vesting](./modules/Vesting.html)
-
-## Query Clients
-
-_coreum-js_ comes with out-of-the-box modules to query the Coreum Blockchain.
+### Query Balances
 
-- [Auth](./interfaces/ClientQueryClient.html#auth)
-- [Bank](./interfaces/ClientQueryClient.html#bank)
-- [FT](./interfaces/ClientQueryClient.html#ft)
-- [NFT](./interfaces/ClientQueryClient.html#nft)
-- [NFTBeta](./interfaces/ClientQueryClient.html#nftbeta)
-- [Gov](./interfaces/ClientQueryClient.html#gov)
-- [Staking](./interfaces/ClientQueryClient.html#staking)
-- [Distribution](./interfaces/ClientQueryClient.html#distribution)
-- [Mint](./interfaces/ClientQueryClient.html#mint)
-- [Feegrant](./interfaces/ClientQueryClient.html#feegrant)
-- [IBC](./interfaces/ClientQueryClient.html#ibc)
-- [WASM](./interfaces/ClientQueryClient.html#wasm)
-- [TX](./interfaces/ClientQueryClient.html#tx)
-
-## Query Balances
-
-```js
+```typescript
 // We take the bank query client from the coreum instance.
 const { bank } = coreum.queryClients;
 
@@ -146,9 +142,9 @@ const address = "core1ll9gdh5ur6gyv6swgshcm4zkkw4ttakt4ukjma";
 const balances = await bank.allBalances(address);
 ```
 
-## Submit Transaction
+### Submit a Transaction
 
-```js
+```typescript
 // We take the Bank Transaction Module from the Library.
 // Note: This TX module and the Query module are different thing. Query Module is ONLY for queries, not transaction handling
 import { Bank } from "coreum-js";
@@ -174,9 +170,9 @@ const send_message = Bank.Send({
 const response = await coreum.sendTx([send_message]);
 ```
 
-## Event Subscription
+### Subscribe to an Event
 
-```js
+```typescript
 // The event is the typeUrl of the desired Msg to track.
 // You can read more about Event subscription here.
 // https://docs.cosmos.network/v0.46/core/events.html#examples

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "coreum-js",
-  "version": "2.6.7",
+  "version": "2.6.8",
   "description": "JS/TS Library to to easily make use of the Coreum Blockchain",
   "main": "dist/main/index.js",
   "module": "dist/module/index.js",
@@ -10,7 +10,7 @@
     "build:version": "npm run build && standard-version && git add -A",
     "build:main": "npx tsc -p tsconfig.json",
     "build:module": "npx tsc -p tsconfig.module.json",
-    "generate:docs": "npx typedoc --plugin typedoc-plugin-missing-exports src/index.ts"
+    "generate:docs": "npx typedoc --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-markdown src/index.ts && rm ./docs/README.md"
   },
   "pre-commit": [
     "build:version"
@@ -51,6 +51,7 @@
     "standard-version": "^9.5.0",
     "ts-node": "^10.9.1",
     "typedoc": "^0.24.4",
+    "typedoc-plugin-markdown": "^3.15.3",
     "typedoc-plugin-missing-exports": "^2.0.0",
     "typescript": "^5.0.2"
   }