Skip to content

Commit

Permalink
docs: Update Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rrr523 committed May 12, 2023
1 parent 8d36cb8 commit b90a8f0
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 177 deletions.
20 changes: 16 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,23 @@

## Documentation

[greenfield-sdk](packages/greenfield-sdk/) is a library that consists of pakcages, a so called monorepo.
[greenfield-chain-sdk](./packages/chain-sdk/) is a library that consists of pakcages, a so called monorepo.

| Package | Description | Doc |
| --- | --- | --- |
| [@bnb-chain/greenfield-chain-sdk](packages/chain-sdk) | A client library for Greenfield Chain | [DOC](packages/chain-sdk/README.md) |
| Package | Description |
| --- | --- |
| [@bnb-chain/greenfield-chain-sdk](./packages/chain-sdk) | A client library for Greenfield Chain |
| [@bnb-chain/greenfiled-file-handle](./packages/files) | WASM module that handle file, such as `checksums` |

## Examples

[Examples](./examples)

* tx
* [transfer](./examples/wallet/src/components/transfer/index.tsx)
* [withdraw](./examples/wallet/src/components/withdraw/index.tsx)
* [bucket](./examples/wallet/src/components/bucket/index.tsx)
* [object](./examples/wallet/src/components/object/index.tsx)
* [query](./examples/wallet/src/components/withdraw/query.tsx)

## Supported JS environments

Expand Down
63 changes: 48 additions & 15 deletions packages/chain-sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,30 +4,50 @@
> npm install @bnb-chain/greenfield-chain-sdk@alpha
```

[Examples](../../examples)



## Create Client
## Usage

### create client
```js
import {Client} from '@bnb-chain/greenfield-chain-sdk'
Client.create()
const client = Client.create(GRPC_URL, GREEN_CHAIN_ID);
```

## Basic API

### simulateRawTx
Apis include transactions and queries.

### broadcastRawTx

### getAccount
### txs

```js
// transfer example
await client.account.transfer(
{
fromAddress: address,
toAddress: transferInfo.to,
amount: [
{
denom: 'BNB',
amount: transferInfo.amount,
},
],
},
{
simulate: false,
denom: 'BNB',
gasLimit: Number(simulateInfo.gasLimit),
gasPrice: simulateInfo.gasPrice,
payer: address,
granter: '',
},
);
```

### querys

## Bucket API
```js
// get account info
await client.account.getAccount(address);
```

### select sp
#### select sp

```js
const sps = await client.sp.getStorageProviders();
Expand All @@ -39,11 +59,24 @@ const secondarySpAddresses = [
].map((item) => item.operatorAddress);
```
more API List:
* [account](./src/api/account.ts)
* [basic](./src/api/basic.ts)
* [backet](./src/api/backet.ts)
* [challenge](./src/api/challenge.ts)
* [object](./src/api/object.ts)
* [group](./src/api/group.ts)
* [payment](./src/api/payment.ts)
* [sp](./src/api/sp.ts)
<!--
### putBucketPolicy
```js
// `resource` params
const resource = newBucketGRN(bucketName);
msg.resource = GRNToString(resource);
```
-->
158 changes: 0 additions & 158 deletions packages/chain-sdk/docs/CHANGELOG.md

This file was deleted.

0 comments on commit b90a8f0

Please sign in to comment.