Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
babybunn committed Dec 3, 2024
1 parent b5a010d commit 5beaab0
Showing 1 changed file with 2 additions and 31 deletions.
33 changes: 2 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ BandChain.js is a library for interacting with BandChain in browser and Node.js

## 📦 Installation

BandChain.js is currently supported on NodeJS 16.x, and 18.x.
BandChain.js is currently supported on Node.js 16.x, and 18.x.

### NPM

Expand All @@ -26,33 +26,4 @@ yarn add @bandprotocol/bandchain.js

## Compatibility

Band 2.2.0, Cosmos SDK 0.44.0, IBC-go 1.1.0

## Usage

#### Retrieving Price Data

```js
const { Client } = require('@bandprotocol/bandchain.js')

// BandChain's Proof-of-Authority REST endpoint
const endpoint = 'https://laozi-testnet6.bandchain.org/grpc-web'
const client = new Client(endpoint)

// This example demonstrates how to query price data from
// Band's standard dataset
async function exampleGetReferenceData() {
const rate = await client.getReferenceData(
['BTC/USD', 'BTC/ETH', 'EUR/USD', 'EUR/ETH'],
3,
4,
)
return rate
}

;(async () => {
console.log(await exampleGetReferenceData())
})()
```

For more examples, please see [`example`](example/) folder.
BandChain v3.0.0, Cosmos SDK v0.50.0, IBC-go v8.5.2

0 comments on commit 5beaab0

Please sign in to comment.