|
|
@@ -1,7 +1,7 @@
|
|
|
-# Pyth2Wormhole
|
|
|
+# Pyth Crosschain
|
|
|
|
|
|
This repository acts as a monorepo for the various components that make up
|
|
|
-Pyth2Wormhole. The base repository is a fork from Certus One's reference
|
|
|
+Pyth Crosschain. The base repository is a fork from Certus One's reference
|
|
|
[Wormhole][] implementation in order to take advantage of the existing tooling
|
|
|
for building projects based on Wormhole's various SDKs. Much of the existing
|
|
|
documentation from there will also apply to this repository.
|
|
|
@@ -10,36 +10,38 @@ documentation from there will also apply to this repository.
|
|
|
|
|
|
Within this monorepo you will find the following subprojects:
|
|
|
|
|
|
-## Pyth2Wormhole Solana
|
|
|
+## Wormhole Attester
|
|
|
|
|
|
-> solana/pyth2wormhole
|
|
|
+> wormhole-attester
|
|
|
|
|
|
The main Pyth implementation currently exists as an [on-chain contract][] on
|
|
|
-Solana. In order to expose these prices cross-chain, the Pyth2Wormhole Solana
|
|
|
+Solana. In order to expose these prices cross-chain, the Wormhole Attester
|
|
|
contract acts as a sender for Pyth prices. At regular intervals the Pyth
|
|
|
contract will observe the current Pyth price for selected products, and produce
|
|
|
an attestation which is then relayed over Wormhole to be consumed by the
|
|
|
-various P2W receiver contracts.
|
|
|
+various receiver contracts.
|
|
|
|
|
|
[on-chain contract]: https://github.com/pyth-network/pyth-client
|
|
|
|
|
|
-## Pyth2Wormhole Ethereum
|
|
|
+## Target Chains
|
|
|
|
|
|
-> ethereum/contracts/pyth
|
|
|
+### Ethereum
|
|
|
|
|
|
-The Ethereum P2W contract acts as a receiver for Pyth prices relayed from the
|
|
|
-P2W Solana contract. It also provides a public API for other Ethereum contracts
|
|
|
+> target-chains/ethereum/contracts/pyth
|
|
|
+
|
|
|
+The Ethereum contract acts as a receiver for Pyth prices relayed from the
|
|
|
+Wormhole Attester. It also provides a public API for other Ethereum contracts
|
|
|
that can be used to consume Pyth prices. For a guide on using this API to
|
|
|
-consume Pyth price feeds see [pyth-evm-sdk][] which contains documented
|
|
|
+consume Pyth price feeds see [pyth-sdk-solidity][] which contains documented
|
|
|
examples.
|
|
|
|
|
|
-[pyth-evm-sdk]: https://github.com/pyth-network/pyth-sdk-solidity
|
|
|
+[pyth-sdk-solidity]: https://github.com/pyth-network/pyth-sdk-solidity
|
|
|
|
|
|
-## Pyth2Wormhole Price Service
|
|
|
+## Price Service
|
|
|
|
|
|
-> third_party/pyth
|
|
|
+> price-service
|
|
|
|
|
|
-The P2W Price Service is an off-chain service which constantly observes the
|
|
|
+The Price Service is an off-chain service which constantly observes the
|
|
|
Wormhole network watching for price attestations emitted from the Pyth Solana
|
|
|
contract. It exposes all observed attestations via a public API over HTTPS/WSS
|
|
|
which can be consumed by client-side applications that wish to use Pyth pricing
|