https://github.com/bnb-chain/greenfield-js-sdk

JS SDK for Greenfield
https://github.com/bnb-chain/greenfield-js-sdk

blockchain greenfield sdk

Last synced: 4 days ago
JSON representation

JS SDK for Greenfield

• Host: GitHub
• URL: https://github.com/bnb-chain/greenfield-js-sdk
• Owner: bnb-chain
• License: gpl-3.0
• Created: 2023-03-28T14:16:07.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-15T11:17:59.000Z (about 1 month ago)
• Last Synced: 2024-10-24T23:24:03.804Z (21 days ago)
• Topics: blockchain, greenfield, sdk
• Language: TypeScript
• Homepage: https://docs.bnbchain.org/greenfield-js-sdk/
• Size: 10.4 MB
• Stars: 28
• Watchers: 3
• Forks: 16
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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 | 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/reed-solomon](./packages/reed-solomon/README.md) | calculate file's `checksums` | [![npm](https://img.shields.io/npm/v/%40bnb-chain%2Freed-solomon?color=blue)](https://www.npmjs.com/package/@bnb-chain/reed-solomon) |

| [@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) |

| [@bnb-chain/bsc-cross-greenfield-sdk](./packages/bsc-cross-sdk/README.md) | Execute tx in BSC | [![npm](https://img.shields.io/npm/v/%40bnb-chain%2Fbsc-cross-greenfield-sdk?color=blue)](https://www.npmjs.com/package/@bnb-chain/bsc-cross-greenfield-sdk) |

## Quick Start

You can use [`create-gnfd-app`](./packages/create-gnfd-app/README.md) to create a app quickly.

```bash

> npx @bnb-chain/create-gnfd-app

```

![quick start example](./packages/create-gnfd-app/example.gif)

## Supported JS environments

1. Modern browsers (Chromium, Firefox, Safari)

2. Browser extensions (Chromium, Firefox)

3. Nodejs

## Contribution

1. install dependencies

```bash

> pnpm install

```

2. Build packages:

```bash

> pnpm -F "@bnb-chain/**" build

```

Look over [CONTRIBUTING](./CONTRIBUTING.md)

## Disclaimer

Look over [DISCLAIMER](./DISCLAIMER.md)

## License

The library is licensed under the

[GNU Lesser General Public License v3.0](https://www.gnu.org/licenses/lgpl-3.0.en.html),

also included in our repository in the [LICENSE](./LICENSE) file.