Skip to content

Commit c0b801e

Browse files
authored
[doc] README updates (#637)
1 parent b9430ae commit c0b801e

File tree

3 files changed

+28
-107
lines changed

3 files changed

+28
-107
lines changed

CONTRIBUTING.md

Lines changed: 0 additions & 68 deletions
This file was deleted.

README.md

Lines changed: 21 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
11
# Pyth Crosschain
22

33
This repository acts as a monorepo for the various components that make up
4-
Pyth Crosschain. The base repository is a fork from Certus One's reference
5-
[Wormhole][] implementation in order to take advantage of the existing tooling
6-
for building projects based on Wormhole's various SDKs. Much of the existing
7-
documentation from there will also apply to this repository.
8-
9-
[wormhole]: https://github.com/wormhole-foundation/wormhole
4+
Pyth Crosschain.
105

116
Within this monorepo you will find the following subprojects:
127

@@ -15,8 +10,8 @@ Within this monorepo you will find the following subprojects:
1510
> wormhole_attester
1611
1712
The main Pyth implementation currently exists as an [on-chain contract][] on
18-
Solana. In order to expose these prices cross-chain, the Wormhole Attester
19-
contract acts as a sender for Pyth prices. At regular intervals the Pyth
13+
Pythnet, a separate instance of the Solana blockchain. In order to expose
14+
these prices cross-chain, the Wormhole Attester contract acts as a sender for Pyth prices. At regular intervals the Pyth
2015
contract will observe the current Pyth price for selected products, and produce
2116
an attestation which is then relayed over Wormhole to be consumed by the
2217
various receiver contracts.
@@ -25,45 +20,28 @@ various receiver contracts.
2520

2621
## Target Chains
2722

28-
### Ethereum
29-
30-
> target_chains/ethereum/contracts/pyth
31-
32-
The Ethereum contract acts as a receiver for Pyth prices relayed from the
33-
Wormhole Attester. It also provides a public API for other Ethereum contracts
34-
that can be used to consume Pyth prices. For a guide on using this API to
35-
consume Pyth price feeds see [pyth-sdk-solidity][] which contains documented
36-
examples.
23+
> target_chains
3724
38-
[pyth-sdk-solidity]: https://github.com/pyth-network/pyth-sdk-solidity
25+
This directory contains on-chain contracts and SDKs for all of the various
26+
blockchain runtimes that Pyth supports. Each subdirectory corresponds to a
27+
blockchain runtime. Inside each subdirectory, there are subfolders for
28+
contracts, SDKs, and examples.
3929

4030
## Price Service
4131

4232
> price_service
4333
4434
The Price Service is an off-chain service which constantly observes the
45-
Wormhole network watching for price attestations emitted from the Pyth Solana
35+
Wormhole network watching for price attestations emitted from the Pyth
4636
contract. It exposes all observed attestations via a public API over HTTPS/WSS
4737
which can be consumed by client-side applications that wish to use Pyth pricing
4838
data.
4939

50-
For a guide on utilising this service in your project, see the documentation in
51-
the [pyth-js][] repository.
52-
53-
[pyth-js]: https://github.com/pyth-network/pyth-js
54-
55-
---
40+
The `client` subdirectory provides an SDK for interacting with the price service.
41+
However, most users will interact with the price service via a chain-specific SDK
5642

57-
See [DEVELOP.md](DEVELOP.md) for instructions on how to set up a local devnet, and
58-
[CONTRIBUTING.md](CONTRIBUTING.md) for instructions on how to contribute to this project.
59-
60-
### Audit / Feature Status
61-
62-
**This software is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
63-
implied. See the License for the specific language governing permissions and limitations under the License.** Or plainly
64-
spoken - this is a very complex piece of software which targets a bleeding-edge, experimental smart contract runtime.
65-
Mistakes happen, and no matter how hard you try and whether you pay someone to audit it, it may eat your tokens, set
66-
your printer on fire or startle your cat. Cryptocurrencies are a high-risk investment, no matter how fancy.
43+
For a guide on utilising this service in your project, see the chain-specific SDK
44+
and examples for your blockchain runtime in the `target_chains` directory.
6745

6846
## Development
6947

@@ -80,3 +58,11 @@ The checks are also performed in the CI to ensure the code follows consistent fo
8058
### Tilt CI
8159

8260
Integration tests run in Tilt (via the `tilt ci` command). The Tilt CI workflow requires approval from a member of the Pyth team. If you are a member, click on "Details" next to the "Workflow / ci-pyth-crosschain" check in a pull request, and then on the "Resume" button on the workflow page.
61+
62+
## Audit / Feature Status
63+
64+
**This software is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
65+
implied. See the License for the specific language governing permissions and limitations under the License.** Or plainly
66+
spoken - this is a very complex piece of software which targets a bleeding-edge, experimental smart contract runtime.
67+
Mistakes happen, and no matter how hard you try and whether you pay someone to audit it, it may eat your tokens, set
68+
your printer on fire or startle your cat. Cryptocurrencies are a high-risk investment, no matter how fancy.

DEVELOP.md renamed to tilt_devnet/README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,24 @@
1-
# Developing the bridge
1+
# Tilt Devnet
22

3-
## Local Devnet
3+
We use Tilt to run integration tests. These tests instantiate docker containers with all of the
4+
various blockchains and services in order to verify that they interoperate correctly.
5+
6+
## Installation
47

58
The following dependencies are required for local development:
69

710
- [Go](https://golang.org/dl/) >= 1.17.5
811
- [Tilt](http://tilt.dev/) >= 0.20.8
912
- Any of the local Kubernetes clusters supported by Tilt.
1013
We strongly recommend [minikube](https://kubernetes.io/docs/setup/learning-environment/minikube/) >=
11-
v1.21.0 with the kvm2 driver.
14+
v1.21.0 .
1215
- Tilt will use Minikube's embedded Docker server. If Minikube is not used, a local instance of
1316
[Docker](https://docs.docker.com/engine/install/) / moby-engine >= 19.03 is required.
1417

1518
See the [Tilt docs](https://docs.tilt.dev/install.html) docs on how to set up your local cluster -
1619
it won't take more than a few minutes to set up! Example minikube invocation, adjust limits as needed:
1720

18-
minikube start --cpus=8 --memory=8G --disk-size=50G --driver=kvm2
21+
minikube start --cpus=8 --memory=8G --disk-size=50G --driver=docker
1922

2023
npm wants to set up an insane number of inotify watches in the web container which may exceed kernel limits.
2124
The minikube default is too low, adjust it like this:

0 commit comments

Comments
 (0)