release 0.2.6

README.md

@@ -1,16 +1,17 @@
-# GreenField JS SDK
+# GreenField JS SDK ![License](https://img.shields.io/npm/l/%40bnb-chain%2Fgreenfield-js-sdk) ![version](https://img.shields.io/npm/v/%40bnb-chain%2Fgreenfield-js-sdk?color=blue)
+
 A Greenfield JS SDK is an easy-to-use tool designed to help developers build decentralized applications (DApps) on the Greenfield blockchain using JavaScript. It provides a simple and straightforward starting point for developers to create DApps with the latest technology and best practices, making Dapp development more efficient. This SDK includes features and tools to make interacting with the Greenfield blockchain easy, such as libraries for common functionality, testing tools, and documentation. With a Greenfield JS SDK, developers can create scalable, maintainable, and efficient DApps for a variety of use cases.
 
 ## Documentation
 
 You can find some package documentation below:
 
-| Package | Description |
-| --- | --- |
-| [@bnb-chain/greenfield-js-sdk](./packages/chain-sdk/README.md) | A client library for Greenfield Chain |
-| [@bnb-chain/greenfiled-file-handle](./packages/file-handle/README.md) | WASM module that handle file, such as `checksums` |
-| [@bnb-chain/greenfield-zk-crypto](./packages/zk-crypto/README.md) | WASM module about sign crypto |
-| [@bnb-chain/create-gnfd-app](./packages/create-gnfd-app/README.md) | Create Greenfield App Quickly |
+| Package | Description | Version | 
+| --- | --- | --- |
+| [@bnb-chain/greenfield-js-sdk](./packages/js-sdk/README.md) | A client library for Greenfield Chain | [![npm](https://img.shields.io/npm/v/%40bnb-chain%2Fgreenfield-js-sdk?color=blue)](https://www.npmjs.com/package/@bnb-chain/greenfield-js-sdk) |
+| [@bnb-chain/greenfiled-file-handle](./packages/file-handle/README.md) | WASM module that handle file, such as `checksums` | [![npm](https://img.shields.io/npm/v/%40bnb-chain%2Fgreenfiled-file-handle?color=blue)](https://www.npmjs.com/package/@bnb-chain/greenfiled-file-handle) |
+| [@bnb-chain/greenfield-zk-crypto](./packages/zk-crypto/README.md) | WASM module about sign crypto | [![npm](https://img.shields.io/npm/v/%40bnb-chain%2Fgreenfield-zk-crypto?color=blue)](https://www.npmjs.com/package/@bnb-chain/greenfield-zk-crypto) |
+| [@bnb-chain/create-gnfd-app](./packages/create-gnfd-app/README.md) | Create Greenfield App Quickly | [![npm](https://img.shields.io/npm/v/%40bnb-chain%2Fcreate-gnfd-app?color=blue)](https://www.npmjs.com/package/@bnb-chain/create-gnfd-app) |
 
 ## Online Examples
 
@@ -28,63 +29,27 @@ You can use [`create-gnfd-app`](./packages/create-gnfd-app/README.md) to create
 
 ![](./packages/create-gnfd-app/example.gif)
 
+## Supported JS environments
 
-<!-- There are runnable examples included in the [examples](./examples/) folder
-
-* [Next.js Example(TypeScript)](./examples/nextjs/README.md)
-* [Nodejs](./examples/nodejs/README.md) -->
+1. Modern browsers (Chromium, Firefox, Safari)
+2. Browser extensions (Chromium, Firefox)
+3. Nodejs
 
+## Contribution
 
-<!-- 
-1. Clone the project and install dependencies:
+1. install dependencies
 
 ```bash
-> git clone [email protected]:bnb-chain/greenfield-js-sdk.git
-> cd greenfield-js-sdk
 > pnpm install
 ```
 
 2. Build package:
 ```bash
-> pnpm run -F "./packages/**" -r build
-```
-
-3. copy env template file:
-```bash
-> cp .env.simple .env
-```
-
-and then enter your own configuration. Take testnet, for example:
-```bash
-NEXT_PUBLIC_GRPC_URL=https://gnfd-testnet-fullnode-tendermint-us.bnbchain.org
-NEXT_PUBLIC_GREENFIELD_RPC_URL=https://gnfd-testnet-fullnode-tendermint-us.bnbchain.org
-NEXT_PUBLIC_GREEN_CHAIN_ID=5600
-NEXT_PUBLIC_BSC_RPC_URL=https://gnfd-bsc-testnet-dataseed1.bnbchain.org
-NEXT_PUBLIC_BSC_CHAIN_ID=97
-
-# refer to https://docs.bnbchain.org/greenfield-docs/docs/guide/dapp/contract-list
-NEXT_PUBLIC_TOKEN_HUB_CONTRACT_ADDRESS=
-NEXT_PUBLIC_CROSS_CHAIN_CONTRACT_ADDRESS=
+> pnpm run build
 ```
 
-> The contract address may be outdated due to Greenfield reset, refer to https://docs.bnbchain.org/greenfield-docs/docs/guide/dapp/contract-list get the latest contract address. -->
-
-<!-- abd then run example:
-```bash
-> npx next dev
-``` -->
-
-## Supported JS environments
-
-1. Modern browsers (Chromium, Firefox, Safari)
-2. Browser extensions (Chromium, Firefox)
-3. Nodejs
-
-## Contribution
-
 Look over [CONTRIBUTING](./CONTRIBUTING.md)
 
-
 ## Disclaimer
 
 Look over [DISCLAIMER](./DISCLAIMER.md)

doc-site/.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

doc-site/README.md

@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+Using SSH:
+
+```
+$ USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```
+$ GIT_USER=<Your GitHub username> yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

doc-site/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};

doc-site/docs/api/_category_.json

@@ -0,0 +1,14 @@
+{
+  "position": 3,
+  "label": "API",
+  "collapsible": true,
+  "collapsed": true,
+  "className": "red",
+  "link": {
+    "type": "generated-index",
+    "title": "apis"
+  },
+  "customProps": {
+    "description": ""
+  }
+}

doc-site/docs/api/account.mdx

@@ -0,0 +1,114 @@
+---
+id: account
+title: 'Account'
+---
+
+import Tx from '../../src/components/snippers/tx.mdx';
+import ApiTypes from '../../src/components/snippers/api-types.tsx';
+
+## getAccount <ApiTypes type="Query" />
+
+Retrieve on-chain account information for a given address.
+
+| params  | description                      |
+| ------- | -------------------------------- |
+| address | The given address for retrieving |
+
+```jsx title="example"
+await client.getAccount('0x0000000000000000000000000000000000000001');
+```
+
+## getAccountBalance <ApiTypes type="Query" />
+
+Get the bank balance for the given address.
+
+| params  | description                          |
+| ------- | ------------------------------------ |
+| address | the address to query balances for    |
+| denom   | the coin denom to query balances for |
+
+```jsx title="example"
+await client.getAccountBalance({
+  address: '0x0000000000000000000000000000000000000001',
+  denom: 'BNB',
+});
+```
+
+## getModuleAccounts <ApiTypes type="Query" />
+
+Get all module accounts.
+
+```jsx title="example"
+await client.getModuleAccounts();
+```
+
+## getModuleAccountByName <ApiTypes type="Query" />
+
+Get module account by module name.
+
+| params | description                       |
+| ------ | --------------------------------- |
+| name   | the address to query balances for |
+
+```jsx title="example"
+await client.getModuleAccountByName('module_name');
+```
+
+## getPaymentAccountsByOwner <ApiTypes type="Query" />
+
+Get all payment accounts owned by the given owner address.
+
+| params  | description                                    |
+| ------- | ---------------------------------------------- |
+| address | The given owner account address for retrieving |
+
+```jsx title="example"
+await client.getPaymentAccountsByOwner('0x0000000000000000000000000000000000000001');
+```
+
+## createPaymentAccount <ApiTypes type="Tx" />
+
+<Tx />
+
+Create a new payment account for the given address.
+
+The payment account is used to pay for the storage and read quota fee of objects. When you need to
+pay for different buckets separately, you can create different payment accounts to do so. Note that
+the payment account does not have a private key, and only the owner of the payment account can
+withdraw funds from it. Once the owner revokes permission for withdrawal, the funds in the payment
+account can only be utilized to cover storage and read quota fees.
+
+| params  | description                                  |
+| ------- | -------------------------------------------- |
+| creator | The owner address of the new payment account |
+
+```jsx title="example"
+const tx = await client.account.createPaymentAccount({
+  creator: address,
+});
+```
+
+## transfer <ApiTypes type="Tx" />
+
+<Tx />
+
+Transfer BNB from sender to receiver.
+
+| params      | description                          |
+| ----------- | ------------------------------------ |
+| fromAddress | The address who will send the BNB    |
+| toAddress   | The address who will receive the BNB |
+| amount      | transfer coin                        |
+
+```jsx title="example"
+const tx = await client.account.transfer({
+  fromAddress: '0x0000000000000000000000000000000000000000',
+  toAddress: '0x0000000000000000000000000000000000000001',
+  amount: [
+    {
+      denom: 'BNB',
+      amount: '1000000000',
+    },
+  ],
+});
+```