Skip to content

Commit

Permalink
chore(docs): Update README (#259)
Browse files Browse the repository at this point in the history
  • Loading branch information
rrr523 authored Aug 25, 2023
1 parent 5548c7b commit 982a1f7
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 10 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ You can find some package documentation below:
| --- | --- |
| [@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 |

## Document
[Document](./packages/chain-sdk/README.md)
Expand Down
15 changes: 5 additions & 10 deletions packages/chain-sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ const client = Client.create(GRPC_URL, GREEN_CHAIN_ID);

Apis include transactions and queries.

### Tx
### Tx Client

#### 1. Tx construction

Expand Down Expand Up @@ -82,7 +82,7 @@ const broadcastRes = await transferTx.broadcast({
});
```

### Query
### Query Client

```js
// get account info
Expand All @@ -101,13 +101,8 @@ more API:
* [payment](./src/api/payment.ts)
* [sp](./src/api/sp.ts)

### Storage Provider Client

> https://docs.bnbchain.org/greenfield-docs/docs/api/storgae-provider-rest
<!--
### putBucketPolicy

```js
// `resource` params
const resource = newBucketGRN(bucketName);
msg.resource = GRNToString(resource);
```
-->

0 comments on commit 982a1f7

Please sign in to comment.