- 📖 Table of Contents
- 📍 Overview
- 📂 repository Structure
- 🚀 Getting Started
- 🤝 Contributing
- 📄 License
- 👏 Acknowledgments
Get the spot price of any token pair listed on curve.
└── Get-Curve-Spot-Price/
├── .build/
│ ├── ICurvePool.json
│ ├── IDAI.json
│ ├── IERC20.json
│ ├── IMATIC.json
│ ├── IUSDC.json
│ ├── IWBTC.json
│ ├── IWETH.json
│ └── __local__.json
├── ape-config.yaml
├── contracts/
│ └── interfaces/
│ ├── ICurvePool.sol
│ ├── IDAI.sol
│ ├── IERC20.sol
│ ├── IMATIC.sol
│ ├── IUSDC.sol
│ ├── IWBTC.sol
│ └── IWETH.sol
├── poetry.lock
├── pyproject.toml
└── scripts/
├── constants.py
├── get_price.py
├── tokens.py
└── utils.py
- Clone the Get-Curve-Spot-Price repository:
git clone https://github.com/Aviksaikat/Get-Curve-Spot-Price
- Change to the project directory:
cd Get-Curve-Spot-Price
- Install the dependencies:
- install poetry
poetry install
poery ape run scripts/get_price.py
# Or
poetry shell
ape run scripts/get_price.py
poery ape test
Contributions are welcome! Here are several ways you can contribute:
- Submit Pull Requests: Review open PRs, and submit your own PRs.
- Join the Discussions: Share your insights, provide feedback, or ask questions.
- Report Issues: Submit bugs found or log feature requests for AVIKSAIKAT.
Click to expand
- Fork the Repository: Start by forking the project repository to your GitHub account.
- Clone Locally: Clone the forked repository to your local machine using a Git client.
git clone <your-forked-repo-url>
- Create a New Branch: Always work on a new branch, giving it a descriptive name.
git checkout -b new-feature-x
- Make Your Changes: Develop and test your changes locally.
- Commit Your Changes: Commit with a clear and concise message describing your updates.
git commit -m 'Implemented new feature x.'
- Push to GitHub: Push the changes to your forked repository.
git push origin new-feature-x
- Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
Once your PR is reviewed and approved, it will be merged into the main branch.