Skip to content

StabilityNexus/OrbOracle-Poster

Repository files navigation

Stability Nexus

 

Static Badge

Telegram Badge    X (formerly Twitter) Badge    Discord Badge    Medium Badge    LinkedIn Badge    Youtube Badge


OrbOracle Poster

OrbOracle Poster automates the value submission to an oracle launched in OrbOracle. It fetches values from networks like ChainLink, Pyth, or general REST APIs, and submits them to an OrbOracle contract on behalf of the user.

Tech Stack

Backend & Core

  • Node.js (TypeScript)
  • Ethers.js (Blockchain interaction)
  • Axios (HTTP requests)
  • Jest (Testing)

Infrastructure

  • Docker & Docker Compose

Getting Started

Prerequisites

  • Node.js 18+
  • npm/yarn/pnpm
  • MetaMask or any other web3 wallet browser extension
  • An oracle on OrbOracle

Installation

1. Fork and Clone the Repository

git clone https://github.com/DeveloperAmrit/OrbOracle-Poster.git
cd OrbOracle-Poster

2. Install Dependencies

npm install

3. Environment Configuration

Copy the example environment file:

cp .env.example .env

Open .env and configure the following variables:

  • RPC_URL: The JSON-RPC endpoint for your node provider (e.g., Alchemy, Infura, or a local node).
  • PRIVATE_KEY: The private key of the wallet submitting the transactions.
  • ORACLE_ADDRESS: The deployed OrbOracle contract address.
  • FEED_URL: The REST API URL for fetching prices (e.g., CoinGecko, Binance, Pyth off-chain API).
  • CHAINLINK_FEED_ADDRESS (Optional): Chainlink Aggregator Contract Address to fetch values from Chainlink.
  • CHAINLINK_RPC_URL (Optional): RPC URL used specifically for the Chainlink feed. Defaults to RPC_URL if omitted.
  • PYTH_PRICE_ID: The Pyth Price Feed ID (Defaults to ADA/USD).
  • UPDATE_INTERVAL_MS: Frequency of submissions in milliseconds.
  • MIN_STAKE_REQUIRED: Minimum token amount required to submit.

4. Launch the App

Start the poster using:

npm start

Contributing

We welcome contributions of all kinds! To contribute:

  1. Fork the repository and create your feature branch (git checkout -b feature/AmazingFeature).
  2. Commit your changes (git commit -m 'Add some AmazingFeature').
  3. Run the development workflow commands to ensure code quality:
    • npm run format:write
    • npm run lint:fix
    • npm run typecheck
  4. Push your branch (git push origin feature/AmazingFeature).
  5. Open a Pull Request for review.

If you encounter bugs, need help, or have feature requests:

  • Please open an issue in this repository providing detailed information.
  • Describe the problem clearly and include any relevant logs or screenshots.

We appreciate your feedback and contributions!

© 2025 The Stable Order.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors