# Band Protocol

{% embed url="<https://docs.bandchain.org/>" %}

## Price Feeds

| Environment | Contract Address                             |
| ----------- | -------------------------------------------- |
| Testnet     | `0x8c064bCf7C0DA3B3b090BAbFE8f3323534D84d68` |
| Mainnet     | `0x9c5490fc68005dF8b2DC124309c2C036B93d785f` |

## Band Protocol's Solidity Standard Reference Contracts

### Overview

This repository contains the Solidity code for Band Protocol's StdReference contracts. The live contract addresses can be found in the [documentation](https://docs.bandchain.org/band-standard-dataset/supported-blockchains.html).

### Usage

To query prices from Band Protocol's StdReference contracts, the contract looking to use the price values should reference Band Protocol's `StdReference` contract. This contract exposes the `getReferenceData` and `getReferenceDataBulk` functions.

These can be imported via the `IStdReference` interface.

```solidity
import interfaces/IStdReference.sol
```

#### ReferenceData

The `ReferenceData` struct is defined as:

```solidity
struct ReferenceData {
    uint256 rate;
    uint256 lastUpdatedBase;
    uint256 lastUpdatedQuote;
}
```

where the struct variables:

* `rate` is defined as the base/quote exchange rate multiplied by 1e18.
* `lastUpdatedBase` is defined as the UNIX epoch of the last time the base price was updated.
* `lastUpdatedQuote` is defined as the UNIX epoch of the last time the quote price was updated.

#### getReferenceData

**Input**

* The base symbol as type `string`
* The quote symbol as type `string`

**Output**

* The base quote pair result as type `ReferenceData`

**Example**

For example, if we wanted to query the price of `BTC/USD`, the demo contract below shows how this can be done.

```solidity
import interfaces/IStdReference.sol

contract Demo {
    IStdReference public ref;

    constructor(IStdReference _ref) public {
        ref = _ref;
    }

    function demo() external view returns (IStdReference.ReferenceData memory) {
        return ref.getReferenceData("BTC", "USD");
    }
}
```

The result from `demo()` would yield:

```
ReferenceData(23131270000000000000000, 1659588229, 1659589497)
```

Where the results can be interpreted as:

* BTC/USD
  * `rate = 23131.27 BTC/USD`
  * `lastUpdatedBase = 1659588229`
  * `lastUpdatedQuote = 1659589497`

#### getReferenceDataBulk

`getReferenceDataBulk` takes two lists as the inputs, the base and quote symbols. The return value is `ReferenceData[]`.

**Input**

* An array of base symbols as type `string[]`
* An array of quote symbol as type `string[]`

**Output**

* An array of the base quote pair results as type `ReferenceData[]`

**Example**

For example, if we wanted to query the price of `BTC/USD` and `ETH/BTC`, the demo contract below shows how this can be done.

```solidity
import interfaces/IStdReference.sol

contract DemoBulk {
    IStdReference public ref;

    constructor(IStdReference _ref) public {
        ref = _ref;
    }

    function demo_bulk() external view returns (IStdReference.ReferenceData[] memory) {
        return ref.getReferenceDataBulk(["BTC","ETH"], ["USD","BTC"]);
    }
}
```

The result from `demo_bulk()` would yield:

```json
[
    ReferenceData(23131270000000000000000, 1659588229, 1659589497),
    ReferenceData(71601775432131482, 1659588229, 1659588229)
]
```

Where the results can be interpreted as:

* BTC/USD
  * `rate = 23131.27 BTC/USD`
  * `lastUpdatedBase = 1659588229`
  * `lastUpdatedQuote = 1659589497`
* ETH/BTC
  * `rate = 0.07160177543213148 ETH/BTC`
  * `lastUpdatedBase = 1659588229`
  * `lastUpdatedQuote = 1659588229`


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.findora.org/developers/evm-tools-and-tutorials/band-protocol.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.