-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* chore: Update deps * chore: Update deps
- Loading branch information
Showing
4 changed files
with
2,186 additions
and
2,382 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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/chain-sdk/README.md) | A client library for Greenfield Chain | ![npm](https://img.shields.io/npm/v/%40bnb-chain%2Fgreenfield-js-sdk?color=blue) | | ||
| [@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) | | ||
| [@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) | | ||
| [@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) | | ||
|
||
## 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) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.