Skip to content

Commit c69e3d2

Browse files
authored
Cargo structure cleanup (#8)
* Add cargo workspace * Fix pyth-sdk repo * Move rustfmt back to root * Add README.md in root
1 parent 095ba76 commit c69e3d2

File tree

7 files changed

+27
-31
lines changed

7 files changed

+27
-31
lines changed

Cargo.toml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[workspace]
2+
3+
members = [
4+
"pyth-sdk",
5+
"pyth-sdk-solana",
6+
]

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Pyth SDK
2+
3+
This repo contains multiple crates for using Pyth Oracle.
4+
1. Pyth SDK: This crate contains general Pyth structures and interfaces which are consistent across different blockchains.
5+
2. Pyth SDK Solana: This crate contains methods for reading and parsing Pyth structures from Pyth Solana accounts.
6+
7+
## Development
8+
9+
These crates can be built for either your native platform or other platforms for specific blockchains.
10+
- Use `cargo build` / `cargo test` to build and test natively.
11+
12+
### Releases
13+
14+
To release new versions of these packages, perform the following steps within the crate being released:
15+
16+
1. Increment the version number in `Cargo.toml`.
17+
You may use a version number with a `-beta.x` suffix such as `0.0.1-beta.0` to create opt-in test versions.
18+
2. Merge your change into `main` on github.
19+
3. Create and publish a new github release.

pyth-sdk-solana/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "pyth-sdk-solana"
3-
version = "0.5.0"
3+
version = "0.1.0"
44
authors = ["Pyth Data Foundation"]
55
edition = "2018"
66
license = "Apache-2.0"

pyth-sdk-solana/README.md

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -175,14 +175,3 @@ Use `cargo build-bpf` / `cargo test-bpf` to build in BPF for Solana; these comma
175175
The BPF tests will also run an instruction count program that logs the resource consumption
176176
of various library functions.
177177
This program can also be run on its own using `cargo test-bpf --test instruction_count`.
178-
179-
### Releases
180-
181-
To release a new version of this package, perform the following steps:
182-
183-
1. Increment the version number in `Cargo.toml`.
184-
You may use a version number with a `-beta.x` suffix such as `0.0.1-beta.0` to create opt-in test versions.
185-
2. Merge your change into `main` on github.
186-
3. Create and publish a new github release.
187-
The name of the release should be the version number, and the tag should be the version number prefixed with `v`.
188-
Publishing the release will trigger a github action that will automatically publish the [pyth-client](https://crates.io/crates/pyth-client) rust crate to `crates.io`.

pyth-sdk/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ authors = ["Pyth Data Foundation"]
55
edition = "2018"
66
license = "Apache-2.0"
77
homepage = "https://pyth.network"
8-
repository = "https://github.com/pyth-network/pyth-client-rs"
8+
repository = "https://github.com/pyth-network/pyth-sdk-rs"
99
description = "pyth price oracle data structures and example usage"
1010
keywords = [ "pyth", "oracle" ]
1111
readme = "README.md"

pyth-sdk/rustfmt.toml

Lines changed: 0 additions & 18 deletions
This file was deleted.
File renamed without changes.

0 commit comments

Comments
 (0)