https://github.com/balmy-protocol/oracles

A repository to store everything related to Mean's oracles
https://github.com/balmy-protocol/oracles

Last synced: 5 days ago
JSON representation

A repository to store everything related to Mean's oracles

• Host: GitHub
• URL: https://github.com/balmy-protocol/oracles
• Owner: Balmy-protocol
• License: gpl-3.0
• Created: 2022-06-09T15:13:32.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-01-28T02:44:37.000Z (10 months ago)
• Last Synced: 2024-11-11T21:55:06.682Z (6 days ago)
• Language: TypeScript
• Size: 649 KB
• Stars: 18
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Lint](https://github.com/Mean-Finance/oracles/actions/workflows/lint.yml/badge.svg?branch=main)](https://github.com/Mean-Finance/oracles/actions/workflows/lint.yml)

[![Tests](https://github.com/Mean-Finance/oracles/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/Mean-Finance/oracles/actions/workflows/tests.yml)

[![Slither Analysis](https://github.com/Mean-Finance/oracles/actions/workflows/slither.yml/badge.svg?branch=main)](https://github.com/Mean-Finance/oracles/actions/workflows/slither.yml)

# Mean Finance Oracles

This repository will hold all Mean Finance's oracle infrastructure. It aims to have a sufficiently flexible architecture as to support a wide amount of tokens composition, and therefore enabling quoting pairs that couldn't be done before.

Some of this is achieved by leveraging already existing oracles like [Uniswap V3 Static Oracle](https://github.com/Mean-Finance/uniswap-v3-oracle).

## 🔒 Audits

Oracles has been audited by [Omniscia](https://omniscia.io/) and can be find [here](https://omniscia.io/reports/mean-finance-oracle-module/).

## 📦 NPM/YARN Package

The package will contain:

- Artifacts can be found under `@mean-finance/oracles/artifacts`

- Typescript smart contract typings under `@mean-finance/oracles/typechained`

## 📚 Documentation

Everything that you need to know as a developer on how to use all repository smart contracts can be found in the [documented interfaces](./solidity/interfaces/).

## 🛠 Installation

To install with [**Hardhat**](https://github.com/nomiclabs/hardhat) or [**Truffle**](https://github.com/trufflesuite/truffle):

#### YARN

```sh

yarn add @mean-finance/oracles

```

### NPM

```sh

npm install @mean-finance/oracles

```

## 📖 Deployment Registry

Contracts are deployed at the same address on all available networks via the [deterministic contract factory](https://github.com/Mean-Finance/deterministic-factory)

> Available networks: Optimism, Arbitrum One, Polygon.

- Identity Oracle: `0x0171C3D8315159d771f4A4e09840b1747b7f7364`

- OracleAggregator: `0x9e1ca4Cd00ED059C5d34204DCe622549583545d9`

- StatefulChainlinkOracle: `0x5587d300d41E418B3F4DC7c273351748a116d78B`

- UniswapV3Adapter: `0xD741623299413d02256aAC2101f8B30873fED1d2`

- TransformerOracle: `0xEB8615cF5bf0f851aEFa894307aAe2b595628148`