-
Notifications
You must be signed in to change notification settings - Fork 104
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add external project integration section (#228)
* feat: try adding external project * feat: try adding barebone * feat: add Integration External Project readme * feat: aDd external projects * feat: chagne to external projects
- Loading branch information
Showing
5 changed files
with
83 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# External Projects | ||
|
||
Osmosis supports integration with a diverse range of external projects. | ||
|
||
For detailed guidance on integration processes, please consult the links below: | ||
|
||
- Pyth: [How to Integrate with Pyth](./pyth.md) | ||
- SubQuery: [How to Integrate with SubQuery](./subquery.md) | ||
|
||
If you represent a project interested in being listed, we welcome your contribution. Kindly submit a Pull Request at [github.com/osmosis-labs/docs](https://github.com/osmosis-labs/docs). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# Pyth | ||
|
||
## Introduction | ||
|
||
Pyth Network is an oracle that publishes financial market data to multiple blockchains. Our market data is contributed by over 90 first-party publishers(opens in a new tab), including some of the biggest exchanges and market making firms in the world. We offer price feeds for a number of different asset classes, including US equities, commodities, and cryptocurrencies(opens in a new tab). Each price feed publishes a robust aggregate of publisher prices that updates multiple times per second. | ||
|
||
## Pyth on Cosmwasm | ||
Cosmwasm contracts can update and fetch the Pyth prices using the Pyth Cosmwasm Contract, deployed on their network. The documented source code can be found [here](https://github.com/pyth-network/pyth-crosschain/tree/main/target_chains/cosmwasm/contracts/pyth). The Cosmwasm API reference lets you interactively explore the complete API of the Pyth contract. | ||
|
||
|
||
## Update Price Feeds | ||
|
||
The mechanism by which price feeds are updated on Cosmwasm is explained in the [Pyth documentation](https://docs.pyth.network/documentation/pythnet-price-feeds/pull-updates). The [`@pythnetwork/price-service-client` TypeScript package](https://github.com/pyth-network/pyth-crosschain/tree/main/price_service/client/js) can be used to fetch the latest price feed data which then can be passed to the contract as the `UpdatePriceFeeds` ExecuteMsg. | ||
|
||
Pyth publishes prices for two kinds of feeds: | ||
|
||
- **Stable price feeds** consist of prices generated on the pythnet blockchain. These feeds are available on both mainnet and testnet blockchains. Use stable feeds if you would like your test environment to be identical to your production environment. | ||
|
||
- **Edge price feeds** consist of prices generated on the pythtest blockchain, which is Pyth's test environment for new features. Consequently, these feeds are not as reliable as the stable feeds, and there are other differences as well (e.g., different price feed ids). These feeds are only available on testnets. | ||
|
||
## Examples | ||
|
||
- A minimal on-chain [contract example](https://github.com/pyth-network/pyth-crosschain/tree/main/target_chains/cosmwasm/examples/cw-contract) which queries the Pyth contract. | ||
|
||
## Contract Address for `Osmosis Test 5` | ||
|
||
- Stable: `osmo1hpdzqku55lmfmptpyj6wdlugqs5etr6teqf7r4yqjjrxjznjhtuqqu5kdh` | ||
- Beta: `osmo1lltupx02sj99suakmuk4sr4ppqf34ajedaxut3ukjwkv6469erwqtpg9t3` | ||
|
||
## Price Feed IDs | ||
|
||
The price feed IDs for stable and edge feeds are different and can be found at the following links: | ||
|
||
- [List of stable ids](https://pyth.network/developers/price-feed-ids#cosmwasm-stable) | ||
- [List of beta ids](https://pyth.network/developers/price-feed-ids#cosmwasm-edge) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# SubQuery | ||
|
||
## Intro | ||
|
||
SubQuery is a leading blockchain data indexer that provides developers with fast, flexible, universal, open source and decentralised APIs for web3 projects. SubQuery SDK allows developers to get rich indexed data and build intuitive and immersive decentralised applications in a faster and more efficient way. SubQuery supports 100+ ecosystems including Osmosis, Cosmos, Ethereum, Polygon, Polkadot, Algorand, NEAR, and Avalanche. | ||
|
||
Another one of SubQuery's competitive advantages is the ability to aggregate data not only within a chain but across multiple blockchains all within a single project. This allows the creation of feature-rich dashboard analytics, multi-chain block scanners, or projects that index IBC transactions across zones. | ||
|
||
Other advantages include superior performance with multiple RPC endpoint configurations, multi-worker capabilities and a configurable caching architecture. To find out more, visit our documentation. | ||
|
||
## Useful resources | ||
|
||
- SubQuery General Docs: <https://academy.subquery.network/> | ||
- Quick Start Guide: <https://academy.subquery.network/quickstart/quickstart.html> | ||
- Osmosis Starter Project: <https://github.com/subquery/cosmos-subql-starter/tree/main/Osmosis> | ||
- SubQuery Osmosis Example Project: <https://academy.subquery.network/quickstart/quickstart_chains/cosmos-osmosis.html> and article <https://blog.subquery.network/subquery-example-project-osmosis/?lng=en?> | ||
- SubQuery Osmosis Workshop Recording: <https://www.youtube.com/watch?v=t6QfK8g5sCw&t=39s> | ||
|
||
# Getting started | ||
|
||
Take a look at this SubQuery starter project that indexes all swaps on Osmosis' on-chain DEX. | ||
|
||
You can also follow along with this step-by-step guide to get familiar with SubQuery. | ||
|
||
## Running and Hosting your Osmosis SubQuery APIs | ||
|
||
SubQuery is open-source, meaning you have the freedom to run it in the following three ways: | ||
|
||
1. Locally on your own computer (or a cloud provider of your choosing), view the instructions on how to run SubQuery Locally. | ||
|
||
2. By publishing it to SubQuery's enterprise-level Managed Service, where we'll host your SubQuery project in production-ready services for mission-critical data with zero-downtime blue/green deployments. There even is a generous free tier. Find out how. | ||
|
||
3. By publishing it to the decentralised SubQuery Network, the most open, performant, reliable, and scalable data service for dApp developers. The SubQuery Network indexes and services data to the global community in an incentivised and verifiable way and supports Osmosis from launch. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bfe9615
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Successfully deployed to the following URLs:
docs – ./
docs-git-main-osmo-labs.vercel.app
docs-osmo-labs.vercel.app
docs.osmosis.zone
docs-beta-olive.vercel.app